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