Support for proc_create and proc_run from KFS
[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/x86.h>
8 #include <arch/mmu.h>
9 #include <arch/console.h>
10 #include <arch/apic.h>
11 #include <arch/timer.h>
12 #include <ros/error.h>
13
14 #include <string.h>
15 #include <assert.h>
16 #include <env.h>
17 #include <pmap.h>
18 #include <trap.h>
19 #include <syscall.h>
20 #include <kfs.h> // eventually replace this with vfs.h
21
22 /* This is called from sysenter's asm, with the tf on the kernel stack. */
23 void sysenter_callwrapper(struct Trapframe *tf)
24 {
25         env_t* curenv = curenvs[lapic_get_id()];
26         curenv->env_tf = *tf;
27         
28         // The trapframe on the stack should be ignored from here on.
29         tf = &curenv->env_tf;
30         tf->tf_regs.reg_eax = (intreg_t) syscall(curenv,
31                                                  tf->tf_regs.reg_eax,
32                                                  tf->tf_regs.reg_edx,
33                                                  tf->tf_regs.reg_ecx,
34                                                  tf->tf_regs.reg_ebx,
35                                                  tf->tf_regs.reg_edi,
36                                                  0);
37         env_run(curenv);
38 }
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         #ifdef SERIAL_IO
50                 char *COUNT(len) _buf = user_mem_assert(e, buf, len, PTE_U);
51                 for(int i =0; i<len; i++)
52                         serial_send_byte(buf[i]);       
53                 return (ssize_t)len;
54         #else
55                 return -EINVAL;
56         #endif
57 }
58
59 //Read a buffer over the serial port
60 static ssize_t sys_serial_read(env_t* e, char *DANGEROUS buf, size_t len) 
61 {
62         #ifdef SERIAL_IO
63             char *COUNT(len) _buf = user_mem_assert(e, buf, len, PTE_U);
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 // Invalidate the cache of this core
77 static void sys_cache_invalidate(void)
78 {
79         wbinvd();
80         return;
81 }
82
83 // Writes 'val' to 'num_writes' entries of the well-known array in the kernel
84 // address space.  It's just #defined to be some random 4MB chunk (which ought
85 // to be boot_alloced or something).  Meant to grab exclusive access to cache
86 // lines, to simulate doing something useful.
87 static void sys_cache_buster(env_t* e, uint32_t num_writes, uint32_t num_pages,
88                              uint32_t flags)
89 {
90         #define BUSTER_ADDR             0xd0000000  // around 512 MB deep
91         #define MAX_WRITES              1048576*8
92         #define MAX_PAGES               32
93         #define INSERT_ADDR     (UINFO + 2*PGSIZE) // should be free for these tests
94         uint32_t* buster = (uint32_t*)BUSTER_ADDR;
95         static uint32_t buster_lock = 0;
96         uint64_t ticks;
97         page_t* a_page[MAX_PAGES];
98
99         /* Strided Accesses or Not (adjust to step by cachelines) */
100         uint32_t stride = 1;
101         if (flags & BUSTER_STRIDED) {
102                 stride = 16;
103                 num_writes *= 16;
104         }
105         
106         /* Shared Accesses or Not (adjust to use per-core regions)
107          * Careful, since this gives 8MB to each core, starting around 512MB.
108          * Also, doesn't separate memory for core 0 if it's an async call.
109          */
110         if (!(flags & BUSTER_SHARED))
111                 buster = (uint32_t*)(BUSTER_ADDR + lapic_get_id() * 0x00800000);
112
113         /* Start the timer, if we're asked to print this info*/
114         if (flags & BUSTER_PRINT_TICKS)
115                 ticks = start_timing();
116
117         /* Allocate num_pages (up to MAX_PAGES), to simulate doing some more
118          * realistic work.  Note we don't write to these pages, even if we pick
119          * unshared.  Mostly due to the inconvenience of having to match up the
120          * number of pages with the number of writes.  And it's unnecessary.
121          */
122         if (num_pages) {
123                 spin_lock(&buster_lock);
124                 for (int i = 0; i < MIN(num_pages, MAX_PAGES); i++) {
125                         page_alloc(&a_page[i]);
126                         page_insert(e->env_pgdir, a_page[i], (void*)INSERT_ADDR + PGSIZE*i,
127                                     PTE_U | PTE_W);
128                 }
129                 spin_unlock(&buster_lock);
130         }
131
132         if (flags & BUSTER_LOCKED)
133                 spin_lock(&buster_lock);
134         for (int i = 0; i < MIN(num_writes, MAX_WRITES); i=i+stride)
135                 buster[i] = 0xdeadbeef;
136         if (flags & BUSTER_LOCKED)
137                 spin_unlock(&buster_lock);
138
139         if (num_pages) {
140                 spin_lock(&buster_lock);
141                 for (int i = 0; i < MIN(num_pages, MAX_PAGES); i++) {
142                         page_remove(e->env_pgdir, (void*)(INSERT_ADDR + PGSIZE * i));
143                         page_decref(a_page[i]);
144                 }
145                 spin_unlock(&buster_lock);
146         }
147
148         /* Print info */
149         if (flags & BUSTER_PRINT_TICKS) {
150                 ticks = stop_timing(ticks);
151                 printk("%llu,", ticks);
152         }
153         return;
154 }
155
156 // Print a string to the system console.
157 // The string is exactly 'len' characters long.
158 // Destroys the environment on memory errors.
159 static ssize_t sys_cputs(env_t* e, const char *DANGEROUS s, size_t len)
160 {
161         // Check that the user has permission to read memory [s, s+len).
162         // Destroy the environment if not.
163     char *COUNT(len) _s = user_mem_assert(e, s, len, PTE_U);
164
165         // Print the string supplied by the user.
166         printk("%.*s", len, _s);
167         return (ssize_t)len;
168 }
169
170 // Read a character from the system console.
171 // Returns the character.
172 static uint16_t sys_cgetc(env_t* e)
173 {
174         uint16_t c;
175
176         // The cons_getc() primitive doesn't wait for a character,
177         // but the sys_cgetc() system call does.
178         while ((c = cons_getc()) == 0)
179                 cpu_relax();
180
181         return c;
182 }
183
184 // Returns the current environment's envid.
185 static envid_t sys_getenvid(env_t* e)
186 {
187         return e->env_id;
188 }
189
190 // Returns the id of the cpu this syscall is executed on.
191 static envid_t sys_getcpuid(void)
192 {
193         return lapic_get_id();
194 }
195
196 // Destroy a given environment (possibly the currently running environment).
197 //
198 // Returns 0 on success, < 0 on error.  Errors are:
199 //      -EBADENV if environment envid doesn't currently exist,
200 //              or the caller doesn't have permission to change envid.
201 static error_t sys_env_destroy(env_t* e, envid_t envid)
202 {
203         int r;
204         env_t *env_to_die;
205
206         if ((r = envid2env(envid, &env_to_die, 1)) < 0)
207                 return r;
208         if (env_to_die == e)
209                 printk("[%08x] exiting gracefully\n", e->env_id);
210         else
211                 printk("[%08x] destroying %08x\n", e->env_id, env_to_die->env_id);
212         env_destroy(env_to_die);
213         return 0;
214 }
215
216 /*
217  * Current process yields its remaining "time slice".  Currently works for
218  * single-core processes.
219  */
220 static void sys_yield(env_t *e)
221 {
222         // TODO: watch for races throughout anything related to process statuses
223         // and schedule/yielding
224         assert(e->env_status == ENV_RUNNING);
225         e->env_status = ENV_RUNNABLE;
226         schedule();
227 }
228
229 /*
230  * Creates a process found at the user string 'path'.  Currently uses KFS.
231  * Not runnable by default, so it needs it's status to be changed so that the
232  * next call to schedule() will try to run it.
233  * TODO: once we have a decent VFS, consider splitting this up
234  */
235 static int sys_proc_create(env_t *e, const char *DANGEROUS path)
236 {
237         #define MAX_PATH_LEN 256 // totally arbitrary
238         int pid = 0;
239         char tpath[MAX_PATH_LEN];
240         /*
241          * There's a bunch of issues with reading in the path, which we'll
242          * need to sort properly in the VFS.  Main concerns are TOCTOU (copy-in),
243          * whether or not it's a big deal that the pointer could be into kernel
244          * space, and resolving both of these without knowing the length of the
245          * string. (TODO)
246          */
247         strncpy(tpath, path, MAX_PATH_LEN);
248         int kfs_inode = kfs_lookup_path(tpath);
249         if (kfs_inode < 0)
250                 return -EINVAL;
251         env_t *new_e = kfs_proc_create(kfs_inode);
252         return new_e->env_id; // TODO replace this with a real proc_id
253 }
254
255 /* Makes process PID runnable.  Consider moving the functionality to env.c */
256 static error_t sys_proc_run(env_t *e, int pid)
257 {
258         // TODO PIDs are currently env_id's and encapsulate these functions better
259         // TODO worry about concurrency on the statuses
260         // get the target process (techincally a neg number is invalid)
261         env_t *target = &envs[ENVX(pid)];
262         // make sure it's in the right state to be activated
263         if (target->env_status != ENV_CREATED)
264                 return -EINVAL;
265         // make sure we have access (are the parent of)
266         if (target->env_parent_id != e->env_id)
267                 return -EINVAL;
268         target->env_status = ENV_RUNNABLE;      
269         return 0;
270 }
271
272 // TODO: Build a dispatch table instead of switching on the syscallno
273 // Dispatches to the correct kernel function, passing the arguments.
274 intreg_t syscall(env_t* e, uint32_t syscallno, uint32_t a1, uint32_t a2,
275                  uint32_t a3, uint32_t a4, uint32_t a5)
276 {
277         // Call the function corresponding to the 'syscallno' parameter.
278         // Return any appropriate return value.
279
280         //cprintf("Incoming syscall number: %d\n    a1: %x\n   "
281         //        " a2: %x\n    a3: %x\n    a4: %x\n    a5: %x\n", 
282         //        syscallno, a1, a2, a3, a4, a5);
283
284         assert(e); // should always have an env for every syscall
285         //printk("Running syscall: %d\n", syscallno);
286         if (INVALID_SYSCALL(syscallno))
287                 return -EINVAL;
288
289         switch (syscallno) {
290                 case SYS_null:
291                         sys_null();
292                         return 0;
293                 case SYS_cache_buster:
294                         sys_cache_buster(e, a1, a2, a3);
295                         return 0;
296                 case SYS_cache_invalidate:
297                         sys_cache_invalidate();
298                         return 0;
299                 case SYS_cputs:
300                         return sys_cputs(e, (char *DANGEROUS)a1, (size_t)a2);
301                 case SYS_cgetc:
302                         return sys_cgetc(e);
303                 case SYS_getcpuid:
304                         return sys_getcpuid();
305                 case SYS_serial_write:
306                         return sys_serial_write(e, (char *DANGEROUS)a1, (size_t)a2);
307                 case SYS_serial_read:
308                         return sys_serial_read(e, (char *DANGEROUS)a1, (size_t)a2);
309                 case SYS_getenvid:
310                         return sys_getenvid(e);
311                 case SYS_env_destroy:
312                         return sys_env_destroy(e, (envid_t)a1);
313                 case SYS_yield:
314                         sys_yield(e);
315                         return 0;
316                 case SYS_proc_create:
317                         return sys_proc_create(e, (char *DANGEROUS)a1);
318                 case SYS_proc_run:
319                         return sys_proc_run(e, (size_t)a1);
320                 default:
321                         // or just return -EINVAL
322                         panic("Invalid syscall number %d for env %x!", syscallno, *e);
323         }
324         return 0xdeadbeef;
325 }
326
327 intreg_t syscall_async(env_t* e, syscall_req_t *call)
328 {
329         return syscall(e, call->num, call->args[0], call->args[1],
330                        call->args[2], call->args[3], call->args[4]);
331 }
332
333 intreg_t process_generic_syscalls(env_t* e, size_t max)
334 {
335         size_t count = 0;
336         syscall_back_ring_t* sysbr = &e->env_sysbackring;
337
338         // make sure the env is still alive.  incref will return 0 on success.
339         if (env_incref(e))
340                 return -1;
341
342         // max is the most we'll process.  max = 0 means do as many as possible
343         while (RING_HAS_UNCONSUMED_REQUESTS(sysbr) && ((!max)||(count < max)) ) {
344                 if (!count) {
345                         // ASSUME: one queue per process
346                         // only switch cr3 for the very first request for this queue
347                         // need to switch to the right context, so we can handle the user pointer
348                         // that points to a data payload of the syscall
349                         lcr3(e->env_cr3);
350                 }
351                 count++;
352                 //printk("DEBUG PRE: sring->req_prod: %d, sring->rsp_prod: %d\n",\
353                            sysbr->sring->req_prod, sysbr->sring->rsp_prod);
354                 // might want to think about 0-ing this out, if we aren't
355                 // going to explicitly fill in all fields
356                 syscall_rsp_t rsp;
357                 // this assumes we get our answer immediately for the syscall.
358                 syscall_req_t* req = RING_GET_REQUEST(sysbr, ++(sysbr->req_cons));
359                 rsp.retval = syscall_async(e, req);
360                 // write response into the slot it came from
361                 memcpy(req, &rsp, sizeof(syscall_rsp_t));
362                 // update our counter for what we've produced (assumes we went in order!)
363                 (sysbr->rsp_prod_pvt)++;
364                 RING_PUSH_RESPONSES(sysbr);
365                 //printk("DEBUG POST: sring->req_prod: %d, sring->rsp_prod: %d\n",\
366                            sysbr->sring->req_prod, sysbr->sring->rsp_prod);
367         }
368         env_decref(e);
369         return (intreg_t)count;
370 }