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