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