Fixed up sysenter/sysexit semantics to allow another environment to be run on exit
[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 <string.h>
14 #include <assert.h>
15 #include <env.h>
16 #include <pmap.h>
17 #include <trap.h>
18 #include <syscall.h>
19
20 void syscall_wrapper(struct Trapframe *tf)
21 {
22         env_t* curenv = curenvs[lapic_get_id()];
23     curenv->env_tf = *tf;
24         //Re enable interrupts. sysenter disables them.
25         enable_irq();
26         
27         curenv->env_tf.tf_regs.reg_eax =
28             (intreg_t) syscall(curenv,
29                                tf->tf_regs.reg_eax,
30                                tf->tf_regs.reg_edx,
31                                tf->tf_regs.reg_ecx,
32                                tf->tf_regs.reg_ebx,
33                                tf->tf_regs.reg_edi,
34                                0);
35         env_run(curenv);
36 }
37
38 //Do absolutely nothing.  Used for profiling.
39 static void sys_null(void)
40 {
41         return;
42 }
43
44 //Write a buffer over the serial port
45 static ssize_t sys_serial_write(env_t* e, const char *DANGEROUS buf, size_t len) 
46 {
47         #ifdef SERIAL_IO
48                 char *COUNT(len) _buf = user_mem_assert(e, buf, len, PTE_U);
49                 for(int i =0; i<len; i++)
50                         serial_send_byte(buf[i]);       
51                 return (ssize_t)len;
52         #else
53                 return -E_INVAL;
54         #endif
55 }
56
57 //Read a buffer over the serial port
58 static ssize_t sys_serial_read(env_t* e, char *DANGEROUS buf, size_t len) 
59 {
60         #ifdef SERIAL_IO
61             char *COUNT(len) _buf = user_mem_assert(e, buf, len, PTE_U);
62                 size_t bytes_read = 0;
63                 int c;
64                 while((c = serial_read_byte()) != -1) {
65                         buf[bytes_read++] = (uint8_t)c;
66                         if(bytes_read == len) break;
67                 }
68                 return (ssize_t)bytes_read;
69         #else
70                 return -E_INVAL;
71         #endif
72 }
73
74 // Invalidate the cache of this core
75 static void sys_cache_invalidate(void)
76 {
77         wbinvd();
78         return;
79 }
80
81 // Writes 'val' to 'num_writes' entries of the well-known array in the kernel
82 // address space.  It's just #defined to be some random 4MB chunk (which ought
83 // to be boot_alloced or something).  Meant to grab exclusive access to cache
84 // lines, to simulate doing something useful.
85 static void sys_cache_buster(env_t* e, uint32_t num_writes, uint32_t num_pages,
86                              uint32_t flags)
87 {
88         #define BUSTER_ADDR             0xd0000000  // around 512 MB deep
89         #define MAX_WRITES              1048576*8
90         #define MAX_PAGES               32
91         #define INSERT_ADDR     (UINFO + 2*PGSIZE) // should be free for these tests
92         uint32_t* buster = (uint32_t*)BUSTER_ADDR;
93         static uint32_t buster_lock = 0;
94         uint64_t ticks;
95         page_t* a_page[MAX_PAGES];
96
97         /* Strided Accesses or Not (adjust to step by cachelines) */
98         uint32_t stride = 1;
99         if (flags & BUSTER_STRIDED) {
100                 stride = 16;
101                 num_writes *= 16;
102         }
103         
104         /* Shared Accesses or Not (adjust to use per-core regions)
105          * Careful, since this gives 8MB to each core, starting around 512MB.
106          * Also, doesn't separate memory for core 0 if it's an async call.
107          */
108         if (!(flags & BUSTER_SHARED))
109                 buster = (uint32_t*)(BUSTER_ADDR + lapic_get_id() * 0x00800000);
110
111         /* Start the timer, if we're asked to print this info*/
112         if (flags & BUSTER_PRINT_TICKS)
113                 ticks = start_timing();
114
115         /* Allocate num_pages (up to MAX_PAGES), to simulate doing some more
116          * realistic work.  Note we don't write to these pages, even if we pick
117          * unshared.  Mostly due to the inconvenience of having to match up the
118          * number of pages with the number of writes.  And it's unnecessary.
119          */
120         if (num_pages) {
121                 spin_lock(&buster_lock);
122                 for (int i = 0; i < MIN(num_pages, MAX_PAGES); i++) {
123                         page_alloc(&a_page[i]);
124                         page_insert(e->env_pgdir, a_page[i], (void*)INSERT_ADDR + PGSIZE*i,
125                                     PTE_U | PTE_W);
126                 }
127                 spin_unlock(&buster_lock);
128         }
129
130         if (flags & BUSTER_LOCKED)
131                 spin_lock(&buster_lock);
132         for (int i = 0; i < MIN(num_writes, MAX_WRITES); i=i+stride)
133                 buster[i] = 0xdeadbeef;
134         if (flags & BUSTER_LOCKED)
135                 spin_unlock(&buster_lock);
136
137         if (num_pages) {
138                 spin_lock(&buster_lock);
139                 for (int i = 0; i < MIN(num_pages, MAX_PAGES); i++) {
140                         page_remove(e->env_pgdir, (void*)(INSERT_ADDR + PGSIZE * i));
141                         page_decref(a_page[i]);
142                 }
143                 spin_unlock(&buster_lock);
144         }
145
146         /* Print info */
147         if (flags & BUSTER_PRINT_TICKS) {
148                 ticks = stop_timing(ticks);
149                 printk("%llu,", ticks);
150         }
151         return;
152 }
153
154 // Print a string to the system console.
155 // The string is exactly 'len' characters long.
156 // Destroys the environment on memory errors.
157 static ssize_t sys_cputs(env_t* e, const char *DANGEROUS s, size_t len)
158 {
159         // Check that the user has permission to read memory [s, s+len).
160         // Destroy the environment if not.
161     char *COUNT(len) _s = user_mem_assert(e, s, len, PTE_U);
162
163         // Print the string supplied by the user.
164         printk("%.*s", len, _s);
165         return (ssize_t)len;
166 }
167
168 // Read a character from the system console.
169 // Returns the character.
170 static uint16_t sys_cgetc(env_t* e)
171 {
172         uint16_t c;
173
174         // The cons_getc() primitive doesn't wait for a character,
175         // but the sys_cgetc() system call does.
176         while ((c = cons_getc()) == 0)
177                 cpu_relax();
178
179         return c;
180 }
181
182 // Returns the current environment's envid.
183 static envid_t sys_getenvid(env_t* e)
184 {
185         return e->env_id;
186 }
187
188 // Returns the id of the cpu this syscall is executed on.
189 static envid_t sys_getcpuid(void)
190 {
191         return lapic_get_id();
192 }
193
194 // Destroy a given environment (possibly the currently running environment).
195 //
196 // Returns 0 on success, < 0 on error.  Errors are:
197 //      -E_BAD_ENV if environment envid doesn't currently exist,
198 //              or the caller doesn't have permission to change envid.
199 static error_t sys_env_destroy(env_t* e, envid_t envid)
200 {
201         int r;
202         env_t *env_to_die;
203
204         if ((r = envid2env(envid, &env_to_die, 1)) < 0)
205                 return r;
206         if (env_to_die == e)
207                 printk("[%08x] exiting gracefully\n", e->env_id);
208         else
209                 printk("[%08x] destroying %08x\n", e->env_id, env_to_die->env_id);
210         env_destroy(env_to_die);
211         return 0;
212 }
213
214
215 // TODO: Build a dispatch table instead of switching on the syscallno
216 // Dispatches to the correct kernel function, passing the arguments.
217 intreg_t syscall(env_t* e, uint32_t syscallno, uint32_t a1, uint32_t a2,
218                 uint32_t a3, uint32_t a4, uint32_t a5)
219 {
220         // Call the function corresponding to the 'syscallno' parameter.
221         // Return any appropriate return value.
222
223         //cprintf("Incoming syscall number: %d\n    a1: %x\n   "
224         //        " a2: %x\n    a3: %x\n    a4: %x\n    a5: %x\n", 
225         //        syscallno, a1, a2, a3, a4, a5);
226
227         assert(e); // should always have an env for every syscall
228         //printk("Running syscall: %d\n", syscallno);
229         if (INVALID_SYSCALL(syscallno))
230                 return -E_INVAL;
231
232         switch (syscallno) {
233                 case SYS_null:
234                         sys_null();
235                         return 0;
236                 case SYS_serial_write:
237                         //printk("I am here\n");
238                         return sys_serial_write(e, (char *DANGEROUS)a1, (size_t)a2);
239                 case SYS_serial_read:
240                         return sys_serial_read(e, (char *DANGEROUS)a1, (size_t)a2);
241                 case SYS_cache_invalidate:
242                         sys_cache_invalidate();
243                         return 0;
244                 case SYS_cache_buster:
245                         sys_cache_buster(e, a1, a2, a3);
246                         return 0;
247                 case SYS_cputs:
248                         return sys_cputs(e, (char *DANGEROUS)a1, (size_t)a2);
249                 case SYS_cgetc:
250                         return sys_cgetc(e);
251                 case SYS_getenvid:
252                         return sys_getenvid(e);
253                 case SYS_getcpuid:
254                         return sys_getcpuid();
255                 case SYS_env_destroy:
256                         return sys_env_destroy(e, (envid_t)a1);
257                 default:
258                         // or just return -E_INVAL
259                         panic("Invalid syscall number %d for env %x!", syscallno, *e);
260         }
261         return 0xdeadbeef;
262 }
263
264 intreg_t syscall_async(env_t* e, syscall_req_t *call)
265 {
266         return syscall(e, call->num, call->args[0], call->args[1],
267                        call->args[2], call->args[3], call->args[4]);
268 }
269
270 intreg_t process_generic_syscalls(env_t* e, size_t max)
271 {
272         size_t count = 0;
273         syscall_back_ring_t* sysbr = &e->env_sysbackring;
274
275         // make sure the env is still alive.  incref will return 0 on success.
276         if (env_incref(e))
277                 return -1;
278
279         // max is the most we'll process.  max = 0 means do as many as possible
280         while (RING_HAS_UNCONSUMED_REQUESTS(sysbr) && ((!max)||(count < max)) ) {
281                 if (!count) {
282                         // ASSUME: one queue per process
283                         // only switch cr3 for the very first request for this queue
284                         // need to switch to the right context, so we can handle the user pointer
285                         // that points to a data payload of the syscall
286                         lcr3(e->env_cr3);
287                 }
288                 count++;
289                 //printk("DEBUG PRE: sring->req_prod: %d, sring->rsp_prod: %d\n",\
290                            sysbr->sring->req_prod, sysbr->sring->rsp_prod);
291                 // might want to think about 0-ing this out, if we aren't
292                 // going to explicitly fill in all fields
293                 syscall_rsp_t rsp;
294                 // this assumes we get our answer immediately for the syscall.
295                 syscall_req_t* req = RING_GET_REQUEST(sysbr, ++(sysbr->req_cons));
296                 rsp.retval = syscall_async(e, req);
297                 // write response into the slot it came from
298                 memcpy(req, &rsp, sizeof(syscall_rsp_t));
299                 // update our counter for what we've produced (assumes we went in order!)
300                 (sysbr->rsp_prod_pvt)++;
301                 RING_PUSH_RESPONSES(sysbr);
302                 //printk("DEBUG POST: sring->req_prod: %d, sring->rsp_prod: %d\n",\
303                            sysbr->sring->req_prod, sysbr->sring->rsp_prod);
304         }
305         env_decref(e);
306         return (intreg_t)count;
307 }