Reworked the user VM map and added sysevent queue
[akaros.git] / kern / src / syscall.c
1 /* See COPYRIGHT for copyright information. */
2 #ifdef __DEPUTY__
3 #pragma nodeputy
4 #endif
5
6 #include <arch/types.h>
7 #include <arch/arch.h>
8 #include <arch/mmu.h>
9 #include <arch/console.h>
10 #include <ros/timer.h>
11 #include <ros/error.h>
12
13 #include <string.h>
14 #include <assert.h>
15 #include <process.h>
16 #include <pmap.h>
17 #include <trap.h>
18 #include <syscall.h>
19 #include <stdio.h>
20 #include <kfs.h> // eventually replace this with vfs.h
21
22 //Do absolutely nothing.  Used for profiling.
23 static void sys_null(void)
24 {
25         return;
26 }
27
28 //Write a buffer over the serial port
29 static ssize_t sys_serial_write(env_t* e, const char *DANGEROUS buf, size_t len) 
30 {
31         #ifdef SERIAL_IO
32                 char *COUNT(len) _buf = user_mem_assert(e, buf, len, PTE_USER_RO);
33                 for(int i =0; i<len; i++)
34                         serial_send_byte(buf[i]);       
35                 return (ssize_t)len;
36         #else
37                 return -EINVAL;
38         #endif
39 }
40
41 //Read a buffer over the serial port
42 static ssize_t sys_serial_read(env_t* e, char *DANGEROUS buf, size_t len) 
43 {
44         #ifdef SERIAL_IO
45             char *COUNT(len) _buf = user_mem_assert(e, buf, len, PTE_USER_RO);
46                 size_t bytes_read = 0;
47                 int c;
48                 while((c = serial_read_byte()) != -1) {
49                         buf[bytes_read++] = (uint8_t)c;
50                         if(bytes_read == len) break;
51                 }
52                 return (ssize_t)bytes_read;
53         #else
54                 return -EINVAL;
55         #endif
56 }
57
58 static ssize_t sys_shared_page_alloc(env_t* p1, 
59                                      void** addr, envid_t p2_id, 
60                                      int p1_flags, int p2_flags
61                                     ) 
62 {
63         //if (!VALID_USER_PERMS(p1_flags)) return -EPERM;
64         //if (!VALID_USER_PERMS(p2_flags)) return -EPERM;
65
66         page_t* page;
67         env_t* p2 = &(envs[ENVX(p2_id)]);
68         error_t e = page_alloc(&page);
69         if(e < 0) return e;
70         
71         void* p2_addr = page_insert_in_range(p2->env_pgdir, page, 
72                                              (void*)UTEXT, (void*)UTOP, p2_flags);
73         if(p2_addr == NULL) 
74                 return -EFAIL;
75                 
76         void* p1_addr = page_insert_in_range(p1->env_pgdir, page, 
77                                             (void*)UTEXT, (void*)UTOP, p1_flags);
78         if(p1_addr == NULL) {
79                 page_remove(p2->env_pgdir, p2_addr);
80                 return -EFAIL;
81         }
82         *addr = p1_addr;
83         return ESUCCESS;
84 }
85
86 static void sys_shared_page_free(env_t* p1, void* addr, envid_t p2)
87 {
88 }
89
90 // Invalidate the cache of this core.  Only useful if you want a cold cache for
91 // performance testing reasons.
92 static void sys_cache_invalidate(void)
93 {
94         #ifdef __i386__
95                 wbinvd();
96         #endif
97         return;
98 }
99
100 // Writes 'val' to 'num_writes' entries of the well-known array in the kernel
101 // address space.  It's just #defined to be some random 4MB chunk (which ought
102 // to be boot_alloced or something).  Meant to grab exclusive access to cache
103 // lines, to simulate doing something useful.
104 static void sys_cache_buster(env_t* e, uint32_t num_writes, uint32_t num_pages,
105                              uint32_t flags)
106 {
107         #define BUSTER_ADDR             0xd0000000  // around 512 MB deep
108         #define MAX_WRITES              1048576*8
109         #define MAX_PAGES               32
110         #define INSERT_ADDR     (UINFO + 2*PGSIZE) // should be free for these tests
111         uint32_t* buster = (uint32_t*)BUSTER_ADDR;
112         static uint32_t buster_lock = 0;
113         uint64_t ticks = -1;
114         page_t* a_page[MAX_PAGES];
115
116         /* Strided Accesses or Not (adjust to step by cachelines) */
117         uint32_t stride = 1;
118         if (flags & BUSTER_STRIDED) {
119                 stride = 16;
120                 num_writes *= 16;
121         }
122         
123         /* Shared Accesses or Not (adjust to use per-core regions)
124          * Careful, since this gives 8MB to each core, starting around 512MB.
125          * Also, doesn't separate memory for core 0 if it's an async call.
126          */
127         if (!(flags & BUSTER_SHARED))
128                 buster = (uint32_t*)(BUSTER_ADDR + core_id() * 0x00800000);
129
130         /* Start the timer, if we're asked to print this info*/
131         if (flags & BUSTER_PRINT_TICKS)
132                 ticks = start_timing();
133
134         /* Allocate num_pages (up to MAX_PAGES), to simulate doing some more
135          * realistic work.  Note we don't write to these pages, even if we pick
136          * unshared.  Mostly due to the inconvenience of having to match up the
137          * number of pages with the number of writes.  And it's unnecessary.
138          */
139         if (num_pages) {
140                 spin_lock(&buster_lock);
141                 for (int i = 0; i < MIN(num_pages, MAX_PAGES); i++) {
142                         page_alloc(&a_page[i]);
143                         page_insert(e->env_pgdir, a_page[i], (void*)INSERT_ADDR + PGSIZE*i,
144                                     PTE_USER_RW);
145                 }
146                 spin_unlock(&buster_lock);
147         }
148
149         if (flags & BUSTER_LOCKED)
150                 spin_lock(&buster_lock);
151         for (int i = 0; i < MIN(num_writes, MAX_WRITES); i=i+stride)
152                 buster[i] = 0xdeadbeef;
153         if (flags & BUSTER_LOCKED)
154                 spin_unlock(&buster_lock);
155
156         if (num_pages) {
157                 spin_lock(&buster_lock);
158                 for (int i = 0; i < MIN(num_pages, MAX_PAGES); i++) {
159                         page_remove(e->env_pgdir, (void*)(INSERT_ADDR + PGSIZE * i));
160                         page_decref(a_page[i]);
161                 }
162                 spin_unlock(&buster_lock);
163         }
164
165         /* Print info */
166         if (flags & BUSTER_PRINT_TICKS) {
167                 ticks = stop_timing(ticks);
168                 printk("%llu,", ticks);
169         }
170         return;
171 }
172
173 // Print a string to the system console.
174 // The string is exactly 'len' characters long.
175 // Destroys the environment on memory errors.
176 static ssize_t sys_cputs(env_t* e, const char *DANGEROUS s, size_t len)
177 {
178         // Check that the user has permission to read memory [s, s+len).
179         // Destroy the environment if not.
180     char *COUNT(len) _s = user_mem_assert(e, s, len, PTE_USER_RO);
181
182         // Print the string supplied by the user.
183         printk("%.*s", len, _s);
184         return (ssize_t)len;
185 }
186
187 // Read a character from the system console.
188 // Returns the character.
189 static uint16_t sys_cgetc(env_t* e)
190 {
191         uint16_t c;
192
193         // The cons_getc() primitive doesn't wait for a character,
194         // but the sys_cgetc() system call does.
195         while ((c = cons_getc()) == 0)
196                 cpu_relax();
197
198         return c;
199 }
200
201 // Returns the current environment's envid.
202 static envid_t sys_getenvid(env_t* e)
203 {
204         return e->env_id;
205 }
206
207 // Returns the id of the cpu this syscall is executed on.
208 static envid_t sys_getcpuid(void)
209 {
210         return core_id();
211 }
212
213 // TODO FIX Me!!!! for processes
214 // Destroy a given environment (possibly the currently running environment).
215 //
216 // Returns 0 on success, < 0 on error.  Errors are:
217 //      -EBADENV if environment envid doesn't currently exist,
218 //              or the caller doesn't have permission to change envid.
219 static error_t sys_env_destroy(env_t* e, envid_t envid)
220 {
221         int r;
222         env_t *env_to_die;
223
224         if ((r = envid2env(envid, &env_to_die, 1)) < 0)
225                 return r;
226         if (env_to_die == e)
227                 printk("[%08x] exiting gracefully\n", e->env_id);
228         else
229                 printk("[%08x] destroying %08x\n", e->env_id, env_to_die->env_id);
230         env_destroy(env_to_die);
231         return ESUCCESS;
232 }
233
234 /*
235  * Current process yields its remaining "time slice".  Currently works for
236  * single-core processes.
237  * TODO: think about how this works with async calls and multicored procs.
238  * Want it to only be callable locally.
239  */
240 static void sys_yield(struct proc *p)
241 {
242         // TODO: watch for races throughout anything related to process statuses
243         // and schedule/yielding
244         assert(p->state == PROC_RUNNING_S);
245         p->state = PROC_RUNNABLE_S;
246         // the implied thing here is that all state has been saved.  and you need
247         // todo that before changing the state to RUNNABLE_S, since the process can
248         // get picked up somewhere else. TODO
249         schedule();
250
251         /* TODO
252          * if running_s, give up your time slice (schedule, save silly state, block)
253          * if running_m and 2+ cores are left, give yours up, stay runnable_m
254          * if running_m and last core, switch to runnable_s
255          */
256 }
257
258 /*
259  * Creates a process found at the user string 'path'.  Currently uses KFS.
260  * Not runnable by default, so it needs it's status to be changed so that the
261  * next call to schedule() will try to run it.
262  * TODO: once we have a decent VFS, consider splitting this up
263  * and once there's an mmap, can have most of this in process.c
264  */
265 static int sys_proc_create(struct proc *p, const char *DANGEROUS path)
266 {
267         #define MAX_PATH_LEN 256 // totally arbitrary
268         int pid = 0;
269         char tpath[MAX_PATH_LEN];
270         /*
271          * There's a bunch of issues with reading in the path, which we'll
272          * need to sort properly in the VFS.  Main concerns are TOCTOU (copy-in),
273          * whether or not it's a big deal that the pointer could be into kernel
274          * space, and resolving both of these without knowing the length of the
275          * string. (TODO)
276          * Change this so that all syscalls with a pointer take a length.
277          */
278         strncpy(tpath, path, MAX_PATH_LEN);
279         int kfs_inode = kfs_lookup_path(tpath);
280         if (kfs_inode < 0)
281                 return -EINVAL;
282         struct proc *new_p = kfs_proc_create(kfs_inode);
283         return new_p->env_id; // TODO replace this with a real proc_id
284 }
285
286 /* Makes process PID runnable.  Consider moving the functionality to env.c */
287 static error_t sys_proc_run(struct proc *p, unsigned pid)
288 {
289         struct proc *target = get_proc(pid);
290         error_t retval = 0;
291         spin_lock(&p->lock); // note we can get interrupted here.  it's not bad.
292         // make sure we have access and it's in the right state to be activated
293         if (!proc_controls(p, target))
294                 retval = -EPERM;
295         else if (target->state != PROC_CREATED)
296                 retval = -EINVAL;
297         else
298                 proc_set_state(target, PROC_RUNNABLE_S);
299         spin_unlock(&p->lock);
300         return retval;
301 }
302
303 // TODO: Build a dispatch table instead of switching on the syscallno
304 // Dispatches to the correct kernel function, passing the arguments.
305 intreg_t syscall(env_t* e, uint32_t syscallno, uint32_t a1, uint32_t a2,
306                  uint32_t a3, uint32_t a4, uint32_t a5)
307 {
308         // Call the function corresponding to the 'syscallno' parameter.
309         // Return any appropriate return value.
310
311         //cprintf("Incoming syscall number: %d\n    a1: %x\n   "
312         //        " a2: %x\n    a3: %x\n    a4: %x\n    a5: %x\n", 
313         //        syscallno, a1, a2, a3, a4, a5);
314
315         assert(e); // should always have an env for every syscall
316         //printk("Running syscall: %d\n", syscallno);
317         if (INVALID_SYSCALL(syscallno))
318                 return -EINVAL;
319
320         switch (syscallno) {
321                 case SYS_null:
322                         sys_null();
323                         return ESUCCESS;
324                 case SYS_cache_buster:
325                         sys_cache_buster(e, a1, a2, a3);
326                         return 0;
327                 case SYS_cache_invalidate:
328                         sys_cache_invalidate();
329                         return 0;
330                 case SYS_shared_page_alloc:
331                         return sys_shared_page_alloc(e, (void** DANGEROUS) a1, 
332                                                  a2, (int) a3, (int) a4);
333                 case SYS_shared_page_free:
334                         sys_shared_page_free(e, (void* DANGEROUS) a1, a2);
335                     return ESUCCESS;
336                 case SYS_cputs:
337                         return sys_cputs(e, (char *DANGEROUS)a1, (size_t)a2);
338                 case SYS_cgetc:
339                         return sys_cgetc(e);
340                 case SYS_getcpuid:
341                         return sys_getcpuid();
342                 case SYS_getpid:
343                         return sys_getenvid(e);
344                 case SYS_proc_destroy:
345                         return sys_env_destroy(e, (envid_t)a1);
346                 case SYS_yield:
347                         sys_yield(e);
348                         return ESUCCESS;
349                 case SYS_proc_create:
350                         return sys_proc_create(e, (char *DANGEROUS)a1);
351                 case SYS_proc_run:
352                         return sys_proc_run(e, (size_t)a1);
353
354         #ifdef __i386__
355                 case SYS_serial_write:
356                         return sys_serial_write(e, (char *DANGEROUS)a1, (size_t)a2);
357                 case SYS_serial_read:
358                         return sys_serial_read(e, (char *DANGEROUS)a1, (size_t)a2);
359         #endif
360
361         #ifdef __sparc_v8__
362                 case SYS_frontend:
363                         return frontend_syscall(a1,a2,a3,a4);
364         #endif
365
366                 default:
367                         // or just return -EINVAL
368                         panic("Invalid syscall number %d for env %x!", syscallno, *e);
369         }
370         return 0xdeadbeef;
371 }
372
373 intreg_t syscall_async(env_t* e, syscall_req_t *call)
374 {
375         return syscall(e, call->num, call->args[0], call->args[1],
376                        call->args[2], call->args[3], call->args[4]);
377 }
378
379 intreg_t process_generic_syscalls(env_t* e, size_t max)
380 {
381         size_t count = 0;
382         syscall_back_ring_t* sysbr = &e->syscallbackring;
383
384         // make sure the env is still alive.  
385         // incref will return ESUCCESS on success.
386         if (env_incref(e))
387                 return -EFAIL;
388
389         // max is the most we'll process.  max = 0 means do as many as possible
390         while (RING_HAS_UNCONSUMED_REQUESTS(sysbr) && ((!max)||(count < max)) ) {
391                 if (!count) {
392                         // ASSUME: one queue per process
393                         // only switch cr3 for the very first request for this queue
394                         // need to switch to the right context, so we can handle the user pointer
395                         // that points to a data payload of the syscall
396                         lcr3(e->env_cr3);
397                 }
398                 count++;
399                 //printk("DEBUG PRE: sring->req_prod: %d, sring->rsp_prod: %d\n",\
400                            sysbr->sring->req_prod, sysbr->sring->rsp_prod);
401                 // might want to think about 0-ing this out, if we aren't
402                 // going to explicitly fill in all fields
403                 syscall_rsp_t rsp;
404                 // this assumes we get our answer immediately for the syscall.
405                 syscall_req_t* req = RING_GET_REQUEST(sysbr, ++(sysbr->req_cons));
406                 rsp.retval = syscall_async(e, req);
407                 // write response into the slot it came from
408                 memcpy(req, &rsp, sizeof(syscall_rsp_t));
409                 // update our counter for what we've produced (assumes we went in order!)
410                 (sysbr->rsp_prod_pvt)++;
411                 RING_PUSH_RESPONSES(sysbr);
412                 //printk("DEBUG POST: sring->req_prod: %d, sring->rsp_prod: %d\n",\
413                            sysbr->sring->req_prod, sysbr->sring->rsp_prod);
414         }
415         // load sane page tables (and don't rely on decref to do it for you).
416         lcr3(boot_cr3);
417         env_decref(e);
418         return (intreg_t)count;
419 }