Fixed bug with user_mem_assert in sparc
[akaros.git] / kern / src / syscall.c
1 /* See COPYRIGHT for copyright information. */
2
3 #ifdef __SHARC__
4 #pragma nosharc
5 #endif
6
7 #include <ros/common.h>
8 #include <arch/types.h>
9 #include <arch/arch.h>
10 #include <arch/mmu.h>
11 #include <arch/console.h>
12 #include <ros/timer.h>
13 #include <ros/error.h>
14
15 #include <string.h>
16 #include <assert.h>
17 #include <process.h>
18 #include <schedule.h>
19 #include <pmap.h>
20 #include <trap.h>
21 #include <syscall.h>
22 #include <kmalloc.h>
23 #include <stdio.h>
24 #include <kfs.h> // eventually replace this with vfs.h
25
26 #ifdef __NETWORK__
27 #include <arch/rl8168.h>
28 #endif
29
30 static void sys_yield(struct proc *p);
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 ssize_t sys_serial_write(env_t* e, const char *DANGEROUS buf, size_t len)
40 {
41         if (len == 0)
42                 return 0;
43         #ifdef SERIAL_IO
44                 char *COUNT(len) _buf = user_mem_assert(e, buf, len, PTE_USER_RO);
45                 for(int i =0; i<len; i++)
46                         serial_send_byte(buf[i]);
47                 return (ssize_t)len;
48         #else
49                 return -EINVAL;
50         #endif
51 }
52
53 //Read a buffer over the serial port
54 static ssize_t sys_serial_read(env_t* e, char *DANGEROUS _buf, size_t len)
55 {
56         if (len == 0)
57                 return 0;
58
59         #ifdef SERIAL_IO
60             char *COUNT(len) buf = user_mem_assert(e, _buf, len, PTE_USER_RO);
61                 size_t bytes_read = 0;
62                 int c;
63                 while((c = serial_read_byte()) != -1) {
64                         buf[bytes_read++] = (uint8_t)c;
65                         if(bytes_read == len) break;
66                 }
67                 return (ssize_t)bytes_read;
68         #else
69                 return -EINVAL;
70         #endif
71 }
72
73 //
74 /* START OF REMOTE SYSTEMCALL SUPPORT SYSCALLS. THESE WILL GO AWAY AS THINGS MATURE */
75 //
76
77 static ssize_t sys_run_binary(env_t* e, void *DANGEROUS binary_buf,
78                               void*DANGEROUS arg, size_t len) {
79         uint8_t *CT(len) checked_binary_buf;
80         checked_binary_buf = user_mem_assert(e, binary_buf, len, PTE_USER_RO);
81
82         uint8_t* new_binary = kmalloc(len, 0);
83         if(new_binary == NULL)
84                 return -ENOMEM;
85         memcpy(new_binary, checked_binary_buf, len);
86
87         env_t* env = env_create(new_binary, len);
88         kfree(new_binary);
89         proc_set_state(env, PROC_RUNNABLE_S);
90         schedule_proc(env);
91         sys_yield(e);
92         
93         return 0;
94 }
95
96 #ifdef __NETWORK__
97 // This is not a syscall we want. Its hacky. Here just for syscall stuff until get a stack.
98 static ssize_t sys_eth_write(env_t* e, const char *DANGEROUS buf, size_t len) 
99
100         extern int eth_up;
101         
102         if (eth_up) {
103                 
104                 if (len == 0)
105                         return 0;
106                 
107                 char *COUNT(len) _buf = user_mem_assert(e, buf, len, PTE_U);
108                 int total_sent = 0;
109                 int just_sent = 0;
110                 int cur_packet_len = 0;
111                 while (total_sent != len) {
112                         cur_packet_len = ((len - total_sent) > MAX_PACKET_DATA) ? MAX_PACKET_DATA : (len - total_sent);
113                         char* wrap_buffer = packet_wrap(_buf + total_sent, cur_packet_len);
114                         just_sent = send_frame(wrap_buffer, cur_packet_len + PACKET_HEADER_SIZE);
115                         
116                         if (just_sent < 0)
117                                 return 0; // This should be an error code of its own
118                                 
119                         if (wrap_buffer)
120                                 kfree(wrap_buffer);
121                                 
122                         total_sent += cur_packet_len;
123                 }
124                 
125                 return (ssize_t)len;
126                 
127         }
128         else
129                 return -EINVAL;
130 }
131
132 // This is not a syscall we want. Its hacky. Here just for syscall stuff until get a stack.
133 static ssize_t sys_eth_read(env_t* e, char *DANGEROUS buf, size_t len) 
134 {
135         extern int eth_up;
136
137         if (eth_up) {
138                 extern int packet_waiting;
139                 extern int packet_buffer_size;
140                 extern char*CT(packet_buffer_size) packet_buffer;
141                 extern char*CT(MAX_FRAME_SIZE) packet_buffer_orig;
142                 extern int packet_buffer_pos;
143
144                 if (len == 0)
145                         return 0;
146
147                 char *CT(len) _buf = user_mem_assert(e, buf,len, PTE_U);
148                         
149                 if (packet_waiting == 0)
150                         return 0;
151                         
152                 int read_len = ((packet_buffer_pos + len) > packet_buffer_size) ? packet_buffer_size - packet_buffer_pos : len;
153
154                 memcpy(_buf, packet_buffer + packet_buffer_pos, read_len);
155         
156                 packet_buffer_pos = packet_buffer_pos + read_len;
157         
158                 if (packet_buffer_pos == packet_buffer_size) {
159                         kfree(packet_buffer_orig);
160                         packet_waiting = 0;
161                 }
162         
163                 return read_len;
164         }
165         else
166                 return -EINVAL;
167 }
168 #endif // Network
169
170 //
171 /* END OF REMOTE SYSTEMCALL SUPPORT SYSCALLS. */
172 //
173
174 static ssize_t sys_shared_page_alloc(env_t* p1,
175                                      void**DANGEROUS _addr, envid_t p2_id,
176                                      int p1_flags, int p2_flags
177                                     )
178 {
179         //if (!VALID_USER_PERMS(p1_flags)) return -EPERM;
180         //if (!VALID_USER_PERMS(p2_flags)) return -EPERM;
181
182         void * COUNT(1) * COUNT(1) addr = user_mem_assert(p1, _addr, sizeof(void *), 
183                                                       PTE_USER_RW);
184         page_t* page;
185         env_t* p2 = &(envs[ENVX(p2_id)]);
186         error_t e = page_alloc(&page);
187
188         if(e < 0) return e;
189
190         void* p2_addr = page_insert_in_range(p2->env_pgdir, page,
191                                              (void*SNT)UTEXT, (void*SNT)UTOP, p2_flags);
192         if(p2_addr == NULL)
193                 return -EFAIL;
194
195         void* p1_addr = page_insert_in_range(p1->env_pgdir, page,
196                                             (void*SNT)UTEXT, (void*SNT)UTOP, p1_flags);
197         if(p1_addr == NULL) {
198                 page_remove(p2->env_pgdir, p2_addr);
199                 return -EFAIL;
200         }
201         *addr = p1_addr;
202         return ESUCCESS;
203 }
204
205 static void sys_shared_page_free(env_t* p1, void*DANGEROUS addr, envid_t p2)
206 {
207 }
208
209 // Invalidate the cache of this core.  Only useful if you want a cold cache for
210 // performance testing reasons.
211 static void sys_cache_invalidate(void)
212 {
213         #ifdef __i386__
214                 wbinvd();
215         #endif
216         return;
217 }
218
219 // Writes 'val' to 'num_writes' entries of the well-known array in the kernel
220 // address space.  It's just #defined to be some random 4MB chunk (which ought
221 // to be boot_alloced or something).  Meant to grab exclusive access to cache
222 // lines, to simulate doing something useful.
223 static void sys_cache_buster(env_t* e, uint32_t num_writes, uint32_t num_pages,
224                              uint32_t flags)
225 { TRUSTEDBLOCK /* zra: this is not really part of the kernel */
226         #define BUSTER_ADDR             0xd0000000  // around 512 MB deep
227         #define MAX_WRITES              1048576*8
228         #define MAX_PAGES               32
229         #define INSERT_ADDR     (UINFO + 2*PGSIZE) // should be free for these tests
230         uint32_t* buster = (uint32_t*)BUSTER_ADDR;
231         static uint32_t buster_lock = 0;
232         uint64_t ticks = -1;
233         page_t* a_page[MAX_PAGES];
234
235         /* Strided Accesses or Not (adjust to step by cachelines) */
236         uint32_t stride = 1;
237         if (flags & BUSTER_STRIDED) {
238                 stride = 16;
239                 num_writes *= 16;
240         }
241
242         /* Shared Accesses or Not (adjust to use per-core regions)
243          * Careful, since this gives 8MB to each core, starting around 512MB.
244          * Also, doesn't separate memory for core 0 if it's an async call.
245          */
246         if (!(flags & BUSTER_SHARED))
247                 buster = (uint32_t*)(BUSTER_ADDR + core_id() * 0x00800000);
248
249         /* Start the timer, if we're asked to print this info*/
250         if (flags & BUSTER_PRINT_TICKS)
251                 ticks = start_timing();
252
253         /* Allocate num_pages (up to MAX_PAGES), to simulate doing some more
254          * realistic work.  Note we don't write to these pages, even if we pick
255          * unshared.  Mostly due to the inconvenience of having to match up the
256          * number of pages with the number of writes.  And it's unnecessary.
257          */
258         if (num_pages) {
259                 spin_lock(&buster_lock);
260                 for (int i = 0; i < MIN(num_pages, MAX_PAGES); i++) {
261                         page_alloc(&a_page[i]);
262                         page_insert(e->env_pgdir, a_page[i], (void*)INSERT_ADDR + PGSIZE*i,
263                                     PTE_USER_RW);
264                 }
265                 spin_unlock(&buster_lock);
266         }
267
268         if (flags & BUSTER_LOCKED)
269                 spin_lock(&buster_lock);
270         for (int i = 0; i < MIN(num_writes, MAX_WRITES); i=i+stride)
271                 buster[i] = 0xdeadbeef;
272         if (flags & BUSTER_LOCKED)
273                 spin_unlock(&buster_lock);
274
275         if (num_pages) {
276                 spin_lock(&buster_lock);
277                 for (int i = 0; i < MIN(num_pages, MAX_PAGES); i++) {
278                         page_remove(e->env_pgdir, (void*)(INSERT_ADDR + PGSIZE * i));
279                         page_decref(a_page[i]);
280                 }
281                 spin_unlock(&buster_lock);
282         }
283
284         /* Print info */
285         if (flags & BUSTER_PRINT_TICKS) {
286                 ticks = stop_timing(ticks);
287                 printk("%llu,", ticks);
288         }
289         return;
290 }
291
292 // Print a string to the system console.
293 // The string is exactly 'len' characters long.
294 // Destroys the environment on memory errors.
295 static ssize_t sys_cputs(env_t* e, const char *DANGEROUS s, size_t len)
296 {
297         // Check that the user has permission to read memory [s, s+len).
298         // Destroy the environment if not.
299         pte_t* p = pgdir_walk(e->env_pgdir,s,0);
300         printk("%x %x\n",*p,PTE_USER_RO);
301         char *COUNT(len) _s = user_mem_assert(e, s, len, PTE_USER_RO);
302
303         // Print the string supplied by the user.
304         printk("%.*s", len, _s);
305         return (ssize_t)len;
306 }
307
308 // Read a character from the system console.
309 // Returns the character.
310 static uint16_t sys_cgetc(env_t* e)
311 {
312         uint16_t c;
313
314         // The cons_getc() primitive doesn't wait for a character,
315         // but the sys_cgetc() system call does.
316         while ((c = cons_getc()) == 0)
317                 cpu_relax();
318
319         return c;
320 }
321
322 // Returns the current environment's envid.
323 static envid_t sys_getenvid(env_t* e)
324 {
325         return e->env_id;
326 }
327
328 // Returns the id of the cpu this syscall is executed on.
329 static envid_t sys_getcpuid(void)
330 {
331         return core_id();
332 }
333
334 // TODO FIX Me!!!! for processes
335 // Destroy a given environment (possibly the currently running environment).
336 //
337 // Returns 0 on success, < 0 on error.  Errors are:
338 //      -EBADENV if environment envid doesn't currently exist,
339 //              or the caller doesn't have permission to change envid.
340 static error_t sys_env_destroy(env_t* e, envid_t envid)
341 {
342         int r;
343         env_t *env_to_die;
344
345         if ((r = envid2env(envid, &env_to_die, 1)) < 0)
346                 return r;
347         if (env_to_die == e)
348                 printk("[%08x] exiting gracefully\n", e->env_id);
349         else
350                 panic("Destroying other processes is not supported yet.");
351                 //printk("[%08x] destroying %08x\n", e->env_id, env_to_die->env_id);
352         proc_destroy(env_to_die);
353         return ESUCCESS;
354 }
355
356 /*
357  * Current process yields its remaining "time slice".  Currently works for
358  * single-core processes.
359  * TODO: think about how this works with async calls and multicored procs.
360  * Want it to only be callable locally.
361  */
362 static void sys_yield(struct proc *p)
363 {
364         // This is all standard single-core, local call
365         spin_lock_irqsave(&p->proc_lock);
366         assert(p->state == PROC_RUNNING_S);
367         proc_set_state(p, PROC_RUNNABLE_S);
368         schedule_proc(p);
369         spin_unlock_irqsave(&p->proc_lock);
370         // the implied thing here is that all state has been saved before leaving
371         // could do the "leaving the process context" here, mentioned in startcore
372         schedule();
373
374         /* TODO
375          * if running_s, give up your time slice (schedule, save silly state, block)
376          * if running_m and 2+ cores are left, give yours up, stay running_m
377          * if running_m and last core, switch to runnable_s
378          */
379 }
380
381 /*
382  * Creates a process found at the user string 'path'.  Currently uses KFS.
383  * Not runnable by default, so it needs it's status to be changed so that the
384  * next call to schedule() will try to run it.
385  * TODO: once we have a decent VFS, consider splitting this up
386  * and once there's an mmap, can have most of this in process.c
387  */
388 static int sys_proc_create(struct proc *p, const char *DANGEROUS path)
389 {
390         #define MAX_PATH_LEN 256 // totally arbitrary
391         int pid = 0;
392         char tpath[MAX_PATH_LEN];
393         /*
394          * There's a bunch of issues with reading in the path, which we'll
395          * need to sort properly in the VFS.  Main concerns are TOCTOU (copy-in),
396          * whether or not it's a big deal that the pointer could be into kernel
397          * space, and resolving both of these without knowing the length of the
398          * string. (TODO)
399          * Change this so that all syscalls with a pointer take a length.
400          *
401          * zra: I've added this user_mem_strlcpy, which I think eliminates the
402      * the TOCTOU issue. Adding a length arg to this call would allow a more
403          * efficient implementation, though, since only one call to user_mem_check
404          * would be required.
405          */
406         int ret = user_mem_strlcpy(p,tpath, path, MAX_PATH_LEN, PTE_USER_RO);
407         int kfs_inode = kfs_lookup_path(tpath);
408         if (kfs_inode < 0)
409                 return -EINVAL;
410         struct proc *new_p = kfs_proc_create(kfs_inode);
411         return new_p->env_id; // TODO replace this with a real proc_id
412 }
413
414 /* Makes process PID runnable.  Consider moving the functionality to env.c */
415 static error_t sys_proc_run(struct proc *p, unsigned pid)
416 {
417         struct proc *target = get_proc(pid);
418         error_t retval = 0;
419         spin_lock_irqsave(&p->proc_lock); // note we can get interrupted here. it's not bad.
420         // make sure we have access and it's in the right state to be activated
421         if (!proc_controls(p, target)) {
422                 retval = -EPERM;
423         } else if (target->state != PROC_CREATED) {
424                 retval = -EINVAL;
425         } else {
426                 proc_set_state(target, PROC_RUNNABLE_S);
427                 schedule_proc(target);
428         }
429         spin_unlock_irqsave(&p->proc_lock);
430         return retval;
431 }
432
433 // TODO: Build a dispatch table instead of switching on the syscallno
434 // Dispatches to the correct kernel function, passing the arguments.
435 intreg_t syscall(env_t* e, uintreg_t syscallno, uintreg_t a1, uintreg_t a2,
436                  uintreg_t a3, uintreg_t a4, uintreg_t a5)
437 {
438         // Call the function corresponding to the 'syscallno' parameter.
439         // Return any appropriate return value.
440
441         //cprintf("Incoming syscall number: %d\n    a1: %x\n   "
442         //        " a2: %x\n    a3: %x\n    a4: %x\n    a5: %x\n",
443         //        syscallno, a1, a2, a3, a4, a5);
444
445         // used if we need more args, like in mmap
446         int32_t _a4, _a5, _a6, *COUNT(3) args;
447
448         assert(e); // should always have an env for every syscall
449         //printk("Running syscall: %d\n", syscallno);
450         if (INVALID_SYSCALL(syscallno))
451                 return -EINVAL;
452
453         switch (syscallno) {
454                 case SYS_null:
455                         sys_null();
456                         return ESUCCESS;
457                 case SYS_cache_buster:
458                         sys_cache_buster(e, a1, a2, a3);
459                         return 0;
460                 case SYS_cache_invalidate:
461                         sys_cache_invalidate();
462                         return 0;
463                 case SYS_shared_page_alloc:
464                         return sys_shared_page_alloc(e, (void** DANGEROUS) a1,
465                                                  a2, (int) a3, (int) a4);
466                 case SYS_shared_page_free:
467                         sys_shared_page_free(e, (void* DANGEROUS) a1, a2);
468                     return ESUCCESS;
469                 case SYS_cputs:
470                         return sys_cputs(e, (char *DANGEROUS)a1, (size_t)a2);
471                 case SYS_cgetc:
472                         return sys_cgetc(e);
473                 case SYS_getcpuid:
474                         return sys_getcpuid();
475                 case SYS_getpid:
476                         return sys_getenvid(e);
477                 case SYS_proc_destroy:
478                         return sys_env_destroy(e, (envid_t)a1);
479                 case SYS_yield:
480                         sys_yield(e);
481                         return ESUCCESS;
482                 case SYS_proc_create:
483                         return sys_proc_create(e, (char *DANGEROUS)a1);
484                 case SYS_proc_run:
485                         return sys_proc_run(e, (size_t)a1);
486                 case SYS_mmap:
487                         // we only have 4 parameters from sysenter currently, need to copy
488                         // in the others.  if we stick with this, we can make a func for it.
489                 args = user_mem_assert(e, (void*DANGEROUS)a4,
490                                                3*sizeof(_a4), PTE_USER_RW);
491                         _a4 = args[0];
492                         _a5 = args[1];
493                         _a6 = args[2];
494                         return (intreg_t) mmap(e, a1, a2, a3, _a4, _a5, _a6);
495                 case SYS_brk:
496                         printk("brk not implemented yet\n");
497                         return -EINVAL;
498
499         #ifdef __i386__
500                 case SYS_serial_write:
501                         return sys_serial_write(e, (char *DANGEROUS)a1, (size_t)a2);
502                 case SYS_serial_read:
503                         return sys_serial_read(e, (char *DANGEROUS)a1, (size_t)a2);
504                 case SYS_run_binary:
505                         return sys_run_binary(e, (char *DANGEROUS)a1,
506                                               (char* DANGEROUS)a2, (size_t)a3);
507         #endif
508         #ifdef __NETWORK__
509                 case SYS_eth_write:
510                         return sys_eth_write(e, (char *DANGEROUS)a1, (size_t)a2);
511                 case SYS_eth_read:
512                         return sys_eth_read(e, (char *DANGEROUS)a1, (size_t)a2);
513         #endif
514         #ifdef __sparc_v8__
515                 case SYS_frontend:
516                         return frontend_syscall(a1,a2,a3,a4);
517         #endif
518
519                 default:
520                         // or just return -EINVAL
521                         panic("Invalid syscall number %d for env %x!", syscallno, *e);
522         }
523         return 0xdeadbeef;
524 }
525
526 intreg_t syscall_async(env_t* e, syscall_req_t *call)
527 {
528         return syscall(e, call->num, call->args[0], call->args[1],
529                        call->args[2], call->args[3], call->args[4]);
530 }
531
532 intreg_t process_generic_syscalls(env_t* e, size_t max)
533 {
534         size_t count = 0;
535         syscall_back_ring_t* sysbr = &e->syscallbackring;
536
537         // make sure the env is still alive.
538         // incref will return ESUCCESS on success.
539         if (proc_incref(e))
540                 return -EFAIL;
541
542         // max is the most we'll process.  max = 0 means do as many as possible
543         while (RING_HAS_UNCONSUMED_REQUESTS(sysbr) && ((!max)||(count < max)) ) {
544                 if (!count) {
545                         // ASSUME: one queue per process
546                         // only switch cr3 for the very first request for this queue
547                         // need to switch to the right context, so we can handle the user pointer
548                         // that points to a data payload of the syscall
549                         lcr3(e->env_cr3);
550                 }
551                 count++;
552                 //printk("DEBUG PRE: sring->req_prod: %d, sring->rsp_prod: %d\n",
553                 //         sysbr->sring->req_prod, sysbr->sring->rsp_prod);
554                 // might want to think about 0-ing this out, if we aren't
555                 // going to explicitly fill in all fields
556                 syscall_rsp_t rsp;
557                 // this assumes we get our answer immediately for the syscall.
558                 syscall_req_t* req = RING_GET_REQUEST(sysbr, ++(sysbr->req_cons));
559                 rsp.retval = syscall_async(e, req);
560                 // write response into the slot it came from
561                 memcpy(req, &rsp, sizeof(syscall_rsp_t));
562                 // update our counter for what we've produced (assumes we went in order!)
563                 (sysbr->rsp_prod_pvt)++;
564                 RING_PUSH_RESPONSES(sysbr);
565                 //printk("DEBUG POST: sring->req_prod: %d, sring->rsp_prod: %d\n",
566                 //         sysbr->sring->req_prod, sysbr->sring->rsp_prod);
567         }
568         // load sane page tables (and don't rely on decref to do it for you).
569         lcr3(boot_cr3);
570         proc_decref(e);
571         return (intreg_t)count;
572 }