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