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