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