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