Redesign of our initialization path for libs (XCC)
[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 #include <signal.h>
28 #include <stdio.h>
29
30 #include <parlib/parlib.h>
31 #include <parlib/event.h>
32 #include <errno.h>
33 #include <assert.h>
34 #include <ros/procinfo.h>
35 #include <ros/syscall.h>
36 #include <sys/mman.h>
37 #include <parlib/vcore.h> /* for print_user_context() */
38 #include <parlib/waitfreelist.h>
39
40 /* This is list of sigactions associated with each posix signal. */
41 static struct sigaction sigactions[_NSIG];
42
43 /* Forward declare some functions. */
44 static int __sigprocmask(int __how, __const sigset_t *__restrict __set,
45                          sigset_t *__restrict __oset);
46
47 /* The default definition of signal_ops (similar to sched_ops in uthread.c) */
48 struct signal_ops default_signal_ops = {
49         .sigprocmask = __sigprocmask,
50 };
51 struct signal_ops *signal_ops = &default_signal_ops;
52
53 /* This is a wait-free-list used to hold the data necessary to execute signal
54  * handlers inside a 2LS. We are able to store them in a wfl because all
55  * sigdata structs are created equal, and reuse is encouraged as uthreads
56  * ask for them on demand. */
57 static struct wfl sigdata_list;
58 #define SIGNAL_STACK_SIZE (2*PGSIZE + sizeof(struct sigdata))
59
60 /* These are the default handlers for each posix signal.  They are listed in
61  * SIGNAL(7) of the Linux Programmer's Manual.  We run them as default
62  * sigactions, instead of the older handlers, so that we have access to the
63  * faulting context.
64  *
65  * Exit codes are set as suggested in the following link.  I wish I could find
66  * the definitive source, but this will have to do for now.
67  * http://unix.stackexchange.com/questions/99112/default-exit-code-when-process-is-terminated
68  * */
69 static void default_term_handler(int signr, siginfo_t *info, void *ctx)
70 {
71         ros_syscall(SYS_proc_destroy, __procinfo.pid, signr, 0, 0, 0, 0);
72 }
73
74 static void default_core_handler(int signr, siginfo_t *info, void *ctx)
75 {
76         fprintf(stderr, "Segmentation Fault (sorry, no core dump yet)\n");
77         print_user_context((struct user_context*)ctx);
78         if (info) {
79                 /* ghetto, we don't have access to the PF err, since we only have a few
80                  * fields available in siginfo (e.g. there's no si_trapno). */
81                 fprintf(stderr, "Fault type %d at addr %p\n", info->si_errno,
82                         info->si_addr);
83         } else {
84                 fprintf(stderr, "No fault info\n");
85         }
86         default_term_handler((1 << 7) + signr, info, ctx);
87 }
88
89 static void default_stop_handler(int signr, siginfo_t *info, void *ctx)
90 {
91         fprintf(stderr, "Stop signal received!  No support to stop yet though!\n");
92 }
93
94 static void default_cont_handler(int signr, siginfo_t *info, void *ctx)
95 {
96         fprintf(stderr, "Cont signal received!  No support to cont yet though!\n");
97 }
98
99 typedef void (*__sigacthandler_t)(int, siginfo_t *, void *);
100 #define SIGACT_ERR      ((__sigacthandler_t) -1)        /* Error return.  */
101 #define SIGACT_DFL      ((__sigacthandler_t) 0)         /* Default action.  */
102 #define SIGACT_IGN      ((__sigacthandler_t) 1)         /* Ignore signal.  */
103
104 static __sigacthandler_t default_handlers[] = {
105         [SIGHUP]    = default_term_handler, 
106         [SIGINT]    = default_term_handler, 
107         [SIGQUIT]   = default_core_handler, 
108         [SIGILL]    = default_core_handler, 
109         [SIGTRAP]   = default_core_handler, 
110         [SIGABRT]   = default_core_handler, 
111         [SIGIOT]    = default_core_handler, 
112         [SIGBUS]    = default_core_handler, 
113         [SIGFPE]    = default_core_handler, 
114         [SIGKILL]   = default_term_handler, 
115         [SIGUSR1]   = default_term_handler, 
116         [SIGSEGV]   = default_core_handler, 
117         [SIGUSR2]   = default_term_handler, 
118         [SIGPIPE]   = default_term_handler, 
119         [SIGALRM]   = default_term_handler, 
120         [SIGTERM]   = default_term_handler, 
121         [SIGSTKFLT] = default_term_handler, 
122         [SIGCHLD]   = SIGACT_IGN,
123         [SIGCONT]   = default_cont_handler, 
124         [SIGSTOP]   = default_stop_handler, 
125         [SIGTSTP]   = default_stop_handler, 
126         [SIGTTIN]   = default_stop_handler, 
127         [SIGTTOU]   = default_stop_handler, 
128         [SIGURG]    = default_term_handler, 
129         [SIGXCPU]   = SIGACT_IGN,
130         [SIGXFSZ]   = default_core_handler, 
131         [SIGVTALRM] = default_term_handler, 
132         [SIGPROF]   = default_term_handler, 
133         [SIGWINCH]  = SIGACT_IGN,
134         [SIGIO]     = default_term_handler, 
135         [SIGPWR]    = SIGACT_IGN,
136         [SIGSYS]    = default_core_handler,
137         [SIGSYS+1 ... _NSIG-1] = SIGACT_IGN
138 };
139
140 /* This function allocates a sigdata struct for use when running signal
141  * handlers inside a 2LS. The sigdata struct returned is pre-initialized with
142  * the 'stack' field pointing to a valid stack.  Space is allocated for both
143  * the sigdata struct and the stack in a single mmap call.  The sigdata struct
144  * just sits at the bottom of the stack, and its 'stack' field points just
145  * above it.  */
146 struct sigdata *alloc_sigdata()
147 {
148         struct sigdata *data = wfl_remove(&sigdata_list);
149         if (data == NULL) {
150                 void *stack = mmap(0, SIGNAL_STACK_SIZE,
151                                    PROT_READ|PROT_WRITE|PROT_EXEC,
152                                    MAP_POPULATE|MAP_ANONYMOUS, -1, 0);
153                 assert(stack != MAP_FAILED);
154                 data = stack + SIGNAL_STACK_SIZE - sizeof(struct sigdata);
155                 data->stack = data;
156         }
157         return data;
158 }
159
160 /* This function frees a previously allocated sigdata struct. */
161 void free_sigdata(struct sigdata *sigdata)
162 {
163         wfl_insert(&sigdata_list, sigdata);
164 }
165
166 /* This is the akaros posix signal trigger.  Signals are dispatched from
167  * this function to their proper posix signal handler */
168 void trigger_posix_signal(int sig_nr, struct siginfo *info, void *aux)
169 {
170         struct sigaction *action;
171         if (sig_nr >= _NSIG || sig_nr < 0)
172                 return;
173         action = &sigactions[sig_nr];
174         /* Would like a switch/case here, but they are pointers.  We can also get
175          * away with this check early since sa_handler and sa_sigaction are macros
176          * referencing the same union.  The man page isn't specific about whether or
177          * not you need to care about SA_SIGINFO when sending DFL/ERR/IGN. */
178         if (action->sa_handler == SIG_ERR)
179                 return;
180         if (action->sa_handler == SIG_IGN)
181                 return;
182         if (action->sa_handler == SIG_DFL) {
183                 if (default_handlers[sig_nr] != SIGACT_IGN)
184                         default_handlers[sig_nr](sig_nr, info, aux);
185                 return;
186         }
187
188         if (action->sa_flags & SA_SIGINFO) {
189                 /* If NULL info struct passed in, construct our own */
190                 struct siginfo s = {0};
191                 if (info == NULL)
192                         info = &s;
193                 /* Make sure the caller either already set singo in the info struct, or
194                  * if they didn't, make sure it has been zeroed out (i.e. not just some
195                  * garbage on the stack. */
196                 assert(info->si_signo == sig_nr || info->si_signo == 0);
197                 info->si_signo = sig_nr;
198                 /* TODO: consider info->pid and whatnot */
199                 /* We assume that this function follows the proper calling convention
200                  * (i.e. it wasn't written in some crazy assembly function that
201                  * trashes all its registers, i.e GO's default runtime handler) */
202                 action->sa_sigaction(sig_nr, info, aux);
203         } else {
204                 action->sa_handler(sig_nr);
205         }
206 }
207
208 /* This is the catch all akaros event->posix signal handler.  All posix signals
209  * are received in a single akaros event type.  They are then dispatched from
210  * this function to their proper posix signal handler */
211 static void handle_event(struct event_msg *ev_msg, unsigned int ev_type,
212                          void *data)
213 {
214         int sig_nr;
215         struct siginfo info = {0};
216         info.si_code = SI_USER;
217
218         assert(ev_msg);
219         sig_nr = ev_msg->ev_arg1;
220         trigger_posix_signal(sig_nr, &info, 0);
221 }
222
223 /* Called from uthread_slim_init() */
224 void init_posix_signals(void)
225 {
226         struct event_queue *posix_sig_ev_q;
227         register_ev_handler(EV_POSIX_SIGNAL, handle_event, 0);
228         posix_sig_ev_q = get_big_event_q();
229         assert(posix_sig_ev_q);
230         posix_sig_ev_q->ev_flags = EVENT_IPI | EVENT_INDIR | EVENT_FALLBACK;
231         register_kevent_q(posix_sig_ev_q, EV_POSIX_SIGNAL);
232         wfl_init(&sigdata_list);
233 }
234
235 int sigaddset(sigset_t *__set, int __signo)
236 {
237         if (__signo == 0 || __signo >= _NSIG) {
238                 errno = EINVAL;
239                 return -1;
240         }
241         __sigaddset(__set, __signo);
242         return 0;
243 }
244
245 int sigdelset(sigset_t *__set, int __signo)
246 {
247         if (__signo == 0 || __signo >= _NSIG) {
248                 errno = EINVAL;
249                 return -1;
250         }
251         __sigdelset(__set, __signo);
252         return 0;
253 }
254
255 int sigismember(__const sigset_t *__set, int __signo)
256 {
257         if (__signo == 0 || __signo >= _NSIG) {
258                 errno = EINVAL;
259                 return -1;
260         }
261         __sigismember(__set, __signo);
262         return 0;
263 }
264
265 static int __sigprocmask(int __how, __const sigset_t *__restrict __set,
266                          sigset_t *__restrict __oset)
267 {
268         printf("Function not supported generically! "
269            "Use 2LS specific function e.g. pthread_sigmask\n");
270         return 0;
271 }
272
273 int sigprocmask(int __how, __const sigset_t *__restrict __set,
274                 sigset_t *__restrict __oset)
275 {
276         return signal_ops->sigprocmask(__how, __set, __oset);
277 }
278
279 /* Could do this with a loop on delivery of the signal, sleeping and getting
280  * woken up by the kernel on any event, like we do with async syscalls. */
281 int sigsuspend(__const sigset_t *__set)
282 {
283         return 0;
284 }
285
286 int sigaction(int __sig, __const struct sigaction *__restrict __act,
287               struct sigaction *__restrict __oact)
288 {
289         if (__sig >= _NSIG || __sig < 0)
290                 return -1;
291         if (__oact) {
292                 *__oact = sigactions[__sig];
293         }
294         if (!__act)
295                 return 0;
296         sigactions[__sig] = *__act;
297         return 0;
298 }
299
300 /* Not really possible or relevant - you'd need to walk/examine the event UCQ */
301 int sigpending(sigset_t *__set)
302 {
303         return 0;
304 }
305
306 /* Can be done similar to sigsuspend */
307 int sigwait(__const sigset_t *__restrict __set, int *__restrict __sig)
308 {
309         return 0;
310 }
311
312 /* Can be done similar to sigsuspend */
313 int sigwaitinfo(__const sigset_t *__restrict __set,
314                 siginfo_t *__restrict __info)
315 {
316         return 0;
317 }
318
319 /* Can be done similar to sigsuspend, with an extra alarm syscall */
320 int sigtimedwait(__const sigset_t *__restrict __set,
321                  siginfo_t *__restrict __info,
322                  __const struct timespec *__restrict __timeout)
323 {
324         return 0;
325 }
326
327 /* Needs support with trigger_posix_signal to deal with passing values with POSIX
328  * signals. */
329 int sigqueue(__pid_t __pid, int __sig, __const union sigval __val)
330 {
331         return 0;
332 }
333
334 /* Old BSD interface, deprecated */
335 int sigvec(int __sig, __const struct sigvec *__vec, struct sigvec *__ovec)
336 {
337         return 0;
338 }
339
340 /* Linux specific, and not really needed for us */
341 int sigreturn(struct sigcontext *__scp)
342 {
343         return 0;
344 }
345
346 /* Akaros can't have signals interrupt syscalls to need a restart, though we can
347  * re-wake-up the process while it is waiting for its syscall. */
348 int siginterrupt(int __sig, int __interrupt)
349 {
350         return 0;
351 }
352
353 /* This is managed by vcore / 2LS code */
354 int sigstack(struct sigstack *__ss, struct sigstack *__oss)
355 {
356         return 0;
357 }
358
359 /* This is managed by vcore / 2LS code */
360 int sigaltstack(__const struct sigaltstack *__restrict __ss,
361                 struct sigaltstack *__restrict __oss)
362 {
363         return 0;
364 }
365
366 __sighandler_t signal(int sig, __sighandler_t handler)
367 {
368         int ret;
369         struct sigaction newsa = {0};
370         struct sigaction oldsa = {0};
371         newsa.sa_handler = handler;
372         ret = sigaction(sig, &newsa, &oldsa);
373         if (ret < 0) {
374                 errno = EINVAL;
375                 return SIG_ERR;
376         }
377         return oldsa.sa_handler;
378 }