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