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