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