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