Revised system call forwarding for multiple processes
[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/types.h>
9 #include <arch/arch.h>
10 #include <arch/mmu.h>
11 #include <arch/console.h>
12 #include <ros/timer.h>
13 #include <ros/error.h>
14
15 #include <string.h>
16 #include <assert.h>
17 #include <process.h>
18 #include <schedule.h>
19 #include <pmap.h>
20 #include <mm.h>
21 #include <trap.h>
22 #include <syscall.h>
23 #include <kmalloc.h>
24 #include <stdio.h>
25 #include <resource.h>
26 #include <colored_caches.h>
27 #include <arch/bitmask.h>
28 #include <kfs.h> // eventually replace this with vfs.h
29
30 #ifdef __sparc_v8__
31 #include <arch/frontend.h>
32 #endif 
33
34 #ifdef __NETWORK__
35 #include <arch/nic_common.h>
36 extern char *CT(PACKET_HEADER_SIZE + len) (*packet_wrap)(const char *CT(len) data, size_t len);
37 extern int (*send_frame)(const char *CT(len) data, size_t len);
38 #endif
39
40 //Do absolutely nothing.  Used for profiling.
41 static void sys_null(void)
42 {
43         return;
44 }
45
46 //Write a buffer over the serial port
47 static ssize_t sys_serial_write(env_t* e, const char *DANGEROUS buf, size_t len)
48 {
49         if (len == 0)
50                 return 0;
51         #ifdef SERIAL_IO
52                 char *COUNT(len) _buf = user_mem_assert(e, buf, len, PTE_USER_RO);
53                 for(int i =0; i<len; i++)
54                         serial_send_byte(buf[i]);
55                 return (ssize_t)len;
56         #else
57                 return -EINVAL;
58         #endif
59 }
60
61 //Read a buffer over the serial port
62 static ssize_t sys_serial_read(env_t* e, char *DANGEROUS _buf, size_t len)
63 {
64         if (len == 0)
65                 return 0;
66
67         #ifdef SERIAL_IO
68             char *COUNT(len) buf = user_mem_assert(e, _buf, len, PTE_USER_RO);
69                 size_t bytes_read = 0;
70                 int c;
71                 while((c = serial_read_byte()) != -1) {
72                         buf[bytes_read++] = (uint8_t)c;
73                         if(bytes_read == len) break;
74                 }
75                 return (ssize_t)bytes_read;
76         #else
77                 return -EINVAL;
78         #endif
79 }
80
81 //
82 /* START OF REMOTE SYSTEMCALL SUPPORT SYSCALLS. THESE WILL GO AWAY AS THINGS MATURE */
83 //
84
85 static ssize_t sys_run_binary(env_t* e, void *DANGEROUS binary_buf,
86                   void*DANGEROUS arg, size_t len, size_t num_colors)
87 {
88         env_t* env = proc_create(0, 0);
89         env_load_icode(env, e, binary_buf, len);
90         __proc_set_state(env, PROC_RUNNABLE_S);
91         schedule_proc(env);
92         if(num_colors > 0) {
93                 env->cache_colors_map = cache_colors_map_alloc();
94                 for(int i=0; i<num_colors; i++)
95                         cache_color_alloc(llc_cache, env->cache_colors_map);
96         }
97         proc_decref(env, 1);
98         proc_yield(e);
99         return 0;
100 }
101
102 #ifdef __NETWORK__
103 // This is not a syscall we want. Its hacky. Here just for syscall stuff until get a stack.
104 static ssize_t sys_eth_write(env_t* e, const char *DANGEROUS buf, size_t len)
105 {
106         extern int eth_up;
107
108         if (eth_up) {
109
110                 if (len == 0)
111                         return 0;
112
113                 char *COUNT(len) _buf = user_mem_assert(e, buf, len, PTE_U);
114                 int total_sent = 0;
115                 int just_sent = 0;
116                 int cur_packet_len = 0;
117                 while (total_sent != len) {
118                         cur_packet_len = ((len - total_sent) > MAX_PACKET_DATA) ? MAX_PACKET_DATA : (len - total_sent);
119                         char* wrap_buffer = packet_wrap(_buf + total_sent, cur_packet_len);
120                         just_sent = send_frame(wrap_buffer, cur_packet_len + PACKET_HEADER_SIZE);
121
122                         if (just_sent < 0)
123                                 return 0; // This should be an error code of its own
124
125                         if (wrap_buffer)
126                                 kfree(wrap_buffer);
127
128                         total_sent += cur_packet_len;
129                 }
130
131                 return (ssize_t)len;
132
133         }
134         else
135                 return -EINVAL;
136 }
137
138 // This is not a syscall we want. Its hacky. Here just for syscall stuff until get a stack.
139 static ssize_t sys_eth_read(env_t* e, char *DANGEROUS buf, size_t len)
140 {
141         extern int eth_up;
142
143         if (eth_up) {
144                 extern int packet_waiting;
145                 extern int packet_buffer_size;
146                 extern char*CT(packet_buffer_size) packet_buffer;
147                 extern char*CT(MAX_FRAME_SIZE) packet_buffer_orig;
148                 extern int packet_buffer_pos;
149
150                 if (len == 0)
151                         return 0;
152
153                 char *CT(len) _buf = user_mem_assert(e, buf,len, PTE_U);
154
155                 if (packet_waiting == 0)
156                         return 0;
157
158                 int read_len = ((packet_buffer_pos + len) > packet_buffer_size) ? packet_buffer_size - packet_buffer_pos : len;
159
160                 memcpy(_buf, packet_buffer + packet_buffer_pos, read_len);
161
162                 packet_buffer_pos = packet_buffer_pos + read_len;
163
164                 if (packet_buffer_pos == packet_buffer_size) {
165                         kfree(packet_buffer_orig);
166                         packet_waiting = 0;
167                 }
168
169                 return read_len;
170         }
171         else
172                 return -EINVAL;
173 }
174 #endif // Network
175
176 //
177 /* END OF REMOTE SYSTEMCALL SUPPORT SYSCALLS. */
178 //
179
180 static ssize_t sys_shared_page_alloc(env_t* p1,
181                                      void**DANGEROUS _addr, pid_t p2_id,
182                                      int p1_flags, int p2_flags
183                                     )
184 {
185         //if (!VALID_USER_PERMS(p1_flags)) return -EPERM;
186         //if (!VALID_USER_PERMS(p2_flags)) return -EPERM;
187
188         void * COUNT(1) * COUNT(1) addr = user_mem_assert(p1, _addr, sizeof(void *),
189                                                       PTE_USER_RW);
190         struct proc *p2 = pid2proc(p2_id);
191         if (!p2)
192                 return -EBADPROC;
193
194         page_t* page;
195         error_t e = upage_alloc(p1, &page);
196         if (e < 0) {
197                 proc_decref(p2, 1);
198                 return e;
199         }
200
201         void* p2_addr = page_insert_in_range(p2->env_pgdir, page,
202                         (void*SNT)UTEXT, (void*SNT)UTOP, p2_flags);
203         if (p2_addr == NULL) {
204                 page_free(page);
205                 proc_decref(p2, 1);
206                 return -EFAIL;
207         }
208
209         void* p1_addr = page_insert_in_range(p1->env_pgdir, page,
210                         (void*SNT)UTEXT, (void*SNT)UTOP, p1_flags);
211         if(p1_addr == NULL) {
212                 page_remove(p2->env_pgdir, p2_addr);
213                 page_free(page);
214                 proc_decref(p2, 1);
215                 return -EFAIL;
216         }
217         *addr = p1_addr;
218         proc_decref(p2, 1);
219         return ESUCCESS;
220 }
221
222 static void sys_shared_page_free(env_t* p1, void*DANGEROUS addr, pid_t p2)
223 {
224 }
225
226 // Invalidate the cache of this core.  Only useful if you want a cold cache for
227 // performance testing reasons.
228 static void sys_cache_invalidate(void)
229 {
230         #ifdef __i386__
231                 wbinvd();
232         #endif
233         return;
234 }
235
236 // Writes 'val' to 'num_writes' entries of the well-known array in the kernel
237 // address space.  It's just #defined to be some random 4MB chunk (which ought
238 // to be boot_alloced or something).  Meant to grab exclusive access to cache
239 // lines, to simulate doing something useful.
240 static void sys_cache_buster(struct proc *p, uint32_t num_writes,
241                              uint32_t num_pages, uint32_t flags)
242 { TRUSTEDBLOCK /* zra: this is not really part of the kernel */
243         #define BUSTER_ADDR             0xd0000000  // around 512 MB deep
244         #define MAX_WRITES              1048576*8
245         #define MAX_PAGES               32
246         #define INSERT_ADDR     (UINFO + 2*PGSIZE) // should be free for these tests
247         uint32_t* buster = (uint32_t*)BUSTER_ADDR;
248         static spinlock_t buster_lock = SPINLOCK_INITIALIZER;
249         uint64_t ticks = -1;
250         page_t* a_page[MAX_PAGES];
251
252         /* Strided Accesses or Not (adjust to step by cachelines) */
253         uint32_t stride = 1;
254         if (flags & BUSTER_STRIDED) {
255                 stride = 16;
256                 num_writes *= 16;
257         }
258
259         /* Shared Accesses or Not (adjust to use per-core regions)
260          * Careful, since this gives 8MB to each core, starting around 512MB.
261          * Also, doesn't separate memory for core 0 if it's an async call.
262          */
263         if (!(flags & BUSTER_SHARED))
264                 buster = (uint32_t*)(BUSTER_ADDR + core_id() * 0x00800000);
265
266         /* Start the timer, if we're asked to print this info*/
267         if (flags & BUSTER_PRINT_TICKS)
268                 ticks = start_timing();
269
270         /* Allocate num_pages (up to MAX_PAGES), to simulate doing some more
271          * realistic work.  Note we don't write to these pages, even if we pick
272          * unshared.  Mostly due to the inconvenience of having to match up the
273          * number of pages with the number of writes.  And it's unnecessary.
274          */
275         if (num_pages) {
276                 spin_lock(&buster_lock);
277                 for (int i = 0; i < MIN(num_pages, MAX_PAGES); i++) {
278                         upage_alloc(p, &a_page[i]);
279                         page_insert(p->env_pgdir, a_page[i], (void*)INSERT_ADDR + PGSIZE*i,
280                                     PTE_USER_RW);
281                 }
282                 spin_unlock(&buster_lock);
283         }
284
285         if (flags & BUSTER_LOCKED)
286                 spin_lock(&buster_lock);
287         for (int i = 0; i < MIN(num_writes, MAX_WRITES); i=i+stride)
288                 buster[i] = 0xdeadbeef;
289         if (flags & BUSTER_LOCKED)
290                 spin_unlock(&buster_lock);
291
292         if (num_pages) {
293                 spin_lock(&buster_lock);
294                 for (int i = 0; i < MIN(num_pages, MAX_PAGES); i++) {
295                         page_remove(p->env_pgdir, (void*)(INSERT_ADDR + PGSIZE * i));
296                         page_decref(a_page[i]);
297                 }
298                 spin_unlock(&buster_lock);
299         }
300
301         /* Print info */
302         if (flags & BUSTER_PRINT_TICKS) {
303                 ticks = stop_timing(ticks);
304                 printk("%llu,", ticks);
305         }
306         return;
307 }
308
309 // Print a string to the system console.
310 // The string is exactly 'len' characters long.
311 // Destroys the environment on memory errors.
312 static ssize_t sys_cputs(env_t* e, const char *DANGEROUS s, size_t len)
313 {
314         // Check that the user has permission to read memory [s, s+len).
315         // Destroy the environment if not.
316         char *COUNT(len) _s = user_mem_assert(e, s, len, PTE_USER_RO);
317
318         // Print the string supplied by the user.
319         printk("%.*s", len, _s);
320         return (ssize_t)len;
321 }
322
323 // Read a character from the system console.
324 // Returns the character.
325 static uint16_t sys_cgetc(env_t* e)
326 {
327         uint16_t c;
328
329         // The cons_getc() primitive doesn't wait for a character,
330         // but the sys_cgetc() system call does.
331         while ((c = cons_getc()) == 0)
332                 cpu_relax();
333
334         return c;
335 }
336
337 /* Returns the calling process's pid */
338 static pid_t sys_getpid(struct proc *p)
339 {
340         return p->pid;
341 }
342
343 /* Returns the id of the cpu this syscall is executed on. */
344 static uint32_t sys_getcpuid(void)
345 {
346         return core_id();
347 }
348
349 // TODO: Temporary hack until thread-local storage is implemented on i386
350 static size_t sys_getvcoreid(env_t* e)
351 {
352         if(e->state == PROC_RUNNING_S)
353                 return 0;
354
355         size_t i;
356         for(i = 0; i < e->num_vcores; i++)
357                 if(core_id() == e->vcoremap[i])
358                         return i;
359
360         panic("virtual core id not found in sys_getvcoreid()!");
361 }
362
363 /* Destroy proc pid.  If this is called by the dying process, it will never
364  * return.  o/w it will return 0 on success, or an error.  Errors include:
365  * - EBADPROC: if there is no such process with pid
366  * - EPERM: if caller does not control pid */
367 static error_t sys_proc_destroy(struct proc *p, pid_t pid)
368 {
369         error_t r;
370         struct proc *p_to_die = pid2proc(pid);
371
372         if (!p_to_die)
373                 return -EBADPROC;
374         if (!proc_controls(p, p_to_die)) {
375                 proc_decref(p_to_die, 1);
376                 return -EPERM;
377         }
378         if (p_to_die == p) {
379                 // syscall code and pid2proc both have edible references, only need 1.
380                 proc_decref(p, 1);
381                 printk("[PID %d] proc exiting gracefully\n", p->pid);
382         } else {
383                 panic("Destroying other processes is not supported yet.");
384                 //printk("[%d] destroying proc %d\n", p->pid, p_to_die->pid);
385         }
386         proc_destroy(p_to_die);
387         return ESUCCESS;
388 }
389
390 /*
391  * Creates a process found at the user string 'path'.  Currently uses KFS.
392  * Not runnable by default, so it needs it's status to be changed so that the
393  * next call to schedule() will try to run it.
394  * TODO: once we have a decent VFS, consider splitting this up
395  * and once there's an mmap, can have most of this in process.c
396  */
397 static int sys_proc_create(struct proc *p, const char *DANGEROUS path)
398 {
399         #define MAX_PATH_LEN 256 // totally arbitrary
400         int pid = 0;
401         char tpath[MAX_PATH_LEN];
402         /*
403          * There's a bunch of issues with reading in the path, which we'll
404          * need to sort properly in the VFS.  Main concerns are TOCTOU (copy-in),
405          * whether or not it's a big deal that the pointer could be into kernel
406          * space, and resolving both of these without knowing the length of the
407          * string. (TODO)
408          * Change this so that all syscalls with a pointer take a length.
409          *
410          * zra: I've added this user_mem_strlcpy, which I think eliminates the
411      * the TOCTOU issue. Adding a length arg to this call would allow a more
412          * efficient implementation, though, since only one call to user_mem_check
413          * would be required.
414          */
415         int ret = user_mem_strlcpy(p,tpath, path, MAX_PATH_LEN, PTE_USER_RO);
416         int kfs_inode = kfs_lookup_path(tpath);
417         if (kfs_inode < 0)
418                 return -EINVAL;
419         struct proc *new_p = kfs_proc_create(kfs_inode);
420         pid = new_p->pid;
421         proc_decref(new_p, 1); // let go of the reference created in proc_create()
422         return pid;
423 }
424
425 /* Makes process PID runnable.  Consider moving the functionality to process.c */
426 static error_t sys_proc_run(struct proc *p, unsigned pid)
427 {
428         struct proc *target = pid2proc(pid);
429         error_t retval = 0;
430
431         if (!target)
432                 return -EBADPROC;
433         // note we can get interrupted here. it's not bad.
434         spin_lock_irqsave(&p->proc_lock);
435         // make sure we have access and it's in the right state to be activated
436         if (!proc_controls(p, target)) {
437                 proc_decref(target, 1);
438                 retval = -EPERM;
439         } else if (target->state != PROC_CREATED) {
440                 proc_decref(target, 1);
441                 retval = -EINVAL;
442         } else {
443                 __proc_set_state(target, PROC_RUNNABLE_S);
444                 schedule_proc(target);
445         }
446         spin_unlock_irqsave(&p->proc_lock);
447         proc_decref(target, 1);
448         return retval;
449 }
450
451 static error_t sys_brk(struct proc *p, void* addr) {
452         size_t range;
453
454         if((addr < p->heap_bottom) || (addr >= (void*)USTACKBOT))
455                 return -EINVAL;
456         if(addr == p->heap_top)
457                 return ESUCCESS;
458
459         if (addr > p->heap_top) {
460                 range = addr - p->heap_top;
461                 env_segment_alloc(p, p->heap_top, range);
462         }
463         else if (addr < p->heap_top) {
464                 range = p->heap_top - addr;
465                 env_segment_free(p, addr, range);
466         }
467         p->heap_top = addr;
468         return ESUCCESS;
469 }
470
471 /* Executes the given syscall.
472  *
473  * Note tf is passed in, which points to the tf of the context on the kernel
474  * stack.  If any syscall needs to block, it needs to save this info, as well as
475  * any silly state.
476  *
477  * TODO: Build a dispatch table instead of switching on the syscallno
478  * Dispatches to the correct kernel function, passing the arguments.
479  */
480 intreg_t syscall(struct proc *p, uintreg_t syscallno, uintreg_t a1,
481                  uintreg_t a2, uintreg_t a3, uintreg_t a4, uintreg_t a5)
482 {
483         // Call the function corresponding to the 'syscallno' parameter.
484         // Return any appropriate return value.
485
486         //cprintf("Incoming syscall on core: %d number: %d\n    a1: %x\n   "
487         //        " a2: %x\n    a3: %x\n    a4: %x\n    a5: %x\n", core_id(),
488         //        syscallno, a1, a2, a3, a4, a5);
489
490         // used if we need more args, like in mmap
491         int32_t _a4, _a5, _a6, *COUNT(3) args;
492
493         assert(p); // should always have a process for every syscall
494         //printk("Running syscall: %d\n", syscallno);
495         if (INVALID_SYSCALL(syscallno))
496                 return -EINVAL;
497
498         switch (syscallno) {
499                 case SYS_null:
500                         sys_null();
501                         return ESUCCESS;
502                 case SYS_cache_buster:
503                         sys_cache_buster(p, a1, a2, a3);
504                         return 0;
505                 case SYS_cache_invalidate:
506                         sys_cache_invalidate();
507                         return 0;
508                 case SYS_shared_page_alloc:
509                         return sys_shared_page_alloc(p, (void** DANGEROUS) a1,
510                                                  a2, (int) a3, (int) a4);
511                 case SYS_shared_page_free:
512                         sys_shared_page_free(p, (void* DANGEROUS) a1, a2);
513                     return ESUCCESS;
514                 case SYS_cputs:
515                         return sys_cputs(p, (char *DANGEROUS)a1, (size_t)a2);
516                 case SYS_cgetc:
517                         return sys_cgetc(p); // this will need to block
518                 case SYS_getcpuid:
519                         return sys_getcpuid();
520                 case SYS_getvcoreid:
521                         return sys_getvcoreid(p);
522                 case SYS_getpid:
523                         return sys_getpid(p);
524                 case SYS_proc_destroy:
525                         return sys_proc_destroy(p, (pid_t)a1);
526                 case SYS_yield:
527                         proc_yield(p);
528                         return ESUCCESS;
529                 case SYS_proc_create:
530                         return sys_proc_create(p, (char *DANGEROUS)a1);
531                 case SYS_proc_run:
532                         return sys_proc_run(p, (size_t)a1);
533                 case SYS_mmap:
534                         // we only have 4 parameters from sysenter currently, need to copy
535                         // in the others.  if we stick with this, we can make a func for it.
536                         args = user_mem_assert(p, (void*DANGEROUS)a4,
537                                                3*sizeof(_a4), PTE_USER_RW);
538                         _a4 = args[0];
539                         _a5 = args[1];
540                         _a6 = args[2];
541                         return (intreg_t) mmap(p, a1, a2, a3, _a4, _a5, _a6);
542                 case SYS_brk:
543                         return sys_brk(p, (void*)a1);
544                 case SYS_resource_req:
545                         return resource_req(p, a1, a2, a3, a4);
546
547         #ifdef __i386__
548                 case SYS_serial_write:
549                         return sys_serial_write(p, (char *DANGEROUS)a1, (size_t)a2);
550                 case SYS_serial_read:
551                         return sys_serial_read(p, (char *DANGEROUS)a1, (size_t)a2);
552         #endif
553                 case SYS_run_binary:
554                         return sys_run_binary(p, (char *DANGEROUS)a1, (char* DANGEROUS)a2, 
555                                                                    (size_t)a3, (size_t)a4);
556         #ifdef __NETWORK__
557                 case SYS_eth_write:
558                         return sys_eth_write(p, (char *DANGEROUS)a1, (size_t)a2);
559                 case SYS_eth_read:
560                         return sys_eth_read(p, (char *DANGEROUS)a1, (size_t)a2);
561         #endif
562         #ifdef __sparc_v8__
563                 case SYS_frontend:
564                         return frontend_syscall_from_user(p,a1,a2,a3,a4,a5);
565         #endif
566
567                 case SYS_reboot:
568                         reboot();
569                         return 0;
570
571                 default:
572                         // or just return -EINVAL
573                         panic("Invalid syscall number %d for proc %x!", syscallno, *p);
574         }
575         return 0xdeadbeef;
576 }
577
578 intreg_t syscall_async(struct proc *p, syscall_req_t *call)
579 {
580         return syscall(p, call->num, call->args[0], call->args[1],
581                        call->args[2], call->args[3], call->args[4]);
582 }
583
584 /* You should already have a refcnt'd ref to p before calling this */
585 intreg_t process_generic_syscalls(struct proc *p, size_t max)
586 {
587         size_t count = 0;
588         syscall_back_ring_t* sysbr = &p->syscallbackring;
589
590         /* make sure the proc is still alive, and keep it from dying from under us
591          * incref will return ESUCCESS on success.  This might need some thought
592          * regarding when the incref should have happened (like by whoever passed us
593          * the *p). */
594         // TODO: ought to be unnecessary, if you called this right, kept here for
595         // now in case anyone actually uses the ARSCs.
596         proc_incref(p, 1);
597
598         // max is the most we'll process.  max = 0 means do as many as possible
599         while (RING_HAS_UNCONSUMED_REQUESTS(sysbr) && ((!max)||(count < max)) ) {
600                 if (!count) {
601                         // ASSUME: one queue per process
602                         // only switch cr3 for the very first request for this queue
603                         // need to switch to the right context, so we can handle the user pointer
604                         // that points to a data payload of the syscall
605                         lcr3(p->env_cr3);
606                 }
607                 count++;
608                 //printk("DEBUG PRE: sring->req_prod: %d, sring->rsp_prod: %d\n",
609                 //         sysbr->sring->req_prod, sysbr->sring->rsp_prod);
610                 // might want to think about 0-ing this out, if we aren't
611                 // going to explicitly fill in all fields
612                 syscall_rsp_t rsp;
613                 // this assumes we get our answer immediately for the syscall.
614                 syscall_req_t* req = RING_GET_REQUEST(sysbr, ++(sysbr->req_cons));
615                 rsp.retval = syscall_async(p, req);
616                 // write response into the slot it came from
617                 memcpy(req, &rsp, sizeof(syscall_rsp_t));
618                 // update our counter for what we've produced (assumes we went in order!)
619                 (sysbr->rsp_prod_pvt)++;
620                 RING_PUSH_RESPONSES(sysbr);
621                 //printk("DEBUG POST: sring->req_prod: %d, sring->rsp_prod: %d\n",
622                 //         sysbr->sring->req_prod, sysbr->sring->rsp_prod);
623         }
624         // load sane page tables (and don't rely on decref to do it for you).
625         lcr3(boot_cr3);
626         proc_decref(p, 1);
627         return (intreg_t)count;
628 }