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