parlib: Add __uth_sync_swap and __uth_sync_is_empty
[akaros.git] / user / parlib / signal.c
1 /* Copyright (c) 2013 The Regents of the University of California
2  * Barret Rhoden <brho@cs.berkeley.edu>
3  * Kevin Klues <klueska@cs.berkeley.edu>
4  * See LICENSE for details.
5  *
6  * POSIX signal handling glue.  All glibc programs link against parlib, so they
7  * will get this mixed in.  Mostly just registration of signal handlers.
8  *
9  * POSIX signal handling caveats:
10  *      - We don't copy signal handling tables or anything across forks or execs
11  *      - We don't send meaningful info in the siginfos, nor do we pass pid/uids on
12  *      signals coming from a kill.  This is especially pertinent for sigqueue,
13  *      which needs a payload (value) and sending PID
14  *      - We run handlers in vcore context, so any blocking syscall will spin.
15  *      Regular signals have restrictions on their syscalls too, though not this
16  *      great.  We could spawn off a uthread to run the handler, given that we have
17  *      a 2LS (which we don't for SCPs).
18  *      - We don't do anything with signal blocking/masking.  When in a signal
19  *      handler, you won't get interrupted with another signal handler (so long as
20  *      you run it in vcore context!).  With uthreads, you could get interrupted.
21  *      There is also no process wide signal blocking yet (sigprocmask()).  If this
22  *      is desired, we can abort certain signals when we h_p_signal(), 
23  *      - Likewise, we don't do waiting for particular signals yet.  Just about the
24  *      only thing we do is allow the registration of signal handlers. 
25  *      - Check each function for further notes.  */
26
27 // Needed for sigmask functions...
28 #define _GNU_SOURCE
29
30 #include <stdio.h>
31 #include <parlib/parlib.h>
32 #include <parlib/signal.h>
33 #include <parlib/uthread.h>
34 #include <parlib/event.h>
35 #include <parlib/ros_debug.h>
36 #include <errno.h>
37 #include <parlib/assert.h>
38 #include <ros/procinfo.h>
39 #include <ros/syscall.h>
40 #include <sys/mman.h>
41 #include <parlib/stdio.h>
42
43 /* Forward declare our signal_ops functions. */
44 static int __sigaltstack(__const struct sigaltstack *__restrict __ss,
45                          struct sigaltstack *__restrict __oss);
46 static int __siginterrupt(int __sig, int __interrupt);
47 static int __sigpending(sigset_t *__set);
48 static int __sigprocmask(int __how, __const sigset_t *__restrict __set,
49                          sigset_t *__restrict __oset);
50 static int __sigqueue(__pid_t __pid, int __sig, __const union sigval __val);
51 static int __sigreturn(struct sigcontext *__scp);
52 static int __sigstack(struct sigstack *__ss, struct sigstack *__oss);
53 static int __sigsuspend(__const sigset_t *__set);
54 static int __sigtimedwait(__const sigset_t *__restrict __set,
55                           siginfo_t *__restrict __info,
56                           __const struct timespec *__restrict __timeout);
57 static int __sigwait(__const sigset_t *__restrict __set, int *__restrict __sig);
58 static int __sigwaitinfo(__const sigset_t *__restrict __set,
59                          siginfo_t *__restrict __info);
60 static int __sigself(int signo);
61
62 /* The default definition of signal_ops (similar to sched_ops in uthread.c) */
63 struct signal_ops default_signal_ops = {
64         .sigaltstack = __sigaltstack,
65         .siginterrupt = __siginterrupt,
66         .sigpending = __sigpending,
67         .sigprocmask = __sigprocmask,
68         .sigqueue = __sigqueue,
69         .sigreturn = __sigreturn,
70         .sigstack = __sigstack,
71         .sigsuspend = __sigsuspend,
72         .sigtimedwait = __sigtimedwait,
73         .sigwait = __sigwait,
74         .sigwaitinfo = __sigwaitinfo,
75         .sigself = __sigself
76 };
77
78 /* This is the catch all akaros event->posix signal handler.  All posix signals
79  * are received in a single akaros event type.  They are then dispatched from
80  * this function to their proper posix signal handler */
81 static void handle_event(struct event_msg *ev_msg, unsigned int ev_type,
82                          void *data)
83 {
84         int sig_nr;
85         struct siginfo info = {0};
86         info.si_code = SI_USER;
87         struct user_context fake_uctx;
88
89         assert(ev_msg);
90         sig_nr = ev_msg->ev_arg1;
91         /* We're handling a process-wide signal, but signal handlers will want a
92          * user context.  They operate on the model that some thread got the signal,
93          * but that didn't happen on Akaros.  If we happen to have a current
94          * uthread, we can use that - perhaps that's what the user wants.  If not,
95          * we'll build a fake one representing our current call stack. */
96         if (current_uthread) {
97                 trigger_posix_signal(sig_nr, &info, get_cur_uth_ctx());
98         } else {
99                 init_user_ctx(&fake_uctx, (uintptr_t)handle_event, get_stack_pointer());
100                 trigger_posix_signal(sig_nr, &info, &fake_uctx);
101         }
102 }
103
104 /* Called from uthread_slim_init() */
105 void init_posix_signals(void)
106 {
107         struct event_queue *posix_sig_ev_q;
108
109         signal_ops = &default_signal_ops;
110         register_ev_handler(EV_POSIX_SIGNAL, handle_event, 0);
111         posix_sig_ev_q = get_eventq(EV_MBOX_UCQ);
112         assert(posix_sig_ev_q);
113         posix_sig_ev_q->ev_flags = EVENT_IPI | EVENT_INDIR | EVENT_SPAM_INDIR |
114                                    EVENT_WAKEUP;
115         register_kevent_q(posix_sig_ev_q, EV_POSIX_SIGNAL);
116 }
117
118 /* Swap the contents of two user contexts (not just their pointers). */
119 static void swap_user_contexts(struct user_context *c1, struct user_context *c2)
120 {
121         struct user_context temp_ctx;
122
123         temp_ctx = *c1;
124         *c1 = *c2;
125         *c2 = temp_ctx;
126 }
127
128 /* Helper for checking a stack pointer.  It's possible the context we're
129  * injecting signals into is complete garbage, so using the SP is a little
130  * dangerous. */
131 static bool stack_ptr_is_sane(uintptr_t sp)
132 {
133         if ((sp < PGSIZE) || (sp > ULIM))
134                 return FALSE;
135         return TRUE;
136 }
137
138 static bool uth_is_handling_sigs(struct uthread *uth)
139 {
140         return uth->sigstate.data ? TRUE : FALSE;
141 }
142
143 /* Prep a uthread to run a signal handler.  The original context of the uthread
144  * is saved on its stack, and a new context is set up to run the signal handler
145  * the next time the uthread is run. */
146 static void __prep_sighandler(struct uthread *uthread,
147                               void (*entry)(void),
148                               struct siginfo *info)
149 {
150         uintptr_t stack;
151         struct user_context *ctx;
152
153         if (uthread->flags & UTHREAD_SAVED) {
154                 ctx = &uthread->u_ctx;
155                 stack = get_user_ctx_sp(ctx) - sizeof(struct sigdata);
156                 assert(stack_ptr_is_sane(stack));
157                 uthread->sigstate.data = (struct sigdata*)stack;
158                 if (uthread->flags & UTHREAD_FPSAVED) {
159                         uthread->sigstate.data->as = uthread->as;
160                         uthread->flags &= ~UTHREAD_FPSAVED;
161                 }
162         } else {
163                 assert(current_uthread == uthread);
164                 ctx = &vcpd_of(vcore_id())->uthread_ctx;
165                 stack = get_user_ctx_sp(ctx) - sizeof(struct sigdata);
166                 stack = ROUNDDOWN(stack, __alignof__(struct sigdata));
167                 assert(stack_ptr_is_sane(stack));
168                 uthread->sigstate.data = (struct sigdata*)stack;
169                 save_fp_state(&uthread->sigstate.data->as);
170         }
171         if (info != NULL)
172                 uthread->sigstate.data->info = *info;
173
174         init_user_ctx(&uthread->sigstate.data->u_ctx, (uintptr_t)entry, stack);
175         swap_user_contexts(ctx, &uthread->sigstate.data->u_ctx);
176 }
177
178 /* Restore the context saved as the result of running a signal handler on a
179  * uthread. This context will execute the next time the uthread is run. */
180 static void __restore_after_sighandler(struct uthread *uthread)
181 {
182         uthread->u_ctx = uthread->sigstate.data->u_ctx;
183         uthread->flags |= UTHREAD_SAVED;
184         switch (uthread->u_ctx.type) {
185         case ROS_HW_CTX:
186         case ROS_VM_CTX:
187                 uthread->as = uthread->sigstate.data->as;
188                 uthread->flags |= UTHREAD_FPSAVED;
189                 break;
190         }
191         uthread->sigstate.data = NULL;
192 }
193
194 /* Callback when yielding a pthread after upon completion of a sighandler.  We
195  * didn't save the current context on yeild, but that's ok because here we
196  * restore the original saved context of the pthread and then treat this like a
197  * normal voluntary yield. */
198 static void __exit_sighandler_cb(struct uthread *uthread, void *junk)
199 {
200         __restore_after_sighandler(uthread);
201         uthread_paused(uthread);
202 }
203
204 /* Run a specific sighandler from the top of the sigstate stack. The 'info'
205  * struct is prepopulated before the call is triggered as the result of a
206  * reflected fault. */
207 static void __run_sighandler(void)
208 {
209         struct uthread *uthread = current_uthread;
210         int signo = uthread->sigstate.data->info.si_signo;
211
212         __sigdelset(&uthread->sigstate.pending, signo);
213         trigger_posix_signal(signo, &uthread->sigstate.data->info,
214                              &uthread->sigstate.data->u_ctx);
215         uthread_yield(FALSE, __exit_sighandler_cb, 0);
216 }
217
218 /* Run through all pending sighandlers and trigger them with a NULL info
219  * field. These handlers are triggered as the result of thread directed
220  * signals (i.e. not interprocess signals), and thus don't require individual
221  * 'info' structs. */
222 static void __run_all_sighandlers(void)
223 {
224         struct uthread *uthread = current_uthread;
225         sigset_t andset = uthread->sigstate.pending & (~uthread->sigstate.mask);
226
227         for (int i = 1; i < _NSIG; i++) {
228                 if (__sigismember(&andset, i)) {
229                         __sigdelset(&uthread->sigstate.pending, i);
230                         trigger_posix_signal(i, NULL, &uthread->sigstate.data->u_ctx);
231                 }
232         }
233         uthread_yield(FALSE, __exit_sighandler_cb, 0);
234 }
235
236 int uthread_signal(struct uthread *uthread, int signo)
237 {
238         // Slightly racy with clearing of mask when triggering the signal, but
239         // that's OK, as signals are inherently racy since they don't queue up.
240         return sigaddset(&uthread->sigstate.pending, signo);
241 }
242
243 /* If there are any pending signals, prep the uthread to run it's signal
244  * handler. The next time the uthread is run, it will pop into it's signal
245  * handler context instead of its original saved context. Once the signal
246  * handler is complete, the original context will be restored and restarted. */
247 void uthread_prep_pending_signals(struct uthread *uthread)
248 {
249         if (!uth_is_handling_sigs(uthread) && uthread->sigstate.pending) {
250                 sigset_t andset = uthread->sigstate.pending & (~uthread->sigstate.mask);
251
252                 if (!__sigisemptyset(&andset))
253                         __prep_sighandler(uthread, __run_all_sighandlers, NULL);
254         }
255 }
256
257 /* If the given signal is unmasked, prep the uthread to run it's signal
258  * handler, but don't run it yet. In either case, make the uthread runnable
259  * again. Once the signal handler is complete, the original context will be
260  * restored and restarted. */
261 void uthread_prep_signal_from_fault(struct uthread *uthread,
262                                     int signo, int code, void *addr)
263 {
264         if (!__sigismember(&uthread->sigstate.mask, signo)) {
265                 struct siginfo info = {0};
266
267                 if (uth_is_handling_sigs(uthread)) {
268                         printf("Uthread sighandler faulted, signal: %d\n", signo);
269                         /* uthread.c already copied out the faulting ctx into the uth */
270                         print_user_context(&uthread->u_ctx);
271                         exit(-1);
272                 }
273                 info.si_signo = signo;
274                 info.si_code = code;
275                 info.si_addr = addr;
276                 __prep_sighandler(uthread, __run_sighandler, &info);
277         }
278 }
279
280 /* This is managed by vcore / 2LS code */
281 static int __sigaltstack(__const struct sigaltstack *__restrict __ss,
282                          struct sigaltstack *__restrict __oss)
283 {
284         return 0;
285 }
286
287 /* Akaros can't have signals interrupt syscalls to need a restart, though we can
288  * re-wake-up the process while it is waiting for its syscall. */
289 static int __siginterrupt(int __sig, int __interrupt)
290 {
291         return 0;
292 }
293
294 /* Not really possible or relevant - you'd need to walk/examine the event UCQ */
295 static int __sigpending(sigset_t *__set)
296 {
297         return 0;
298 }
299
300 static int __sigprocmask(int __how, __const sigset_t *__restrict __set,
301                          sigset_t *__restrict __oset)
302 {
303         sigset_t *sigmask;
304
305         /* Signal handlers might call sigprocmask, with the intent of affecting the
306          * uthread's sigmask.  Process-wide signal handlers run on behalf of the
307          * entire process and aren't bound to a uthread, which means sigprocmask
308          * won't work.  We can tell we're running one of these handlers since we are
309          * in vcore context.  Uthread signals (e.g. pthread_kill()) run from uthread
310          * context. */
311         if (in_vcore_context()) {
312                 errno = ENOENT;
313                 return -1;
314         }
315
316         sigmask = &current_uthread->sigstate.mask;
317
318         if (__set && (__how != SIG_BLOCK) &&
319                      (__how != SIG_SETMASK) &&
320                      (__how != SIG_UNBLOCK)) {
321                 errno = EINVAL;
322                 return -1;
323         }
324
325         if (__oset)
326                 *__oset = *sigmask;
327         if (__set) {
328                 switch (__how) {
329                         case SIG_BLOCK:
330                                 *sigmask = *sigmask | *__set;
331                                 break;
332                         case SIG_SETMASK:
333                                 *sigmask = *__set;
334                                 break;
335                         case SIG_UNBLOCK:
336                                 *sigmask = *sigmask & ~(*__set);
337                                 break;
338                 }
339         }
340         return 0;
341 }
342
343 /* Needs support with trigger_posix_signal to deal with passing values with
344  * POSIX signals. */
345 static int __sigqueue(__pid_t __pid, int __sig, __const union sigval __val)
346 {
347         return 0;
348 }
349
350 /* Linux specific, and not really needed for us */
351 static int __sigreturn(struct sigcontext *__scp)
352 {
353         return 0;
354 }
355
356 /* This is managed by vcore / 2LS code */
357 static int __sigstack(struct sigstack *__ss, struct sigstack *__oss)
358 {
359         return 0;
360 }
361
362 /* Could do this with a loop on delivery of the signal, sleeping and getting
363  * woken up by the kernel on any event, like we do with async syscalls. */
364 static int __sigsuspend(__const sigset_t *__set)
365 {
366         return 0;
367 }
368
369 /* Can be done similar to sigsuspend, with an extra alarm syscall */
370 static int __sigtimedwait(__const sigset_t *__restrict __set,
371                           siginfo_t *__restrict __info,
372                           __const struct timespec *__restrict __timeout)
373 {
374         return 0;
375 }
376
377 /* Can be done similar to sigsuspend */
378 static int __sigwait(__const sigset_t *__restrict __set, int *__restrict __sig)
379 {
380         return 0;
381 }
382
383 /* Can be done similar to sigsuspend */
384 static int __sigwaitinfo(__const sigset_t *__restrict __set,
385                          siginfo_t *__restrict __info)
386 {
387         return 0;
388 }
389
390 static int __sigself(int signo)
391 {
392         int ret;
393
394         if (in_vcore_context())
395                 return kill(getpid(), signo);
396
397         ret = uthread_signal(current_uthread, signo);
398
399         void cb(struct uthread *uthread, void *arg)
400         {
401                 uthread_paused(uthread);
402         }
403         if (ret == 0)
404                 uthread_yield(TRUE, cb, 0);
405         return ret;
406 }