Massive reorganizing and making all the makefiles consistent.
[akaros.git] / kern / src / syscall.c
1 /* See COPYRIGHT for copyright information. */
2 #ifdef __DEPUTY__
3 #pragma nodeputy
4 #endif
5
6 #include <inc/x86.h>
7 #include <inc/error.h>
8 #include <inc/string.h>
9 #include <inc/assert.h>
10
11 #include <kern/env.h>
12 #include <kern/pmap.h>
13 #include <kern/trap.h>
14 #include <kern/syscall.h>
15 #include <kern/console.h>
16 #include <kern/apic.h>
17
18
19 void syscall_wrapper(struct Trapframe *tf)
20 {
21         env_t* curenv = curenvs[lapic_get_id()];
22     curenv->env_tf = *tf;
23     tf->tf_regs.reg_eax =
24         syscall(curenv,
25                                 tf->tf_regs.reg_eax,
26                 tf->tf_regs.reg_edx,
27                 tf->tf_regs.reg_ecx,
28                 tf->tf_regs.reg_ebx,
29                 tf->tf_regs.reg_edi,
30                                 0);
31     return;
32 }
33
34 //Do absolutely nothing.  Used for profiling.
35 static void sys_null(env_t* e)
36 {
37         return;
38 }
39
40 // Writes 'val' to 'num_writes' entries of the well-known array in the kernel
41 // address space.  It's just #defined to be some random 4MB chunk (which ought
42 // to be boot_alloced or something).  Meant to grab exclusive access to cache
43 // lines, to simulate doing something useful.
44 static void sys_cache_buster(env_t* e, uint32_t num_writes, uint32_t val)
45 {
46         #define BUSTER_ADDR 0xd0000000
47         #define MAX_WRITES 1048576
48         uint32_t* buster = (uint32_t*)BUSTER_ADDR;
49         static uint32_t buster_lock = 0;
50         
51         spin_lock(&buster_lock);
52         for (int i = 0; i < MIN(num_writes, MAX_WRITES); i++)
53                 buster[i] = val;
54         spin_unlock(&buster_lock);
55 }
56
57 // Print a string to the system console.
58 // The string is exactly 'len' characters long.
59 // Destroys the environment on memory errors.
60 static void
61 sys_cputs(env_t* e, const char *DANGEROUS s, size_t len)
62 {
63         // Check that the user has permission to read memory [s, s+len).
64         // Destroy the environment if not.
65     char *COUNT(len) _s = user_mem_assert(e, s, len, PTE_U);
66
67         // Print the string supplied by the user.
68         cprintf("%.*s", len, _s);
69 }
70
71 // Read a character from the system console.
72 // Returns the character.
73 static int
74 sys_cgetc(env_t* e)
75 {
76         int c;
77
78         // The cons_getc() primitive doesn't wait for a character,
79         // but the sys_cgetc() system call does.
80         while ((c = cons_getc()) == 0)
81                 /* do nothing */;
82
83         return c;
84 }
85
86 // Returns the current environment's envid.
87 static envid_t
88 sys_getenvid(env_t* e)
89 {
90         return e->env_id;
91 }
92
93 // Destroy a given environment (possibly the currently running environment).
94 //
95 // Returns 0 on success, < 0 on error.  Errors are:
96 //      -E_BAD_ENV if environment envid doesn't currently exist,
97 //              or the caller doesn't have permission to change envid.
98 static int
99 sys_env_destroy(env_t* e, envid_t envid)
100 {
101         int r;
102         env_t *env_to_die;
103
104         if ((r = envid2env(envid, &env_to_die, 1)) < 0)
105                 return r;
106         if (env_to_die == e)
107                 cprintf("[%08x] exiting gracefully\n", e->env_id);
108         else
109                 cprintf("[%08x] destroying %08x\n", e->env_id, env_to_die->env_id);
110         env_destroy(env_to_die);
111         return 0;
112 }
113
114
115 // TODO: Build a dispatch table instead of switching on the syscallno
116 // Dispatches to the correct kernel function, passing the arguments.
117 int32_t syscall(env_t* e, uint32_t syscallno, uint32_t a1, uint32_t a2,
118                 uint32_t a3, uint32_t a4, uint32_t a5)
119 {
120         // Call the function corresponding to the 'syscallno' parameter.
121         // Return any appropriate return value.
122
123         //cprintf("Incoming syscall number: %d\n    a1: %x\n    a2: %x\n    a3: %x\n    a4: %x\n    a5: %x\n", syscallno, a1, a2, a3, a4, a5);
124
125         assert(e); // should always have an env for every syscall
126         if (INVALID_SYSCALL(syscallno))
127                 return -E_INVAL;
128
129         switch (syscallno) {
130                 case SYS_null:
131                         sys_null(e);
132                         return 0;
133                 case SYS_cache_buster:
134                         sys_cache_buster(e, a1, a2);
135                         return 0;
136                 case SYS_cputs:
137                         sys_cputs(e, (char *DANGEROUS)a1, (size_t)a2);
138                         return 0;  // would rather have this return the number of chars put.
139                 case SYS_cgetc:
140                         return sys_cgetc(e);
141                 case SYS_getenvid:
142                         return sys_getenvid(e);
143                 case SYS_env_destroy:
144                         return sys_env_destroy(e, (envid_t)a1);
145                 default:
146                         // or just return -E_INVAL
147                         panic("Invalid syscall number %d for env %x!", syscallno, *e);
148         }
149         return 0xdeadbeef;
150 }
151
152 int32_t syscall_async(env_t* e, syscall_req_t *call)
153 {
154         return syscall(e, call->num, call->args[0], call->args[1],
155                        call->args[2], call->args[3], call->args[4]);
156 }
157
158 uint32_t process_generic_syscalls(env_t* e, uint32_t max)
159 {
160         uint32_t count = 0;
161         syscall_back_ring_t* sysbr = &e->env_sysbackring;
162
163         // make sure the env is still alive.  TODO: this cannot handle an env being
164         // freed async while this is processing.  (need a ref count or lock, etc).
165         if (e->env_status == ENV_FREE)
166                 return 0;
167
168         // need to switch to the right context, so we can handle the user pointer
169         // that points to a data payload of the syscall
170         lcr3(e->env_cr3);
171         // max is the most we'll process.  max = 0 means do as many as possible
172         while (RING_HAS_UNCONSUMED_REQUESTS(sysbr) && ((!max)||(count < max)) ) {
173                 count++;
174                 //printk("DEBUG PRE: sring->req_prod: %d, sring->rsp_prod: %d\n",\
175                            sysbr->sring->req_prod, sysbr->sring->rsp_prod);
176                 // might want to think about 0-ing this out, if we aren't
177                 // going to explicitly fill in all fields
178                 syscall_rsp_t rsp;
179                 // this assumes we get our answer immediately for the syscall.
180                 syscall_req_t* req = RING_GET_REQUEST(sysbr, ++(sysbr->req_cons));
181                 rsp.retval = syscall_async(e, req);
182                 // write response into the slot it came from
183                 memcpy(req, &rsp, sizeof(syscall_rsp_t));
184                 // update our counter for what we've produced (assumes we went in order!)
185                 (sysbr->rsp_prod_pvt)++;
186                 RING_PUSH_RESPONSES(sysbr);
187                 //printk("DEBUG POST: sring->req_prod: %d, sring->rsp_prod: %d\n",\
188                            sysbr->sring->req_prod, sysbr->sring->rsp_prod);
189         }
190         return count;
191 }