strace: Coalesce a common case statement
[akaros.git] / kern / src / syscall.c
1 /* See COPYRIGHT for copyright information. */
2
3 //#define DEBUG
4 #include <ros/common.h>
5 #include <ros/limits.h>
6 #include <arch/types.h>
7 #include <arch/arch.h>
8 #include <arch/mmu.h>
9 #include <arch/console.h>
10 #include <time.h>
11 #include <error.h>
12
13 #include <elf.h>
14 #include <string.h>
15 #include <assert.h>
16 #include <process.h>
17 #include <schedule.h>
18 #include <pmap.h>
19 #include <umem.h>
20 #include <mm.h>
21 #include <trap.h>
22 #include <syscall.h>
23 #include <kmalloc.h>
24 #include <profiler.h>
25 #include <stdio.h>
26 #include <hashtable.h>
27 #include <bitmask.h>
28 #include <smp.h>
29 #include <arsc_server.h>
30 #include <event.h>
31 #include <kprof.h>
32 #include <termios.h>
33 #include <manager.h>
34 #include <ros/procinfo.h>
35 #include <rcu.h>
36
37 static int execargs_stringer(struct proc *p, char *d, size_t slen,
38                              char *path, size_t path_l,
39                              char *argenv, size_t argenv_l);
40
41 /* Global, used by the kernel monitor for syscall debugging. */
42 bool systrace_loud = FALSE;
43
44 /* Helper, given the trace record, pretty-print the trace's contents into the
45  * trace's pretty buf.  'entry' says whether we're an entry record or not
46  * (exit).  Returns the number of bytes put into the pretty_buf. */
47 static size_t systrace_fill_pretty_buf(struct systrace_record *trace,
48                                        bool entry)
49 {
50         size_t len = 0;
51         struct timespec ts_start = tsc2timespec(trace->start_timestamp);
52         struct timespec ts_end = tsc2timespec(trace->end_timestamp);
53
54         /* Slightly different formats between entry and exit.  Entry has retval set
55          * to ---, and begins with E.  Exit begins with X. */
56         if (entry) {
57                 len = snprintf(trace->pretty_buf, SYSTR_PRETTY_BUF_SZ - len,
58                       "E [%7d.%09d]-[%7d.%09d] Syscall %3d (%12s):(0x%llx, 0x%llx, "
59                       "0x%llx, 0x%llx, 0x%llx, 0x%llx) ret: --- proc: %d core: %2d "
60                       "vcore: %2d errno: --- data: ",
61                                ts_start.tv_sec,
62                                ts_start.tv_nsec,
63                                ts_end.tv_sec,
64                                ts_end.tv_nsec,
65                                trace->syscallno,
66                                syscall_table[trace->syscallno].name,
67                                trace->arg0,
68                                trace->arg1,
69                                trace->arg2,
70                                trace->arg3,
71                                trace->arg4,
72                                trace->arg5,
73                                trace->pid,
74                                trace->coreid,
75                                trace->vcoreid);
76         } else {
77                 len = snprintf(trace->pretty_buf, SYSTR_PRETTY_BUF_SZ - len,
78                       "X [%7d.%09d]-[%7d.%09d] Syscall %3d (%12s):(0x%llx, 0x%llx, "
79                       "0x%llx, 0x%llx, 0x%llx, 0x%llx) ret: 0x%llx proc: %d core: %2d "
80                       "vcore: -- errno: %3d data: ",
81                                ts_start.tv_sec,
82                                ts_start.tv_nsec,
83                                ts_end.tv_sec,
84                                ts_end.tv_nsec,
85                                trace->syscallno,
86                                syscall_table[trace->syscallno].name,
87                                trace->arg0,
88                                trace->arg1,
89                                trace->arg2,
90                                trace->arg3,
91                                trace->arg4,
92                                trace->arg5,
93                                trace->retval,
94                                trace->pid,
95                                trace->coreid,
96                                trace->errno);
97         }
98         len += printdump(trace->pretty_buf + len, trace->datalen,
99                          SYSTR_PRETTY_BUF_SZ - len - 1,
100                          trace->data);
101         len += snprintf(trace->pretty_buf + len, SYSTR_PRETTY_BUF_SZ - len, "\n");
102         return len;
103 }
104
105 /* If some syscalls block, then they can really hurt the user and the
106  * kernel.  For instance, if you blocked another call because the trace queue is
107  * full, the 2LS will want to yield the vcore, but then *that* call would block
108  * too.  Since that caller was in vcore context, the core will just spin
109  * forever.
110  *
111  * Even worse, some syscalls operate on the calling core or current context,
112  * thus accessing pcpui.  If we block, then that old context is gone.  Worse, we
113  * could migrate and then be operating on a different core.  Imagine
114  * SYS_halt_core.  Doh! */
115 static bool sysc_can_block(unsigned int sysc_num)
116 {
117         switch (sysc_num) {
118         case SYS_proc_yield:
119         case SYS_fork:
120         case SYS_exec:
121         case SYS_pop_ctx:
122         case SYS_getvcoreid:
123         case SYS_halt_core:
124         case SYS_vc_entry:
125         case SYS_change_vcore:
126         case SYS_change_to_m:
127                 return FALSE;
128         }
129         return TRUE;
130 }
131
132 /* Helper: spits out our trace to the various sinks. */
133 static void systrace_output(struct systrace_record *trace,
134                             struct strace *strace, bool entry)
135 {
136         ERRSTACK(1);
137         size_t pretty_len;
138
139         /* qio ops can throw, especially the blocking qwrite.  I had it block on the
140          * outbound path of sys_proc_destroy().  The rendez immediately throws. */
141         if (waserror()) {
142                 poperror();
143                 return;
144         }
145         pretty_len = systrace_fill_pretty_buf(trace, entry);
146         if (strace) {
147                 /* At this point, we're going to emit the exit trace.  It's just a
148                  * question of whether or not we block while doing it. */
149                 if (strace->drop_overflow || !sysc_can_block(trace->syscallno))
150                         qiwrite(strace->q, trace->pretty_buf, pretty_len);
151                 else
152                         qwrite(strace->q, trace->pretty_buf, pretty_len);
153         }
154         if (systrace_loud)
155                 printk("%s", trace->pretty_buf);
156         poperror();
157 }
158
159 static bool should_strace(struct proc *p, struct syscall *sysc)
160 {
161         unsigned int sysc_num;
162
163         if (systrace_loud)
164                 return TRUE;
165         if (!p->strace || !p->strace->tracing)
166                 return FALSE;
167         /* TOCTTOU concerns - sysc is __user. */
168         sysc_num = ACCESS_ONCE(sysc->num);
169         if (qfull(p->strace->q)) {
170                 if (p->strace->drop_overflow || !sysc_can_block(sysc_num)) {
171                         atomic_inc(&p->strace->nr_drops);
172                         return FALSE;
173                 }
174         }
175         if (sysc_num > MAX_SYSCALL_NR)
176                 return FALSE;
177         return test_bit(sysc_num, p->strace->trace_set);
178 }
179
180 /* Helper, copies len bytes from u_data to the trace->data, if there's room. */
181 static void copy_tracedata_from_user(struct systrace_record *trace,
182                                      long u_data, size_t len)
183 {
184         size_t copy_amt;
185
186         copy_amt = MIN(sizeof(trace->data) - trace->datalen, len);
187         copy_from_user(trace->data + trace->datalen, (void*)u_data, copy_amt);
188         trace->datalen += copy_amt;
189 }
190
191 /* Helper, snprintfs to the trace, if there's room. */
192 static void snprintf_to_trace(struct systrace_record *trace, const char *fmt,
193                               ...)
194 {
195         va_list ap;
196         int rc;
197
198         va_start(ap, fmt);
199         rc = vsnprintf((char*)trace->data + trace->datalen,
200                        sizeof(trace->data) - trace->datalen, fmt, ap);
201         va_end(ap);
202         if (!snprintf_error(rc, sizeof(trace->data) - trace->datalen))
203                 trace->datalen += rc;
204 }
205
206 static bool trace_data_full(struct systrace_record *trace)
207 {
208         return trace->datalen == sizeof(trace->data);
209 }
210
211 static bool systrace_has_error(struct systrace_record *trace)
212 {
213         return syscall_retval_is_error(trace->syscallno, trace->retval);
214 }
215
216 /* Starts a trace for p running sysc, attaching it to kthread.  Pairs with
217  * systrace_finish_trace(). */
218 static void systrace_start_trace(struct kthread *kthread, struct syscall *sysc)
219 {
220         struct proc *p = current;
221         struct systrace_record *trace;
222
223         kthread->strace = 0;
224         if (!should_strace(p, sysc))
225                 return;
226         /* TODO: consider a block_alloc and qpass, though note that we actually
227          * write the same trace in twice (entry and exit). */
228         trace = kpages_alloc(SYSTR_BUF_SZ, MEM_ATOMIC);
229         if (p->strace) {
230                 if (!trace) {
231                         atomic_inc(&p->strace->nr_drops);
232                         return;
233                 }
234                 /* Avoiding the atomic op.  We sacrifice accuracy for less overhead. */
235                 p->strace->appx_nr_sysc++;
236         } else {
237                 if (!trace)
238                         return;
239         }
240         /* if you ever need to debug just one strace function, this is
241          * handy way to do it: just bail out if it's not the one you
242          * want.
243          * if (sysc->num != SYS_exec)
244          * return; */
245         trace->start_timestamp = read_tsc();
246         trace->end_timestamp = 0;
247         trace->syscallno = sysc->num;
248         trace->arg0 = sysc->arg0;
249         trace->arg1 = sysc->arg1;
250         trace->arg2 = sysc->arg2;
251         trace->arg3 = sysc->arg3;
252         trace->arg4 = sysc->arg4;
253         trace->arg5 = sysc->arg5;
254         trace->retval = 0;
255         trace->pid = p->pid;
256         trace->coreid = core_id();
257         trace->vcoreid = proc_get_vcoreid(p);
258         trace->pretty_buf = (char*)trace + sizeof(struct systrace_record);
259         trace->datalen = 0;
260         trace->data[0] = 0;
261
262         switch (sysc->num) {
263         case SYS_write:
264         case SYS_openat:
265         case SYS_chdir:
266         case SYS_nmount:
267                 copy_tracedata_from_user(trace, sysc->arg1, sysc->arg2);
268                 break;
269         case SYS_stat:
270         case SYS_lstat:
271         case SYS_access:
272         case SYS_unlink:
273         case SYS_mkdir:
274         case SYS_rmdir:
275         case SYS_wstat:
276                 copy_tracedata_from_user(trace, sysc->arg0, sysc->arg1);
277                 break;
278         case SYS_link:
279         case SYS_symlink:
280         case SYS_rename:
281         case SYS_nbind:
282                 copy_tracedata_from_user(trace, sysc->arg0, sysc->arg1);
283                 snprintf_to_trace(trace, " -> ");
284                 copy_tracedata_from_user(trace, sysc->arg2, sysc->arg3);
285                 break;
286         case SYS_nunmount:
287                 copy_tracedata_from_user(trace, sysc->arg2, sysc->arg3);
288                 break;
289         case SYS_exec:
290                 trace->datalen = execargs_stringer(current,
291                                                    (char *)trace->data,
292                                                    sizeof(trace->data),
293                                                    (char *)sysc->arg0,
294                                                    sysc->arg1,
295                                                    (char *)sysc->arg2,
296                                                    sysc->arg3);
297                 break;
298         case SYS_proc_create:
299                 trace->datalen = execargs_stringer(current,
300                                                    (char *)trace->data,
301                                                    sizeof(trace->data),
302                                                    (char *)sysc->arg0,
303                                                    sysc->arg1,
304                                                    (char *)sysc->arg2,
305                                                    sysc->arg3);
306                 break;
307         case SYS_tap_fds:
308                 for (size_t i = 0; i < (size_t)sysc->arg1; i++) {
309                         struct fd_tap_req *tap_reqs = (struct fd_tap_req*)sysc->arg0;
310                         int fd, cmd, filter;
311
312                         tap_reqs += i;
313                         copy_from_user(&fd, &tap_reqs->fd, sizeof(fd));
314                         copy_from_user(&cmd, &tap_reqs->cmd, sizeof(cmd));
315                         copy_from_user(&filter, &tap_reqs->filter, sizeof(filter));
316                         snprintf_to_trace(trace, "%d (%d 0x%x), ", fd, cmd, filter);
317                         if (trace_data_full(trace))
318                                 break;
319                 }
320                 break;
321         }
322         systrace_output(trace, p->strace, TRUE);
323
324         kthread->strace = trace;
325 }
326
327 /* Finishes the trace on kthread for p, with retval being the return from the
328  * syscall we're tracing.  Pairs with systrace_start_trace(). */
329 static void systrace_finish_trace(struct kthread *kthread, long retval)
330 {
331         struct proc *p = current;
332         struct systrace_record *trace;
333
334         if (!kthread->strace)
335                 return;
336         trace = kthread->strace;
337         trace->end_timestamp = read_tsc();
338         trace->retval = retval;
339         trace->coreid = core_id();
340         /* Can't trust the vcoreid of an exit record.  This'll be ignored later. */
341         trace->vcoreid = -1;
342         trace->errno = get_errno();
343         trace->datalen = 0;
344
345         /* Only try to do the trace data if we didn't do it on entry */
346         if (systrace_has_error(trace)) {
347                 snprintf_to_trace(trace, "errstr: %s", current_errstr());
348         } else {
349                 switch (trace->syscallno) {
350                 case SYS_read:
351                         if (retval <= 0)
352                                 break;
353                         copy_tracedata_from_user(trace, trace->arg1, retval);
354                         break;
355                 case SYS_getcwd:
356                         if (retval < 0)
357                                 break;
358                         copy_tracedata_from_user(trace, trace->arg0, retval);
359                         break;
360                 case SYS_readlink:
361                         if (retval <= 0)
362                                 break;
363                         copy_tracedata_from_user(trace, trace->arg0, trace->arg1);
364                         snprintf_to_trace(trace, " -> ");
365                         copy_tracedata_from_user(trace, trace->arg2, retval);
366                         break;
367                 }
368         }
369
370         systrace_output(trace, p->strace, FALSE);
371         kpages_free(kthread->strace, SYSTR_BUF_SZ);
372         kthread->strace = 0;
373 }
374
375 #ifdef CONFIG_SYSCALL_STRING_SAVING
376
377 static void alloc_sysc_str(struct kthread *kth)
378 {
379         kth->name = kmalloc(SYSCALL_STRLEN, MEM_ATOMIC);
380         if (!kth->name)
381                 return;
382         kth->name[0] = 0;
383 }
384
385 static void free_sysc_str(struct kthread *kth)
386 {
387         char *str = kth->name;
388
389         kth->name = 0;
390         kfree(str);
391 }
392
393 #define sysc_save_str(...)                                                     \
394 {                                                                              \
395         struct per_cpu_info *pcpui = this_pcpui_ptr();                             \
396                                                                                \
397         if (pcpui->cur_kthread->name)                                              \
398                 snprintf(pcpui->cur_kthread->name, SYSCALL_STRLEN, __VA_ARGS__);       \
399 }
400
401 #else
402
403 static void alloc_sysc_str(struct kthread *kth)
404 {
405 }
406
407 static void free_sysc_str(struct kthread *kth)
408 {
409 }
410
411 #define sysc_save_str(...)
412
413 #endif /* CONFIG_SYSCALL_STRING_SAVING */
414
415 /* Helper to finish a syscall, signalling if appropriate */
416 static void finish_sysc(struct syscall *sysc, struct proc *p, long retval)
417 {
418         sysc->retval = retval;
419         /* Atomically turn on the LOCK and SC_DONE flag.  The lock tells userspace
420          * we're messing with the flags and to not proceed.  We use it instead of
421          * CASing with userspace.  We need the atomics since we're racing with
422          * userspace for the event_queue registration.  The 'lock' tells userspace
423          * to not muck with the flags while we're signalling. */
424         atomic_or(&sysc->flags, SC_K_LOCK | SC_DONE);
425         __signal_syscall(sysc, p);
426         atomic_and(&sysc->flags, ~SC_K_LOCK);
427 }
428
429 /* Helper that "finishes" the current async syscall.  This should be used with
430  * care when we are not using the normal syscall completion path.
431  *
432  * Do *NOT* complete the same syscall twice.  This is catastrophic for _Ms, and
433  * a bad idea for _S.
434  *
435  * It is possible for another user thread to see the syscall being done early -
436  * they just need to be careful with the weird proc management calls (as in,
437  * don't trust an async fork).
438  *
439  * *sysc is in user memory, and should be pinned (TODO: UMEM).  There may be
440  * issues with unpinning this if we never return. */
441 static void finish_current_sysc(long retval)
442 {
443         /* Need to re-load pcpui, in case we migrated */
444         struct per_cpu_info *pcpui = this_pcpui_ptr();
445         struct syscall *sysc = pcpui->cur_kthread->sysc;
446
447         assert(sysc);
448         /* Some 9ns paths set errstr, but not errno.  glibc will ignore errstr.
449          * this is somewhat hacky, since errno might get set unnecessarily */
450         if ((current_errstr()[0] != 0) && !get_errno())
451                 set_errno(EUNSPECIFIED);
452         sysc->err = pcpui->cur_kthread->errno;
453         strncpy(sysc->errstr, pcpui->cur_kthread->errstr, MAX_ERRSTR_LEN);
454         free_sysc_str(pcpui->cur_kthread);
455         systrace_finish_trace(pcpui->cur_kthread, retval);
456         pcpui = this_pcpui_ptr();       /* reload again */
457         finish_sysc(pcpui->cur_kthread->sysc, pcpui->cur_proc, retval);
458         pcpui->cur_kthread->sysc = NULL;
459 }
460
461 /* Callable by any function while executing a syscall (or otherwise, actually).
462  */
463 void set_errno(int errno)
464 {
465         struct per_cpu_info *pcpui = this_pcpui_ptr();
466
467         if (pcpui->cur_kthread)
468                 pcpui->cur_kthread->errno = errno;
469 }
470
471 /* Callable by any function while executing a syscall (or otherwise, actually).
472  */
473 int get_errno(void)
474 {
475         struct per_cpu_info *pcpui = this_pcpui_ptr();
476
477         if (pcpui->cur_kthread)
478                 return pcpui->cur_kthread->errno;
479         /* if there's no errno to get, that's not an error I guess. */
480         return 0;
481 }
482
483 void unset_errno(void)
484 {
485         struct per_cpu_info *pcpui = this_pcpui_ptr();
486
487         if (!pcpui->cur_kthread)
488                 return;
489         pcpui->cur_kthread->errno = 0;
490         pcpui->cur_kthread->errstr[0] = '\0';
491 }
492
493 void vset_errstr(const char *fmt, va_list ap)
494 {
495         struct per_cpu_info *pcpui = this_pcpui_ptr();
496
497         if (!pcpui->cur_kthread)
498                 return;
499
500         vsnprintf(pcpui->cur_kthread->errstr, MAX_ERRSTR_LEN, fmt, ap);
501
502         /* TODO: likely not needed */
503         pcpui->cur_kthread->errstr[MAX_ERRSTR_LEN - 1] = '\0';
504 }
505
506 void set_errstr(const char *fmt, ...)
507 {
508         va_list ap;
509
510         assert(fmt);
511         va_start(ap, fmt);
512         vset_errstr(fmt, ap);
513         va_end(ap);
514 }
515
516 char *current_errstr(void)
517 {
518         struct per_cpu_info *pcpui = this_pcpui_ptr();
519
520         if (!pcpui->cur_kthread)
521                 return "no errstr";
522         return pcpui->cur_kthread->errstr;
523 }
524
525 void set_error(int error, const char *fmt, ...)
526 {
527         va_list ap;
528
529         set_errno(error);
530
531         assert(fmt);
532         va_start(ap, fmt);
533         vset_errstr(fmt, ap);
534         va_end(ap);
535 }
536
537 struct errbuf *get_cur_errbuf(void)
538 {
539         return this_pcpui_var(cur_kthread)->errbuf;
540 }
541
542 void set_cur_errbuf(struct errbuf *ebuf)
543 {
544         this_pcpui_var(cur_kthread)->errbuf = ebuf;
545 }
546
547 char *get_cur_genbuf(void)
548 {
549         struct per_cpu_info *pcpui = this_pcpui_ptr();
550
551         assert(pcpui->cur_kthread);
552         return pcpui->cur_kthread->generic_buf;
553 }
554
555 /* Helper, looks up proc* for pid and ensures p controls that proc. 0 o/w */
556 static struct proc *get_controllable_proc(struct proc *p, pid_t pid)
557 {
558         struct proc *target = pid2proc(pid);
559         if (!target) {
560                 set_errno(ESRCH);
561                 return 0;
562         }
563         if (!proc_controls(p, target)) {
564                 set_errno(EPERM);
565                 proc_decref(target);
566                 return 0;
567         }
568         return target;
569 }
570
571 static int unpack_argenv(struct argenv *argenv, size_t argenv_l,
572                          int *argc_p, char ***argv_p,
573                          int *envc_p, char ***envp_p)
574 {
575         int argc = argenv->argc;
576         int envc = argenv->envc;
577         char **argv = (char**)argenv->buf;
578         char **envp = argv + argc;
579         char *argbuf = (char*)(envp + envc);
580         uintptr_t argbuf_offset = (uintptr_t)(argbuf - (char*)(argenv));
581
582         if (((char*)argv - (char*)argenv) > argenv_l)
583                 return -1;
584         if (((char*)argv + (argc * sizeof(char**)) - (char*)argenv) > argenv_l)
585                 return -1;
586         if (((char*)envp - (char*)argenv) > argenv_l)
587                 return -1;
588         if (((char*)envp + (envc * sizeof(char**)) - (char*)argenv) > argenv_l)
589                 return -1;
590         if (((char*)argbuf - (char*)argenv) > argenv_l)
591                 return -1;
592         for (int i = 0; i < argc; i++) {
593                 if ((uintptr_t)(argv[i] + argbuf_offset) > argenv_l)
594                         return -1;
595                 argv[i] += (uintptr_t)argbuf;
596         }
597         for (int i = 0; i < envc; i++) {
598                 if ((uintptr_t)(envp[i] + argbuf_offset) > argenv_l)
599                         return -1;
600                 envp[i] += (uintptr_t)argbuf;
601         }
602         *argc_p = argc;
603         *argv_p = argv;
604         *envc_p = envc;
605         *envp_p = envp;
606         return 0;
607 }
608
609 /************** Utility Syscalls **************/
610
611 static int sys_null(void)
612 {
613         return 0;
614 }
615
616 /* Diagnostic function: blocks the kthread/syscall, to help userspace test its
617  * async I/O handling. */
618 static int sys_block(struct proc *p, unsigned long usec)
619 {
620         sysc_save_str("block for %lu usec", usec);
621         kthread_usleep(usec);
622         return 0;
623 }
624
625 /* Pause execution for a number of nanoseconds.
626  * The current implementation rounds up to the nearest microsecond. If the
627  * syscall is aborted, we return the remaining time the call would have ran
628  * in the 'rem' parameter.  */
629 static int sys_nanosleep(struct proc *p,
630                          const struct timespec *req,
631                          struct timespec *rem)
632 {
633         ERRSTACK(1);
634         uint64_t usec;
635         struct timespec kreq, krem = {0, 0};
636         uint64_t tsc = read_tsc();
637
638         /* Check the input arguments. */
639         if (memcpy_from_user(p, &kreq, req, sizeof(struct timespec))) {
640                 set_errno(EFAULT);
641                 return -1;
642         }
643         if (rem && memcpy_to_user(p, rem, &krem, sizeof(struct timespec))) {
644                 set_errno(EFAULT);
645                 return -1;
646         }
647         if (kreq.tv_sec < 0) {
648                 set_errno(EINVAL);
649                 return -1;
650         }
651         if ((kreq.tv_nsec < 0) || (kreq.tv_nsec > 999999999)) {
652                 set_errno(EINVAL);
653                 return -1;
654         }
655
656         /* Convert timespec to usec. Ignore overflow on the tv_sec field. */
657         usec = kreq.tv_sec * 1000000;
658         usec += DIV_ROUND_UP(kreq.tv_nsec, 1000);
659
660         /* Attempt to sleep. If we get aborted, copy the remaining time into
661          * 'rem' and return. We assume the tsc is sufficient to tell how much
662          * time is remaining (i.e. it only overflows on the order of hundreds of
663          * years, which should be sufficiently long enough to ensure we don't
664          * overflow). */
665         if (waserror()) {
666                 krem = tsc2timespec(read_tsc() - tsc);
667                 if (rem && memcpy_to_user(p, rem, &krem, sizeof(struct timespec)))
668                         set_errno(EFAULT);
669                 poperror();
670                 return -1;
671         }
672         sysc_save_str("nanosleep for %lu usec", usec);
673         kthread_usleep(usec);
674         poperror();
675         return 0;
676 }
677
678 static int sys_cache_invalidate(void)
679 {
680         #ifdef CONFIG_X86
681                 wbinvd();
682         #endif
683         return 0;
684 }
685
686 /* sys_reboot(): called directly from dispatch table. */
687
688 /* Returns the id of the physical core this syscall is executed on. */
689 static uint32_t sys_getpcoreid(void)
690 {
691         return core_id();
692 }
693
694 // TODO: Temporary hack until thread-local storage is implemented on i386 and
695 // this is removed from the user interface
696 static size_t sys_getvcoreid(struct proc *p)
697 {
698         return proc_get_vcoreid(p);
699 }
700
701 /************** Process management syscalls **************/
702
703 /* Helper for proc_create and fork */
704 static void inherit_strace(struct proc *parent, struct proc *child)
705 {
706         if (parent->strace && parent->strace->inherit) {
707                 /* Refcnt on both, put in the child's ->strace. */
708                 kref_get(&parent->strace->users, 1);
709                 kref_get(&parent->strace->procs, 1);
710                 child->strace = parent->strace;
711         }
712 }
713
714 /* Creates a process from the file 'path'.  The process is not runnable by
715  * default, so it needs it's status to be changed so that the next call to
716  * schedule() will try to run it. */
717 static int sys_proc_create(struct proc *p, char *path, size_t path_l,
718                            char *argenv, size_t argenv_l, int flags)
719 {
720         int pid = 0;
721         char *t_path;
722         struct file_or_chan *program;
723         struct proc *new_p;
724         int argc, envc;
725         char **argv, **envp;
726         struct argenv *kargenv;
727
728         t_path = copy_in_path(p, path, path_l);
729         if (!t_path)
730                 return -1;
731         program = foc_open(t_path, O_EXEC | O_READ, 0);
732         if (!program)
733                 goto error_with_path;
734         if (!is_valid_elf(program)) {
735                 set_errno(ENOEXEC);
736                 goto error_with_file;
737         }
738         /* Check the size of the argenv array, error out if too large. */
739         if ((argenv_l < sizeof(struct argenv)) || (argenv_l > ARG_MAX)) {
740                 set_error(EINVAL, "The argenv array has an invalid size: %lu\n",
741                                   argenv_l);
742                 goto error_with_file;
743         }
744         /* Copy the argenv array into a kernel buffer. Delay processing of the
745          * array to load_elf(). */
746         kargenv = user_memdup_errno(p, argenv, argenv_l);
747         if (!kargenv) {
748                 set_error(EINVAL, "Failed to copy in the args");
749                 goto error_with_file;
750         }
751         /* Unpack the argenv array into more usable variables. Integrity checking
752          * done along side this as well. */
753         if (unpack_argenv(kargenv, argenv_l, &argc, &argv, &envc, &envp)) {
754                 set_error(EINVAL, "Failed to unpack the args");
755                 goto error_with_kargenv;
756         }
757         /* TODO: need to split the proc creation, since you must load after setting
758          * args/env, since auxp gets set up there. */
759         //new_p = proc_create(program, 0, 0);
760         if (proc_alloc(&new_p, current, flags)) {
761                 set_error(ENOMEM, "Failed to alloc new proc");
762                 goto error_with_kargenv;
763         }
764         inherit_strace(p, new_p);
765         /* close the CLOEXEC ones, even though this isn't really an exec */
766         close_fdt(&new_p->open_files, TRUE);
767         /* Load the elf. */
768         if (load_elf(new_p, program, argc, argv, envc, envp)) {
769                 set_error(EINVAL, "Failed to load elf");
770                 goto error_with_proc;
771         }
772         /* progname is argv0, which accounts for symlinks */
773         proc_set_progname(new_p, argc ? argv[0] : NULL);
774         proc_replace_binary_path(new_p, t_path);
775         foc_decref(program);
776         user_memdup_free(p, kargenv);
777         __proc_ready(new_p);
778         pid = new_p->pid;
779         profiler_notify_new_process(new_p);
780         proc_decref(new_p);     /* give up the reference created in proc_create() */
781         return pid;
782 error_with_proc:
783         /* proc_destroy will decref once, which is for the ref created in
784          * proc_create().  We don't decref again (the usual "+1 for existing"),
785          * since the scheduler, which usually handles that, hasn't heard about the
786          * process (via __proc_ready()). */
787         proc_destroy(new_p);
788 error_with_kargenv:
789         user_memdup_free(p, kargenv);
790 error_with_file:
791         foc_decref(program);
792 error_with_path:
793         free_path(p, t_path);
794         return -1;
795 }
796
797 /* Makes process PID runnable.  Consider moving the functionality to process.c */
798 static error_t sys_proc_run(struct proc *p, unsigned pid)
799 {
800         error_t retval = 0;
801         struct proc *target = get_controllable_proc(p, pid);
802         if (!target)
803                 return -1;
804         if (target->state != PROC_CREATED) {
805                 set_errno(EINVAL);
806                 proc_decref(target);
807                 return -1;
808         }
809         /* Note a proc can spam this for someone it controls.  Seems safe - if it
810          * isn't we can change it. */
811         proc_wakeup(target);
812         proc_decref(target);
813         return 0;
814 }
815
816 /* Destroy proc pid.  If this is called by the dying process, it will never
817  * return.  o/w it will return 0 on success, or an error.  Errors include:
818  * - ESRCH: if there is no such process with pid
819  * - EPERM: if caller does not control pid */
820 static error_t sys_proc_destroy(struct proc *p, pid_t pid, int exitcode)
821 {
822         error_t r;
823         struct proc *p_to_die = get_controllable_proc(p, pid);
824         if (!p_to_die)
825                 return -1;
826         if (p_to_die == p) {
827                 p->exitcode = exitcode;
828                 printd("[PID %d] proc exiting gracefully (code %d)\n", p->pid,exitcode);
829         } else {
830                 p_to_die->exitcode = exitcode;  /* so its parent has some clue */
831                 printd("[%d] destroying proc %d\n", p->pid, p_to_die->pid);
832         }
833         proc_destroy(p_to_die);
834         proc_decref(p_to_die);
835         return 0;
836 }
837
838 static int sys_proc_yield(struct proc *p, bool being_nice)
839 {
840         /* proc_yield() often doesn't return - we need to finish the syscall early.
841          * If it doesn't return, it expects to eat our reference (for now). */
842         finish_current_sysc(0);
843         proc_incref(p, 1);
844         proc_yield(p, being_nice);
845         proc_decref(p);
846         /* Shouldn't return, to prevent the chance of mucking with cur_sysc. */
847         smp_idle();
848         assert(0);
849 }
850
851 static int sys_change_vcore(struct proc *p, uint32_t vcoreid,
852                              bool enable_my_notif)
853 {
854         /* Note retvals can be negative, but we don't mess with errno in case
855          * callers use this in low-level code and want to extract the 'errno'. */
856         return proc_change_to_vcore(p, vcoreid, enable_my_notif);
857 }
858
859 static ssize_t sys_fork(env_t* e)
860 {
861         uintptr_t temp;
862         int ret;
863         struct per_cpu_info *pcpui = this_pcpui_ptr();
864
865         // TODO: right now we only support fork for single-core processes
866         if (e->state != PROC_RUNNING_S) {
867                 set_errno(EINVAL);
868                 return -1;
869         }
870         env_t* env;
871         ret = proc_alloc(&env, current, PROC_DUP_FGRP);
872         assert(!ret);
873         assert(env != NULL);
874         proc_set_progname(env, e->progname);
875
876         /* Can't really fork if we don't have a current_ctx to fork */
877         if (!current_ctx) {
878                 proc_destroy(env);
879                 proc_decref(env);
880                 set_errno(EINVAL);
881                 return -1;
882         }
883         assert(pcpui->cur_proc == pcpui->owning_proc);
884         copy_current_ctx_to(&env->scp_ctx);
885
886         /* Make the new process have the same VMRs as the older.  This will copy the
887          * contents of non MAP_SHARED pages to the new VMRs. */
888         if (duplicate_vmrs(e, env)) {
889                 proc_destroy(env);      /* this is prob what you want, not decref by 2 */
890                 proc_decref(env);
891                 set_errno(ENOMEM);
892                 return -1;
893         }
894         /* Switch to the new proc's address space and finish the syscall.  We'll
895          * never naturally finish this syscall for the new proc, since its memory
896          * is cloned before we return for the original process.  If we ever do CoW
897          * for forked memory, this will be the first place that gets CoW'd. */
898         temp = switch_to(env);
899         pcpui = this_pcpui_ptr();       /* reload in case of migration */
900         finish_sysc(pcpui->cur_kthread->sysc, env, 0);
901         switch_back(env, temp);
902
903         /* Copy some state from the original proc into the new proc. */
904         env->env_flags = e->env_flags;
905
906         inherit_strace(e, env);
907
908         /* In general, a forked process should be a fresh process, and we copy over
909          * whatever stuff is needed between procinfo/procdata. */
910         *env->procdata = *e->procdata;
911         env->procinfo->program_end = e->procinfo->program_end;
912
913         /* FYI: once we call ready, the proc is open for concurrent usage */
914         __proc_ready(env);
915         proc_wakeup(env);
916
917         // don't decref the new process.
918         // that will happen when the parent waits for it.
919         // TODO: if the parent doesn't wait, we need to change the child's parent
920         // when the parent dies, or at least decref it
921
922         printd("[PID %d] fork PID %d\n", e->pid, env->pid);
923         ret = env->pid;
924         profiler_notify_new_process(env);
925         proc_decref(env);       /* give up the reference created in proc_alloc() */
926         return ret;
927 }
928
929 /* string for sys_exec arguments. Assumes that d is pointing to zero'd
930  * storage or storage that does not require null termination or
931  * provides the null. */
932 static int execargs_stringer(struct proc *p, char *d, size_t slen,
933                              char *path, size_t path_l,
934                              char *argenv, size_t argenv_l)
935 {
936         int argc, envc, i;
937         char **argv, **envp;
938         struct argenv *kargenv;
939         int amt;
940         char *s = d;
941         char *e = d + slen;
942
943         if (path_l > slen)
944                 path_l = slen;
945         if (memcpy_from_user(p, d, path, path_l)) {
946                 s = seprintf(s, e, "Invalid exec path");
947                 return s - d;
948         }
949         s += path_l;
950
951         /* yes, this code is cloned from below. I wrote a helper but
952          * Barret and I concluded after talking about it that the
953          * helper was not really helper-ful, as it has almost 10
954          * arguments. Please, don't suggest a cpp macro. Thank you. */
955         /* Check the size of the argenv array, error out if too large. */
956         if ((argenv_l < sizeof(struct argenv)) || (argenv_l > ARG_MAX)) {
957                 s = seprintf(s, e, "The argenv array has an invalid size: %lu\n",
958                                   argenv_l);
959                 return s - d;
960         }
961         /* Copy the argenv array into a kernel buffer. */
962         kargenv = user_memdup_errno(p, argenv, argenv_l);
963         if (!kargenv) {
964                 s = seprintf(s, e, "Failed to copy in the args and environment");
965                 return s - d;
966         }
967         /* Unpack the argenv array into more usable variables. Integrity checking
968          * done along side this as well. */
969         if (unpack_argenv(kargenv, argenv_l, &argc, &argv, &envc, &envp)) {
970                 s = seprintf(s, e, "Failed to unpack the args");
971                 user_memdup_free(p, kargenv);
972                 return s - d;
973         }
974         s = seprintf(s, e, "[%d]{", argc);
975         for (i = 0; i < argc; i++)
976                 s = seprintf(s, e, "%s, ", argv[i]);
977         s = seprintf(s, e, "}");
978
979         user_memdup_free(p, kargenv);
980         return s - d;
981 }
982
983 /* Load the binary "path" into the current process, and start executing it.
984  * argv and envp are magically bundled in procinfo for now.  Keep in sync with
985  * glibc's sysdeps/ros/execve.c.  Once past a certain point, this function won't
986  * return.  It assumes (and checks) that it is current.  Don't give it an extra
987  * refcnt'd *p (syscall won't do that).
988  * Note: if someone batched syscalls with this call, they could clobber their
989  * old memory (and will likely PF and die).  Don't do it... */
990 static int sys_exec(struct proc *p, char *path, size_t path_l,
991                     char *argenv, size_t argenv_l)
992 {
993         int ret = -1;
994         char *t_path = NULL;
995         struct file_or_chan *program;
996         struct per_cpu_info *pcpui = this_pcpui_ptr();
997         int argc, envc;
998         char **argv, **envp;
999         struct argenv *kargenv;
1000
1001         /* We probably want it to never be allowed to exec if it ever was _M */
1002         if (p->state != PROC_RUNNING_S) {
1003                 set_error(EINVAL, "Can't exec an MCP");
1004                 return -1;
1005         }
1006         /* Check the size of the argenv array, error out if too large. */
1007         if ((argenv_l < sizeof(struct argenv)) || (argenv_l > ARG_MAX)) {
1008                 set_error(EINVAL, "The argenv array has an invalid size: %lu\n",
1009                                   argenv_l);
1010                 return -1;
1011         }
1012
1013         if (p != pcpui->owning_proc) {
1014                 warn("Proc %d tried to exec and wasn't owning_proc", p->pid);
1015                 set_error(EAGAIN, "exec may have blocked during execution");
1016                 return -1;
1017         }
1018         /* Not sure if these can happen; I don't expect them. */
1019         assert(pcpui->cur_ctx);
1020         assert(pcpui->cur_proc == pcpui->owning_proc);
1021         /* Before this, we shouldn't have blocked (maybe with strace, though we
1022          * explicitly don't block exec for strace).  The owning proc, cur_proc, and
1023          * cur_ctx checks should catch that.  After this, we might still block, such
1024          * as on accessing the filesystem.
1025          *
1026          * After this point, we're treated like a yield - we're waiting until
1027          * something wakes us.  The kthread might block, error and fail, or succeed.
1028          * We shouldn't return to userspace before one of those.  The only way out
1029          * of this function is via smp_idle, not returning the way we came.
1030          *
1031          * Under normal situations, the only thing that will wake us is this kthread
1032          * completing.  I think you can trigger wakeups with events and async
1033          * syscalls started before the exec.  I'm not sure if that could trigger
1034          * more bugs or if that would hurt the kernel.  If so, we could add an
1035          * EXEC_LIMBO state.
1036          *
1037          * Note that we will 'hard block' if we block at all.  We can't return to
1038          * userspace and then asynchronously finish the exec later. */
1039         spin_lock(&p->proc_lock);
1040         /* We only need the context for the error case.  We have to save it now,
1041          * since once we leave this core, such as when the kthread blocks, the old
1042          * SCP's context will be gone. */
1043         __proc_save_context_s(p);
1044         /* We are no longer owning, but we are still current, like any
1045          * kthread-that-blocked-on-behalf of a process.  I think one invariant for
1046          * SCPs is: "RUNNING_S <==> is the owning proc". */
1047         clear_owning_proc(core_id());
1048         __proc_set_state(p, PROC_WAITING);
1049         spin_unlock(&p->proc_lock);
1050
1051         /* Copy the argenv array into a kernel buffer. */
1052         kargenv = user_memdup_errno(p, argenv, argenv_l);
1053         if (!kargenv) {
1054                 set_error(EINVAL, "Failed to copy in the args and environment");
1055                 goto out_error;
1056         }
1057         /* Unpack the argenv array into more usable variables. Integrity checking
1058          * done along side this as well. */
1059         if (unpack_argenv(kargenv, argenv_l, &argc, &argv, &envc, &envp)) {
1060                 set_error(EINVAL, "Failed to unpack the args");
1061                 goto out_error_kargenv;
1062         }
1063         t_path = copy_in_path(p, path, path_l);
1064         if (!t_path) {
1065                 user_memdup_free(p, kargenv);
1066                 goto out_error_kargenv;
1067         }
1068         program = foc_open(t_path, O_EXEC | O_READ, 0);
1069         if (!program)
1070                 goto out_error_tpath;
1071         if (!is_valid_elf(program)) {
1072                 set_error(ENOEXEC, "Program was not a valid ELF");
1073                 goto out_error_program;
1074         }
1075
1076         /* This is the point of no return for the process.  Any errors here lead to
1077          * destruction. */
1078
1079         /* progname is argv0, which accounts for symlinks */
1080         proc_replace_binary_path(p, t_path);
1081         /* p now owns the t_path, and it'll get freed when we destroy p. */
1082         t_path = NULL;
1083         proc_set_progname(p, argc ? argv[0] : NULL);
1084         proc_init_procdata(p);
1085         p->procinfo->program_end = 0;
1086         /* When we destroy our memory regions, accessing cur_sysc would PF */
1087         pcpui->cur_kthread->sysc = 0;
1088         unmap_and_destroy_vmrs(p);
1089         /* close the CLOEXEC ones */
1090         close_fdt(&p->open_files, TRUE);
1091         env_user_mem_free(p, 0, UMAPTOP);
1092         if (load_elf(p, program, argc, argv, envc, envp)) {
1093                 set_error(EINVAL, "Failed to load elf");
1094                 /* At this point, we destroyed memory and can't return to the app.  We
1095                  * can't use the error cases, since they assume we'll return. */
1096                 foc_decref(program);
1097                 user_memdup_free(p, kargenv);
1098                 /* We finish the trace and not the sysc, since the sysc is gone. */
1099                 systrace_finish_trace(pcpui->cur_kthread, -1);
1100                 /* Note this is an inedible reference, but proc_destroy now returns */
1101                 proc_destroy(p);
1102                 /* We don't want to do anything else - we just need to not accidentally
1103                  * return to the user (hence the all_out) */
1104                 goto all_out;
1105         }
1106         printd("[PID %d] exec %s\n", p->pid, foc_to_name(program));
1107         foc_decref(program);
1108         user_memdup_free(p, kargenv);
1109         systrace_finish_trace(pcpui->cur_kthread, 0);
1110         proc_wakeup(p);
1111
1112         goto all_out;
1113
1114 out_error_program:
1115         foc_decref(program);
1116 out_error_tpath:
1117         /* Note the t_path is passed to proc_replace_binary_path in the non
1118          * out_error cases. */
1119         free_path(p, t_path);
1120 out_error_kargenv:
1121         user_memdup_free(p, kargenv);
1122 out_error:
1123         finish_current_sysc(-1);
1124         proc_wakeup(p);
1125
1126 all_out:
1127         /* This free and setting sysc = NULL may happen twice (early errors do it),
1128          * but they are idempotent. */
1129         free_sysc_str(pcpui->cur_kthread);
1130         pcpui->cur_kthread->sysc = NULL;
1131         /* we can't return, since we'd write retvals to the old location of the
1132          * syscall struct (which has been freed and is in the old userspace) (or has
1133          * already been written to).*/
1134         disable_irq();                  /* abandon_core/clear_own wants irqs disabled */
1135         abandon_core();
1136         smp_idle();                             /* will reenable interrupts */
1137 }
1138
1139 /* Helper, will attempt a particular wait on a proc.  Returns the pid of the
1140  * process if we waited on it successfully, and the status will be passed back
1141  * in ret_status (kernel memory).  Returns 0 if the wait failed and we should
1142  * try again.  Returns -1 if we should abort.  Only handles DYING.  Callers
1143  * need to lock to protect the children tailq and reaping bits.  Callers must
1144  * decref the child on success. */
1145 static pid_t __try_wait(struct proc *parent, struct proc *child,
1146                         int *ret_status, int options)
1147 {
1148         if (proc_is_dying(child)) {
1149                 /* Disown returns -1 if it's already been disowned or we should o/w
1150                  * abort.  This can happen if we have concurrent waiters, both with
1151                  * pointers to the child (only one should reap).  Note that if we don't
1152                  * do this, we could go to sleep and never receive a cv_signal. */
1153                 if (__proc_disown_child(parent, child))
1154                         return -1;
1155                 /* despite disowning, the child won't be freed til we drop this ref
1156                  * held by this function, so it is safe to access the memory.
1157                  *
1158                  * Note the exit code one byte in the 0xff00 spot.  Check out glibc's
1159                  * posix/sys/wait.h and bits/waitstatus.h for more info.  If we ever
1160                  * deal with signalling and stopping, we'll need to do some more work
1161                  * here.*/
1162                 *ret_status = (child->exitcode & 0xff) << 8;
1163                 return child->pid;
1164         }
1165         return 0;
1166 }
1167
1168 /* Helper, like __try_wait, but attempts a wait on any of the children,
1169  * returning the specific PID we waited on, 0 to try again (a waitable exists),
1170  * and -1 to abort (no children/waitables exist).  Callers need to lock to
1171  * protect the children tailq and reaping bits.  Callers must decref the child,
1172  * if successful. */
1173 static pid_t __try_wait_any(struct proc *parent, int *ret_status, int options,
1174                             struct proc **child)
1175 {
1176         struct proc *i, *temp;
1177         pid_t retval;
1178
1179         if (TAILQ_EMPTY(&parent->children))
1180                 return -1;
1181         /* Could have concurrent waiters mucking with the tailq, caller must lock */
1182         TAILQ_FOREACH_SAFE(i, &parent->children, sibling_link, temp) {
1183                 retval = __try_wait(parent, i, ret_status, options);
1184                 /* This catches a thread causing a wait to fail but not taking the
1185                  * child off the list before unlocking.  Should never happen. */
1186                 assert(retval != -1);
1187                 /* Succeeded, return the pid of the child we waited on */
1188                 if (retval) {
1189                         *child = i;
1190                         return retval;
1191                 }
1192         }
1193         assert(retval == 0);
1194         return 0;
1195 }
1196
1197 /* Waits on a particular child, returns the pid of the child waited on, and
1198  * puts the ret status in *ret_status.  Returns the pid if we succeeded, 0 if
1199  * the child was not waitable and WNOHANG, and -1 on error. */
1200 static pid_t wait_one(struct proc *parent, struct proc *child, int *ret_status,
1201                       int options)
1202 {
1203         pid_t retval;
1204
1205         cv_lock(&parent->child_wait);
1206         /* retval == 0 means we should block */
1207         retval = __try_wait(parent, child, ret_status, options);
1208         if ((retval == 0) && (options & WNOHANG))
1209                 goto out_unlock;
1210         while (!retval) {
1211                 cpu_relax();
1212                 cv_wait(&parent->child_wait);
1213                 /* If we're dying, then we don't need to worry about waiting.  We don't
1214                  * do this yet, but we'll need this outlet when we deal with orphaned
1215                  * children and having init inherit them. */
1216                 if (proc_is_dying(parent))
1217                         goto out_unlock;
1218                 /* Any child can wake us up, but we check for the particular child we
1219                  * care about */
1220                 retval = __try_wait(parent, child, ret_status, options);
1221         }
1222         if (retval == -1) {
1223                 /* Child was already waited on by a concurrent syscall. */
1224                 set_errno(ECHILD);
1225         }
1226         /* Fallthrough */
1227 out_unlock:
1228         cv_unlock(&parent->child_wait);
1229         if (retval > 0)
1230                 proc_decref(child);
1231         return retval;
1232 }
1233
1234 /* Waits on any child, returns the pid of the child waited on, and puts the ret
1235  * status in *ret_status.  Is basically a waitpid(-1, ... );  See wait_one for
1236  * more details.  Returns -1 if there are no children to wait on, and returns 0
1237  * if there are children and we need to block but WNOHANG was set. */
1238 static pid_t wait_any(struct proc *parent, int *ret_status, int options)
1239 {
1240         pid_t retval;
1241         struct proc *child;
1242
1243         cv_lock(&parent->child_wait);
1244         retval = __try_wait_any(parent, ret_status, options, &child);
1245         if ((retval == 0) && (options & WNOHANG))
1246                 goto out_unlock;
1247         while (!retval) {
1248                 cpu_relax();
1249                 cv_wait(&parent->child_wait);
1250                 if (proc_is_dying(parent))
1251                         goto out_unlock;
1252                 /* Any child can wake us up from the CV.  This is a linear __try_wait
1253                  * scan.  If we have a lot of children, we could optimize this. */
1254                 retval = __try_wait_any(parent, ret_status, options, &child);
1255         }
1256         if (retval == -1)
1257                 assert(TAILQ_EMPTY(&parent->children));
1258         /* Fallthrough */
1259 out_unlock:
1260         cv_unlock(&parent->child_wait);
1261         if (retval > 0)
1262                 proc_decref(child);
1263         return retval;
1264 }
1265
1266 /* Note: we only allow waiting on children (no such thing as threads, for
1267  * instance).  Right now we only allow waiting on termination (not signals),
1268  * and we don't have a way for parents to disown their children (such as
1269  * ignoring SIGCHLD, see man 2 waitpid's Notes).
1270  *
1271  * We don't bother with stop/start signals here, though we can probably build
1272  * it in the helper above.
1273  *
1274  * Returns the pid of who we waited on, or -1 on error, or 0 if we couldn't
1275  * wait (WNOHANG). */
1276 static pid_t sys_waitpid(struct proc *parent, pid_t pid, int *status,
1277                          int options)
1278 {
1279         struct proc *child;
1280         pid_t retval = 0;
1281         int ret_status = 0;
1282
1283         sysc_save_str("waitpid on %d", pid);
1284         /* -1 is the signal for 'any child' */
1285         if (pid == -1) {
1286                 retval = wait_any(parent, &ret_status, options);
1287                 goto out;
1288         }
1289         child = pid2proc(pid);
1290         if (!child) {
1291                 set_errno(ECHILD);      /* ECHILD also used for no proc */
1292                 retval = -1;
1293                 goto out;
1294         }
1295         if (!(parent->pid == child->ppid)) {
1296                 set_errno(ECHILD);
1297                 retval = -1;
1298                 goto out_decref;
1299         }
1300         retval = wait_one(parent, child, &ret_status, options);
1301         /* fall-through */
1302 out_decref:
1303         proc_decref(child);
1304 out:
1305         /* ignoring / don't care about memcpy's retval here. */
1306         if (status)
1307                 memcpy_to_user(parent, status, &ret_status, sizeof(ret_status));
1308         printd("[PID %d] waited for PID %d, got retval %d (status 0x%x)\n",
1309                parent->pid, pid, retval, ret_status);
1310         return retval;
1311 }
1312
1313 /************** Memory Management Syscalls **************/
1314
1315 static void *sys_mmap(struct proc *p, uintptr_t addr, size_t len, int prot,
1316                       int flags, int fd, off_t offset)
1317 {
1318         return mmap(p, addr, len, prot, flags, fd, offset);
1319 }
1320
1321 static intreg_t sys_mprotect(struct proc *p, void *addr, size_t len, int prot)
1322 {
1323         return mprotect(p, (uintptr_t)addr, len, prot);
1324 }
1325
1326 static intreg_t sys_munmap(struct proc *p, void *addr, size_t len)
1327 {
1328         return munmap(p, (uintptr_t)addr, len);
1329 }
1330
1331 static ssize_t sys_shared_page_alloc(env_t* p1,
1332                                      void **_addr, pid_t p2_id,
1333                                      int p1_flags, int p2_flags
1334                                     )
1335 {
1336         printk("[kernel] shared page alloc is deprecated/unimplemented.\n");
1337         return -1;
1338 }
1339
1340 static int sys_shared_page_free(env_t* p1, void *addr, pid_t p2)
1341 {
1342         return -1;
1343 }
1344
1345 /* Helper, to do the actual provisioning of a resource to a proc */
1346 static int prov_resource(struct proc *target, unsigned int res_type,
1347                          long res_val)
1348 {
1349         switch (res_type) {
1350                 case (RES_CORES):
1351                         /* in the off chance we have a kernel scheduler that can't
1352                          * provision, we'll need to change this. */
1353                         return provision_core(target, res_val);
1354                 default:
1355                         printk("[kernel] received provisioning for unknown resource %d\n",
1356                                res_type);
1357                         set_errno(ENOENT);      /* or EINVAL? */
1358                         return -1;
1359         }
1360 }
1361
1362 /* Rough syscall to provision res_val of type res_type to target_pid */
1363 static int sys_provision(struct proc *p, int target_pid,
1364                          unsigned int res_type, long res_val)
1365 {
1366         struct proc *target = pid2proc(target_pid);
1367         int retval;
1368         if (!target) {
1369                 if (target_pid == 0)
1370                         return prov_resource(0, res_type, res_val);
1371                 /* debugging interface */
1372                 if (target_pid == -1)
1373                         print_coreprov_map();
1374                 set_errno(ESRCH);
1375                 return -1;
1376         }
1377         retval = prov_resource(target, res_type, res_val);
1378         proc_decref(target);
1379         return retval;
1380 }
1381
1382 /* Untested.  Will notify the target on the given vcore, if the caller controls
1383  * the target.  Will honor the target's wanted/vcoreid.  u_ne can be NULL. */
1384 static int sys_notify(struct proc *p, int target_pid, unsigned int ev_type,
1385                       struct event_msg *u_msg)
1386 {
1387         struct event_msg local_msg = {0};
1388         struct proc *target = get_controllable_proc(p, target_pid);
1389         if (!target)
1390                 return -1;
1391         /* if the user provided an ev_msg, copy it in and use that */
1392         if (u_msg) {
1393                 if (memcpy_from_user(p, &local_msg, u_msg, sizeof(struct event_msg))) {
1394                         proc_decref(target);
1395                         set_errno(EINVAL);
1396                         return -1;
1397                 }
1398         } else {
1399                 local_msg.ev_type = ev_type;
1400         }
1401         send_kernel_event(target, &local_msg, 0);
1402         proc_decref(target);
1403         return 0;
1404 }
1405
1406 /* Will notify the calling process on the given vcore, independently of WANTED
1407  * or advertised vcoreid.  If you change the parameters, change pop_user_ctx().
1408  */
1409 static int sys_self_notify(struct proc *p, uint32_t vcoreid,
1410                            unsigned int ev_type, struct event_msg *u_msg,
1411                            bool priv)
1412 {
1413         struct event_msg local_msg = {0};
1414         /* if the user provided an ev_msg, copy it in and use that */
1415         if (u_msg) {
1416                 if (memcpy_from_user(p, &local_msg, u_msg, sizeof(struct event_msg))) {
1417                         set_errno(EINVAL);
1418                         return -1;
1419                 }
1420         } else {
1421                 local_msg.ev_type = ev_type;
1422         }
1423         if (local_msg.ev_type >= MAX_NR_EVENT) {
1424                 printk("[kernel] received self-notify for vcoreid %d, ev_type %d, "
1425                        "u_msg %p, u_msg->type %d\n", vcoreid, ev_type, u_msg,
1426                        u_msg ? u_msg->ev_type : 0);
1427                 return -1;
1428         }
1429         /* this will post a message and IPI, regardless of wants/needs/debutantes.*/
1430         post_vcore_event(p, &local_msg, vcoreid, priv ? EVENT_VCORE_PRIVATE : 0);
1431         proc_notify(p, vcoreid);
1432         return 0;
1433 }
1434
1435 static int sys_send_event(struct proc *p, struct event_queue *ev_q,
1436                           struct event_msg *u_msg, uint32_t vcoreid)
1437 {
1438         struct event_msg local_msg = {0};
1439
1440         if (memcpy_from_user(p, &local_msg, u_msg, sizeof(struct event_msg))) {
1441                 set_errno(EINVAL);
1442                 return -1;
1443         }
1444         send_event(p, ev_q, &local_msg, vcoreid);
1445         return 0;
1446 }
1447
1448 /* Puts the calling core into vcore context, if it wasn't already, via a
1449  * self-IPI / active notification.  Barring any weird unmappings, we just send
1450  * ourselves a __notify. */
1451 static int sys_vc_entry(struct proc *p)
1452 {
1453         send_kernel_message(core_id(), __notify, (long)p, 0, 0, KMSG_ROUTINE);
1454         return 0;
1455 }
1456
1457 /* This will halt the core, waking on an IRQ.  These could be kernel IRQs for
1458  * things like timers or devices, or they could be IPIs for RKMs (__notify for
1459  * an evq with IPIs for a syscall completion, etc).  With arch support, this
1460  * will also wake on a write to notif_pending.
1461  *
1462  * We don't need to finish the syscall early (worried about the syscall struct,
1463  * on the vcore's stack).  The syscall will finish before any __preempt RKM
1464  * executes, so the vcore will not restart somewhere else before the syscall
1465  * completes (unlike with yield, where the syscall itself adjusts the vcore
1466  * structures).
1467  *
1468  * In the future, RKM code might avoid sending IPIs if the core is already in
1469  * the kernel.  That code will need to check the CPU's state in some manner, and
1470  * send if the core is halted/idle.  Or perhaps use mwait, if there's arch
1471  * support.
1472  *
1473  * The core must wake up for RKMs, including RKMs that arrive while the kernel
1474  * is trying to halt.
1475  *
1476  * If our hardware supports something like monitor/mwait, we'll abort if
1477  * notif_pending was or gets set.  Note that whoever writes notif_pending may
1478  * send an IPI regardless of whether or not we have mwait.  That's up to the
1479  * ev_q settings (so basically userspace).  If userspace doesn't want an IPI, a
1480  * notif will wake it up, but it won't break it out of a uthread loop. */
1481 static int sys_halt_core(struct proc *p, unsigned long usec)
1482 {
1483         struct per_cpu_info *pcpui = this_pcpui_ptr();
1484         struct preempt_data *vcpd;
1485
1486         /* The user can only halt CG cores!  (ones it owns) */
1487         if (management_core())
1488                 return -1;
1489         rcu_report_qs();
1490         disable_irq();
1491         /* both for accounting and possible RKM optimizations */
1492         __set_cpu_state(pcpui, CPU_STATE_IDLE);
1493         wrmb();
1494         if (has_routine_kmsg()) {
1495                 __set_cpu_state(pcpui, CPU_STATE_KERNEL);
1496                 enable_irq();
1497                 return 0;
1498         }
1499         vcpd = &p->procdata->vcore_preempt_data[pcpui->owning_vcoreid];
1500         /* We pretend to not be in vcore context so other cores will send us IPIs
1501          * (__notify).  If we do get a __notify, we'll have set notif_disabled back
1502          * on before we handle the message, since it's a routine KMSG.  Note that
1503          * other vcores will think we are not in vcore context.  This is no
1504          * different to when we pop contexts: 'briefly' leave VC ctx, check
1505          * notif_pending, and (possibly) abort and set notif_disabled. */
1506         vcpd->notif_disabled = false;
1507         cpu_halt_notif_pending(vcpd);
1508         __set_cpu_state(pcpui, CPU_STATE_KERNEL);
1509         vcpd->notif_disabled = true;
1510         enable_irq();
1511         return 0;
1512 }
1513
1514 /* Changes a process into _M mode, or -EINVAL if it already is an mcp.
1515  * __proc_change_to_m() returns and we'll eventually finish the sysc later.  The
1516  * original context may restart on a remote core before we return and finish,
1517  * but that's fine thanks to the async kernel interface. */
1518 static int sys_change_to_m(struct proc *p)
1519 {
1520         int retval = proc_change_to_m(p);
1521         /* convert the kernel error code into (-1, errno) */
1522         if (retval) {
1523                 set_errno(-retval);
1524                 retval = -1;
1525         }
1526         return retval;
1527 }
1528
1529 /* Assists the user/2LS by atomically running *ctx and leaving vcore context.
1530  * Normally, the user can do this themselves, but x86 VM contexts need kernel
1531  * support.  The caller ought to be in vcore context, and if a notif is pending,
1532  * then the calling vcore will restart in a fresh VC ctx (as if it was notified
1533  * or did a sys_vc_entry).
1534  *
1535  * Note that this will set the TLS too, which is part of the context.  Parlib's
1536  * pop_user_ctx currently does *not* do this, since the TLS is managed
1537  * separately.  If you want to use this syscall for testing, you'll need to 0
1538  * out fsbase and conditionally write_msr in proc_pop_ctx(). */
1539 static int sys_pop_ctx(struct proc *p, struct user_context *ctx)
1540 {
1541         int pcoreid = core_id();
1542         struct per_cpu_info *pcpui = &per_cpu_info[pcoreid];
1543         int vcoreid = pcpui->owning_vcoreid;
1544         struct preempt_data *vcpd = &p->procdata->vcore_preempt_data[vcoreid];
1545
1546         /* With change_to, there's a bunch of concerns about changing the vcore map,
1547          * since the kernel may have already locked and sent preempts, deaths, etc.
1548          *
1549          * In this case, we don't care as much.  Other than notif_pending and
1550          * notif_disabled, it's more like we're just changing a few registers in
1551          * cur_ctx.  We can safely order-after any kernel messages or other changes,
1552          * as if the user had done all of the changes we'll make and then did a
1553          * no-op syscall.
1554          *
1555          * Since we are mucking with current_ctx, it is important that we don't
1556          * block before or during this syscall. */
1557         arch_finalize_ctx(pcpui->cur_ctx);
1558         if (copy_from_user(pcpui->cur_ctx, ctx, sizeof(struct user_context))) {
1559                 /* The 2LS isn't really in a position to handle errors.  At the very
1560                  * least, we can print something and give them a fresh vc ctx. */
1561                 printk("[kernel] unable to copy user_ctx, 2LS bug\n");
1562                 memset(pcpui->cur_ctx, 0, sizeof(struct user_context));
1563                 proc_init_ctx(pcpui->cur_ctx, vcoreid, vcpd->vcore_entry,
1564                               vcpd->vcore_stack, vcpd->vcore_tls_desc);
1565                 return -1;
1566         }
1567         proc_secure_ctx(pcpui->cur_ctx);
1568         /* The caller leaves vcore context no matter what.  We'll put them back in
1569          * if they missed a message. */
1570         vcpd->notif_disabled = FALSE;
1571         wrmb(); /* order disabled write before pending read */
1572         if (vcpd->notif_pending)
1573                 send_kernel_message(pcoreid, __notify, (long)p, 0, 0, KMSG_ROUTINE);
1574         return 0;
1575 }
1576
1577 static int sys_vmm_add_gpcs(struct proc *p, unsigned int nr_more_gpcs,
1578                             struct vmm_gpcore_init *gpcis)
1579 {
1580         ERRSTACK(1);
1581         struct vmm *vmm = &p->vmm;
1582
1583         qlock(&vmm->qlock);
1584         if (waserror()) {
1585                 qunlock(&vmm->qlock);
1586                 poperror();
1587                 return -1;
1588         }
1589         __vmm_struct_init(p);
1590         __vmm_add_gpcs(p, nr_more_gpcs, gpcis);
1591         qunlock(&vmm->qlock);
1592         poperror();
1593         return nr_more_gpcs;
1594 }
1595
1596 static int sys_vmm_poke_guest(struct proc *p, int guest_pcoreid)
1597 {
1598         return vmm_poke_guest(p, guest_pcoreid);
1599 }
1600
1601 static int sys_vmm_ctl(struct proc *p, int cmd, unsigned long arg1,
1602                        unsigned long arg2, unsigned long arg3,
1603                        unsigned long arg4)
1604 {
1605         ERRSTACK(1);
1606         int ret;
1607         struct vmm *vmm = &p->vmm;
1608
1609         /* Protects against concurrent setters and for gets that are not atomic
1610          * reads (say, multiple exec ctls). */
1611         qlock(&vmm->qlock);
1612         if (waserror()) {
1613                 qunlock(&vmm->qlock);
1614                 poperror();
1615                 return -1;
1616         }
1617         __vmm_struct_init(p);
1618         switch (cmd) {
1619         case VMM_CTL_GET_EXITS:
1620                 if (vmm->amd)
1621                         error(ENOTSUP, "AMD VMMs unsupported");
1622                 ret = vmx_ctl_get_exits(&vmm->vmx);
1623                 break;
1624         case VMM_CTL_SET_EXITS:
1625                 if (arg1 & ~VMM_CTL_ALL_EXITS)
1626                         error(EINVAL, "Bad vmm_ctl_exits %x (%x)", arg1,
1627                               VMM_CTL_ALL_EXITS);
1628                 if (vmm->amd)
1629                         error(ENOTSUP, "AMD VMMs unsupported");
1630                 ret = vmx_ctl_set_exits(&vmm->vmx, arg1);
1631                 break;
1632         case VMM_CTL_GET_FLAGS:
1633                 ret = vmm->flags;
1634                 break;
1635         case VMM_CTL_SET_FLAGS:
1636                 if (arg1 & ~VMM_CTL_ALL_FLAGS)
1637                         error(EINVAL, "Bad vmm_ctl flags.  Got 0x%lx, allowed 0x%lx\n",
1638                               arg1, VMM_CTL_ALL_FLAGS);
1639                 vmm->flags = arg1;
1640                 ret = 0;
1641                 break;
1642         default:
1643                 error(EINVAL, "Bad vmm_ctl cmd %d", cmd);
1644         }
1645         qunlock(&vmm->qlock);
1646         poperror();
1647         return ret;
1648 }
1649
1650 /* Pokes the ksched for the given resource for target_pid.  If the target pid
1651  * == 0, we just poke for the calling process.  The common case is poking for
1652  * self, so we avoid the lookup.
1653  *
1654  * Not sure if you could harm someone via asking the kernel to look at them, so
1655  * we'll do a 'controls' check for now.  In the future, we might have something
1656  * in the ksched that limits or penalizes excessive pokes. */
1657 static int sys_poke_ksched(struct proc *p, int target_pid,
1658                            unsigned int res_type)
1659 {
1660         struct proc *target;
1661         int retval = 0;
1662         if (!target_pid) {
1663                 poke_ksched(p, res_type);
1664                 return 0;
1665         }
1666         target = pid2proc(target_pid);
1667         if (!target) {
1668                 set_errno(ESRCH);
1669                 return -1;
1670         }
1671         if (!proc_controls(p, target)) {
1672                 set_errno(EPERM);
1673                 retval = -1;
1674                 goto out;
1675         }
1676         poke_ksched(target, res_type);
1677 out:
1678         proc_decref(target);
1679         return retval;
1680 }
1681
1682 static int sys_abort_sysc(struct proc *p, struct syscall *sysc)
1683 {
1684         return abort_sysc(p, sysc);
1685 }
1686
1687 static int sys_abort_sysc_fd(struct proc *p, int fd)
1688 {
1689         /* Consider checking for a bad fd.  Doesn't matter now, since we only look
1690          * for actual syscalls blocked that had used fd. */
1691         return abort_all_sysc_fd(p, fd);
1692 }
1693
1694 static unsigned long sys_populate_va(struct proc *p, uintptr_t va,
1695                                      unsigned long nr_pgs)
1696 {
1697         return populate_va(p, ROUNDDOWN(va, PGSIZE), nr_pgs);
1698 }
1699
1700 static intreg_t sys_read(struct proc *p, int fd, void *buf, size_t len)
1701 {
1702         sysc_save_str("read on fd %d", fd);
1703         return sysread(fd, buf, len);
1704 }
1705
1706 static intreg_t sys_write(struct proc *p, int fd, const void *buf, size_t len)
1707 {
1708         sysc_save_str("write on fd %d", fd);
1709         return syswrite(fd, (void*)buf, len);
1710 }
1711
1712 /* Checks args/reads in the path, opens the file (relative to fromfd if the path
1713  * is not absolute), and inserts it into the process's open file list. */
1714 static intreg_t sys_openat(struct proc *p, int fromfd, const char *path,
1715                            size_t path_l, int oflag, int mode)
1716 {
1717         int fd;
1718         char *t_path;
1719
1720         printd("File %s Open attempt oflag %x mode %x\n", path, oflag, mode);
1721         if ((oflag & O_PATH) && (oflag & O_ACCMODE)) {
1722                 set_error(EINVAL, "Cannot open O_PATH with any I/O perms (O%o)", oflag);
1723                 return -1;
1724         }
1725         t_path = copy_in_path(p, path, path_l);
1726         if (!t_path)
1727                 return -1;
1728         sysc_save_str("open %s at fd %d", t_path, fromfd);
1729         fd = sysopenat(fromfd, t_path, oflag);
1730         /* successful lookup with CREATE and EXCL is an error */
1731         if (fd != -1) {
1732                 if ((oflag & O_CREATE) && (oflag & O_EXCL)) {
1733                         set_errno(EEXIST);
1734                         sysclose(fd);
1735                         free_path(p, t_path);
1736                         return -1;
1737                 }
1738         } else {
1739                 if (oflag & O_CREATE) {
1740                         mode &= ~p->umask;
1741                         mode &= S_PMASK;
1742                         static_assert(!(DMMODE_BITS & S_PMASK));
1743                         fd = syscreate(t_path, oflag, mode);
1744                 }
1745         }
1746         free_path(p, t_path);
1747         printd("File %s Open, fd=%d\n", path, fd);
1748         return fd;
1749 }
1750
1751 static intreg_t sys_close(struct proc *p, int fd)
1752 {
1753         return sysclose(fd);
1754 }
1755
1756 static intreg_t sys_fstat(struct proc *p, int fd, struct kstat *u_stat)
1757 {
1758         struct kstat *kbuf;
1759
1760         kbuf = kmalloc(sizeof(struct kstat), 0);
1761         if (!kbuf) {
1762                 set_errno(ENOMEM);
1763                 return -1;
1764         }
1765         if (sysfstatakaros(fd, (struct kstat *)kbuf) < 0) {
1766                 kfree(kbuf);
1767                 return -1;
1768         }
1769         /* TODO: UMEM: pin the memory, copy directly, and skip the kernel buffer */
1770         if (memcpy_to_user_errno(p, u_stat, kbuf, sizeof(struct kstat))) {
1771                 kfree(kbuf);
1772                 return -1;
1773         }
1774         kfree(kbuf);
1775         return 0;
1776 }
1777
1778 /* sys_stat() and sys_lstat() do nearly the same thing, differing in how they
1779  * treat a symlink for the final item, which (probably) will be controlled by
1780  * the lookup flags */
1781 static intreg_t stat_helper(struct proc *p, const char *path, size_t path_l,
1782                             struct kstat *u_stat, int flags)
1783 {
1784         struct kstat *kbuf;
1785         char *t_path = copy_in_path(p, path, path_l);
1786         int retval = 0;
1787
1788         if (!t_path)
1789                 return -1;
1790         kbuf = kmalloc(sizeof(struct kstat), 0);
1791         if (!kbuf) {
1792                 set_errno(ENOMEM);
1793                 retval = -1;
1794                 goto out_with_path;
1795         }
1796         retval = sysstatakaros(t_path, (struct kstat *)kbuf, flags);
1797         if (retval < 0)
1798                 goto out_with_kbuf;
1799         /* TODO: UMEM: pin the memory, copy directly, and skip the kernel buffer */
1800         if (memcpy_to_user_errno(p, u_stat, kbuf, sizeof(struct kstat)))
1801                 retval = -1;
1802         /* Fall-through */
1803 out_with_kbuf:
1804         kfree(kbuf);
1805 out_with_path:
1806         free_path(p, t_path);
1807         return retval;
1808 }
1809
1810 /* Follow a final symlink */
1811 static intreg_t sys_stat(struct proc *p, const char *path, size_t path_l,
1812                          struct kstat *u_stat)
1813 {
1814         return stat_helper(p, path, path_l, u_stat, 0);
1815 }
1816
1817 /* Don't follow a final symlink */
1818 static intreg_t sys_lstat(struct proc *p, const char *path, size_t path_l,
1819                           struct kstat *u_stat)
1820 {
1821         return stat_helper(p, path, path_l, u_stat, O_NOFOLLOW);
1822 }
1823
1824 intreg_t sys_fcntl(struct proc *p, int fd, int cmd, unsigned long arg1,
1825                    unsigned long arg2, unsigned long arg3, unsigned long arg4)
1826 {
1827         switch (cmd) {
1828         case (F_DUPFD):
1829                 /* TODO: glibc uses regular DUPFD for dup2, which is racy. */
1830                 return sysdup(fd, arg1, FALSE);
1831         case (F_GETFD):
1832                 return fd_get_fd_flags(&p->open_files, fd);
1833         case (F_SETFD):
1834                 if (arg1 & ~FD_VALID_FLAGS) {
1835                         set_error(EINVAL, "Bad FD flags %p, valid are %p", arg1,
1836                                   FD_VALID_FLAGS);
1837                         return -1;
1838                 }
1839                 return fd_set_fd_flags(&p->open_files, fd, arg1);
1840         case (F_SYNC):
1841                 return fd_chan_ctl(fd, CCTL_SYNC, 0, 0, 0, 0);
1842         case (F_GETFL):
1843                 return fd_getfl(fd);
1844         case (F_SETFL):
1845                 return fd_chan_ctl(fd, CCTL_SET_FL, arg1, 0, 0, 0);
1846         default:
1847                 /* chanctl and fcntl share flags */
1848                 if (cmd >= F_CHANCTL_BASE)
1849                         return fd_chan_ctl(fd, cmd, arg1, arg2, arg3, arg4);
1850                 set_error(EINVAL, "Unsupported fcntl cmd %d", cmd);
1851                 return -1;
1852         }
1853 }
1854
1855 static intreg_t sys_access(struct proc *p, const char *path, size_t path_l,
1856                            int mode)
1857 {
1858         int retval;
1859         struct dir *dir;
1860         char *t_path = copy_in_path(p, path, path_l);
1861
1862         if (!t_path)
1863                 return -1;
1864         dir = sysdirstat(t_path);
1865         if (!dir)
1866                 goto out;
1867         if ((mode == F_OK) || caller_has_dir_perms(dir, access_bits_to_omode(mode)))
1868                 retval = 0;
1869         kfree(dir);
1870 out:
1871         free_path(p, t_path);
1872         return retval;
1873 }
1874
1875 intreg_t sys_umask(struct proc *p, int mask)
1876 {
1877         int old_mask = p->umask;
1878
1879         p->umask = mask & S_PMASK;
1880         return old_mask;
1881 }
1882
1883 /* 64 bit seek, with the off64_t passed in via two (potentially 32 bit) off_ts.
1884  * We're supporting both 32 and 64 bit kernels/userspaces, but both use the
1885  * llseek syscall with 64 bit parameters. */
1886 static intreg_t sys_llseek(struct proc *p, int fd, off_t offset_hi,
1887                            off_t offset_lo, off64_t *result, int whence)
1888 {
1889         off64_t retoff = 0;
1890         off64_t tempoff = 0;
1891         int ret = 0;
1892
1893         tempoff = offset_hi;
1894         tempoff <<= 32;
1895         tempoff |= offset_lo;
1896         retoff = sysseek(fd, tempoff, whence);
1897         ret = (retoff < 0);
1898         if (ret)
1899                 return -1;
1900         if (memcpy_to_user_errno(p, result, &retoff, sizeof(off64_t)))
1901                 return -1;
1902         return 0;
1903 }
1904
1905 intreg_t sys_link(struct proc *p, char *old_path, size_t old_l,
1906                   char *new_path, size_t new_l)
1907 {
1908         int ret;
1909         char *t_oldpath = copy_in_path(p, old_path, old_l);
1910         if (t_oldpath == NULL)
1911                 return -1;
1912         char *t_newpath = copy_in_path(p, new_path, new_l);
1913         if (t_newpath == NULL) {
1914                 free_path(p, t_oldpath);
1915                 return -1;
1916         }
1917         set_error(ENOSYS, "no link");
1918         ret = -1;
1919         free_path(p, t_oldpath);
1920         free_path(p, t_newpath);
1921         return ret;
1922 }
1923
1924 intreg_t sys_unlink(struct proc *p, const char *path, size_t path_l)
1925 {
1926         int retval;
1927         char *t_path = copy_in_path(p, path, path_l);
1928
1929         if (!t_path)
1930                 return -1;
1931         retval = sysremove(t_path);
1932         free_path(p, t_path);
1933         return retval;
1934 }
1935
1936 intreg_t sys_symlink(struct proc *p, char *old_path, size_t old_l,
1937                      char *new_path, size_t new_l)
1938 {
1939         int ret;
1940         char *t_oldpath = copy_in_path(p, old_path, old_l);
1941         if (t_oldpath == NULL)
1942                 return -1;
1943         char *t_newpath = copy_in_path(p, new_path, new_l);
1944         if (t_newpath == NULL) {
1945                 free_path(p, t_oldpath);
1946                 return -1;
1947         }
1948         ret = syssymlink(t_newpath, t_oldpath);
1949         free_path(p, t_oldpath);
1950         free_path(p, t_newpath);
1951         return ret;
1952 }
1953
1954 intreg_t sys_readlink(struct proc *p, char *path, size_t path_l,
1955                       char *u_buf, size_t buf_l)
1956 {
1957         char *symname = NULL;
1958         ssize_t copy_amt;
1959         int ret = -1;
1960         char *t_path = copy_in_path(p, path, path_l);
1961         struct dir *dir = NULL;
1962
1963         if (t_path == NULL)
1964                 return -1;
1965         dir = sysdirlstat(t_path);
1966         if (!(dir->mode & DMSYMLINK))
1967                 set_error(EINVAL, "not a symlink: %s", t_path);
1968         else
1969                 symname = dir->ext;
1970         free_path(p, t_path);
1971         if (symname){
1972                 copy_amt = strnlen(symname, buf_l - 1) + 1;
1973                 if (!memcpy_to_user_errno(p, u_buf, symname, copy_amt))
1974                         ret = copy_amt - 1;
1975         }
1976         kfree(dir);
1977         return ret;
1978 }
1979
1980 static intreg_t sys_chdir(struct proc *p, pid_t pid, const char *path,
1981                           size_t path_l)
1982 {
1983         int retval;
1984         char *t_path;
1985         struct proc *target = get_controllable_proc(p, pid);
1986
1987         if (!target)
1988                 return -1;
1989         t_path = copy_in_path(p, path, path_l);
1990         if (!t_path) {
1991                 proc_decref(target);
1992                 return -1;
1993         }
1994         retval = syschdir(t_path);
1995         free_path(p, t_path);
1996         proc_decref(target);
1997         return retval;
1998 }
1999
2000 static intreg_t sys_fchdir(struct proc *p, pid_t pid, int fd)
2001 {
2002         int retval;
2003         struct proc *target = get_controllable_proc(p, pid);
2004
2005         if (!target)
2006                 return -1;
2007         retval = sysfchdir(fd);
2008         proc_decref(target);
2009         return retval;
2010 }
2011
2012 /* Note cwd_l is not a strlen, it's an absolute size.
2013  * Same as with readlink, we give them a null-terminated string, and we return
2014  * strlen, which doesn't include the \0.  If we can't give them the \0, we'll
2015  * error out.  Our readlink also does that, which is not POSIX-like. */
2016 intreg_t sys_getcwd(struct proc *p, char *u_cwd, size_t cwd_l)
2017 {
2018         ssize_t retval = -1;
2019         size_t copy_amt;
2020         char *k_cwd;
2021
2022         k_cwd = sysgetcwd();
2023         if (!k_cwd) {
2024                 set_error(EINVAL, "unable to getcwd");
2025                 return -1;
2026         }
2027         copy_amt = strlen(k_cwd) + 1;
2028         if (copy_amt > cwd_l) {
2029                 set_error(ERANGE, "getcwd buf too small, needed %d", copy_amt);
2030                 goto out;
2031         }
2032         if (!memcpy_to_user_errno(p, u_cwd, k_cwd, copy_amt))
2033                 retval = copy_amt - 1;
2034 out:
2035         kfree(k_cwd);
2036         return retval;
2037 }
2038
2039 intreg_t sys_mkdir(struct proc *p, const char *path, size_t path_l, int mode)
2040 {
2041         int retval;
2042         char *t_path = copy_in_path(p, path, path_l);
2043
2044         if (!t_path)
2045                 return -1;
2046         mode &= ~p->umask;
2047         mode &= S_PMASK;
2048         static_assert(!(DMMODE_BITS & S_PMASK));
2049         retval = syscreate(t_path, O_READ, DMDIR | mode);
2050         if (retval >= 0) {
2051                 sysclose(retval);
2052                 retval = 0;
2053         }
2054         free_path(p, t_path);
2055         return retval;
2056 }
2057
2058 intreg_t sys_rmdir(struct proc *p, const char *path, size_t path_l)
2059 {
2060         int retval;
2061         char *t_path = copy_in_path(p, path, path_l);
2062
2063         if (!t_path)
2064                 return -1;
2065         retval = sysremove(t_path);
2066         free_path(p, t_path);
2067         return retval;
2068 }
2069
2070 intreg_t sys_tcgetattr(struct proc *p, int fd, void *termios_p)
2071 {
2072         int retval = 0;
2073         /* TODO: actually support this call on tty FDs.  Right now, we just fake
2074          * what my linux box reports for a bash pty. */
2075         struct termios *kbuf = kmalloc(sizeof(struct termios), 0);
2076         kbuf->c_iflag = 0x2d02;
2077         kbuf->c_oflag = 0x0005;
2078         kbuf->c_cflag = 0x04bf;
2079         kbuf->c_lflag = 0x8a3b;
2080         kbuf->c_line = 0x0;
2081         kbuf->c_ispeed = 0xf;
2082         kbuf->c_ospeed = 0xf;
2083         kbuf->c_cc[0] = 0x03;
2084         kbuf->c_cc[1] = 0x1c;
2085         kbuf->c_cc[2] = 0x7f;
2086         kbuf->c_cc[3] = 0x15;
2087         kbuf->c_cc[4] = 0x04;
2088         kbuf->c_cc[5] = 0x00;
2089         kbuf->c_cc[6] = 0x01;
2090         kbuf->c_cc[7] = 0xff;
2091         kbuf->c_cc[8] = 0x11;
2092         kbuf->c_cc[9] = 0x13;
2093         kbuf->c_cc[10] = 0x1a;
2094         kbuf->c_cc[11] = 0xff;
2095         kbuf->c_cc[12] = 0x12;
2096         kbuf->c_cc[13] = 0x0f;
2097         kbuf->c_cc[14] = 0x17;
2098         kbuf->c_cc[15] = 0x16;
2099         kbuf->c_cc[16] = 0xff;
2100         kbuf->c_cc[17] = 0x00;
2101         kbuf->c_cc[18] = 0x00;
2102         kbuf->c_cc[19] = 0x00;
2103         kbuf->c_cc[20] = 0x00;
2104         kbuf->c_cc[21] = 0x00;
2105         kbuf->c_cc[22] = 0x00;
2106         kbuf->c_cc[23] = 0x00;
2107         kbuf->c_cc[24] = 0x00;
2108         kbuf->c_cc[25] = 0x00;
2109         kbuf->c_cc[26] = 0x00;
2110         kbuf->c_cc[27] = 0x00;
2111         kbuf->c_cc[28] = 0x00;
2112         kbuf->c_cc[29] = 0x00;
2113         kbuf->c_cc[30] = 0x00;
2114         kbuf->c_cc[31] = 0x00;
2115
2116         if (memcpy_to_user_errno(p, termios_p, kbuf, sizeof(struct termios)))
2117                 retval = -1;
2118         kfree(kbuf);
2119         return retval;
2120 }
2121
2122 intreg_t sys_tcsetattr(struct proc *p, int fd, int optional_actions,
2123                        const void *termios_p)
2124 {
2125         /* TODO: do this properly too.  For now, we just say 'it worked' */
2126         return 0;
2127 }
2128
2129 /* TODO: we don't have any notion of UIDs or GIDs yet, but don't let that stop a
2130  * process from thinking it can do these.  The other alternative is to have
2131  * glibc return 0 right away, though someone might want to do something with
2132  * these calls.  Someday. */
2133 intreg_t sys_setuid(struct proc *p, uid_t uid)
2134 {
2135         return 0;
2136 }
2137
2138 intreg_t sys_setgid(struct proc *p, gid_t gid)
2139 {
2140         return 0;
2141 }
2142
2143 /* long bind(char* src_path, char* onto_path, int flag);
2144  *
2145  * The naming for the args in bind is messy historically.  We do:
2146  *              bind src_path onto_path
2147  * plan9 says bind NEW OLD, where new is *src*, and old is *onto*.
2148  * Linux says mount --bind OLD NEW, where OLD is *src* and NEW is *onto*. */
2149 intreg_t sys_nbind(struct proc *p,
2150                    char *src_path, size_t src_l,
2151                    char *onto_path, size_t onto_l,
2152                    unsigned int flag)
2153
2154 {
2155         int ret;
2156         char *t_srcpath = copy_in_path(p, src_path, src_l);
2157         if (t_srcpath == NULL) {
2158                 printd("srcpath dup failed ptr %p size %d\n", src_path, src_l);
2159                 return -1;
2160         }
2161         char *t_ontopath = copy_in_path(p, onto_path, onto_l);
2162         if (t_ontopath == NULL) {
2163                 free_path(p, t_srcpath);
2164                 printd("ontopath dup failed ptr %p size %d\n", onto_path, onto_l);
2165                 return -1;
2166         }
2167         printd("sys_nbind: %s -> %s flag %d\n", t_srcpath, t_ontopath, flag);
2168         ret = sysbind(t_srcpath, t_ontopath, flag);
2169         free_path(p, t_srcpath);
2170         free_path(p, t_ontopath);
2171         return ret;
2172 }
2173
2174 /* int mount(int fd, int afd, char* onto_path, int flag, char* aname); */
2175 intreg_t sys_nmount(struct proc *p,
2176                     int fd,
2177                     char *onto_path, size_t onto_l,
2178                     unsigned int flag
2179                         /* we ignore these */
2180                         /* no easy way to pass this many args anyway. *
2181                     int afd,
2182                     char *auth, size_t auth_l*/)
2183 {
2184         int ret;
2185         int afd;
2186
2187         afd = -1;
2188         char *t_ontopath = copy_in_path(p, onto_path, onto_l);
2189         if (t_ontopath == NULL)
2190                 return -1;
2191         ret = sysmount(fd, afd, t_ontopath, flag, /* spec or auth */"/");
2192         free_path(p, t_ontopath);
2193         return ret;
2194 }
2195
2196 /* Unmount undoes the operation of a bind or mount.  Check out
2197  * http://plan9.bell-labs.com/magic/man2html/1/bind .  Though our mount takes an
2198  * FD, not servename (aka src_path), so it's not quite the same.
2199  *
2200  * To translate between Plan 9 and Akaros, old -> onto_path.  new -> src_path.
2201  *
2202  * For unmount, src_path / new is optional.  If set, we only unmount the
2203  * bindmount that came from src_path. */
2204 intreg_t sys_nunmount(struct proc *p, char *src_path, int src_l,
2205                       char *onto_path, int onto_l)
2206 {
2207         int ret;
2208         char *t_ontopath, *t_srcpath;
2209         t_ontopath = copy_in_path(p, onto_path, onto_l);
2210         if (t_ontopath == NULL)
2211                 return -1;
2212         if (src_path) {
2213                 t_srcpath = copy_in_path(p, src_path, src_l);
2214                 if (t_srcpath == NULL) {
2215                         free_path(p, t_ontopath);
2216                         return -1;
2217                 }
2218         } else {
2219                 t_srcpath = 0;
2220         }
2221         ret = sysunmount(t_srcpath, t_ontopath);
2222         free_path(p, t_ontopath);
2223         free_path(p, t_srcpath);        /* you can free a null path */
2224         return ret;
2225 }
2226
2227 intreg_t sys_fd2path(struct proc *p, int fd, void *u_buf, size_t len)
2228 {
2229         int ret = 0;
2230         struct chan *ch;
2231         ERRSTACK(1);
2232         /* UMEM: Check the range, can PF later and kill if the page isn't present */
2233         if (!is_user_rwaddr(u_buf, len)) {
2234                 printk("[kernel] bad user addr %p (+%p) in %s (user bug)\n", u_buf,
2235                        len, __FUNCTION__);
2236                 return -1;
2237         }
2238         /* fdtochan throws */
2239         if (waserror()) {
2240                 poperror();
2241                 return -1;
2242         }
2243         ch = fdtochan(&current->open_files, fd, -1, FALSE, TRUE);
2244         if (snprintf(u_buf, len, "%s", channame(ch)) >= len) {
2245                 set_error(ERANGE, "fd2path buf too small, needed %d", ret);
2246                 ret = -1;
2247         }
2248         cclose(ch);
2249         poperror();
2250         return ret;
2251 }
2252
2253 intreg_t sys_wstat(struct proc *p, char *path, size_t path_l,
2254                    uint8_t *stat_m, size_t stat_sz, int flags)
2255 {
2256         int retval = 0;
2257         char *t_path = copy_in_path(p, path, path_l);
2258
2259         if (!t_path)
2260                 return -1;
2261         retval = syswstat(t_path, stat_m, stat_sz);
2262         free_path(p, t_path);
2263         return retval;
2264 }
2265
2266 intreg_t sys_fwstat(struct proc *p, int fd, uint8_t *stat_m, size_t stat_sz,
2267                     int flags)
2268 {
2269         return sysfwstat(fd, stat_m, stat_sz);
2270 }
2271
2272 intreg_t sys_rename(struct proc *p, char *old_path, size_t old_path_l,
2273                     char *new_path, size_t new_path_l)
2274 {
2275         char *from_path = copy_in_path(p, old_path, old_path_l);
2276         char *to_path = copy_in_path(p, new_path, new_path_l);
2277         int ret;
2278
2279         if ((!from_path) || (!to_path))
2280                 return -1;
2281         ret = sysrename(from_path, to_path);
2282         free_path(p, from_path);
2283         free_path(p, to_path);
2284         return ret;
2285 }
2286
2287 /* Careful: if an FD is busy, we don't close the old object, it just fails */
2288 static intreg_t sys_dup_fds_to(struct proc *p, unsigned int pid,
2289                                struct childfdmap *map, unsigned int nentries)
2290 {
2291         ssize_t ret = 0;
2292         struct proc *child;
2293         int slot;
2294
2295         if (!is_user_rwaddr(map, sizeof(struct childfdmap) * nentries)) {
2296                 set_errno(EINVAL);
2297                 return -1;
2298         }
2299         child = get_controllable_proc(p, pid);
2300         if (!child)
2301                 return -1;
2302         for (int i = 0; i < nentries; i++) {
2303                 map[i].ok = -1;
2304                 if (!sys_dup_to(p, map[i].parentfd, child, map[i].childfd)) {
2305                         map[i].ok = 0;
2306                         ret++;
2307                         continue;
2308                 }
2309                 /* probably a bug, could send EBADF, maybe via 'ok' */
2310                 printk("[kernel] dup_fds_to: couldn't find %d\n", map[i].parentfd);
2311         }
2312         proc_decref(child);
2313         return ret;
2314 }
2315
2316 /* 0 on success, anything else is an error, with errno/errstr set */
2317 static int handle_tap_req(struct proc *p, struct fd_tap_req *req)
2318 {
2319         switch (req->cmd) {
2320                 case (FDTAP_CMD_ADD):
2321                         return add_fd_tap(p, req);
2322                 case (FDTAP_CMD_REM):
2323                         return remove_fd_tap(p, req->fd);
2324                 default:
2325                         set_error(ENOSYS, "FD Tap Command %d not supported", req->cmd);
2326                         return -1;
2327         }
2328 }
2329
2330 /* Processes up to nr_reqs tap requests.  If a request errors out, we stop
2331  * immediately.  Returns the number processed.  If done != nr_reqs, check errno
2332  * and errstr for the last failure, which is for tap_reqs[done]. */
2333 static intreg_t sys_tap_fds(struct proc *p, struct fd_tap_req *tap_reqs,
2334                             size_t nr_reqs)
2335 {
2336         struct fd_tap_req *req_i = tap_reqs;
2337         int done;
2338         if (!is_user_rwaddr(tap_reqs, sizeof(struct fd_tap_req) * nr_reqs)) {
2339                 set_errno(EINVAL);
2340                 return 0;
2341         }
2342         for (done = 0; done < nr_reqs; done++, req_i++) {
2343                 if (handle_tap_req(p, req_i))
2344                         break;
2345         }
2346         return done;
2347 }
2348
2349 /************** Syscall Invokation **************/
2350
2351 const struct sys_table_entry syscall_table[] = {
2352         [SYS_null] = {(syscall_t)sys_null, "null"},
2353         [SYS_block] = {(syscall_t)sys_block, "block"},
2354         [SYS_cache_invalidate] = {(syscall_t)sys_cache_invalidate, "wbinv"},
2355         [SYS_reboot] = {(syscall_t)reboot, "reboot!"},
2356         [SYS_getpcoreid] = {(syscall_t)sys_getpcoreid, "getpcoreid"},
2357         [SYS_getvcoreid] = {(syscall_t)sys_getvcoreid, "getvcoreid"},
2358         [SYS_proc_create] = {(syscall_t)sys_proc_create, "proc_create"},
2359         [SYS_proc_run] = {(syscall_t)sys_proc_run, "proc_run"},
2360         [SYS_proc_destroy] = {(syscall_t)sys_proc_destroy, "proc_destroy"},
2361         [SYS_proc_yield] = {(syscall_t)sys_proc_yield, "proc_yield"},
2362         [SYS_change_vcore] = {(syscall_t)sys_change_vcore, "change_vcore"},
2363         [SYS_fork] = {(syscall_t)sys_fork, "fork"},
2364         [SYS_exec] = {(syscall_t)sys_exec, "exec"},
2365         [SYS_waitpid] = {(syscall_t)sys_waitpid, "waitpid"},
2366         [SYS_mmap] = {(syscall_t)sys_mmap, "mmap"},
2367         [SYS_munmap] = {(syscall_t)sys_munmap, "munmap"},
2368         [SYS_mprotect] = {(syscall_t)sys_mprotect, "mprotect"},
2369         [SYS_shared_page_alloc] = {(syscall_t)sys_shared_page_alloc, "pa"},
2370         [SYS_shared_page_free] = {(syscall_t)sys_shared_page_free, "pf"},
2371         [SYS_provision] = {(syscall_t)sys_provision, "provision"},
2372         [SYS_notify] = {(syscall_t)sys_notify, "notify"},
2373         [SYS_self_notify] = {(syscall_t)sys_self_notify, "self_notify"},
2374         [SYS_send_event] = {(syscall_t)sys_send_event, "send_event"},
2375         [SYS_vc_entry] = {(syscall_t)sys_vc_entry, "vc_entry"},
2376         [SYS_halt_core] = {(syscall_t)sys_halt_core, "halt_core"},
2377 #ifdef CONFIG_ARSC_SERVER
2378         [SYS_init_arsc] = {(syscall_t)sys_init_arsc, "init_arsc"},
2379 #endif
2380         [SYS_change_to_m] = {(syscall_t)sys_change_to_m, "change_to_m"},
2381         [SYS_vmm_add_gpcs] = {(syscall_t)sys_vmm_add_gpcs, "vmm_add_gpcs"},
2382         [SYS_vmm_poke_guest] = {(syscall_t)sys_vmm_poke_guest, "vmm_poke_guest"},
2383         [SYS_vmm_ctl] = {(syscall_t)sys_vmm_ctl, "vmm_ctl"},
2384         [SYS_poke_ksched] = {(syscall_t)sys_poke_ksched, "poke_ksched"},
2385         [SYS_abort_sysc] = {(syscall_t)sys_abort_sysc, "abort_sysc"},
2386         [SYS_abort_sysc_fd] = {(syscall_t)sys_abort_sysc_fd, "abort_sysc_fd"},
2387         [SYS_populate_va] = {(syscall_t)sys_populate_va, "populate_va"},
2388         [SYS_nanosleep] = {(syscall_t)sys_nanosleep, "nanosleep"},
2389         [SYS_pop_ctx] = {(syscall_t)sys_pop_ctx, "pop_ctx"},
2390
2391         [SYS_read] = {(syscall_t)sys_read, "read"},
2392         [SYS_write] = {(syscall_t)sys_write, "write"},
2393         [SYS_openat] = {(syscall_t)sys_openat, "openat"},
2394         [SYS_close] = {(syscall_t)sys_close, "close"},
2395         [SYS_fstat] = {(syscall_t)sys_fstat, "fstat"},
2396         [SYS_stat] = {(syscall_t)sys_stat, "stat"},
2397         [SYS_lstat] = {(syscall_t)sys_lstat, "lstat"},
2398         [SYS_fcntl] = {(syscall_t)sys_fcntl, "fcntl"},
2399         [SYS_access] = {(syscall_t)sys_access, "access"},
2400         [SYS_umask] = {(syscall_t)sys_umask, "umask"},
2401         [SYS_llseek] = {(syscall_t)sys_llseek, "llseek"},
2402         [SYS_link] = {(syscall_t)sys_link, "link"},
2403         [SYS_unlink] = {(syscall_t)sys_unlink, "unlink"},
2404         [SYS_symlink] = {(syscall_t)sys_symlink, "symlink"},
2405         [SYS_readlink] = {(syscall_t)sys_readlink, "readlink"},
2406         [SYS_chdir] = {(syscall_t)sys_chdir, "chdir"},
2407         [SYS_fchdir] = {(syscall_t)sys_fchdir, "fchdir"},
2408         [SYS_getcwd] = {(syscall_t)sys_getcwd, "getcwd"},
2409         [SYS_mkdir] = {(syscall_t)sys_mkdir, "mkdir"},
2410         [SYS_rmdir] = {(syscall_t)sys_rmdir, "rmdir"},
2411         [SYS_tcgetattr] = {(syscall_t)sys_tcgetattr, "tcgetattr"},
2412         [SYS_tcsetattr] = {(syscall_t)sys_tcsetattr, "tcsetattr"},
2413         [SYS_setuid] = {(syscall_t)sys_setuid, "setuid"},
2414         [SYS_setgid] = {(syscall_t)sys_setgid, "setgid"},
2415         /* special! */
2416         [SYS_nbind] ={(syscall_t)sys_nbind, "nbind"},
2417         [SYS_nmount] ={(syscall_t)sys_nmount, "nmount"},
2418         [SYS_nunmount] ={(syscall_t)sys_nunmount, "nunmount"},
2419         [SYS_fd2path] ={(syscall_t)sys_fd2path, "fd2path"},
2420         [SYS_wstat] ={(syscall_t)sys_wstat, "wstat"},
2421         [SYS_fwstat] ={(syscall_t)sys_fwstat, "fwstat"},
2422         [SYS_rename] ={(syscall_t)sys_rename, "rename"},
2423         [SYS_dup_fds_to] = {(syscall_t)sys_dup_fds_to, "dup_fds_to"},
2424         [SYS_tap_fds] = {(syscall_t)sys_tap_fds, "tap_fds"},
2425 };
2426 const int max_syscall = sizeof(syscall_table)/sizeof(syscall_table[0]);
2427
2428 /* Executes the given syscall.
2429  *
2430  * Note tf is passed in, which points to the tf of the context on the kernel
2431  * stack.  If any syscall needs to block, it needs to save this info, as well as
2432  * any silly state.
2433  *
2434  * This syscall function is used by both local syscall and arsc, and should
2435  * remain oblivious of the caller. */
2436 intreg_t syscall(struct proc *p, uintreg_t sc_num, uintreg_t a0, uintreg_t a1,
2437                  uintreg_t a2, uintreg_t a3, uintreg_t a4, uintreg_t a5)
2438 {
2439         intreg_t ret = -1;
2440         ERRSTACK(1);
2441
2442         if (sc_num > max_syscall || syscall_table[sc_num].call == NULL) {
2443                 printk("[kernel] Invalid syscall %d for proc %d\n", sc_num, p->pid);
2444                 printk("\tArgs: %p, %p, %p, %p, %p, %p\n", a0, a1, a2, a3, a4, a5);
2445                 print_user_ctx(this_pcpui_var(cur_ctx));
2446                 return -1;
2447         }
2448
2449         /* N.B. This is going away. */
2450         if (waserror()){
2451                 printk("Plan 9 system call returned via waserror()\n");
2452                 printk("String: '%s'\n", current_errstr());
2453                 /* if we got here, then the errbuf was right.
2454                  * no need to check!
2455                  */
2456                 return -1;
2457         }
2458         //printd("before syscall errstack %p\n", errstack);
2459         //printd("before syscall errstack base %p\n", get_cur_errbuf());
2460         ret = syscall_table[sc_num].call(p, a0, a1, a2, a3, a4, a5);
2461         //printd("after syscall errstack base %p\n", get_cur_errbuf());
2462         if (get_cur_errbuf() != &errstack[0]) {
2463                 /* Can't trust coreid and vcoreid anymore, need to check the trace */
2464                 printk("[%16llu] Syscall %3d (%12s):(%p, %p, %p, %p, "
2465                        "%p, %p) proc: %d\n", read_tsc(),
2466                        sc_num, syscall_table[sc_num].name, a0, a1, a2, a3,
2467                        a4, a5, p->pid);
2468                 if (sc_num != SYS_fork)
2469                         panic("errstack mismatch");
2470         }
2471         return ret;
2472 }
2473
2474 /* Execute the syscall on the local core */
2475 void run_local_syscall(struct syscall *sysc)
2476 {
2477         struct per_cpu_info *pcpui = this_pcpui_ptr();
2478         struct proc *p = pcpui->cur_proc;
2479         long retval;
2480
2481         /* In lieu of pinning, we just check the sysc and will PF on the user addr
2482          * later (if the addr was unmapped).  Which is the plan for all UMEM. */
2483         if (!is_user_rwaddr(sysc, sizeof(struct syscall))) {
2484                 printk("[kernel] bad user addr %p (+%p) in %s (user bug)\n", sysc,
2485                        sizeof(struct syscall), __FUNCTION__);
2486                 return;
2487         }
2488         pcpui->cur_kthread->sysc = sysc;        /* let the core know which sysc it is */
2489         unset_errno();
2490         systrace_start_trace(pcpui->cur_kthread, sysc);
2491         pcpui = this_pcpui_ptr();       /* reload again */
2492         alloc_sysc_str(pcpui->cur_kthread);
2493         /* syscall() does not return for exec and yield, so put any cleanup in there
2494          * too. */
2495         retval = syscall(pcpui->cur_proc, sysc->num, sysc->arg0, sysc->arg1,
2496                          sysc->arg2, sysc->arg3, sysc->arg4, sysc->arg5);
2497         finish_current_sysc(retval);
2498 }
2499
2500 /* A process can trap and call this function, which will set up the core to
2501  * handle all the syscalls.  a.k.a. "sys_debutante(needs, wants)".  If there is
2502  * at least one, it will run it directly. */
2503 void prep_syscalls(struct proc *p, struct syscall *sysc, unsigned int nr_syscs)
2504 {
2505         /* Careful with pcpui here, we could have migrated */
2506         if (!nr_syscs) {
2507                 printk("[kernel] No nr_sysc, probably a bug, user!\n");
2508                 return;
2509         }
2510         /* For all after the first call, send ourselves a KMSG (TODO). */
2511         if (nr_syscs != 1)
2512                 warn("Only one supported (Debutante calls: %d)\n", nr_syscs);
2513         /* Call the first one directly.  (we already checked to make sure there is
2514          * 1) */
2515         run_local_syscall(sysc);
2516 }
2517
2518 /* Call this when something happens on the syscall where userspace might want to
2519  * get signaled.  Passing p, since the caller should know who the syscall
2520  * belongs to (probably is current).
2521  *
2522  * You need to have SC_K_LOCK set when you call this. */
2523 void __signal_syscall(struct syscall *sysc, struct proc *p)
2524 {
2525         struct event_queue *ev_q;
2526         struct event_msg local_msg;
2527         /* User sets the ev_q then atomically sets the flag (races with SC_DONE) */
2528         if (atomic_read(&sysc->flags) & SC_UEVENT) {
2529                 rmb();  /* read the ev_q after reading the flag */
2530                 ev_q = sysc->ev_q;
2531                 if (ev_q) {
2532                         memset(&local_msg, 0, sizeof(struct event_msg));
2533                         local_msg.ev_type = EV_SYSCALL;
2534                         local_msg.ev_arg3 = sysc;
2535                         send_event(p, ev_q, &local_msg, 0);
2536                 }
2537         }
2538 }
2539
2540 bool syscall_uses_fd(struct syscall *sysc, int fd)
2541 {
2542         switch (sysc->num) {
2543                 case (SYS_read):
2544                 case (SYS_write):
2545                 case (SYS_close):
2546                 case (SYS_fstat):
2547                 case (SYS_fcntl):
2548                 case (SYS_llseek):
2549                 case (SYS_nmount):
2550                 case (SYS_fd2path):
2551                         if (sysc->arg0 == fd)
2552                                 return TRUE;
2553                         return FALSE;
2554                 case (SYS_mmap):
2555                         /* mmap always has to be special. =) */
2556                         if (sysc->arg4 == fd)
2557                                 return TRUE;
2558                         return FALSE;
2559                 default:
2560                         return FALSE;
2561         }
2562 }
2563
2564 void print_sysc(struct proc *p, struct syscall *sysc)
2565 {
2566         uintptr_t old_p = switch_to(p);
2567         printk("SYS_%d, flags %p, a0 %p, a1 %p, a2 %p, a3 %p, a4 %p, a5 %p\n",
2568                sysc->num, atomic_read(&sysc->flags),
2569                sysc->arg0, sysc->arg1, sysc->arg2, sysc->arg3, sysc->arg4,
2570                sysc->arg5);
2571         switch_back(p, old_p);
2572 }
2573
2574 /* Called when we try to return from a panic. */
2575 void kth_panic_sysc(struct kthread *kth)
2576 {
2577         kth->sysc = NULL;
2578         /* We actually could block here, but that might be OK, since we cleared
2579          * cur_kthread->sysc.  As OK as anything is after a panic... */
2580         systrace_finish_trace(kth, -12345);
2581 }