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