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