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