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