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