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