Fixed up ivy annotations on the new structure supporting page_coloring.
[akaros.git] / kern / src / syscall.c
1 /* See COPYRIGHT for copyright information. */
2
3 #include <arch/types.h>
4 #include <arch/arch.h>
5 #include <arch/mmu.h>
6 #include <arch/console.h>
7 #include <ros/timer.h>
8 #include <ros/error.h>
9
10 #include <string.h>
11 #include <assert.h>
12 #include <process.h>
13 #include <schedule.h>
14 #include <pmap.h>
15 #include <trap.h>
16 #include <syscall.h>
17 #include <stdio.h>
18 #include <kfs.h> // eventually replace this with vfs.h
19
20 //Do absolutely nothing.  Used for profiling.
21 static void sys_null(void)
22 {
23         return;
24 }
25
26 //Write a buffer over the serial port
27 static ssize_t sys_serial_write(env_t* e, const char *DANGEROUS buf, size_t len)
28 {
29         #ifdef SERIAL_IO
30                 char *COUNT(len) _buf = user_mem_assert(e, buf, len, PTE_USER_RO);
31                 for(int i =0; i<len; i++)
32                         serial_send_byte(buf[i]);
33                 return (ssize_t)len;
34         #else
35                 return -EINVAL;
36         #endif
37 }
38
39 //Read a buffer over the serial port
40 static ssize_t sys_serial_read(env_t* e, char *DANGEROUS _buf, size_t len)
41 {
42         #ifdef SERIAL_IO
43             char *COUNT(len) buf = user_mem_assert(e, _buf, len, PTE_USER_RO);
44                 size_t bytes_read = 0;
45                 int c;
46                 while((c = serial_read_byte()) != -1) {
47                         buf[bytes_read++] = (uint8_t)c;
48                         if(bytes_read == len) break;
49                 }
50                 return (ssize_t)bytes_read;
51         #else
52                 return -EINVAL;
53         #endif
54 }
55
56 static ssize_t sys_shared_page_alloc(env_t* p1,
57                                      void**DANGEROUS _addr, envid_t p2_id,
58                                      int p1_flags, int p2_flags
59                                     )
60 {
61         //if (!VALID_USER_PERMS(p1_flags)) return -EPERM;
62         //if (!VALID_USER_PERMS(p2_flags)) return -EPERM;
63
64         void * COUNT(1) * COUNT(1) addr = user_mem_assert(p1, _addr, sizeof(void *), 
65                                                       PTE_USER_RW);
66         page_t* page;
67         env_t* p2 = &(envs[ENVX(p2_id)]);
68         error_t e = page_alloc(&page);
69
70         if(e < 0) return e;
71
72         void* p2_addr = page_insert_in_range(p2->env_pgdir, page,
73                                              (void*SNT)UTEXT, (void*SNT)UTOP, p2_flags);
74         if(p2_addr == NULL)
75                 return -EFAIL;
76
77         void* p1_addr = page_insert_in_range(p1->env_pgdir, page,
78                                             (void*SNT)UTEXT, (void*SNT)UTOP, p1_flags);
79         if(p1_addr == NULL) {
80                 page_remove(p2->env_pgdir, p2_addr);
81                 return -EFAIL;
82         }
83         *addr = p1_addr;
84         return ESUCCESS;
85 }
86
87 static void sys_shared_page_free(env_t* p1, void*DANGEROUS addr, envid_t p2)
88 {
89 }
90
91 // Invalidate the cache of this core.  Only useful if you want a cold cache for
92 // performance testing reasons.
93 static void sys_cache_invalidate(void)
94 {
95         #ifdef __i386__
96                 wbinvd();
97         #endif
98         return;
99 }
100
101 // Writes 'val' to 'num_writes' entries of the well-known array in the kernel
102 // address space.  It's just #defined to be some random 4MB chunk (which ought
103 // to be boot_alloced or something).  Meant to grab exclusive access to cache
104 // lines, to simulate doing something useful.
105 static void sys_cache_buster(env_t* e, uint32_t num_writes, uint32_t num_pages,
106                              uint32_t flags)
107 { TRUSTEDBLOCK /* zra: this is not really part of the kernel */
108         #define BUSTER_ADDR             0xd0000000  // around 512 MB deep
109         #define MAX_WRITES              1048576*8
110         #define MAX_PAGES               32
111         #define INSERT_ADDR     (UINFO + 2*PGSIZE) // should be free for these tests
112         uint32_t* buster = (uint32_t*)BUSTER_ADDR;
113         static uint32_t buster_lock = 0;
114         uint64_t ticks = -1;
115         page_t* a_page[MAX_PAGES];
116
117         /* Strided Accesses or Not (adjust to step by cachelines) */
118         uint32_t stride = 1;
119         if (flags & BUSTER_STRIDED) {
120                 stride = 16;
121                 num_writes *= 16;
122         }
123
124         /* Shared Accesses or Not (adjust to use per-core regions)
125          * Careful, since this gives 8MB to each core, starting around 512MB.
126          * Also, doesn't separate memory for core 0 if it's an async call.
127          */
128         if (!(flags & BUSTER_SHARED))
129                 buster = (uint32_t*)(BUSTER_ADDR + core_id() * 0x00800000);
130
131         /* Start the timer, if we're asked to print this info*/
132         if (flags & BUSTER_PRINT_TICKS)
133                 ticks = start_timing();
134
135         /* Allocate num_pages (up to MAX_PAGES), to simulate doing some more
136          * realistic work.  Note we don't write to these pages, even if we pick
137          * unshared.  Mostly due to the inconvenience of having to match up the
138          * number of pages with the number of writes.  And it's unnecessary.
139          */
140         if (num_pages) {
141                 spin_lock(&buster_lock);
142                 for (int i = 0; i < MIN(num_pages, MAX_PAGES); i++) {
143                         page_alloc(&a_page[i]);
144                         page_insert(e->env_pgdir, a_page[i], (void*)INSERT_ADDR + PGSIZE*i,
145                                     PTE_USER_RW);
146                 }
147                 spin_unlock(&buster_lock);
148         }
149
150         if (flags & BUSTER_LOCKED)
151                 spin_lock(&buster_lock);
152         for (int i = 0; i < MIN(num_writes, MAX_WRITES); i=i+stride)
153                 buster[i] = 0xdeadbeef;
154         if (flags & BUSTER_LOCKED)
155                 spin_unlock(&buster_lock);
156
157         if (num_pages) {
158                 spin_lock(&buster_lock);
159                 for (int i = 0; i < MIN(num_pages, MAX_PAGES); i++) {
160                         page_remove(e->env_pgdir, (void*)(INSERT_ADDR + PGSIZE * i));
161                         page_decref(a_page[i]);
162                 }
163                 spin_unlock(&buster_lock);
164         }
165
166         /* Print info */
167         if (flags & BUSTER_PRINT_TICKS) {
168                 ticks = stop_timing(ticks);
169                 printk("%llu,", ticks);
170         }
171         return;
172 }
173
174 // Print a string to the system console.
175 // The string is exactly 'len' characters long.
176 // Destroys the environment on memory errors.
177 static ssize_t sys_cputs(env_t* e, const char *DANGEROUS s, size_t len)
178 {
179         // Check that the user has permission to read memory [s, s+len).
180         // Destroy the environment if not.
181     char *COUNT(len) _s = user_mem_assert(e, s, len, PTE_USER_RO);
182
183         // Print the string supplied by the user.
184         printk("%.*s", len, _s);
185         return (ssize_t)len;
186 }
187
188 // Read a character from the system console.
189 // Returns the character.
190 static uint16_t sys_cgetc(env_t* e)
191 {
192         uint16_t c;
193
194         // The cons_getc() primitive doesn't wait for a character,
195         // but the sys_cgetc() system call does.
196         while ((c = cons_getc()) == 0)
197                 cpu_relax();
198
199         return c;
200 }
201
202 // Returns the current environment's envid.
203 static envid_t sys_getenvid(env_t* e)
204 {
205         return e->env_id;
206 }
207
208 // Returns the id of the cpu this syscall is executed on.
209 static envid_t sys_getcpuid(void)
210 {
211         return core_id();
212 }
213
214 // TODO FIX Me!!!! for processes
215 // Destroy a given environment (possibly the currently running environment).
216 //
217 // Returns 0 on success, < 0 on error.  Errors are:
218 //      -EBADENV if environment envid doesn't currently exist,
219 //              or the caller doesn't have permission to change envid.
220 static error_t sys_env_destroy(env_t* e, envid_t envid)
221 {
222         int r;
223         env_t *env_to_die;
224
225         if ((r = envid2env(envid, &env_to_die, 1)) < 0)
226                 return r;
227         if (env_to_die == e)
228                 printk("[%08x] exiting gracefully\n", e->env_id);
229         else
230                 panic("Destroying other processes is not supported yet.");
231                 //printk("[%08x] destroying %08x\n", e->env_id, env_to_die->env_id);
232         proc_destroy(env_to_die);
233         return ESUCCESS;
234 }
235
236 /*
237  * Current process yields its remaining "time slice".  Currently works for
238  * single-core processes.
239  * TODO: think about how this works with async calls and multicored procs.
240  * Want it to only be callable locally.
241  */
242 static void sys_yield(struct proc *p)
243 {
244         // This is all standard single-core, local call
245         spin_lock_irqsave(&p->proc_lock);
246         assert(p->state == PROC_RUNNING_S);
247         proc_set_state(p, PROC_RUNNABLE_S);
248         schedule_proc(p);
249         spin_unlock_irqsave(&p->proc_lock);
250         // the implied thing here is that all state has been saved before leaving
251         // could do the "leaving the process context" here, mentioned in startcore
252         schedule();
253
254         /* TODO
255          * if running_s, give up your time slice (schedule, save silly state, block)
256          * if running_m and 2+ cores are left, give yours up, stay running_m
257          * if running_m and last core, switch to runnable_s
258          */
259 }
260
261 /*
262  * Creates a process found at the user string 'path'.  Currently uses KFS.
263  * Not runnable by default, so it needs it's status to be changed so that the
264  * next call to schedule() will try to run it.
265  * TODO: once we have a decent VFS, consider splitting this up
266  * and once there's an mmap, can have most of this in process.c
267  */
268 static int sys_proc_create(struct proc *p, const char *DANGEROUS path)
269 {
270         #define MAX_PATH_LEN 256 // totally arbitrary
271         int pid = 0;
272         char tpath[MAX_PATH_LEN];
273         /*
274          * There's a bunch of issues with reading in the path, which we'll
275          * need to sort properly in the VFS.  Main concerns are TOCTOU (copy-in),
276          * whether or not it's a big deal that the pointer could be into kernel
277          * space, and resolving both of these without knowing the length of the
278          * string. (TODO)
279          * Change this so that all syscalls with a pointer take a length.
280          *
281          * zra: I've added this user_mem_strlcpy, which I think eliminates the
282      * the TOCTOU issue. Adding a length arg to this call would allow a more
283          * efficient implementation, though, since only one call to user_mem_check
284          * would be required.
285          */
286         int ret = user_mem_strlcpy(p,tpath, path, MAX_PATH_LEN, PTE_USER_RO);
287         int kfs_inode = kfs_lookup_path(tpath);
288         if (kfs_inode < 0)
289                 return -EINVAL;
290         struct proc *new_p = kfs_proc_create(kfs_inode);
291         return new_p->env_id; // TODO replace this with a real proc_id
292 }
293
294 /* Makes process PID runnable.  Consider moving the functionality to env.c */
295 static error_t sys_proc_run(struct proc *p, unsigned pid)
296 {
297         struct proc *target = get_proc(pid);
298         error_t retval = 0;
299         spin_lock_irqsave(&p->proc_lock); // note we can get interrupted here. it's not bad.
300         // make sure we have access and it's in the right state to be activated
301         if (!proc_controls(p, target)) {
302                 retval = -EPERM;
303         } else if (target->state != PROC_CREATED) {
304                 retval = -EINVAL;
305         } else {
306                 proc_set_state(target, PROC_RUNNABLE_S);
307                 schedule_proc(target);
308         }
309         spin_unlock_irqsave(&p->proc_lock);
310         return retval;
311 }
312
313 // TODO: Build a dispatch table instead of switching on the syscallno
314 // Dispatches to the correct kernel function, passing the arguments.
315 intreg_t syscall(env_t* e, uint32_t syscallno, uint32_t a1, uint32_t a2,
316                  uint32_t a3, uint32_t a4, uint32_t a5)
317 {
318         // Call the function corresponding to the 'syscallno' parameter.
319         // Return any appropriate return value.
320
321         //cprintf("Incoming syscall number: %d\n    a1: %x\n   "
322         //        " a2: %x\n    a3: %x\n    a4: %x\n    a5: %x\n",
323         //        syscallno, a1, a2, a3, a4, a5);
324
325         assert(e); // should always have an env for every syscall
326         //printk("Running syscall: %d\n", syscallno);
327         if (INVALID_SYSCALL(syscallno))
328                 return -EINVAL;
329
330         switch (syscallno) {
331                 case SYS_null:
332                         sys_null();
333                         return ESUCCESS;
334                 case SYS_cache_buster:
335                         sys_cache_buster(e, a1, a2, a3);
336                         return 0;
337                 case SYS_cache_invalidate:
338                         sys_cache_invalidate();
339                         return 0;
340                 case SYS_shared_page_alloc:
341                         return sys_shared_page_alloc(e, (void** DANGEROUS) a1,
342                                                  a2, (int) a3, (int) a4);
343                 case SYS_shared_page_free:
344                         sys_shared_page_free(e, (void* DANGEROUS) a1, a2);
345                     return ESUCCESS;
346                 case SYS_cputs:
347                         return sys_cputs(e, (char *DANGEROUS)a1, (size_t)a2);
348                 case SYS_cgetc:
349                         return sys_cgetc(e);
350                 case SYS_getcpuid:
351                         return sys_getcpuid();
352                 case SYS_getpid:
353                         return sys_getenvid(e);
354                 case SYS_proc_destroy:
355                         return sys_env_destroy(e, (envid_t)a1);
356                 case SYS_yield:
357                         sys_yield(e);
358                         return ESUCCESS;
359                 case SYS_proc_create:
360                         return sys_proc_create(e, (char *DANGEROUS)a1);
361                 case SYS_proc_run:
362                         return sys_proc_run(e, (size_t)a1);
363
364         #ifdef __i386__
365                 case SYS_serial_write:
366                         return sys_serial_write(e, (char *DANGEROUS)a1, (size_t)a2);
367                 case SYS_serial_read:
368                         return sys_serial_read(e, (char *DANGEROUS)a1, (size_t)a2);
369         #endif
370
371         #ifdef __sparc_v8__
372                 case SYS_frontend:
373                         return frontend_syscall(a1,a2,a3,a4);
374         #endif
375
376                 default:
377                         // or just return -EINVAL
378                         panic("Invalid syscall number %d for env %x!", syscallno, *e);
379         }
380         return 0xdeadbeef;
381 }
382
383 intreg_t syscall_async(env_t* e, syscall_req_t *call)
384 {
385         return syscall(e, call->num, call->args[0], call->args[1],
386                        call->args[2], call->args[3], call->args[4]);
387 }
388
389 intreg_t process_generic_syscalls(env_t* e, size_t max)
390 {
391         size_t count = 0;
392         syscall_back_ring_t* sysbr = &e->syscallbackring;
393
394         // make sure the env is still alive.
395         // incref will return ESUCCESS on success.
396         if (proc_incref(e))
397                 return -EFAIL;
398
399         // max is the most we'll process.  max = 0 means do as many as possible
400         while (RING_HAS_UNCONSUMED_REQUESTS(sysbr) && ((!max)||(count < max)) ) {
401                 if (!count) {
402                         // ASSUME: one queue per process
403                         // only switch cr3 for the very first request for this queue
404                         // need to switch to the right context, so we can handle the user pointer
405                         // that points to a data payload of the syscall
406                         lcr3(e->env_cr3);
407                 }
408                 count++;
409                 //printk("DEBUG PRE: sring->req_prod: %d, sring->rsp_prod: %d\n",\
410                            sysbr->sring->req_prod, sysbr->sring->rsp_prod);
411                 // might want to think about 0-ing this out, if we aren't
412                 // going to explicitly fill in all fields
413                 syscall_rsp_t rsp;
414                 // this assumes we get our answer immediately for the syscall.
415                 syscall_req_t* req = RING_GET_REQUEST(sysbr, ++(sysbr->req_cons));
416                 rsp.retval = syscall_async(e, req);
417                 // write response into the slot it came from
418                 memcpy(req, &rsp, sizeof(syscall_rsp_t));
419                 // update our counter for what we've produced (assumes we went in order!)
420                 (sysbr->rsp_prod_pvt)++;
421                 RING_PUSH_RESPONSES(sysbr);
422                 //printk("DEBUG POST: sring->req_prod: %d, sring->rsp_prod: %d\n",\
423                            sysbr->sring->req_prod, sysbr->sring->rsp_prod);
424         }
425         // load sane page tables (and don't rely on decref to do it for you).
426         lcr3(boot_cr3);
427         proc_decref(e);
428         return (intreg_t)count;
429 }