Merge commit 'origin' into net-dev
[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 <rl8168.h>
15 #include <string.h>
16 #include <assert.h>
17 #include <env.h>
18 #include <pmap.h>
19 #include <trap.h>
20 #include <syscall.h>
21 #include <kmalloc.h>
22
23 /* This is called from sysenter's asm, with the tf on the kernel stack. */
24 void sysenter_callwrapper(struct Trapframe *tf)
25 {
26         env_t* curenv = curenvs[lapic_get_id()];
27         curenv->env_tf = *tf;
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 -EINVAL;
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 -EINVAL;
74         #endif
75 }
76
77 static ssize_t sys_run_binary(env_t* e, void* binary_buf, void* arg, size_t len) {
78         uint8_t* new_binary = kmalloc(len, 0);
79         if(new_binary == NULL)
80                 return -ENOMEM;
81         memcpy(new_binary, binary_buf, len);
82
83         env_t* env = env_create((uint8_t*)new_binary, len);
84         kfree(new_binary);
85         
86         e->env_status = ENV_RUNNABLE;
87         env_run(env);
88         return 0;
89 }
90
91 // This is probably not a syscall we want. Its hacky. Here just for syscall stuff until get a stack.
92 static ssize_t sys_eth_write(env_t* e, const char *DANGEROUS buf, size_t len) 
93
94         extern int eth_up;
95         
96         if (eth_up) {
97                 
98                 char *COUNT(len) _buf = user_mem_assert(e, buf, len, PTE_U);
99                 int total_sent = 0;
100                 int just_sent = 0;
101                 int cur_packet_len = 0;
102                 while (total_sent != len) {
103                         cur_packet_len = ((len - total_sent) > MAX_PACKET_DATA) ? MAX_PACKET_DATA : (len - total_sent);
104                         char* wrap_buffer = packet_wrap(buf + total_sent, cur_packet_len);
105                         just_sent = send_frame(wrap_buffer, cur_packet_len + PACKET_HEADER_SIZE);
106                         
107                         if (just_sent < 0)
108                                 return 0; // This should be an error code of its own
109                                 
110                         if (wrap_buffer)
111                                 kfree(wrap_buffer);
112                                 
113                         total_sent += cur_packet_len;
114                 }
115                 
116                 return (ssize_t)len;
117                 
118         }
119         else
120                 return -EINVAL;
121 }
122 /*
123 static ssize_t sys_eth_write(env_t* e, const char *DANGEROUS buf, size_t len) 
124
125         extern int eth_up;
126         
127         if (eth_up) {
128                 
129                 char *COUNT(len) _buf = user_mem_assert(e, buf, len, PTE_U);
130                 
131                 return(send_frame(buf, len));
132         }
133         return -EINVAL;
134 }
135 */
136
137
138 // This is probably not a syscall we want. Its hacky. Here just for syscall stuff until get a stack.
139 static ssize_t sys_eth_read(env_t* e, char *DANGEROUS buf, size_t len) 
140 {
141         extern int eth_up;
142         
143         if (eth_up) {
144                 extern int packet_waiting;
145                 extern int packet_buffer_size;
146                 extern char* packet_buffer;
147                 extern char* packet_buffer_orig;
148                 extern int packet_buffer_pos;
149                         
150                 if (packet_waiting == 0)
151                         return 0;
152                         
153                 int read_len = ((packet_buffer_pos + len) > packet_buffer_size) ? packet_buffer_size - packet_buffer_pos : len;
154
155                 memcpy(buf, packet_buffer + packet_buffer_pos, read_len);
156         
157                 packet_buffer_pos = packet_buffer_pos + read_len;
158         
159                 if (packet_buffer_pos == packet_buffer_size) {
160                         kfree(packet_buffer_orig);
161                         packet_waiting = 0;
162                 }
163         
164                 return read_len;
165         }
166         else
167                 return -EINVAL;
168 }
169
170 // Invalidate the cache of this core
171 static void sys_cache_invalidate(void)
172 {
173         wbinvd();
174         return;
175 }
176
177 // Writes 'val' to 'num_writes' entries of the well-known array in the kernel
178 // address space.  It's just #defined to be some random 4MB chunk (which ought
179 // to be boot_alloced or something).  Meant to grab exclusive access to cache
180 // lines, to simulate doing something useful.
181 static void sys_cache_buster(env_t* e, uint32_t num_writes, uint32_t num_pages,
182                              uint32_t flags)
183 {
184         #define BUSTER_ADDR             0xd0000000  // around 512 MB deep
185         #define MAX_WRITES              1048576*8
186         #define MAX_PAGES               32
187         #define INSERT_ADDR     (UINFO + 2*PGSIZE) // should be free for these tests
188         uint32_t* buster = (uint32_t*)BUSTER_ADDR;
189         static uint32_t buster_lock = 0;
190         uint64_t ticks;
191         page_t* a_page[MAX_PAGES];
192
193         /* Strided Accesses or Not (adjust to step by cachelines) */
194         uint32_t stride = 1;
195         if (flags & BUSTER_STRIDED) {
196                 stride = 16;
197                 num_writes *= 16;
198         }
199         
200         /* Shared Accesses or Not (adjust to use per-core regions)
201          * Careful, since this gives 8MB to each core, starting around 512MB.
202          * Also, doesn't separate memory for core 0 if it's an async call.
203          */
204         if (!(flags & BUSTER_SHARED))
205                 buster = (uint32_t*)(BUSTER_ADDR + lapic_get_id() * 0x00800000);
206
207         /* Start the timer, if we're asked to print this info*/
208         if (flags & BUSTER_PRINT_TICKS)
209                 ticks = start_timing();
210
211         /* Allocate num_pages (up to MAX_PAGES), to simulate doing some more
212          * realistic work.  Note we don't write to these pages, even if we pick
213          * unshared.  Mostly due to the inconvenience of having to match up the
214          * number of pages with the number of writes.  And it's unnecessary.
215          */
216         if (num_pages) {
217                 spin_lock(&buster_lock);
218                 for (int i = 0; i < MIN(num_pages, MAX_PAGES); i++) {
219                         page_alloc(&a_page[i]);
220                         page_insert(e->env_pgdir, a_page[i], (void*)INSERT_ADDR + PGSIZE*i,
221                                     PTE_U | PTE_W);
222                 }
223                 spin_unlock(&buster_lock);
224         }
225
226         if (flags & BUSTER_LOCKED)
227                 spin_lock(&buster_lock);
228         for (int i = 0; i < MIN(num_writes, MAX_WRITES); i=i+stride)
229                 buster[i] = 0xdeadbeef;
230         if (flags & BUSTER_LOCKED)
231                 spin_unlock(&buster_lock);
232
233         if (num_pages) {
234                 spin_lock(&buster_lock);
235                 for (int i = 0; i < MIN(num_pages, MAX_PAGES); i++) {
236                         page_remove(e->env_pgdir, (void*)(INSERT_ADDR + PGSIZE * i));
237                         page_decref(a_page[i]);
238                 }
239                 spin_unlock(&buster_lock);
240         }
241
242         /* Print info */
243         if (flags & BUSTER_PRINT_TICKS) {
244                 ticks = stop_timing(ticks);
245                 printk("%llu,", ticks);
246         }
247         return;
248 }
249
250 // Print a string to the system console.
251 // The string is exactly 'len' characters long.
252 // Destroys the environment on memory errors.
253 static ssize_t sys_cputs(env_t* e, const char *DANGEROUS s, size_t len)
254 {
255         // Check that the user has permission to read memory [s, s+len).
256         // Destroy the environment if not.
257     char *COUNT(len) _s = user_mem_assert(e, s, len, PTE_U);
258
259         // Print the string supplied by the user.
260         printk("%.*s", len, _s);
261         return (ssize_t)len;
262 }
263
264 // Read a character from the system console.
265 // Returns the character.
266 static uint16_t sys_cgetc(env_t* e)
267 {
268         uint16_t c;
269
270         // The cons_getc() primitive doesn't wait for a character,
271         // but the sys_cgetc() system call does.
272         while ((c = cons_getc()) == 0)
273                 cpu_relax();
274
275         return c;
276 }
277
278 // Returns the current environment's envid.
279 static envid_t sys_getenvid(env_t* e)
280 {
281         return e->env_id;
282 }
283
284 // Returns the id of the cpu this syscall is executed on.
285 static envid_t sys_getcpuid(void)
286 {
287         return lapic_get_id();
288 }
289
290 // Destroy a given environment (possibly the currently running environment).
291 //
292 // Returns 0 on success, < 0 on error.  Errors are:
293 //      -EBADENV if environment envid doesn't currently exist,
294 //              or the caller doesn't have permission to change envid.
295 static error_t sys_env_destroy(env_t* e, envid_t envid)
296 {
297         int r;
298         env_t *env_to_die;
299
300         if ((r = envid2env(envid, &env_to_die, 1)) < 0)
301                 return r;
302         if (env_to_die == e)
303                 printk("[%08x] exiting gracefully\n", e->env_id);
304         else
305                 printk("[%08x] destroying %08x\n", e->env_id, env_to_die->env_id);
306         env_destroy(env_to_die);
307         return 0;
308 }
309
310 /*
311  * Current process yields its remaining "time slice".  Currently works for
312  * single-core processes.
313  */
314 static void sys_yield(env_t *e)
315 {
316         // TODO: watch for races throughout anything related to process statuses
317         // and schedule/yielding
318         assert(e->env_status == ENV_RUNNING);
319         e->env_status = ENV_RUNNABLE;
320         schedule();
321 }
322
323 // TODO: Build a dispatch table instead of switching on the syscallno
324 // Dispatches to the correct kernel function, passing the arguments.
325 intreg_t syscall(env_t* e, uint32_t syscallno, uint32_t a1, uint32_t a2,
326                 uint32_t a3, uint32_t a4, uint32_t a5)
327 {
328         // Call the function corresponding to the 'syscallno' parameter.
329         // Return any appropriate return value.
330
331         //cprintf("Incoming syscall number: %d\n    a1: %x\n   "
332         //        " a2: %x\n    a3: %x\n    a4: %x\n    a5: %x\n", 
333         //        syscallno, a1, a2, a3, a4, a5);
334
335         assert(e); // should always have an env for every syscall
336         //printk("Running syscall: %d\n", syscallno);
337         if (INVALID_SYSCALL(syscallno))
338                 return -EINVAL;
339
340         switch (syscallno) {
341                 case SYS_null:
342                         sys_null();
343                         return 0;
344                 case SYS_run_binary:
345                         return sys_run_binary(e, (char *DANGEROUS)a1, 
346                                               (char* DANGEROUS)a2, (size_t)a3);
347                 case SYS_eth_write:
348                         return sys_eth_write(e, (char *DANGEROUS)a1, (size_t)a2);
349                 case SYS_eth_read:
350                         return sys_eth_read(e, (char *DANGEROUS)a1, (size_t)a2);        
351                 case SYS_cache_buster:
352                         sys_cache_buster(e, a1, a2, a3);
353                         return 0;
354                 case SYS_cache_invalidate:
355                         sys_cache_invalidate();
356                         return 0;
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_serial_write:
364                         return sys_serial_write(e, (char *DANGEROUS)a1, (size_t)a2);
365                 case SYS_serial_read:
366                         return sys_serial_read(e, (char *DANGEROUS)a1, (size_t)a2);
367                 case SYS_getenvid:
368                         return sys_getenvid(e);
369                 case SYS_env_destroy:
370                         return sys_env_destroy(e, (envid_t)a1);
371                 case SYS_yield:
372                         sys_yield(e);
373                         return 0;
374                 case SYS_proc_create:
375                 case SYS_proc_run:
376                         panic("Not implemented");
377                 default:
378                         // or just return -EINVAL
379                         panic("Invalid syscall number %d for env %x!", syscallno, *e);
380         }
381         return 0xdeadbeef;
382 }
383
384 intreg_t syscall_async(env_t* e, syscall_req_t *call)
385 {
386         return syscall(e, call->num, call->args[0], call->args[1],
387                        call->args[2], call->args[3], call->args[4]);
388 }
389
390 intreg_t process_generic_syscalls(env_t* e, size_t max)
391 {
392         size_t count = 0;
393         syscall_back_ring_t* sysbr = &e->env_sysbackring;
394
395         // make sure the env is still alive.  incref will return 0 on success.
396         if (env_incref(e))
397                 return -1;
398
399         // max is the most we'll process.  max = 0 means do as many as possible
400         while (RING_HAS_UNCONSUMED_REQUESTS(sysbr) && ((!max)||(count < max)) ) {
401                 if (!count) {
402                         // ASSUME: one queue per process
403                         // only switch cr3 for the very first request for this queue
404                         // need to switch to the right context, so we can handle the user pointer
405                         // that points to a data payload of the syscall
406                         lcr3(e->env_cr3);
407                 }
408                 count++;
409                 //printk("DEBUG PRE: sring->req_prod: %d, sring->rsp_prod: %d\n",\
410                            sysbr->sring->req_prod, sysbr->sring->rsp_prod);
411                 // might want to think about 0-ing this out, if we aren't
412                 // going to explicitly fill in all fields
413                 syscall_rsp_t rsp;
414                 // this assumes we get our answer immediately for the syscall.
415                 syscall_req_t* req = RING_GET_REQUEST(sysbr, ++(sysbr->req_cons));
416                 rsp.retval = syscall_async(e, req);
417                 // write response into the slot it came from
418                 memcpy(req, &rsp, sizeof(syscall_rsp_t));
419                 // update our counter for what we've produced (assumes we went in order!)
420                 (sysbr->rsp_prod_pvt)++;
421                 RING_PUSH_RESPONSES(sysbr);
422                 //printk("DEBUG POST: sring->req_prod: %d, sring->rsp_prod: %d\n",\
423                            sysbr->sring->req_prod, sysbr->sring->rsp_prod);
424         }
425         env_decref(e);
426         return (intreg_t)count;
427 }