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