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