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