5fd173e0df85af9d0aa120ec5ef77b0f58ed8cf9
[sbcl.git] / src / runtime / interrupt.c
1 /*
2  * interrupt-handling magic
3  */
4
5 /*
6  * This software is part of the SBCL system. See the README file for
7  * more information.
8  *
9  * This software is derived from the CMU CL system, which was
10  * written at Carnegie Mellon University and released into the
11  * public domain. The software is in the public domain and is
12  * provided with absolutely no warranty. See the COPYING and CREDITS
13  * files for more information.
14  */
15
16
17 /* As far as I can tell, what's going on here is:
18  *
19  * In the case of most signals, when Lisp asks us to handle the
20  * signal, the outermost handler (the one actually passed to UNIX) is
21  * either interrupt_handle_now(..) or maybe_now_maybe_later(..).
22  * In that case, the Lisp-level handler is stored in interrupt_handlers[..]
23  * and interrupt_low_level_handlers[..] is cleared.
24  *
25  * However, some signals need special handling, e.g.
26  *
27  * o the SIGSEGV (for e.g. Linux) or SIGBUS (for e.g. FreeBSD) used by the
28  *   garbage collector to detect violations of write protection,
29  *   because some cases of such signals (e.g. GC-related violations of
30  *   write protection) are handled at C level and never passed on to
31  *   Lisp. For such signals, we still store any Lisp-level handler
32  *   in interrupt_handlers[..], but for the outermost handle we use
33  *   the value from interrupt_low_level_handlers[..], instead of the
34  *   ordinary interrupt_handle_now(..) or interrupt_handle_later(..).
35  *
36  * o the SIGTRAP (Linux/Alpha) which Lisp code uses to handle breakpoints,
37  *   pseudo-atomic sections, and some classes of error (e.g. "function
38  *   not defined").  This never goes anywhere near the Lisp handlers at all.
39  *   See runtime/alpha-arch.c and code/signal.lisp
40  *
41  * - WHN 20000728, dan 20010128 */
42
43 #include "sbcl.h"
44
45 #include <stdio.h>
46 #include <stdlib.h>
47 #include <string.h>
48 #include <signal.h>
49 #include <sys/types.h>
50 #ifndef LISP_FEATURE_WIN32
51 #include <sys/wait.h>
52 #endif
53 #include <errno.h>
54
55 #include "runtime.h"
56 #include "arch.h"
57 #include "os.h"
58 #include "interrupt.h"
59 #include "globals.h"
60 #include "lispregs.h"
61 #include "validate.h"
62 #include "gc.h"
63 #include "alloc.h"
64 #include "dynbind.h"
65 #include "interr.h"
66 #include "genesis/fdefn.h"
67 #include "genesis/simple-fun.h"
68 #include "genesis/cons.h"
69
70 static void run_deferred_handler(struct interrupt_data *data, void *v_context);
71 #ifndef LISP_FEATURE_WIN32
72 static void store_signal_data_for_later (struct interrupt_data *data,
73                                          void *handler, int signal,
74                                          siginfo_t *info,
75                                          os_context_t *context);
76
77 void
78 sigaddset_deferrable(sigset_t *s)
79 {
80     sigaddset(s, SIGHUP);
81     sigaddset(s, SIGINT);
82     sigaddset(s, SIGQUIT);
83     sigaddset(s, SIGPIPE);
84     sigaddset(s, SIGALRM);
85     sigaddset(s, SIGURG);
86     sigaddset(s, SIGTSTP);
87     sigaddset(s, SIGCHLD);
88     sigaddset(s, SIGIO);
89 #ifndef LISP_FEATURE_HPUX
90     sigaddset(s, SIGXCPU);
91     sigaddset(s, SIGXFSZ);
92 #endif
93     sigaddset(s, SIGVTALRM);
94     sigaddset(s, SIGPROF);
95     sigaddset(s, SIGWINCH);
96
97 #if !((defined(LISP_FEATURE_DARWIN) || defined(LISP_FEATURE_FREEBSD)) && defined(LISP_FEATURE_SB_THREAD))
98     sigaddset(s, SIGUSR1);
99     sigaddset(s, SIGUSR2);
100 #endif
101
102 #ifdef LISP_FEATURE_SB_THREAD
103     sigaddset(s, SIG_INTERRUPT_THREAD);
104 #endif
105 }
106
107 void
108 sigaddset_blockable(sigset_t *s)
109 {
110     sigaddset_deferrable(s);
111 #ifdef LISP_FEATURE_SB_THREAD
112 #ifdef SIG_RESUME_FROM_GC
113     sigaddset(s, SIG_RESUME_FROM_GC);
114 #endif
115     sigaddset(s, SIG_STOP_FOR_GC);
116 #endif
117 }
118
119 /* initialized in interrupt_init */
120 static sigset_t deferrable_sigset;
121 static sigset_t blockable_sigset;
122 #endif
123
124 void
125 check_blockables_blocked_or_lose(void)
126 {
127 #if !defined(LISP_FEATURE_WIN32)
128     /* Get the current sigmask, by blocking the empty set. */
129     sigset_t empty,current;
130     int i;
131     sigemptyset(&empty);
132     thread_sigmask(SIG_BLOCK, &empty, &current);
133     for(i = 1; i < NSIG; i++) {
134         if (sigismember(&blockable_sigset, i) && !sigismember(&current, i))
135             lose("blockable signal %d not blocked\n",i);
136     }
137 #endif
138 }
139
140 void
141 unblock_gc_signals(void)
142 {
143 #ifdef LISP_FEATURE_SB_THREAD
144     sigset_t new;
145     sigemptyset(&new);
146 #if defined(SIG_RESUME_FROM_GC)
147     sigaddset(&new,SIG_RESUME_FROM_GC);
148 #endif
149     sigaddset(&new,SIG_STOP_FOR_GC);
150     thread_sigmask(SIG_UNBLOCK,&new,0);
151 #endif
152 }
153
154 inline static void
155 check_interrupts_enabled_or_lose(os_context_t *context)
156 {
157     struct thread *thread=arch_os_get_current_thread();
158     if (SymbolValue(INTERRUPTS_ENABLED,thread) == NIL)
159         lose("interrupts not enabled\n");
160     if (arch_pseudo_atomic_atomic(context))
161         lose ("in pseudo atomic section\n");
162 }
163
164 /* When we catch an internal error, should we pass it back to Lisp to
165  * be handled in a high-level way? (Early in cold init, the answer is
166  * 'no', because Lisp is still too brain-dead to handle anything.
167  * After sufficient initialization has been completed, the answer
168  * becomes 'yes'.) */
169 boolean internal_errors_enabled = 0;
170
171 #ifndef LISP_FEATURE_WIN32
172 static void (*interrupt_low_level_handlers[NSIG]) (int, siginfo_t*, void*);
173 #endif
174 union interrupt_handler interrupt_handlers[NSIG];
175
176 /* At the toplevel repl we routinely call this function.  The signal
177  * mask ought to be clear anyway most of the time, but may be non-zero
178  * if we were interrupted e.g. while waiting for a queue.  */
179
180 void
181 reset_signal_mask(void)
182 {
183 #ifndef LISP_FEATURE_WIN32
184     sigset_t new;
185     sigemptyset(&new);
186     thread_sigmask(SIG_SETMASK,&new,0);
187 #endif
188 }
189
190 void
191 block_blockable_signals(void)
192 {
193 #ifndef LISP_FEATURE_WIN32
194     thread_sigmask(SIG_BLOCK, &blockable_sigset, 0);
195 #endif
196 }
197
198 void
199 block_deferrable_signals(void)
200 {
201 #ifndef LISP_FEATURE_WIN32
202     thread_sigmask(SIG_BLOCK, &deferrable_sigset, 0);
203 #endif
204 }
205
206 \f
207 /*
208  * utility routines used by various signal handlers
209  */
210
211 static void
212 build_fake_control_stack_frames(struct thread *th,os_context_t *context)
213 {
214 #ifndef LISP_FEATURE_C_STACK_IS_CONTROL_STACK
215
216     lispobj oldcont;
217
218     /* Build a fake stack frame or frames */
219
220     current_control_frame_pointer =
221         (lispobj *)(unsigned long)
222             (*os_context_register_addr(context, reg_CSP));
223     if ((lispobj *)(unsigned long)
224             (*os_context_register_addr(context, reg_CFP))
225         == current_control_frame_pointer) {
226         /* There is a small window during call where the callee's
227          * frame isn't built yet. */
228         if (lowtag_of(*os_context_register_addr(context, reg_CODE))
229             == FUN_POINTER_LOWTAG) {
230             /* We have called, but not built the new frame, so
231              * build it for them. */
232             current_control_frame_pointer[0] =
233                 *os_context_register_addr(context, reg_OCFP);
234             current_control_frame_pointer[1] =
235                 *os_context_register_addr(context, reg_LRA);
236             current_control_frame_pointer += 8;
237             /* Build our frame on top of it. */
238             oldcont = (lispobj)(*os_context_register_addr(context, reg_CFP));
239         }
240         else {
241             /* We haven't yet called, build our frame as if the
242              * partial frame wasn't there. */
243             oldcont = (lispobj)(*os_context_register_addr(context, reg_OCFP));
244         }
245     }
246     /* We can't tell whether we are still in the caller if it had to
247      * allocate a stack frame due to stack arguments. */
248     /* This observation provoked some past CMUCL maintainer to ask
249      * "Can anything strange happen during return?" */
250     else {
251         /* normal case */
252         oldcont = (lispobj)(*os_context_register_addr(context, reg_CFP));
253     }
254
255     current_control_stack_pointer = current_control_frame_pointer + 8;
256
257     current_control_frame_pointer[0] = oldcont;
258     current_control_frame_pointer[1] = NIL;
259     current_control_frame_pointer[2] =
260         (lispobj)(*os_context_register_addr(context, reg_CODE));
261 #endif
262 }
263
264 /* Stores the context for gc to scavange and builds fake stack
265  * frames. */
266 void
267 fake_foreign_function_call(os_context_t *context)
268 {
269     int context_index;
270     struct thread *thread=arch_os_get_current_thread();
271
272     /* context_index incrementing must not be interrupted */
273     check_blockables_blocked_or_lose();
274
275     /* Get current Lisp state from context. */
276 #ifdef reg_ALLOC
277     dynamic_space_free_pointer =
278         (lispobj *)(unsigned long)
279             (*os_context_register_addr(context, reg_ALLOC));
280 /*     fprintf(stderr,"dynamic_space_free_pointer: %p\n", */
281 /*             dynamic_space_free_pointer); */
282 #if defined(LISP_FEATURE_ALPHA) || defined(LISP_FEATURE_MIPS)
283     if ((long)dynamic_space_free_pointer & 1) {
284         lose("dead in fake_foreign_function_call, context = %x\n", context);
285     }
286 #endif
287 /* why doesnt PPC and SPARC do something like this: */
288 #if defined(LISP_FEATURE_HPPA)
289     if ((long)dynamic_space_free_pointer & 4) {
290         lose("dead in fake_foreign_function_call, context = %x, d_s_f_p = %x\n", context, dynamic_space_free_pointer);
291     }
292 #endif
293 #endif
294 #ifdef reg_BSP
295     current_binding_stack_pointer =
296         (lispobj *)(unsigned long)
297             (*os_context_register_addr(context, reg_BSP));
298 #endif
299
300     build_fake_control_stack_frames(thread,context);
301
302     /* Do dynamic binding of the active interrupt context index
303      * and save the context in the context array. */
304     context_index =
305         fixnum_value(SymbolValue(FREE_INTERRUPT_CONTEXT_INDEX,thread));
306
307     if (context_index >= MAX_INTERRUPTS) {
308         lose("maximum interrupt nesting depth (%d) exceeded\n", MAX_INTERRUPTS);
309     }
310
311     bind_variable(FREE_INTERRUPT_CONTEXT_INDEX,
312                   make_fixnum(context_index + 1),thread);
313
314     thread->interrupt_contexts[context_index] = context;
315
316 #ifdef FOREIGN_FUNCTION_CALL_FLAG
317     foreign_function_call_active = 1;
318 #endif
319 }
320
321 /* blocks all blockable signals.  If you are calling from a signal handler,
322  * the usual signal mask will be restored from the context when the handler
323  * finishes.  Otherwise, be careful */
324 void
325 undo_fake_foreign_function_call(os_context_t *context)
326 {
327     struct thread *thread=arch_os_get_current_thread();
328     /* Block all blockable signals. */
329     block_blockable_signals();
330
331 #ifdef FOREIGN_FUNCTION_CALL_FLAG
332     foreign_function_call_active = 0;
333 #endif
334
335     /* Undo dynamic binding of FREE_INTERRUPT_CONTEXT_INDEX */
336     unbind(thread);
337
338 #ifdef reg_ALLOC
339     /* Put the dynamic space free pointer back into the context. */
340     *os_context_register_addr(context, reg_ALLOC) =
341         (unsigned long) dynamic_space_free_pointer
342         | (*os_context_register_addr(context, reg_ALLOC)
343            & LOWTAG_MASK);
344     /*
345       ((unsigned long)(*os_context_register_addr(context, reg_ALLOC))
346       & ~LOWTAG_MASK)
347       | ((unsigned long) dynamic_space_free_pointer & LOWTAG_MASK);
348     */
349 #endif
350 }
351
352 /* a handler for the signal caused by execution of a trap opcode
353  * signalling an internal error */
354 void
355 interrupt_internal_error(os_context_t *context, boolean continuable)
356 {
357     lispobj context_sap;
358
359     fake_foreign_function_call(context);
360
361     if (!internal_errors_enabled) {
362         describe_internal_error(context);
363         /* There's no good way to recover from an internal error
364          * before the Lisp error handling mechanism is set up. */
365         lose("internal error too early in init, can't recover\n");
366     }
367
368     /* Allocate the SAP object while the interrupts are still
369      * disabled. */
370     context_sap = alloc_sap(context);
371
372 #ifndef LISP_FEATURE_WIN32
373     thread_sigmask(SIG_SETMASK, os_context_sigmask_addr(context), 0);
374 #endif
375
376     SHOW("in interrupt_internal_error");
377 #ifdef QSHOW
378     /* Display some rudimentary debugging information about the
379      * error, so that even if the Lisp error handler gets badly
380      * confused, we have a chance to determine what's going on. */
381     describe_internal_error(context);
382 #endif
383     funcall2(StaticSymbolFunction(INTERNAL_ERROR), context_sap,
384              continuable ? T : NIL);
385
386     undo_fake_foreign_function_call(context); /* blocks signals again */
387     if (continuable)
388         arch_skip_instruction(context);
389 }
390
391 void
392 interrupt_handle_pending(os_context_t *context)
393 {
394     /* There are three ways we can get here. First, if an interrupt
395      * occurs within pseudo-atomic, it will be deferred, and we'll
396      * trap to here at the end of the pseudo-atomic block. Second, if
397      * the GC (in alloc()) decides that a GC is required, it will set
398      * *GC-PENDING* and pseudo-atomic-interrupted if not *GC-INHIBIT*,
399      * and alloc() is always called from within pseudo-atomic, and
400      * thus we end up here again. Third, when calling GC-ON or at the
401      * end of a WITHOUT-GCING, MAYBE-HANDLE-PENDING-GC will trap to
402      * here if there is a pending GC. Fourth, ahem, at the end of
403      * WITHOUT-INTERRUPTS (bar complications with nesting). */
404
405     /* Win32 only needs to handle the GC cases (for now?) */
406
407     struct thread *thread;
408
409     /* Punt if in PA section, marking it as interrupted. This can
410      * happenat least if we pick up a GC request while in a
411      * WITHOUT-GCING with an outer PA -- it is not immediately clear
412      * to me that this should/could ever happen, but better safe then
413      * sorry. --NS 2007-05-15 */
414     if (arch_pseudo_atomic_atomic(context)) {
415         arch_set_pseudo_atomic_interrupted(context);
416         return;
417     }
418
419     thread = arch_os_get_current_thread();
420
421     FSHOW_SIGNAL((stderr, "/entering interrupt_handle_pending\n"));
422
423     check_blockables_blocked_or_lose();
424
425     /* If pseudo_atomic_interrupted is set then the interrupt is going
426      * to be handled now, ergo it's safe to clear it. */
427     arch_clear_pseudo_atomic_interrupted(context);
428
429     if (SymbolValue(GC_INHIBIT,thread)==NIL) {
430 #ifdef LISP_FEATURE_SB_THREAD
431         if (SymbolValue(STOP_FOR_GC_PENDING,thread) != NIL) {
432             /* STOP_FOR_GC_PENDING and GC_PENDING are cleared by
433              * the signal handler if it actually stops us. */
434             sig_stop_for_gc_handler(SIG_STOP_FOR_GC,NULL,context);
435         } else
436 #endif
437         if (SymbolValue(GC_PENDING,thread) != NIL) {
438             /* GC_PENDING is cleared in SUB-GC, or if another thread
439              * is doing a gc already we will get a SIG_STOP_FOR_GC and
440              * that will clear it. */
441             maybe_gc(context);
442         }
443         check_blockables_blocked_or_lose();
444     }
445
446 #ifndef LISP_FEATURE_WIN32
447     /* we may be here only to do the gc stuff, if interrupts are
448      * enabled run the pending handler */
449     if (SymbolValue(INTERRUPTS_ENABLED,thread) != NIL) {
450         struct interrupt_data *data = thread->interrupt_data;
451
452         /* There may be no pending handler, because it was only a gc
453          * that had to be executed or because pseudo atomic triggered
454          * twice for a single interrupt. For the interested reader,
455          * that may happen if an interrupt hits after the interrupted
456          * flag is cleared but before pseudo-atomic is set and a
457          * pseudo atomic is interrupted in that interrupt. */
458         if (data->pending_handler) {
459
460             /* If we're here as the result of a pseudo-atomic as opposed
461              * to WITHOUT-INTERRUPTS, then INTERRUPT_PENDING is already
462              * NIL, because maybe_defer_handler sets
463              * PSEUDO_ATOMIC_INTERRUPTED only if interrupts are enabled.*/
464             SetSymbolValue(INTERRUPT_PENDING, NIL, thread);
465
466             /* restore the saved signal mask from the original signal (the
467              * one that interrupted us during the critical section) into the
468              * os_context for the signal we're currently in the handler for.
469              * This should ensure that when we return from the handler the
470              * blocked signals are unblocked */
471             sigcopyset(os_context_sigmask_addr(context), &data->pending_mask);
472
473             sigemptyset(&data->pending_mask);
474             /* This will break on sparc linux: the deferred handler really wants
475              * to be called with a void_context */
476             run_deferred_handler(data,(void *)context);
477         }
478     }
479 #endif
480 }
481 \f
482 /*
483  * the two main signal handlers:
484  *   interrupt_handle_now(..)
485  *   maybe_now_maybe_later(..)
486  *
487  * to which we have added interrupt_handle_now_handler(..).  Why?
488  * Well, mostly because the SPARC/Linux platform doesn't quite do
489  * signals the way we want them done.  The third argument in the
490  * handler isn't filled in by the kernel properly, so we fix it up
491  * ourselves in the arch_os_get_context(..) function; however, we only
492  * want to do this when we first hit the handler, and not when
493  * interrupt_handle_now(..) is being called from some other handler
494  * (when the fixup will already have been done). -- CSR, 2002-07-23
495  */
496
497 void
498 interrupt_handle_now(int signal, siginfo_t *info, os_context_t *context)
499 {
500 #ifdef FOREIGN_FUNCTION_CALL_FLAG
501     boolean were_in_lisp;
502 #endif
503     union interrupt_handler handler;
504
505     check_blockables_blocked_or_lose();
506
507 #ifndef LISP_FEATURE_WIN32
508     if (sigismember(&deferrable_sigset,signal))
509         check_interrupts_enabled_or_lose(context);
510 #endif
511
512 #if defined(LISP_FEATURE_LINUX) || defined(RESTORE_FP_CONTROL_FROM_CONTEXT)
513     /* Under Linux on some architectures, we appear to have to restore
514        the FPU control word from the context, as after the signal is
515        delivered we appear to have a null FPU control word. */
516     os_restore_fp_control(context);
517 #endif
518
519     handler = interrupt_handlers[signal];
520
521     if (ARE_SAME_HANDLER(handler.c, SIG_IGN)) {
522         return;
523     }
524
525 #ifdef FOREIGN_FUNCTION_CALL_FLAG
526     were_in_lisp = !foreign_function_call_active;
527     if (were_in_lisp)
528 #endif
529     {
530         fake_foreign_function_call(context);
531     }
532
533     FSHOW_SIGNAL((stderr,
534                   "/entering interrupt_handle_now(%d, info, context)\n",
535                   signal));
536
537     if (ARE_SAME_HANDLER(handler.c, SIG_DFL)) {
538
539         /* This can happen if someone tries to ignore or default one
540          * of the signals we need for runtime support, and the runtime
541          * support decides to pass on it. */
542         lose("no handler for signal %d in interrupt_handle_now(..)\n", signal);
543
544     } else if (lowtag_of(handler.lisp) == FUN_POINTER_LOWTAG) {
545         /* Once we've decided what to do about contexts in a
546          * return-elsewhere world (the original context will no longer
547          * be available; should we copy it or was nobody using it anyway?)
548          * then we should convert this to return-elsewhere */
549
550         /* CMUCL comment said "Allocate the SAPs while the interrupts
551          * are still disabled.".  I (dan, 2003.08.21) assume this is
552          * because we're not in pseudoatomic and allocation shouldn't
553          * be interrupted.  In which case it's no longer an issue as
554          * all our allocation from C now goes through a PA wrapper,
555          * but still, doesn't hurt.
556          *
557          * Yeah, but non-gencgc platforms don't really wrap allocation
558          * in PA. MG - 2005-08-29  */
559
560         lispobj info_sap,context_sap = alloc_sap(context);
561         info_sap = alloc_sap(info);
562         /* Leave deferrable signals blocked, the handler itself will
563          * allow signals again when it sees fit. */
564 #ifdef LISP_FEATURE_SB_THREAD
565         {
566             sigset_t unblock;
567             sigemptyset(&unblock);
568             sigaddset(&unblock, SIG_STOP_FOR_GC);
569 #ifdef SIG_RESUME_FROM_GC
570             sigaddset(&unblock, SIG_RESUME_FROM_GC);
571 #endif
572             thread_sigmask(SIG_UNBLOCK, &unblock, 0);
573         }
574 #endif
575
576         FSHOW_SIGNAL((stderr,"/calling Lisp-level handler\n"));
577
578         funcall3(handler.lisp,
579                  make_fixnum(signal),
580                  info_sap,
581                  context_sap);
582     } else {
583
584         FSHOW_SIGNAL((stderr,"/calling C-level handler\n"));
585
586 #ifndef LISP_FEATURE_WIN32
587         /* Allow signals again. */
588         thread_sigmask(SIG_SETMASK, os_context_sigmask_addr(context), 0);
589 #endif
590         (*handler.c)(signal, info, context);
591     }
592
593 #ifdef FOREIGN_FUNCTION_CALL_FLAG
594     if (were_in_lisp)
595 #endif
596     {
597         undo_fake_foreign_function_call(context); /* block signals again */
598     }
599
600     FSHOW_SIGNAL((stderr,
601                   "/returning from interrupt_handle_now(%d, info, context)\n",
602                   signal));
603 }
604
605 /* This is called at the end of a critical section if the indications
606  * are that some signal was deferred during the section.  Note that as
607  * far as C or the kernel is concerned we dealt with the signal
608  * already; we're just doing the Lisp-level processing now that we
609  * put off then */
610 static void
611 run_deferred_handler(struct interrupt_data *data, void *v_context)
612 {
613     /* The pending_handler may enable interrupts and then another
614      * interrupt may hit, overwrite interrupt_data, so reset the
615      * pending handler before calling it. Trust the handler to finish
616      * with the siginfo before enabling interrupts. */
617     void (*pending_handler) (int, siginfo_t*, void*)=data->pending_handler;
618
619     data->pending_handler=0;
620     (*pending_handler)(data->pending_signal,&(data->pending_info), v_context);
621 }
622
623 #ifndef LISP_FEATURE_WIN32
624 boolean
625 maybe_defer_handler(void *handler, struct interrupt_data *data,
626                     int signal, siginfo_t *info, os_context_t *context)
627 {
628     struct thread *thread=arch_os_get_current_thread();
629
630     check_blockables_blocked_or_lose();
631
632     if (SymbolValue(INTERRUPT_PENDING,thread) != NIL)
633         lose("interrupt already pending\n");
634     /* If interrupts are disabled then INTERRUPT_PENDING is set and
635      * not PSEDUO_ATOMIC_INTERRUPTED. This is important for a pseudo
636      * atomic section inside a WITHOUT-INTERRUPTS.
637      */
638     if (SymbolValue(INTERRUPTS_ENABLED,thread) == NIL) {
639         store_signal_data_for_later(data,handler,signal,info,context);
640         SetSymbolValue(INTERRUPT_PENDING, T,thread);
641         FSHOW_SIGNAL((stderr,
642                       "/maybe_defer_handler(%x,%d),thread=%lu: deferred\n",
643                       (unsigned int)handler,signal,
644                       (unsigned long)thread->os_thread));
645         return 1;
646     }
647     /* a slightly confusing test. arch_pseudo_atomic_atomic() doesn't
648      * actually use its argument for anything on x86, so this branch
649      * may succeed even when context is null (gencgc alloc()) */
650     if (arch_pseudo_atomic_atomic(context)) {
651         store_signal_data_for_later(data,handler,signal,info,context);
652         arch_set_pseudo_atomic_interrupted(context);
653         FSHOW_SIGNAL((stderr,
654                       "/maybe_defer_handler(%x,%d),thread=%lu: deferred(PA)\n",
655                       (unsigned int)handler,signal,
656                       (unsigned long)thread->os_thread));
657         return 1;
658     }
659     FSHOW_SIGNAL((stderr,
660                   "/maybe_defer_handler(%x,%d),thread=%lu: not deferred\n",
661                   (unsigned int)handler,signal,
662                   (unsigned long)thread->os_thread));
663     return 0;
664 }
665
666 static void
667 store_signal_data_for_later (struct interrupt_data *data, void *handler,
668                              int signal,
669                              siginfo_t *info, os_context_t *context)
670 {
671     if (data->pending_handler)
672         lose("tried to overwrite pending interrupt handler %x with %x\n",
673              data->pending_handler, handler);
674     if (!handler)
675         lose("tried to defer null interrupt handler\n");
676     data->pending_handler = handler;
677     data->pending_signal = signal;
678     if(info)
679         memcpy(&(data->pending_info), info, sizeof(siginfo_t));
680
681     FSHOW_SIGNAL((stderr, "/store_signal_data_for_later: signal: %d\n",
682                   signal));
683
684     if(context) {
685         /* the signal mask in the context (from before we were
686          * interrupted) is copied to be restored when
687          * run_deferred_handler happens.  Then the usually-blocked
688          * signals are added to the mask in the context so that we are
689          * running with blocked signals when the handler returns */
690         sigcopyset(&(data->pending_mask),os_context_sigmask_addr(context));
691         sigaddset_deferrable(os_context_sigmask_addr(context));
692     }
693 }
694
695 static void
696 maybe_now_maybe_later(int signal, siginfo_t *info, void *void_context)
697 {
698     os_context_t *context = arch_os_get_context(&void_context);
699     struct thread *thread = arch_os_get_current_thread();
700     struct interrupt_data *data = thread->interrupt_data;
701
702 #if defined(LISP_FEATURE_LINUX) || defined(RESTORE_FP_CONTROL_FROM_CONTEXT)
703     os_restore_fp_control(context);
704 #endif
705
706     if(!maybe_defer_handler(interrupt_handle_now,data,signal,info,context))
707         interrupt_handle_now(signal, info, context);
708 }
709
710 static void
711 low_level_interrupt_handle_now(int signal, siginfo_t *info,
712                                os_context_t *context)
713 {
714     /* No FP control fixage needed, caller has done that. */
715     check_blockables_blocked_or_lose();
716     check_interrupts_enabled_or_lose(context);
717     (*interrupt_low_level_handlers[signal])(signal, info, context);
718     /* No Darwin context fixage needed, caller does that. */
719 }
720
721 static void
722 low_level_maybe_now_maybe_later(int signal, siginfo_t *info, void *void_context)
723 {
724     os_context_t *context = arch_os_get_context(&void_context);
725     struct thread *thread = arch_os_get_current_thread();
726     struct interrupt_data *data = thread->interrupt_data;
727
728 #if defined(LISP_FEATURE_LINUX) || defined(RESTORE_FP_CONTROL_FROM_CONTEXT)
729     os_restore_fp_control(context);
730 #endif
731
732     if(!maybe_defer_handler(low_level_interrupt_handle_now,data,
733                             signal,info,context))
734         low_level_interrupt_handle_now(signal, info, context);
735 }
736 #endif
737
738 #ifdef LISP_FEATURE_SB_THREAD
739
740 void
741 sig_stop_for_gc_handler(int signal, siginfo_t *info, void *void_context)
742 {
743     os_context_t *context = arch_os_get_context(&void_context);
744
745     struct thread *thread=arch_os_get_current_thread();
746     sigset_t ss;
747
748     if (arch_pseudo_atomic_atomic(context)) {
749         SetSymbolValue(STOP_FOR_GC_PENDING,T,thread);
750         arch_set_pseudo_atomic_interrupted(context);
751         FSHOW_SIGNAL((stderr,"thread=%lu sig_stop_for_gc deferred (PA)\n",
752                       thread->os_thread));
753         return;
754     }
755     else if (SymbolValue(GC_INHIBIT,thread) != NIL) {
756         SetSymbolValue(STOP_FOR_GC_PENDING,T,thread);
757         FSHOW_SIGNAL((stderr,
758                       "thread=%lu sig_stop_for_gc deferred (*GC-INHIBIT*)\n",
759                       thread->os_thread));
760         return;
761     }
762
763     /* Not PA and GC not inhibited -- we can stop now. */
764
765     /* need the context stored so it can have registers scavenged */
766     fake_foreign_function_call(context);
767
768     /* Block everything. */
769     sigfillset(&ss);
770     thread_sigmask(SIG_BLOCK,&ss,0);
771
772     /* Not pending anymore. */
773     SetSymbolValue(GC_PENDING,NIL,thread);
774     SetSymbolValue(STOP_FOR_GC_PENDING,NIL,thread);
775
776     if(thread->state!=STATE_RUNNING) {
777         lose("sig_stop_for_gc_handler: wrong thread state: %ld\n",
778              fixnum_value(thread->state));
779     }
780
781     thread->state=STATE_SUSPENDED;
782     FSHOW_SIGNAL((stderr,"thread=%lu suspended\n",thread->os_thread));
783
784     sigemptyset(&ss);
785 #if defined(SIG_RESUME_FROM_GC)
786     sigaddset(&ss,SIG_RESUME_FROM_GC);
787 #else
788     sigaddset(&ss,SIG_STOP_FOR_GC);
789 #endif
790
791     /* It is possible to get SIGCONT (and probably other non-blockable
792      * signals) here. */
793 #ifdef SIG_RESUME_FROM_GC
794     {
795         int sigret;
796         do { sigwait(&ss, &sigret); }
797         while (sigret != SIG_RESUME_FROM_GC);
798     }
799 #else
800     while (sigwaitinfo(&ss,0) != SIG_STOP_FOR_GC);
801 #endif
802
803     FSHOW_SIGNAL((stderr,"thread=%lu resumed\n",thread->os_thread));
804     if(thread->state!=STATE_RUNNING) {
805         lose("sig_stop_for_gc_handler: wrong thread state on wakeup: %ld\n",
806              fixnum_value(thread->state));
807     }
808
809     undo_fake_foreign_function_call(context);
810 }
811 #endif
812
813 void
814 interrupt_handle_now_handler(int signal, siginfo_t *info, void *void_context)
815 {
816     os_context_t *context = arch_os_get_context(&void_context);
817 #if defined(LISP_FEATURE_LINUX) || defined(RESTORE_FP_CONTROL_FROM_CONTEXT)
818     os_restore_fp_control(context);
819 #endif
820     interrupt_handle_now(signal, info, context);
821 }
822
823 /* manipulate the signal context and stack such that when the handler
824  * returns, it will call function instead of whatever it was doing
825  * previously
826  */
827
828 #if (defined(LISP_FEATURE_X86) || defined(LISP_FEATURE_X86_64))
829 extern int *context_eflags_addr(os_context_t *context);
830 #endif
831
832 extern lispobj call_into_lisp(lispobj fun, lispobj *args, int nargs);
833 extern void post_signal_tramp(void);
834 extern void call_into_lisp_tramp(void);
835 void
836 arrange_return_to_lisp_function(os_context_t *context, lispobj function)
837 {
838 #if !(defined(LISP_FEATURE_X86) || defined(LISP_FEATURE_X86_64))
839     void * fun=native_pointer(function);
840     void *code = &(((struct simple_fun *) fun)->code);
841 #endif
842
843     /* Build a stack frame showing `interrupted' so that the
844      * user's backtrace makes (as much) sense (as usual) */
845
846     /* FIXME: what about restoring fp state? */
847     /* FIXME: what about restoring errno? */
848 #ifdef LISP_FEATURE_X86
849     /* Suppose the existence of some function that saved all
850      * registers, called call_into_lisp, then restored GP registers and
851      * returned.  It would look something like this:
852
853      push   ebp
854      mov    ebp esp
855      pushfl
856      pushal
857      push   $0
858      push   $0
859      pushl  {address of function to call}
860      call   0x8058db0 <call_into_lisp>
861      addl   $12,%esp
862      popal
863      popfl
864      leave
865      ret
866
867      * What we do here is set up the stack that call_into_lisp would
868      * expect to see if it had been called by this code, and frob the
869      * signal context so that signal return goes directly to call_into_lisp,
870      * and when that function (and the lisp function it invoked) returns,
871      * it returns to the second half of this imaginary function which
872      * restores all registers and returns to C
873
874      * For this to work, the latter part of the imaginary function
875      * must obviously exist in reality.  That would be post_signal_tramp
876      */
877
878     u32 *sp=(u32 *)*os_context_register_addr(context,reg_ESP);
879
880 #if defined(LISP_FEATURE_DARWIN)
881     u32 *register_save_area = (u32 *)os_validate(0, 0x40);
882
883     FSHOW_SIGNAL((stderr, "/arrange_return_to_lisp_function: preparing to go to function %x, sp: %x\n", function, sp));
884     FSHOW_SIGNAL((stderr, "/arrange_return_to_lisp_function: context: %x, &context %x\n", context, &context));
885
886     /* 1. os_validate (malloc/mmap) register_save_block
887      * 2. copy register state into register_save_block
888      * 3. put a pointer to register_save_block in a register in the context
889      * 4. set the context's EIP to point to a trampoline which:
890      *    a. builds the fake stack frame from the block
891      *    b. frees the block
892      *    c. calls the function
893      */
894
895     *register_save_area = *os_context_pc_addr(context);
896     *(register_save_area + 1) = function;
897     *(register_save_area + 2) = *os_context_register_addr(context,reg_EDI);
898     *(register_save_area + 3) = *os_context_register_addr(context,reg_ESI);
899     *(register_save_area + 4) = *os_context_register_addr(context,reg_EDX);
900     *(register_save_area + 5) = *os_context_register_addr(context,reg_ECX);
901     *(register_save_area + 6) = *os_context_register_addr(context,reg_EBX);
902     *(register_save_area + 7) = *os_context_register_addr(context,reg_EAX);
903     *(register_save_area + 8) = *context_eflags_addr(context);
904
905     *os_context_pc_addr(context) =
906       (os_context_register_t) call_into_lisp_tramp;
907     *os_context_register_addr(context,reg_ECX) =
908       (os_context_register_t) register_save_area;
909 #else
910
911     /* return address for call_into_lisp: */
912     *(sp-15) = (u32)post_signal_tramp;
913     *(sp-14) = function;        /* args for call_into_lisp : function*/
914     *(sp-13) = 0;               /*                           arg array */
915     *(sp-12) = 0;               /*                           no. args */
916     /* this order matches that used in POPAD */
917     *(sp-11)=*os_context_register_addr(context,reg_EDI);
918     *(sp-10)=*os_context_register_addr(context,reg_ESI);
919
920     *(sp-9)=*os_context_register_addr(context,reg_ESP)-8;
921     /* POPAD ignores the value of ESP:  */
922     *(sp-8)=0;
923     *(sp-7)=*os_context_register_addr(context,reg_EBX);
924
925     *(sp-6)=*os_context_register_addr(context,reg_EDX);
926     *(sp-5)=*os_context_register_addr(context,reg_ECX);
927     *(sp-4)=*os_context_register_addr(context,reg_EAX);
928     *(sp-3)=*context_eflags_addr(context);
929     *(sp-2)=*os_context_register_addr(context,reg_EBP);
930     *(sp-1)=*os_context_pc_addr(context);
931
932 #endif
933
934 #elif defined(LISP_FEATURE_X86_64)
935     u64 *sp=(u64 *)*os_context_register_addr(context,reg_RSP);
936
937     /* return address for call_into_lisp: */
938     *(sp-18) = (u64)post_signal_tramp;
939
940     *(sp-17)=*os_context_register_addr(context,reg_R15);
941     *(sp-16)=*os_context_register_addr(context,reg_R14);
942     *(sp-15)=*os_context_register_addr(context,reg_R13);
943     *(sp-14)=*os_context_register_addr(context,reg_R12);
944     *(sp-13)=*os_context_register_addr(context,reg_R11);
945     *(sp-12)=*os_context_register_addr(context,reg_R10);
946     *(sp-11)=*os_context_register_addr(context,reg_R9);
947     *(sp-10)=*os_context_register_addr(context,reg_R8);
948     *(sp-9)=*os_context_register_addr(context,reg_RDI);
949     *(sp-8)=*os_context_register_addr(context,reg_RSI);
950     /* skip RBP and RSP */
951     *(sp-7)=*os_context_register_addr(context,reg_RBX);
952     *(sp-6)=*os_context_register_addr(context,reg_RDX);
953     *(sp-5)=*os_context_register_addr(context,reg_RCX);
954     *(sp-4)=*os_context_register_addr(context,reg_RAX);
955     *(sp-3)=*context_eflags_addr(context);
956     *(sp-2)=*os_context_register_addr(context,reg_RBP);
957     *(sp-1)=*os_context_pc_addr(context);
958
959     *os_context_register_addr(context,reg_RDI) =
960         (os_context_register_t)function; /* function */
961     *os_context_register_addr(context,reg_RSI) = 0;        /* arg. array */
962     *os_context_register_addr(context,reg_RDX) = 0;        /* no. args */
963 #else
964     struct thread *th=arch_os_get_current_thread();
965     build_fake_control_stack_frames(th,context);
966 #endif
967
968 #ifdef LISP_FEATURE_X86
969
970 #if !defined(LISP_FEATURE_DARWIN)
971     *os_context_pc_addr(context) = (os_context_register_t)call_into_lisp;
972     *os_context_register_addr(context,reg_ECX) = 0;
973     *os_context_register_addr(context,reg_EBP) = (os_context_register_t)(sp-2);
974 #ifdef __NetBSD__
975     *os_context_register_addr(context,reg_UESP) =
976         (os_context_register_t)(sp-15);
977 #else
978     *os_context_register_addr(context,reg_ESP) = (os_context_register_t)(sp-15);
979 #endif /* __NETBSD__ */
980 #endif /* LISP_FEATURE_DARWIN */
981
982 #elif defined(LISP_FEATURE_X86_64)
983     *os_context_pc_addr(context) = (os_context_register_t)call_into_lisp;
984     *os_context_register_addr(context,reg_RCX) = 0;
985     *os_context_register_addr(context,reg_RBP) = (os_context_register_t)(sp-2);
986     *os_context_register_addr(context,reg_RSP) = (os_context_register_t)(sp-18);
987 #else
988     /* this much of the calling convention is common to all
989        non-x86 ports */
990     *os_context_pc_addr(context) = (os_context_register_t)(unsigned long)code;
991     *os_context_register_addr(context,reg_NARGS) = 0;
992     *os_context_register_addr(context,reg_LIP) =
993         (os_context_register_t)(unsigned long)code;
994     *os_context_register_addr(context,reg_CFP) =
995         (os_context_register_t)(unsigned long)current_control_frame_pointer;
996 #endif
997 #ifdef ARCH_HAS_NPC_REGISTER
998     *os_context_npc_addr(context) =
999         4 + *os_context_pc_addr(context);
1000 #endif
1001 #ifdef LISP_FEATURE_SPARC
1002     *os_context_register_addr(context,reg_CODE) =
1003         (os_context_register_t)(fun + FUN_POINTER_LOWTAG);
1004 #endif
1005 }
1006
1007 #ifdef LISP_FEATURE_SB_THREAD
1008
1009 /* FIXME: this function can go away when all lisp handlers are invoked
1010  * via arrange_return_to_lisp_function. */
1011 void
1012 interrupt_thread_handler(int num, siginfo_t *info, void *v_context)
1013 {
1014     os_context_t *context = (os_context_t*)arch_os_get_context(&v_context);
1015
1016     /* let the handler enable interrupts again when it sees fit */
1017     sigaddset_deferrable(os_context_sigmask_addr(context));
1018     arrange_return_to_lisp_function(context,
1019                                     StaticSymbolFunction(RUN_INTERRUPTION));
1020 }
1021
1022 #endif
1023
1024 /* KLUDGE: Theoretically the approach we use for undefined alien
1025  * variables should work for functions as well, but on PPC/Darwin
1026  * we get bus error at bogus addresses instead, hence this workaround,
1027  * that has the added benefit of automatically discriminating between
1028  * functions and variables.
1029  */
1030 void
1031 undefined_alien_function(void)
1032 {
1033     funcall0(StaticSymbolFunction(UNDEFINED_ALIEN_FUNCTION_ERROR));
1034 }
1035
1036 boolean
1037 handle_guard_page_triggered(os_context_t *context,os_vm_address_t addr)
1038 {
1039     struct thread *th=arch_os_get_current_thread();
1040
1041     /* note the os_context hackery here.  When the signal handler returns,
1042      * it won't go back to what it was doing ... */
1043     if(addr >= CONTROL_STACK_GUARD_PAGE(th) &&
1044        addr < CONTROL_STACK_GUARD_PAGE(th) + os_vm_page_size) {
1045         /* We hit the end of the control stack: disable guard page
1046          * protection so the error handler has some headroom, protect the
1047          * previous page so that we can catch returns from the guard page
1048          * and restore it. */
1049         protect_control_stack_guard_page(0);
1050         protect_control_stack_return_guard_page(1);
1051
1052         arrange_return_to_lisp_function
1053             (context, StaticSymbolFunction(CONTROL_STACK_EXHAUSTED_ERROR));
1054         return 1;
1055     }
1056     else if(addr >= CONTROL_STACK_RETURN_GUARD_PAGE(th) &&
1057             addr < CONTROL_STACK_RETURN_GUARD_PAGE(th) + os_vm_page_size) {
1058         /* We're returning from the guard page: reprotect it, and
1059          * unprotect this one. This works even if we somehow missed
1060          * the return-guard-page, and hit it on our way to new
1061          * exhaustion instead. */
1062         protect_control_stack_guard_page(1);
1063         protect_control_stack_return_guard_page(0);
1064         return 1;
1065     }
1066     else if (addr >= undefined_alien_address &&
1067              addr < undefined_alien_address + os_vm_page_size) {
1068         arrange_return_to_lisp_function
1069           (context, StaticSymbolFunction(UNDEFINED_ALIEN_VARIABLE_ERROR));
1070         return 1;
1071     }
1072     else return 0;
1073 }
1074 \f
1075 /*
1076  * noise to install handlers
1077  */
1078
1079 #ifndef LISP_FEATURE_WIN32
1080 /* In Linux 2.4 synchronous signals (sigtrap & co) can be delivered if
1081  * they are blocked, in Linux 2.6 the default handler is invoked
1082  * instead that usually coredumps. One might hastily think that adding
1083  * SA_NODEFER helps, but until ~2.6.13 if SA_NODEFER is specified then
1084  * the whole sa_mask is ignored and instead of not adding the signal
1085  * in question to the mask. That means if it's not blockable the
1086  * signal must be unblocked at the beginning of signal handlers.
1087  *
1088  * It turns out that NetBSD's SA_NODEFER doesn't DTRT in a different
1089  * way: if SA_NODEFER is set and the signal is in sa_mask, the signal
1090  * will be unblocked in the sigmask during the signal handler.  -- RMK
1091  * X-mas day, 2005
1092  */
1093 static volatile int sigaction_nodefer_works = -1;
1094
1095 #define SA_NODEFER_TEST_BLOCK_SIGNAL SIGABRT
1096 #define SA_NODEFER_TEST_KILL_SIGNAL SIGUSR1
1097
1098 static void
1099 sigaction_nodefer_test_handler(int signal, siginfo_t *info, void *void_context)
1100 {
1101     sigset_t empty, current;
1102     int i;
1103     sigemptyset(&empty);
1104     thread_sigmask(SIG_BLOCK, &empty, &current);
1105     /* There should be exactly two blocked signals: the two we added
1106      * to sa_mask when setting up the handler.  NetBSD doesn't block
1107      * the signal we're handling when SA_NODEFER is set; Linux before
1108      * 2.6.13 or so also doesn't block the other signal when
1109      * SA_NODEFER is set. */
1110     for(i = 1; i < NSIG; i++)
1111         if (sigismember(&current, i) !=
1112             (((i == SA_NODEFER_TEST_BLOCK_SIGNAL) || (i == signal)) ? 1 : 0)) {
1113             FSHOW_SIGNAL((stderr, "SA_NODEFER doesn't work, signal %d\n", i));
1114             sigaction_nodefer_works = 0;
1115         }
1116     if (sigaction_nodefer_works == -1)
1117         sigaction_nodefer_works = 1;
1118 }
1119
1120 static void
1121 see_if_sigaction_nodefer_works(void)
1122 {
1123     struct sigaction sa, old_sa;
1124
1125     sa.sa_flags = SA_SIGINFO | SA_NODEFER;
1126     sa.sa_sigaction = sigaction_nodefer_test_handler;
1127     sigemptyset(&sa.sa_mask);
1128     sigaddset(&sa.sa_mask, SA_NODEFER_TEST_BLOCK_SIGNAL);
1129     sigaddset(&sa.sa_mask, SA_NODEFER_TEST_KILL_SIGNAL);
1130     sigaction(SA_NODEFER_TEST_KILL_SIGNAL, &sa, &old_sa);
1131     /* Make sure no signals are blocked. */
1132     {
1133         sigset_t empty;
1134         sigemptyset(&empty);
1135         thread_sigmask(SIG_SETMASK, &empty, 0);
1136     }
1137     kill(getpid(), SA_NODEFER_TEST_KILL_SIGNAL);
1138     while (sigaction_nodefer_works == -1);
1139     sigaction(SA_NODEFER_TEST_KILL_SIGNAL, &old_sa, NULL);
1140 }
1141
1142 #undef SA_NODEFER_TEST_BLOCK_SIGNAL
1143 #undef SA_NODEFER_TEST_KILL_SIGNAL
1144
1145 static void
1146 unblock_me_trampoline(int signal, siginfo_t *info, void *void_context)
1147 {
1148     sigset_t unblock;
1149
1150     sigemptyset(&unblock);
1151     sigaddset(&unblock, signal);
1152     thread_sigmask(SIG_UNBLOCK, &unblock, 0);
1153     interrupt_handle_now_handler(signal, info, void_context);
1154 }
1155
1156 static void
1157 low_level_unblock_me_trampoline(int signal, siginfo_t *info, void *void_context)
1158 {
1159     sigset_t unblock;
1160
1161     sigemptyset(&unblock);
1162     sigaddset(&unblock, signal);
1163     thread_sigmask(SIG_UNBLOCK, &unblock, 0);
1164     (*interrupt_low_level_handlers[signal])(signal, info, void_context);
1165 }
1166
1167 void
1168 undoably_install_low_level_interrupt_handler (int signal,
1169                                               interrupt_handler_t handler)
1170 {
1171     struct sigaction sa;
1172
1173     if (0 > signal || signal >= NSIG) {
1174         lose("bad signal number %d\n", signal);
1175     }
1176
1177     if (ARE_SAME_HANDLER(handler, SIG_DFL))
1178         sa.sa_sigaction = handler;
1179     else if (sigismember(&deferrable_sigset,signal))
1180         sa.sa_sigaction = low_level_maybe_now_maybe_later;
1181     /* The use of a trampoline appears to break the
1182        arch_os_get_context() workaround for SPARC/Linux.  For now,
1183        don't use the trampoline (and so be vulnerable to the problems
1184        that SA_NODEFER is meant to solve. */
1185 #if !(defined(LISP_FEATURE_SPARC) && defined(LISP_FEATURE_LINUX))
1186     else if (!sigaction_nodefer_works &&
1187              !sigismember(&blockable_sigset, signal))
1188         sa.sa_sigaction = low_level_unblock_me_trampoline;
1189 #endif
1190     else
1191         sa.sa_sigaction = handler;
1192
1193     sigcopyset(&sa.sa_mask, &blockable_sigset);
1194     sa.sa_flags = SA_SIGINFO | SA_RESTART
1195         | (sigaction_nodefer_works ? SA_NODEFER : 0);
1196 #ifdef LISP_FEATURE_C_STACK_IS_CONTROL_STACK
1197     if((signal==SIG_MEMORY_FAULT)
1198 #ifdef SIG_INTERRUPT_THREAD
1199        || (signal==SIG_INTERRUPT_THREAD)
1200 #endif
1201        )
1202         sa.sa_flags |= SA_ONSTACK;
1203 #endif
1204
1205     sigaction(signal, &sa, NULL);
1206     interrupt_low_level_handlers[signal] =
1207         (ARE_SAME_HANDLER(handler, SIG_DFL) ? 0 : handler);
1208 }
1209 #endif
1210
1211 /* This is called from Lisp. */
1212 unsigned long
1213 install_handler(int signal, void handler(int, siginfo_t*, void*))
1214 {
1215 #ifndef LISP_FEATURE_WIN32
1216     struct sigaction sa;
1217     sigset_t old, new;
1218     union interrupt_handler oldhandler;
1219
1220     FSHOW((stderr, "/entering POSIX install_handler(%d, ..)\n", signal));
1221
1222     sigemptyset(&new);
1223     sigaddset(&new, signal);
1224     thread_sigmask(SIG_BLOCK, &new, &old);
1225
1226     FSHOW((stderr, "/interrupt_low_level_handlers[signal]=%x\n",
1227            (unsigned int)interrupt_low_level_handlers[signal]));
1228     if (interrupt_low_level_handlers[signal]==0) {
1229         if (ARE_SAME_HANDLER(handler, SIG_DFL) ||
1230             ARE_SAME_HANDLER(handler, SIG_IGN))
1231             sa.sa_sigaction = handler;
1232         else if (sigismember(&deferrable_sigset, signal))
1233             sa.sa_sigaction = maybe_now_maybe_later;
1234         else if (!sigaction_nodefer_works &&
1235                  !sigismember(&blockable_sigset, signal))
1236             sa.sa_sigaction = unblock_me_trampoline;
1237         else
1238             sa.sa_sigaction = interrupt_handle_now_handler;
1239
1240         sigcopyset(&sa.sa_mask, &blockable_sigset);
1241         sa.sa_flags = SA_SIGINFO | SA_RESTART |
1242             (sigaction_nodefer_works ? SA_NODEFER : 0);
1243         sigaction(signal, &sa, NULL);
1244     }
1245
1246     oldhandler = interrupt_handlers[signal];
1247     interrupt_handlers[signal].c = handler;
1248
1249     thread_sigmask(SIG_SETMASK, &old, 0);
1250
1251     FSHOW((stderr, "/leaving POSIX install_handler(%d, ..)\n", signal));
1252
1253     return (unsigned long)oldhandler.lisp;
1254 #else
1255     /* Probably-wrong Win32 hack */
1256     return 0;
1257 #endif
1258 }
1259
1260 void
1261 interrupt_init(void)
1262 {
1263 #ifndef LISP_FEATURE_WIN32
1264     int i;
1265     SHOW("entering interrupt_init()");
1266     see_if_sigaction_nodefer_works();
1267     sigemptyset(&deferrable_sigset);
1268     sigemptyset(&blockable_sigset);
1269     sigaddset_deferrable(&deferrable_sigset);
1270     sigaddset_blockable(&blockable_sigset);
1271
1272     /* Set up high level handler information. */
1273     for (i = 0; i < NSIG; i++) {
1274         interrupt_handlers[i].c =
1275             /* (The cast here blasts away the distinction between
1276              * SA_SIGACTION-style three-argument handlers and
1277              * signal(..)-style one-argument handlers, which is OK
1278              * because it works to call the 1-argument form where the
1279              * 3-argument form is expected.) */
1280             (void (*)(int, siginfo_t*, void*))SIG_DFL;
1281     }
1282
1283     SHOW("returning from interrupt_init()");
1284 #endif
1285 }
1286
1287 #ifndef LISP_FEATURE_WIN32
1288 int
1289 siginfo_code(siginfo_t *info)
1290 {
1291     return info->si_code;
1292 }
1293 os_vm_address_t current_memory_fault_address;
1294
1295 void
1296 lisp_memory_fault_error(os_context_t *context, os_vm_address_t addr)
1297 {
1298    /* FIXME: This is lossy: if we get another memory fault (eg. from
1299     * another thread) before lisp has read this, we lose the information.
1300     * However, since this is mostly informative, we'll live with that for
1301     * now -- some address is better then no address in this case.
1302     */
1303     current_memory_fault_address = addr;
1304     arrange_return_to_lisp_function(context,
1305                                     StaticSymbolFunction(MEMORY_FAULT_ERROR));
1306 }
1307 #endif
1308
1309 static void
1310 unhandled_trap_error(os_context_t *context)
1311 {
1312     lispobj context_sap;
1313     fake_foreign_function_call(context);
1314     context_sap = alloc_sap(context);
1315 #ifndef LISP_FEATURE_WIN32
1316     thread_sigmask(SIG_SETMASK, os_context_sigmask_addr(context), 0);
1317 #endif
1318     funcall1(StaticSymbolFunction(UNHANDLED_TRAP_ERROR), context_sap);
1319     lose("UNHANDLED-TRAP-ERROR fell through");
1320 }
1321
1322 /* Common logic for trapping instructions. How we actually handle each
1323  * case is highly architecture dependent, but the overall shape is
1324  * this. */
1325 void
1326 handle_trap(os_context_t *context, int trap)
1327 {
1328     switch(trap) {
1329     case trap_PendingInterrupt:
1330         FSHOW((stderr, "/<trap pending interrupt>\n"));
1331         arch_skip_instruction(context);
1332         interrupt_handle_pending(context);
1333         break;
1334     case trap_Error:
1335     case trap_Cerror:
1336         FSHOW((stderr, "/<trap error/cerror %d>\n", trap));
1337         interrupt_internal_error(context, trap==trap_Cerror);
1338         break;
1339     case trap_Breakpoint:
1340         arch_handle_breakpoint(context);
1341         break;
1342     case trap_FunEndBreakpoint:
1343         arch_handle_fun_end_breakpoint(context);
1344         break;
1345 #ifdef trap_AfterBreakpoint
1346     case trap_AfterBreakpoint:
1347         arch_handle_after_breakpoint(context);
1348         break;
1349 #endif
1350 #ifdef trap_SingleStepAround
1351     case trap_SingleStepAround:
1352     case trap_SingleStepBefore:
1353         arch_handle_single_step_trap(context, trap);
1354         break;
1355 #endif
1356     case trap_Halt:
1357         fake_foreign_function_call(context);
1358         lose("%%PRIMITIVE HALT called; the party is over.\n");
1359     default:
1360         unhandled_trap_error(context);
1361     }
1362 }
1363