Added doxygen support to pci/mptables/ioapic.c. General code cleanup across all files...
[akaros.git] / kern / src / syscall.c
1 /* See COPYRIGHT for copyright information. */
2
3 #ifdef __DEPUTY__
4 #pragma nodeputy
5 #endif
6
7
8 #include <arch/types.h>
9 #include <arch/arch.h>
10 #include <arch/mmu.h>
11 #include <arch/console.h>
12 #include <ros/timer.h>
13 #include <ros/error.h>
14
15 #include <rl8168.h>
16 #include <string.h>
17 #include <assert.h>
18 #include <process.h>
19 #include <schedule.h>
20 #include <pmap.h>
21 #include <trap.h>
22 #include <syscall.h>
23 #include <kmalloc.h>
24 #include <stdio.h>
25 #include <kfs.h> // eventually replace this with vfs.h
26
27 static void sys_yield(struct proc *p);
28
29 //Do absolutely nothing.  Used for profiling.
30 static void sys_null(void)
31 {
32         return;
33 }
34
35 //Write a buffer over the serial port
36 static ssize_t sys_serial_write(env_t* e, const char *DANGEROUS buf, size_t len)
37 {
38         #ifdef SERIAL_IO
39                 char *COUNT(len) _buf = user_mem_assert(e, buf, len, PTE_USER_RO);
40                 for(int i =0; i<len; i++)
41                         serial_send_byte(buf[i]);
42                 return (ssize_t)len;
43         #else
44                 return -EINVAL;
45         #endif
46 }
47
48 //Read a buffer over the serial port
49 static ssize_t sys_serial_read(env_t* e, char *DANGEROUS _buf, size_t len)
50 {
51         #ifdef SERIAL_IO
52             char *COUNT(len) buf = user_mem_assert(e, _buf, len, PTE_USER_RO);
53                 size_t bytes_read = 0;
54                 int c;
55                 while((c = serial_read_byte()) != -1) {
56                         buf[bytes_read++] = (uint8_t)c;
57                         if(bytes_read == len) break;
58                 }
59                 return (ssize_t)bytes_read;
60         #else
61                 return -EINVAL;
62         #endif
63 }
64
65 static ssize_t sys_run_binary(env_t* e, void *binary_buf, void* arg, size_t len) {
66         uint8_t* new_binary = kmalloc(len, 0);
67         if(new_binary == NULL)
68                 return -ENOMEM;
69         memcpy(new_binary, binary_buf, len);
70
71         env_t* env = env_create((uint8_t*)new_binary, len);
72         kfree(new_binary);
73         proc_set_state(env, PROC_RUNNABLE_S);
74         schedule_proc(env);
75         sys_yield(e);
76         
77         return 0;
78 }
79
80 // This is probably not a syscall we want. Its hacky. Here just for syscall stuff until get a stack.
81 static ssize_t sys_eth_write(env_t* e, const char *DANGEROUS buf, size_t len) 
82
83         extern int eth_up;
84         
85         if (eth_up) {
86                 
87                 char *COUNT(len) _buf = user_mem_assert(e, buf, len, PTE_U);
88                 int total_sent = 0;
89                 int just_sent = 0;
90                 int cur_packet_len = 0;
91                 while (total_sent != len) {
92                         cur_packet_len = ((len - total_sent) > MAX_PACKET_DATA) ? MAX_PACKET_DATA : (len - total_sent);
93                         char* wrap_buffer = packet_wrap(buf + total_sent, cur_packet_len);
94                         just_sent = send_frame(wrap_buffer, cur_packet_len + PACKET_HEADER_SIZE);
95                         
96                         if (just_sent < 0)
97                                 return 0; // This should be an error code of its own
98                                 
99                         if (wrap_buffer)
100                                 kfree(wrap_buffer);
101                                 
102                         total_sent += cur_packet_len;
103                 }
104                 
105                 return (ssize_t)len;
106                 
107         }
108         else
109                 return -EINVAL;
110 }
111 /*
112 static ssize_t sys_eth_write(env_t* e, const char *DANGEROUS buf, size_t len) 
113
114         extern int eth_up;
115         
116         if (eth_up) {
117                 
118                 char *COUNT(len) _buf = user_mem_assert(e, buf, len, PTE_U);
119                 
120                 return(send_frame(buf, len));
121         }
122         return -EINVAL;
123 }
124 */
125
126
127 // This is probably not a syscall we want. Its hacky. Here just for syscall stuff until get a stack.
128 static ssize_t sys_eth_read(env_t* e, char *DANGEROUS buf, size_t len) 
129 {
130         extern int eth_up;
131         
132         if (eth_up) {
133                 extern int packet_waiting;
134                 extern int packet_buffer_size;
135                 extern char* packet_buffer;
136                 extern char* packet_buffer_orig;
137                 extern int packet_buffer_pos;
138                         
139                 if (packet_waiting == 0)
140                         return 0;
141                         
142                 int read_len = ((packet_buffer_pos + len) > packet_buffer_size) ? packet_buffer_size - packet_buffer_pos : len;
143
144                 memcpy(buf, packet_buffer + packet_buffer_pos, read_len);
145         
146                 packet_buffer_pos = packet_buffer_pos + read_len;
147         
148                 if (packet_buffer_pos == packet_buffer_size) {
149                         kfree(packet_buffer_orig);
150                         packet_waiting = 0;
151                 }
152         
153                 return read_len;
154         }
155         else
156                 return -EINVAL;
157 }
158
159 static ssize_t sys_shared_page_alloc(env_t* p1,
160                                      void**DANGEROUS _addr, envid_t p2_id,
161                                      int p1_flags, int p2_flags
162                                     )
163 {
164         //if (!VALID_USER_PERMS(p1_flags)) return -EPERM;
165         //if (!VALID_USER_PERMS(p2_flags)) return -EPERM;
166
167         void * COUNT(1) * COUNT(1) addr = user_mem_assert(p1, _addr, sizeof(void *), 
168                                                       PTE_USER_RW);
169         page_t* page;
170         env_t* p2 = &(envs[ENVX(p2_id)]);
171         error_t e = page_alloc(&page);
172
173         if(e < 0) return e;
174
175         void* p2_addr = page_insert_in_range(p2->env_pgdir, page,
176                                              (void*SNT)UTEXT, (void*SNT)UTOP, p2_flags);
177         if(p2_addr == NULL)
178                 return -EFAIL;
179
180         void* p1_addr = page_insert_in_range(p1->env_pgdir, page,
181                                             (void*SNT)UTEXT, (void*SNT)UTOP, p1_flags);
182         if(p1_addr == NULL) {
183                 page_remove(p2->env_pgdir, p2_addr);
184                 return -EFAIL;
185         }
186         *addr = p1_addr;
187         return ESUCCESS;
188 }
189
190 static void sys_shared_page_free(env_t* p1, void*DANGEROUS addr, envid_t p2)
191 {
192 }
193
194 // Invalidate the cache of this core.  Only useful if you want a cold cache for
195 // performance testing reasons.
196 static void sys_cache_invalidate(void)
197 {
198         #ifdef __i386__
199                 wbinvd();
200         #endif
201         return;
202 }
203
204 // Writes 'val' to 'num_writes' entries of the well-known array in the kernel
205 // address space.  It's just #defined to be some random 4MB chunk (which ought
206 // to be boot_alloced or something).  Meant to grab exclusive access to cache
207 // lines, to simulate doing something useful.
208 static void sys_cache_buster(env_t* e, uint32_t num_writes, uint32_t num_pages,
209                              uint32_t flags)
210 { TRUSTEDBLOCK /* zra: this is not really part of the kernel */
211         #define BUSTER_ADDR             0xd0000000  // around 512 MB deep
212         #define MAX_WRITES              1048576*8
213         #define MAX_PAGES               32
214         #define INSERT_ADDR     (UINFO + 2*PGSIZE) // should be free for these tests
215         uint32_t* buster = (uint32_t*)BUSTER_ADDR;
216         static uint32_t buster_lock = 0;
217         uint64_t ticks = -1;
218         page_t* a_page[MAX_PAGES];
219
220         /* Strided Accesses or Not (adjust to step by cachelines) */
221         uint32_t stride = 1;
222         if (flags & BUSTER_STRIDED) {
223                 stride = 16;
224                 num_writes *= 16;
225         }
226
227         /* Shared Accesses or Not (adjust to use per-core regions)
228          * Careful, since this gives 8MB to each core, starting around 512MB.
229          * Also, doesn't separate memory for core 0 if it's an async call.
230          */
231         if (!(flags & BUSTER_SHARED))
232                 buster = (uint32_t*)(BUSTER_ADDR + core_id() * 0x00800000);
233
234         /* Start the timer, if we're asked to print this info*/
235         if (flags & BUSTER_PRINT_TICKS)
236                 ticks = start_timing();
237
238         /* Allocate num_pages (up to MAX_PAGES), to simulate doing some more
239          * realistic work.  Note we don't write to these pages, even if we pick
240          * unshared.  Mostly due to the inconvenience of having to match up the
241          * number of pages with the number of writes.  And it's unnecessary.
242          */
243         if (num_pages) {
244                 spin_lock(&buster_lock);
245                 for (int i = 0; i < MIN(num_pages, MAX_PAGES); i++) {
246                         page_alloc(&a_page[i]);
247                         page_insert(e->env_pgdir, a_page[i], (void*)INSERT_ADDR + PGSIZE*i,
248                                     PTE_USER_RW);
249                 }
250                 spin_unlock(&buster_lock);
251         }
252
253         if (flags & BUSTER_LOCKED)
254                 spin_lock(&buster_lock);
255         for (int i = 0; i < MIN(num_writes, MAX_WRITES); i=i+stride)
256                 buster[i] = 0xdeadbeef;
257         if (flags & BUSTER_LOCKED)
258                 spin_unlock(&buster_lock);
259
260         if (num_pages) {
261                 spin_lock(&buster_lock);
262                 for (int i = 0; i < MIN(num_pages, MAX_PAGES); i++) {
263                         page_remove(e->env_pgdir, (void*)(INSERT_ADDR + PGSIZE * i));
264                         page_decref(a_page[i]);
265                 }
266                 spin_unlock(&buster_lock);
267         }
268
269         /* Print info */
270         if (flags & BUSTER_PRINT_TICKS) {
271                 ticks = stop_timing(ticks);
272                 printk("%llu,", ticks);
273         }
274         return;
275 }
276
277 // Print a string to the system console.
278 // The string is exactly 'len' characters long.
279 // Destroys the environment on memory errors.
280 static ssize_t sys_cputs(env_t* e, const char *DANGEROUS s, size_t len)
281 {
282         // Check that the user has permission to read memory [s, s+len).
283         // Destroy the environment if not.
284     char *COUNT(len) _s = user_mem_assert(e, s, len, PTE_USER_RO);
285
286         // Print the string supplied by the user.
287         printk("%.*s", len, _s);
288         return (ssize_t)len;
289 }
290
291 // Read a character from the system console.
292 // Returns the character.
293 static uint16_t sys_cgetc(env_t* e)
294 {
295         uint16_t c;
296
297         // The cons_getc() primitive doesn't wait for a character,
298         // but the sys_cgetc() system call does.
299         while ((c = cons_getc()) == 0)
300                 cpu_relax();
301
302         return c;
303 }
304
305 // Returns the current environment's envid.
306 static envid_t sys_getenvid(env_t* e)
307 {
308         return e->env_id;
309 }
310
311 // Returns the id of the cpu this syscall is executed on.
312 static envid_t sys_getcpuid(void)
313 {
314         return core_id();
315 }
316
317 // TODO FIX Me!!!! for processes
318 // Destroy a given environment (possibly the currently running environment).
319 //
320 // Returns 0 on success, < 0 on error.  Errors are:
321 //      -EBADENV if environment envid doesn't currently exist,
322 //              or the caller doesn't have permission to change envid.
323 static error_t sys_env_destroy(env_t* e, envid_t envid)
324 {
325         int r;
326         env_t *env_to_die;
327
328         if ((r = envid2env(envid, &env_to_die, 1)) < 0)
329                 return r;
330         if (env_to_die == e)
331                 printk("[%08x] exiting gracefully\n", e->env_id);
332         else
333                 panic("Destroying other processes is not supported yet.");
334                 //printk("[%08x] destroying %08x\n", e->env_id, env_to_die->env_id);
335         proc_destroy(env_to_die);
336         return ESUCCESS;
337 }
338
339 /*
340  * Current process yields its remaining "time slice".  Currently works for
341  * single-core processes.
342  * TODO: think about how this works with async calls and multicored procs.
343  * Want it to only be callable locally.
344  */
345 static void sys_yield(struct proc *p)
346 {
347         // This is all standard single-core, local call
348         spin_lock_irqsave(&p->proc_lock);
349         assert(p->state == PROC_RUNNING_S);
350         proc_set_state(p, PROC_RUNNABLE_S);
351         schedule_proc(p);
352         spin_unlock_irqsave(&p->proc_lock);
353         // the implied thing here is that all state has been saved before leaving
354         // could do the "leaving the process context" here, mentioned in startcore
355         schedule();
356
357         /* TODO
358          * if running_s, give up your time slice (schedule, save silly state, block)
359          * if running_m and 2+ cores are left, give yours up, stay running_m
360          * if running_m and last core, switch to runnable_s
361          */
362 }
363
364 /*
365  * Creates a process found at the user string 'path'.  Currently uses KFS.
366  * Not runnable by default, so it needs it's status to be changed so that the
367  * next call to schedule() will try to run it.
368  * TODO: once we have a decent VFS, consider splitting this up
369  * and once there's an mmap, can have most of this in process.c
370  */
371 static int sys_proc_create(struct proc *p, const char *DANGEROUS path)
372 {
373         #define MAX_PATH_LEN 256 // totally arbitrary
374         int pid = 0;
375         char tpath[MAX_PATH_LEN];
376         /*
377          * There's a bunch of issues with reading in the path, which we'll
378          * need to sort properly in the VFS.  Main concerns are TOCTOU (copy-in),
379          * whether or not it's a big deal that the pointer could be into kernel
380          * space, and resolving both of these without knowing the length of the
381          * string. (TODO)
382          * Change this so that all syscalls with a pointer take a length.
383          *
384          * zra: I've added this user_mem_strlcpy, which I think eliminates the
385      * the TOCTOU issue. Adding a length arg to this call would allow a more
386          * efficient implementation, though, since only one call to user_mem_check
387          * would be required.
388          */
389         int ret = user_mem_strlcpy(p,tpath, path, MAX_PATH_LEN, PTE_USER_RO);
390         int kfs_inode = kfs_lookup_path(tpath);
391         if (kfs_inode < 0)
392                 return -EINVAL;
393         struct proc *new_p = kfs_proc_create(kfs_inode);
394         return new_p->env_id; // TODO replace this with a real proc_id
395 }
396
397 /* Makes process PID runnable.  Consider moving the functionality to env.c */
398 static error_t sys_proc_run(struct proc *p, unsigned pid)
399 {
400         struct proc *target = get_proc(pid);
401         error_t retval = 0;
402         spin_lock_irqsave(&p->proc_lock); // note we can get interrupted here. it's not bad.
403         // make sure we have access and it's in the right state to be activated
404         if (!proc_controls(p, target)) {
405                 retval = -EPERM;
406         } else if (target->state != PROC_CREATED) {
407                 retval = -EINVAL;
408         } else {
409                 proc_set_state(target, PROC_RUNNABLE_S);
410                 schedule_proc(target);
411         }
412         spin_unlock_irqsave(&p->proc_lock);
413         return retval;
414 }
415
416 // TODO: Build a dispatch table instead of switching on the syscallno
417 // Dispatches to the correct kernel function, passing the arguments.
418 intreg_t syscall(env_t* e, uint32_t syscallno, uint32_t a1, uint32_t a2,
419                  uint32_t a3, uint32_t a4, uint32_t a5)
420 {
421         // Call the function corresponding to the 'syscallno' parameter.
422         // Return any appropriate return value.
423
424         //cprintf("Incoming syscall number: %d\n    a1: %x\n   "
425         //        " a2: %x\n    a3: %x\n    a4: %x\n    a5: %x\n",
426         //        syscallno, a1, a2, a3, a4, a5);
427
428         assert(e); // should always have an env for every syscall
429         //printk("Running syscall: %d\n", syscallno);
430         if (INVALID_SYSCALL(syscallno))
431                 return -EINVAL;
432
433         switch (syscallno) {
434                 case SYS_null:
435                         sys_null();
436                         return ESUCCESS;
437                 case SYS_run_binary:
438                         return sys_run_binary(e, (char *DANGEROUS)a1, 
439                                               (char* DANGEROUS)a2, (size_t)a3);
440                 case SYS_eth_write:
441                         return sys_eth_write(e, (char *DANGEROUS)a1, (size_t)a2);
442                 case SYS_eth_read:
443                         return sys_eth_read(e, (char *DANGEROUS)a1, (size_t)a2);        
444                 case SYS_cache_buster:
445                         sys_cache_buster(e, a1, a2, a3);
446                         return 0;
447                 case SYS_cache_invalidate:
448                         sys_cache_invalidate();
449                         return 0;
450                 case SYS_shared_page_alloc:
451                         return sys_shared_page_alloc(e, (void** DANGEROUS) a1,
452                                                  a2, (int) a3, (int) a4);
453                 case SYS_shared_page_free:
454                         sys_shared_page_free(e, (void* DANGEROUS) a1, a2);
455                     return ESUCCESS;
456                 case SYS_cputs:
457                         return sys_cputs(e, (char *DANGEROUS)a1, (size_t)a2);
458                 case SYS_cgetc:
459                         return sys_cgetc(e);
460                 case SYS_getcpuid:
461                         return sys_getcpuid();
462                 case SYS_getpid:
463                         return sys_getenvid(e);
464                 case SYS_proc_destroy:
465                         return sys_env_destroy(e, (envid_t)a1);
466                 case SYS_yield:
467                         sys_yield(e);
468                         return ESUCCESS;
469                 case SYS_proc_create:
470                         return sys_proc_create(e, (char *DANGEROUS)a1);
471                 case SYS_proc_run:
472                         return sys_proc_run(e, (size_t)a1);
473
474         #ifdef __i386__
475                 case SYS_serial_write:
476                         return sys_serial_write(e, (char *DANGEROUS)a1, (size_t)a2);
477                 case SYS_serial_read:
478                         return sys_serial_read(e, (char *DANGEROUS)a1, (size_t)a2);
479         #endif
480
481         #ifdef __sparc_v8__
482                 case SYS_frontend:
483                         return frontend_syscall(a1,a2,a3,a4);
484         #endif
485
486                 default:
487                         // or just return -EINVAL
488                         panic("Invalid syscall number %d for env %x!", syscallno, *e);
489         }
490         return 0xdeadbeef;
491 }
492
493 intreg_t syscall_async(env_t* e, syscall_req_t *call)
494 {
495         return syscall(e, call->num, call->args[0], call->args[1],
496                        call->args[2], call->args[3], call->args[4]);
497 }
498
499 intreg_t process_generic_syscalls(env_t* e, size_t max)
500 {
501         size_t count = 0;
502         syscall_back_ring_t* sysbr = &e->syscallbackring;
503
504         // make sure the env is still alive.
505         // incref will return ESUCCESS on success.
506         if (proc_incref(e))
507                 return -EFAIL;
508
509         // max is the most we'll process.  max = 0 means do as many as possible
510         while (RING_HAS_UNCONSUMED_REQUESTS(sysbr) && ((!max)||(count < max)) ) {
511                 if (!count) {
512                         // ASSUME: one queue per process
513                         // only switch cr3 for the very first request for this queue
514                         // need to switch to the right context, so we can handle the user pointer
515                         // that points to a data payload of the syscall
516                         lcr3(e->env_cr3);
517                 }
518                 count++;
519                 //printk("DEBUG PRE: sring->req_prod: %d, sring->rsp_prod: %d\n",\
520                            sysbr->sring->req_prod, sysbr->sring->rsp_prod);
521                 // might want to think about 0-ing this out, if we aren't
522                 // going to explicitly fill in all fields
523                 syscall_rsp_t rsp;
524                 // this assumes we get our answer immediately for the syscall.
525                 syscall_req_t* req = RING_GET_REQUEST(sysbr, ++(sysbr->req_cons));
526                 rsp.retval = syscall_async(e, req);
527                 // write response into the slot it came from
528                 memcpy(req, &rsp, sizeof(syscall_rsp_t));
529                 // update our counter for what we've produced (assumes we went in order!)
530                 (sysbr->rsp_prod_pvt)++;
531                 RING_PUSH_RESPONSES(sysbr);
532                 //printk("DEBUG POST: sring->req_prod: %d, sring->rsp_prod: %d\n",\
533                            sysbr->sring->req_prod, sysbr->sring->rsp_prod);
534         }
535         // load sane page tables (and don't rely on decref to do it for you).
536         lcr3(boot_cr3);
537         proc_decref(e);
538         return (intreg_t)count;
539 }