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