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