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