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