Cleaned up the return values for all system calls.
[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 <ros/error.h>
11 #include <string.h>
12 #include <assert.h>
13 #include <env.h>
14 #include <pmap.h>
15 #include <trap.h>
16 #include <syscall.h>
17
18 void syscall_wrapper(struct Trapframe *tf)
19 {
20         env_t* curenv = curenvs[lapic_get_id()];
21     curenv->env_tf = *tf;
22     tf->tf_regs.reg_eax =
23             (intreg_t) syscall(curenv,
24                                tf->tf_regs.reg_eax,
25                                tf->tf_regs.reg_edx,
26                                tf->tf_regs.reg_ecx,
27                                tf->tf_regs.reg_ebx,
28                                tf->tf_regs.reg_edi,
29                                0);
30     return;
31 }
32
33 //Do absolutely nothing.  Used for profiling.
34 static void sys_null(void)
35 {
36         return;
37 }
38
39 //Write a buffer over the serial port
40 static ssize_t sys_serial_write(env_t* e, const char *DANGEROUS buf, size_t len) 
41 {
42         char *COUNT(len) _buf = user_mem_assert(e, buf, len, PTE_U);
43         for(int i =0; i<len; i++)
44                 serial_send_byte(buf[i]);       
45         return (ssize_t)len;
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     char *COUNT(len) _buf = user_mem_assert(e, buf, len, PTE_U);
52         size_t bytes_read = 0;
53         int c;
54         while((c = serial_read_byte()) != -1) {
55                 buf[bytes_read++] = (uint8_t)c;
56                 if(bytes_read == len) break;
57         }
58         return (ssize_t)bytes_read;
59 }
60
61 // Invalidate the cache of this core
62 static void sys_cache_invalidate(void)
63 {
64         wbinvd();
65         return;
66 }
67
68 // Writes 'val' to 'num_writes' entries of the well-known array in the kernel
69 // address space.  It's just #defined to be some random 4MB chunk (which ought
70 // to be boot_alloced or something).  Meant to grab exclusive access to cache
71 // lines, to simulate doing something useful.
72 static void sys_cache_buster(env_t* e, uint32_t num_writes, uint32_t val)
73 {
74         #define BUSTER_ADDR 0xd0000000
75         #define MAX_WRITES 1048576
76         uint32_t* buster = (uint32_t*)BUSTER_ADDR;
77         static uint32_t buster_lock = 0;
78
79         spin_lock(&buster_lock);
80         for (int i = 0; i < MIN(num_writes, MAX_WRITES); i++)
81                 buster[i] = val;
82         spin_unlock(&buster_lock);
83         return;
84 }
85
86 // Print a string to the system console.
87 // The string is exactly 'len' characters long.
88 // Destroys the environment on memory errors.
89 static ssize_t sys_cputs(env_t* e, const char *DANGEROUS s, size_t len)
90 {
91         // Check that the user has permission to read memory [s, s+len).
92         // Destroy the environment if not.
93     char *COUNT(len) _s = user_mem_assert(e, s, len, PTE_U);
94
95         // Print the string supplied by the user.
96         printk("%.*s", len, _s);
97         return (ssize_t)len;
98 }
99
100 // Read a character from the system console.
101 // Returns the character.
102 static uint16_t sys_cgetc(env_t* e)
103 {
104         uint16_t c;
105
106         // The cons_getc() primitive doesn't wait for a character,
107         // but the sys_cgetc() system call does.
108         while ((c = cons_getc()) == 0)
109                 cpu_relax();
110
111         return c;
112 }
113
114 // Returns the current environment's envid.
115 static envid_t sys_getenvid(env_t* e)
116 {
117         return e->env_id;
118 }
119
120 // Returns the id of the cpu this syscall is executed on.
121 static envid_t sys_getcpuid(void)
122 {
123         return lapic_get_id();
124 }
125
126 // Destroy a given environment (possibly the currently running environment).
127 //
128 // Returns 0 on success, < 0 on error.  Errors are:
129 //      -E_BAD_ENV if environment envid doesn't currently exist,
130 //              or the caller doesn't have permission to change envid.
131 static error_t sys_env_destroy(env_t* e, envid_t envid)
132 {
133         int r;
134         env_t *env_to_die;
135
136         if ((r = envid2env(envid, &env_to_die, 1)) < 0)
137                 return r;
138         if (env_to_die == e)
139                 printk("[%08x] exiting gracefully\n", e->env_id);
140         else
141                 printk("[%08x] destroying %08x\n", e->env_id, env_to_die->env_id);
142         env_destroy(env_to_die);
143         return 0;
144 }
145
146
147 // TODO: Build a dispatch table instead of switching on the syscallno
148 // Dispatches to the correct kernel function, passing the arguments.
149 intreg_t syscall(env_t* e, uint32_t syscallno, uint32_t a1, uint32_t a2,
150                 uint32_t a3, uint32_t a4, uint32_t a5)
151 {
152         // Call the function corresponding to the 'syscallno' parameter.
153         // Return any appropriate return value.
154
155         //cprintf("Incoming syscall number: %d\n    a1: %x\n   "
156         //        " a2: %x\n    a3: %x\n    a4: %x\n    a5: %x\n", 
157         //        syscallno, a1, a2, a3, a4, a5);
158
159         assert(e); // should always have an env for every syscall
160         //printk("Running syscall: %d\n", syscallno);
161         if (INVALID_SYSCALL(syscallno))
162                 return -E_INVAL;
163
164         switch (syscallno) {
165                 case SYS_null:
166                         sys_null();
167                         return 0;
168                 case SYS_serial_write:
169                         //printk("I am here\n");
170                         return sys_serial_write(e, (char *DANGEROUS)a1, (size_t)a2);
171                 case SYS_serial_read:
172                         return sys_serial_read(e, (char *DANGEROUS)a1, (size_t)a2);
173                 case SYS_cache_invalidate:
174                         sys_cache_invalidate();
175                         return 0;
176                 case SYS_cache_buster:
177                         sys_cache_buster(e, a1, a2);
178                         return 0;
179                 case SYS_cputs:
180                         return sys_cputs(e, (char *DANGEROUS)a1, (size_t)a2);
181                 case SYS_cgetc:
182                         return sys_cgetc(e);
183                 case SYS_getenvid:
184                         return sys_getenvid(e);
185                 case SYS_getcpuid:
186                         return sys_getcpuid();
187                 case SYS_env_destroy:
188                         return sys_env_destroy(e, (envid_t)a1);
189                 default:
190                         // or just return -E_INVAL
191                         panic("Invalid syscall number %d for env %x!", syscallno, *e);
192         }
193         return 0xdeadbeef;
194 }
195
196 intreg_t syscall_async(env_t* e, syscall_req_t *call)
197 {
198         return syscall(e, call->num, call->args[0], call->args[1],
199                        call->args[2], call->args[3], call->args[4]);
200 }
201
202 intreg_t process_generic_syscalls(env_t* e, size_t max)
203 {
204         size_t count = 0;
205         syscall_back_ring_t* sysbr = &e->env_sysbackring;
206
207         // make sure the env is still alive.  incref will return 0 on success.
208         if (env_incref(e))
209                 return -1;
210
211         // max is the most we'll process.  max = 0 means do as many as possible
212         while (RING_HAS_UNCONSUMED_REQUESTS(sysbr) && ((!max)||(count < max)) ) {
213                 if (!count) {
214                         // ASSUME: one queue per process
215                         // only switch cr3 for the very first request for this queue
216                         // need to switch to the right context, so we can handle the user pointer
217                         // that points to a data payload of the syscall
218                         lcr3(e->env_cr3);
219                 }
220                 count++;
221                 //printk("DEBUG PRE: sring->req_prod: %d, sring->rsp_prod: %d\n",\
222                            sysbr->sring->req_prod, sysbr->sring->rsp_prod);
223                 // might want to think about 0-ing this out, if we aren't
224                 // going to explicitly fill in all fields
225                 syscall_rsp_t rsp;
226                 // this assumes we get our answer immediately for the syscall.
227                 syscall_req_t* req = RING_GET_REQUEST(sysbr, ++(sysbr->req_cons));
228                 rsp.retval = syscall_async(e, req);
229                 // write response into the slot it came from
230                 memcpy(req, &rsp, sizeof(syscall_rsp_t));
231                 // update our counter for what we've produced (assumes we went in order!)
232                 (sysbr->rsp_prod_pvt)++;
233                 RING_PUSH_RESPONSES(sysbr);
234                 //printk("DEBUG POST: sring->req_prod: %d, sring->rsp_prod: %d\n",\
235                            sysbr->sring->req_prod, sysbr->sring->rsp_prod);
236         }
237         env_decref(e);
238         return (intreg_t)count;
239 }