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