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