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