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