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