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