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