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