882e2bb322e64bda821c0c90dadee262911685f5
[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 "interr.h"
63 #include "gc.h"
64 #include "alloc.h"
65 #include "dynbind.h"
66 #include "pseudo-atomic.h"
67 #include "genesis/fdefn.h"
68 #include "genesis/simple-fun.h"
69 #include "genesis/cons.h"
70
71 /* When we catch an internal error, should we pass it back to Lisp to
72  * be handled in a high-level way? (Early in cold init, the answer is
73  * 'no', because Lisp is still too brain-dead to handle anything.
74  * After sufficient initialization has been completed, the answer
75  * becomes 'yes'.) */
76 boolean internal_errors_enabled = 0;
77
78 #ifndef LISP_FEATURE_WIN32
79 static
80 void (*interrupt_low_level_handlers[NSIG]) (int, siginfo_t*, os_context_t*);
81 #endif
82 union interrupt_handler interrupt_handlers[NSIG];
83
84 /* Under Linux on some architectures, we appear to have to restore the
85  * FPU control word from the context, as after the signal is delivered
86  * we appear to have a null FPU control word. */
87 #if defined(RESTORE_FP_CONTROL_FROM_CONTEXT)
88 #define RESTORE_FP_CONTROL_WORD(context,void_context)           \
89     os_context_t *context = arch_os_get_context(&void_context); \
90     os_restore_fp_control(context);
91 #else
92 #define RESTORE_FP_CONTROL_WORD(context,void_context)           \
93     os_context_t *context = arch_os_get_context(&void_context);
94 #endif
95
96 /* Foreign code may want to start some threads on its own.
97  * Non-targetted, truly asynchronous signals can be delivered to
98  * basically any thread, but invoking Lisp handlers in such foregign
99  * threads is really bad, so let's resignal it.
100  *
101  * This should at least bring attention to the problem, but it cannot
102  * work for SIGSEGV and similar. It is good enough for timers, and
103  * maybe all deferrables. */
104
105 #if defined(LISP_FEATURE_SB_THREAD) && !defined(LISP_FEATURE_WIN32)
106 static void
107 add_handled_signals(sigset_t *sigset)
108 {
109     int i;
110     for(i = 1; i < NSIG; i++) {
111         if (!(ARE_SAME_HANDLER(interrupt_low_level_handlers[i], SIG_DFL)) ||
112             !(ARE_SAME_HANDLER(interrupt_handlers[i].c, SIG_DFL))) {
113             sigaddset(sigset, i);
114         }
115     }
116 }
117
118 void block_signals(sigset_t *what, sigset_t *where, sigset_t *old);
119 #endif
120
121 static boolean
122 maybe_resignal_to_lisp_thread(int signal, os_context_t *context)
123 {
124 #if defined(LISP_FEATURE_SB_THREAD) && !defined(LISP_FEATURE_WIN32)
125     if (!pthread_getspecific(lisp_thread)) {
126         if (!(sigismember(&deferrable_sigset,signal))) {
127             corruption_warning_and_maybe_lose
128                 ("Received signal %d in non-lisp thread %lu, resignalling to a lisp thread.",
129                  signal,
130                  pthread_self());
131         }
132         {
133             sigset_t sigset;
134             sigemptyset(&sigset);
135             add_handled_signals(&sigset);
136             block_signals(&sigset, 0, 0);
137             block_signals(&sigset, os_context_sigmask_addr(context), 0);
138             kill(getpid(), signal);
139         }
140         return 1;
141     } else
142 #endif
143         return 0;
144 }
145
146 /* These are to be used in signal handlers. Currently all handlers are
147  * called from one of:
148  *
149  * interrupt_handle_now_handler
150  * maybe_now_maybe_later
151  * unblock_me_trampoline
152  * low_level_handle_now_handler
153  * low_level_maybe_now_maybe_later
154  * low_level_unblock_me_trampoline
155  *
156  * This gives us a single point of control (or six) over errno, fp
157  * control word, and fixing up signal context on sparc.
158  *
159  * The SPARC/Linux platform doesn't quite do signals the way we want
160  * them done. The third argument in the handler isn't filled in by the
161  * kernel properly, so we fix it up ourselves in the
162  * arch_os_get_context(..) function. -- CSR, 2002-07-23
163  */
164 #define SAVE_ERRNO(signal,context,void_context)                 \
165     {                                                           \
166         int _saved_errno = errno;                               \
167         RESTORE_FP_CONTROL_WORD(context,void_context);          \
168         if (!maybe_resignal_to_lisp_thread(signal, context))    \
169         {
170
171 #define RESTORE_ERRNO                                           \
172         }                                                       \
173         errno = _saved_errno;                                   \
174     }
175
176 static void run_deferred_handler(struct interrupt_data *data,
177                                  os_context_t *context);
178 #if !defined(LISP_FEATURE_WIN32) || defined(LISP_FEATURE_SB_THREAD)
179 static void store_signal_data_for_later (struct interrupt_data *data,
180                                          void *handler, int signal,
181                                          siginfo_t *info,
182                                          os_context_t *context);
183 \f
184
185 /* Generic signal related utilities. */
186
187 void
188 get_current_sigmask(sigset_t *sigset)
189 {
190     /* Get the current sigmask, by blocking the empty set. */
191     thread_sigmask(SIG_BLOCK, 0, sigset);
192 }
193
194 void
195 block_signals(sigset_t *what, sigset_t *where, sigset_t *old)
196 {
197     if (where) {
198         int i;
199         if (old)
200             sigcopyset(old, where);
201         for(i = 1; i < NSIG; i++) {
202             if (sigismember(what, i))
203                 sigaddset(where, i);
204         }
205     } else {
206         thread_sigmask(SIG_BLOCK, what, old);
207     }
208 }
209
210 void
211 unblock_signals(sigset_t *what, sigset_t *where, sigset_t *old)
212 {
213     if (where) {
214         int i;
215         if (old)
216             sigcopyset(old, where);
217         for(i = 1; i < NSIG; i++) {
218             if (sigismember(what, i))
219                 sigdelset(where, i);
220         }
221     } else {
222         thread_sigmask(SIG_UNBLOCK, what, old);
223     }
224 }
225
226 static void
227 print_sigset(sigset_t *sigset)
228 {
229   int i;
230   for(i = 1; i < NSIG; i++) {
231     if (sigismember(sigset, i))
232       fprintf(stderr, "Signal %d masked\n", i);
233   }
234 }
235
236 /* Return 1 is all signals is sigset2 are masked in sigset, return 0
237  * if all re unmasked else die. Passing NULL for sigset is a shorthand
238  * for the current sigmask. */
239 boolean
240 all_signals_blocked_p(sigset_t *sigset, sigset_t *sigset2,
241                                 const char *name)
242 {
243 #if !defined(LISP_FEATURE_WIN32) || defined(LISP_FEATURE_SB_THREAD)
244     int i;
245     boolean has_blocked = 0, has_unblocked = 0;
246     sigset_t current;
247     if (sigset == 0) {
248         get_current_sigmask(&current);
249         sigset = &current;
250     }
251     for(i = 1; i < NSIG; i++) {
252         if (sigismember(sigset2, i)) {
253             if (sigismember(sigset, i))
254                 has_blocked = 1;
255             else
256                 has_unblocked = 1;
257         }
258     }
259     if (has_blocked && has_unblocked) {
260         print_sigset(sigset);
261         lose("some %s signals blocked, some unblocked\n", name);
262     }
263     if (has_blocked)
264         return 1;
265     else
266         return 0;
267 #endif
268 }
269 \f
270
271 /* Deferrables, blockables, gc signals. */
272
273 void
274 sigaddset_deferrable(sigset_t *s)
275 {
276     sigaddset(s, SIGHUP);
277     sigaddset(s, SIGINT);
278     sigaddset(s, SIGTERM);
279     sigaddset(s, SIGQUIT);
280     sigaddset(s, SIGPIPE);
281     sigaddset(s, SIGALRM);
282     sigaddset(s, SIGURG);
283     sigaddset(s, SIGTSTP);
284     sigaddset(s, SIGCHLD);
285     sigaddset(s, SIGIO);
286 #ifndef LISP_FEATURE_HPUX
287     sigaddset(s, SIGXCPU);
288     sigaddset(s, SIGXFSZ);
289 #endif
290     sigaddset(s, SIGVTALRM);
291     sigaddset(s, SIGPROF);
292     sigaddset(s, SIGWINCH);
293 }
294
295 void
296 sigaddset_blockable(sigset_t *sigset)
297 {
298     sigaddset_deferrable(sigset);
299     sigaddset_gc(sigset);
300 }
301
302 void
303 sigaddset_gc(sigset_t *sigset)
304 {
305 #ifdef THREADS_USING_GCSIGNAL
306     sigaddset(sigset,SIG_STOP_FOR_GC);
307 #endif
308 }
309
310 /* initialized in interrupt_init */
311 sigset_t deferrable_sigset;
312 sigset_t blockable_sigset;
313 sigset_t gc_sigset;
314
315 #endif
316
317 #if !defined(LISP_FEATURE_WIN32) || defined(LISP_FEATURE_SB_THREAD)
318 boolean
319 deferrables_blocked_p(sigset_t *sigset)
320 {
321     return all_signals_blocked_p(sigset, &deferrable_sigset, "deferrable");
322 }
323 #endif
324
325 void
326 check_deferrables_unblocked_or_lose(sigset_t *sigset)
327 {
328 #if !defined(LISP_FEATURE_WIN32) || defined(LISP_FEATURE_SB_THREAD)
329     if (deferrables_blocked_p(sigset))
330         lose("deferrables blocked\n");
331 #endif
332 }
333
334 void
335 check_deferrables_blocked_or_lose(sigset_t *sigset)
336 {
337 #if !defined(LISP_FEATURE_WIN32) || defined(LISP_FEATURE_SB_THREAD)
338     if (!deferrables_blocked_p(sigset))
339         lose("deferrables unblocked\n");
340 #endif
341 }
342
343 #if !defined(LISP_FEATURE_WIN32) || defined(LISP_FEATURE_SB_THREAD)
344 boolean
345 blockables_blocked_p(sigset_t *sigset)
346 {
347     return all_signals_blocked_p(sigset, &blockable_sigset, "blockable");
348 }
349 #endif
350
351 void
352 check_blockables_unblocked_or_lose(sigset_t *sigset)
353 {
354 #if !defined(LISP_FEATURE_WIN32) || defined(LISP_FEATURE_SB_THREAD)
355     if (blockables_blocked_p(sigset))
356         lose("blockables blocked\n");
357 #endif
358 }
359
360 void
361 check_blockables_blocked_or_lose(sigset_t *sigset)
362 {
363 #if !defined(LISP_FEATURE_WIN32)
364     /* On Windows, there are no actual signals, but since the win32 port
365      * tracks the sigmask and checks it explicitly, some functions are
366      * still required to keep the mask set up properly.  (After all, the
367      * goal of the sigmask emulation is to not have to change all the
368      * call sites in the first place.)
369      *
370      * However, this does not hold for all signals equally: While
371      * deferrables matter ("is interrupt-thread okay?"), it is not worth
372      * having to set up blockables properly (which include the
373      * non-existing GC signals).
374      *
375      * Yet, as the original comment explains it:
376      *   Adjusting FREE-INTERRUPT-CONTEXT-INDEX* and other aspecs of
377      *   fake_foreign_function_call machinery are sometimes useful here[...].
378      *
379      * So we merely skip this assertion.
380      *   -- DFL, trying to expand on a comment by AK.
381      */
382     if (!blockables_blocked_p(sigset))
383         lose("blockables unblocked\n");
384 #endif
385 }
386
387 #ifndef LISP_FEATURE_SB_SAFEPOINT
388 #if !defined(LISP_FEATURE_WIN32)
389 boolean
390 gc_signals_blocked_p(sigset_t *sigset)
391 {
392     return all_signals_blocked_p(sigset, &gc_sigset, "gc");
393 }
394 #endif
395
396 void
397 check_gc_signals_unblocked_or_lose(sigset_t *sigset)
398 {
399 #if !defined(LISP_FEATURE_WIN32)
400     if (gc_signals_blocked_p(sigset))
401         lose("gc signals blocked\n");
402 #endif
403 }
404
405 void
406 check_gc_signals_blocked_or_lose(sigset_t *sigset)
407 {
408 #if !defined(LISP_FEATURE_WIN32)
409     if (!gc_signals_blocked_p(sigset))
410         lose("gc signals unblocked\n");
411 #endif
412 }
413 #endif
414
415 void
416 block_deferrable_signals(sigset_t *where, sigset_t *old)
417 {
418 #if !defined(LISP_FEATURE_WIN32) || defined(LISP_FEATURE_SB_THREAD)
419     block_signals(&deferrable_sigset, where, old);
420 #endif
421 }
422
423 void
424 block_blockable_signals(sigset_t *where, sigset_t *old)
425 {
426 #if !defined(LISP_FEATURE_WIN32) || defined(LISP_FEATURE_SB_THREAD)
427     block_signals(&blockable_sigset, where, old);
428 #endif
429 }
430
431 #ifndef LISP_FEATURE_SB_SAFEPOINT
432 void
433 block_gc_signals(sigset_t *where, sigset_t *old)
434 {
435 #if !defined(LISP_FEATURE_WIN32) || defined(LISP_FEATURE_SB_THREAD)
436     block_signals(&gc_sigset, where, old);
437 #endif
438 }
439 #endif
440
441 void
442 unblock_deferrable_signals(sigset_t *where, sigset_t *old)
443 {
444 #if !defined(LISP_FEATURE_WIN32) || defined(LISP_FEATURE_SB_THREAD)
445     if (interrupt_handler_pending_p())
446         lose("unblock_deferrable_signals: losing proposition\n");
447 #ifndef LISP_FEATURE_SB_SAFEPOINT
448     check_gc_signals_unblocked_or_lose(where);
449 #endif
450     unblock_signals(&deferrable_sigset, where, old);
451 #endif
452 }
453
454 void
455 unblock_blockable_signals(sigset_t *where, sigset_t *old)
456 {
457 #if !defined(LISP_FEATURE_WIN32) || defined(LISP_FEATURE_SB_THREAD)
458     unblock_signals(&blockable_sigset, where, old);
459 #endif
460 }
461
462 #ifndef LISP_FEATURE_SB_SAFEPOINT
463 void
464 unblock_gc_signals(sigset_t *where, sigset_t *old)
465 {
466 #ifndef LISP_FEATURE_WIN32
467     unblock_signals(&gc_sigset, where, old);
468 #endif
469 }
470 #endif
471
472 void
473 unblock_signals_in_context_and_maybe_warn(os_context_t *context)
474 {
475 #if !defined(LISP_FEATURE_WIN32) || defined(LISP_FEATURE_SB_THREAD)
476     sigset_t *sigset = os_context_sigmask_addr(context);
477 #ifndef LISP_FEATURE_SB_SAFEPOINT
478     if (all_signals_blocked_p(sigset, &gc_sigset, "gc")) {
479         corruption_warning_and_maybe_lose(
480 "Enabling blocked gc signals to allow returning to Lisp without risking\n\
481 gc deadlocks. Since GC signals are only blocked in signal handlers when \n\
482 they are not safe to interrupt at all, this is a pretty severe occurrence.\n");
483         unblock_gc_signals(sigset, 0);
484     }
485 #endif
486     if (!interrupt_handler_pending_p()) {
487         unblock_deferrable_signals(sigset, 0);
488     }
489 #endif
490 }
491 \f
492
493 inline static void
494 check_interrupts_enabled_or_lose(os_context_t *context)
495 {
496     struct thread *thread=arch_os_get_current_thread();
497     if (SymbolValue(INTERRUPTS_ENABLED,thread) == NIL)
498         lose("interrupts not enabled\n");
499     if (arch_pseudo_atomic_atomic(context))
500         lose ("in pseudo atomic section\n");
501 }
502
503 /* Save sigset (or the current sigmask if 0) if there is no pending
504  * handler, because that means that deferabbles are already blocked.
505  * The purpose is to avoid losing the pending gc signal if a
506  * deferrable interrupt async unwinds between clearing the pseudo
507  * atomic and trapping to GC.*/
508 #ifndef LISP_FEATURE_SB_SAFEPOINT
509 void
510 maybe_save_gc_mask_and_block_deferrables(sigset_t *sigset)
511 {
512 #ifndef LISP_FEATURE_WIN32
513     struct thread *thread = arch_os_get_current_thread();
514     struct interrupt_data *data = thread->interrupt_data;
515     sigset_t oldset;
516     /* Obviously, this function is called when signals may not be
517      * blocked. Let's make sure we are not interrupted. */
518     block_blockable_signals(0, &oldset);
519 #ifndef LISP_FEATURE_SB_THREAD
520     /* With threads a SIG_STOP_FOR_GC and a normal GC may also want to
521      * block. */
522     if (data->gc_blocked_deferrables)
523         lose("gc_blocked_deferrables already true\n");
524 #endif
525     if ((!data->pending_handler) &&
526         (!data->gc_blocked_deferrables)) {
527         FSHOW_SIGNAL((stderr,"/setting gc_blocked_deferrables\n"));
528         data->gc_blocked_deferrables = 1;
529         if (sigset) {
530             /* This is the sigmask of some context. */
531             sigcopyset(&data->pending_mask, sigset);
532             sigaddset_deferrable(sigset);
533             thread_sigmask(SIG_SETMASK,&oldset,0);
534             return;
535         } else {
536             /* Operating on the current sigmask. Save oldset and
537              * unblock gc signals. In the end, this is equivalent to
538              * blocking the deferrables. */
539             sigcopyset(&data->pending_mask, &oldset);
540             thread_sigmask(SIG_UNBLOCK, &gc_sigset, 0);
541             return;
542         }
543     }
544     thread_sigmask(SIG_SETMASK,&oldset,0);
545 #endif
546 }
547 #endif
548
549 /* Are we leaving WITH-GCING and already running with interrupts
550  * enabled, without the protection of *GC-INHIBIT* T and there is gc
551  * (or stop for gc) pending, but we haven't trapped yet? */
552 int
553 in_leaving_without_gcing_race_p(struct thread *thread)
554 {
555     return ((SymbolValue(IN_WITHOUT_GCING,thread) != NIL) &&
556             (SymbolValue(INTERRUPTS_ENABLED,thread) != NIL) &&
557             (SymbolValue(GC_INHIBIT,thread) == NIL) &&
558             ((SymbolValue(GC_PENDING,thread) != NIL)
559 #if defined(LISP_FEATURE_SB_THREAD)
560              || (SymbolValue(STOP_FOR_GC_PENDING,thread) != NIL)
561 #endif
562              ));
563 }
564
565 /* Check our baroque invariants. */
566 void
567 check_interrupt_context_or_lose(os_context_t *context)
568 {
569 #if !defined(LISP_FEATURE_WIN32) || defined(LISP_FEATURE_SB_THREAD)
570     struct thread *thread = arch_os_get_current_thread();
571     struct interrupt_data *data = thread->interrupt_data;
572     int interrupt_deferred_p = (data->pending_handler != 0);
573     int interrupt_pending = (SymbolValue(INTERRUPT_PENDING,thread) != NIL);
574     sigset_t *sigset = os_context_sigmask_addr(context);
575     /* On PPC pseudo_atomic_interrupted is cleared when coming out of
576      * handle_allocation_trap. */
577 #if defined(LISP_FEATURE_GENCGC) && !defined(GENCGC_IS_PRECISE)
578     int interrupts_enabled = (SymbolValue(INTERRUPTS_ENABLED,thread) != NIL);
579     int gc_inhibit = (SymbolValue(GC_INHIBIT,thread) != NIL);
580     int gc_pending = (SymbolValue(GC_PENDING,thread) == T);
581     int pseudo_atomic_interrupted = get_pseudo_atomic_interrupted(thread);
582     int in_race_p = in_leaving_without_gcing_race_p(thread);
583     /* In the time window between leaving the *INTERRUPTS-ENABLED* NIL
584      * section and trapping, a SIG_STOP_FOR_GC would see the next
585      * check fail, for this reason sig_stop_for_gc handler does not
586      * call this function. */
587     if (interrupt_deferred_p) {
588         if (!(!interrupts_enabled || pseudo_atomic_interrupted || in_race_p))
589             lose("Stray deferred interrupt.\n");
590     }
591     if (gc_pending)
592         if (!(pseudo_atomic_interrupted || gc_inhibit || in_race_p))
593             lose("GC_PENDING, but why?\n");
594 #if defined(LISP_FEATURE_SB_THREAD)
595     {
596         int stop_for_gc_pending =
597             (SymbolValue(STOP_FOR_GC_PENDING,thread) != NIL);
598         if (stop_for_gc_pending)
599             if (!(pseudo_atomic_interrupted || gc_inhibit || in_race_p))
600                 lose("STOP_FOR_GC_PENDING, but why?\n");
601         if (pseudo_atomic_interrupted)
602             if (!(gc_pending || stop_for_gc_pending || interrupt_deferred_p))
603                 lose("pseudo_atomic_interrupted, but why?\n");
604     }
605 #else
606     if (pseudo_atomic_interrupted)
607         if (!(gc_pending || interrupt_deferred_p))
608             lose("pseudo_atomic_interrupted, but why?\n");
609 #endif
610 #endif
611     if (interrupt_pending && !interrupt_deferred_p)
612         lose("INTERRUPT_PENDING but not pending handler.\n");
613     if ((data->gc_blocked_deferrables) && interrupt_pending)
614         lose("gc_blocked_deferrables and interrupt pending\n.");
615     if (data->gc_blocked_deferrables)
616         check_deferrables_blocked_or_lose(sigset);
617     if (interrupt_pending || interrupt_deferred_p ||
618         data->gc_blocked_deferrables)
619         check_deferrables_blocked_or_lose(sigset);
620     else {
621         check_deferrables_unblocked_or_lose(sigset);
622 #ifndef LISP_FEATURE_SB_SAFEPOINT
623         /* If deferrables are unblocked then we are open to signals
624          * that run lisp code. */
625         check_gc_signals_unblocked_or_lose(sigset);
626 #endif
627     }
628 #endif
629 }
630 \f
631 /*
632  * utility routines used by various signal handlers
633  */
634
635 static void
636 build_fake_control_stack_frames(struct thread *th,os_context_t *context)
637 {
638 #ifndef LISP_FEATURE_C_STACK_IS_CONTROL_STACK
639
640     lispobj oldcont;
641
642     /* Build a fake stack frame or frames */
643
644     access_control_frame_pointer(th) =
645         (lispobj *)(uword_t)
646             (*os_context_register_addr(context, reg_CSP));
647     if ((lispobj *)(uword_t)
648             (*os_context_register_addr(context, reg_CFP))
649         == access_control_frame_pointer(th)) {
650         /* There is a small window during call where the callee's
651          * frame isn't built yet. */
652         if (lowtag_of(*os_context_register_addr(context, reg_CODE))
653             == FUN_POINTER_LOWTAG) {
654             /* We have called, but not built the new frame, so
655              * build it for them. */
656             access_control_frame_pointer(th)[0] =
657                 *os_context_register_addr(context, reg_OCFP);
658             access_control_frame_pointer(th)[1] =
659                 *os_context_register_addr(context, reg_LRA);
660             access_control_frame_pointer(th) += 8;
661             /* Build our frame on top of it. */
662             oldcont = (lispobj)(*os_context_register_addr(context, reg_CFP));
663         }
664         else {
665             /* We haven't yet called, build our frame as if the
666              * partial frame wasn't there. */
667             oldcont = (lispobj)(*os_context_register_addr(context, reg_OCFP));
668         }
669     }
670     /* We can't tell whether we are still in the caller if it had to
671      * allocate a stack frame due to stack arguments. */
672     /* This observation provoked some past CMUCL maintainer to ask
673      * "Can anything strange happen during return?" */
674     else {
675         /* normal case */
676         oldcont = (lispobj)(*os_context_register_addr(context, reg_CFP));
677     }
678
679     access_control_stack_pointer(th) = access_control_frame_pointer(th) + 8;
680
681     access_control_frame_pointer(th)[0] = oldcont;
682     access_control_frame_pointer(th)[1] = NIL;
683     access_control_frame_pointer(th)[2] =
684         (lispobj)(*os_context_register_addr(context, reg_CODE));
685 #endif
686 }
687
688 /* Stores the context for gc to scavange and builds fake stack
689  * frames. */
690 void
691 fake_foreign_function_call(os_context_t *context)
692 {
693     int context_index;
694     struct thread *thread=arch_os_get_current_thread();
695
696     /* context_index incrementing must not be interrupted */
697     check_blockables_blocked_or_lose(0);
698
699     /* Get current Lisp state from context. */
700 #ifdef reg_ALLOC
701 #ifdef LISP_FEATURE_SB_THREAD
702     thread->pseudo_atomic_bits =
703 #else
704     dynamic_space_free_pointer =
705         (lispobj *)(uword_t)
706 #endif
707             (*os_context_register_addr(context, reg_ALLOC));
708 /*     fprintf(stderr,"dynamic_space_free_pointer: %p\n", */
709 /*             dynamic_space_free_pointer); */
710 #if defined(LISP_FEATURE_ALPHA) || defined(LISP_FEATURE_MIPS)
711     if ((sword_t)dynamic_space_free_pointer & 1) {
712         lose("dead in fake_foreign_function_call, context = %x\n", context);
713     }
714 #endif
715 /* why doesnt PPC and SPARC do something like this: */
716 #if defined(LISP_FEATURE_HPPA)
717     if ((sword_t)dynamic_space_free_pointer & 4) {
718         lose("dead in fake_foreign_function_call, context = %x, d_s_f_p = %x\n", context, dynamic_space_free_pointer);
719     }
720 #endif
721 #endif
722 #ifdef reg_BSP
723     set_binding_stack_pointer(thread,
724         *os_context_register_addr(context, reg_BSP));
725 #endif
726
727     build_fake_control_stack_frames(thread,context);
728
729     /* Do dynamic binding of the active interrupt context index
730      * and save the context in the context array. */
731     context_index =
732         fixnum_value(SymbolValue(FREE_INTERRUPT_CONTEXT_INDEX,thread));
733
734     if (context_index >= MAX_INTERRUPTS) {
735         lose("maximum interrupt nesting depth (%d) exceeded\n", MAX_INTERRUPTS);
736     }
737
738     bind_variable(FREE_INTERRUPT_CONTEXT_INDEX,
739                   make_fixnum(context_index + 1),thread);
740
741     thread->interrupt_contexts[context_index] = context;
742
743 #if !defined(LISP_FEATURE_X86) && !defined(LISP_FEATURE_X86_64)
744     /* x86oid targets don't maintain the foreign function call flag at
745      * all, so leave them to believe that they are never in foreign
746      * code. */
747     foreign_function_call_active_p(thread) = 1;
748 #endif
749 }
750
751 /* blocks all blockable signals.  If you are calling from a signal handler,
752  * the usual signal mask will be restored from the context when the handler
753  * finishes.  Otherwise, be careful */
754 void
755 undo_fake_foreign_function_call(os_context_t *context)
756 {
757     struct thread *thread=arch_os_get_current_thread();
758     /* Block all blockable signals. */
759     block_blockable_signals(0, 0);
760
761     foreign_function_call_active_p(thread) = 0;
762
763     /* Undo dynamic binding of FREE_INTERRUPT_CONTEXT_INDEX */
764     unbind(thread);
765
766 #if defined(reg_ALLOC) && !defined(LISP_FEATURE_SB_THREAD)
767     /* Put the dynamic space free pointer back into the context. */
768     *os_context_register_addr(context, reg_ALLOC) =
769         (uword_t) dynamic_space_free_pointer
770         | (*os_context_register_addr(context, reg_ALLOC)
771            & LOWTAG_MASK);
772     /*
773       ((uword_t)(*os_context_register_addr(context, reg_ALLOC))
774       & ~LOWTAG_MASK)
775       | ((uword_t) dynamic_space_free_pointer & LOWTAG_MASK);
776     */
777 #endif
778 #if defined(reg_ALLOC) && defined(LISP_FEATURE_SB_THREAD)
779     /* Put the pseudo-atomic bits and dynamic space free pointer back
780      * into the context (p-a-bits for p-a, and dynamic space free
781      * pointer for ROOM). */
782     *os_context_register_addr(context, reg_ALLOC) =
783         (uword_t) dynamic_space_free_pointer
784         | (thread->pseudo_atomic_bits & LOWTAG_MASK);
785     /* And clear them so we don't get bit later by call-in/call-out
786      * not updating them. */
787     thread->pseudo_atomic_bits = 0;
788 #endif
789 }
790
791 /* a handler for the signal caused by execution of a trap opcode
792  * signalling an internal error */
793 void
794 interrupt_internal_error(os_context_t *context, boolean continuable)
795 {
796     lispobj context_sap;
797
798     fake_foreign_function_call(context);
799
800     if (!internal_errors_enabled) {
801         describe_internal_error(context);
802         /* There's no good way to recover from an internal error
803          * before the Lisp error handling mechanism is set up. */
804         lose("internal error too early in init, can't recover\n");
805     }
806
807     /* Allocate the SAP object while the interrupts are still
808      * disabled. */
809 #ifndef LISP_FEATURE_SB_SAFEPOINT
810     unblock_gc_signals(0, 0);
811 #endif
812     context_sap = alloc_sap(context);
813
814 #if !defined(LISP_FEATURE_WIN32) || defined(LISP_FEATURE_SB_THREAD)
815     thread_sigmask(SIG_SETMASK, os_context_sigmask_addr(context), 0);
816 #endif
817
818 #if defined(LISP_FEATURE_LINUX) && defined(LISP_FEATURE_MIPS)
819     /* Workaround for blocked SIGTRAP. */
820     {
821         sigset_t newset;
822         sigemptyset(&newset);
823         sigaddset(&newset, SIGTRAP);
824         thread_sigmask(SIG_UNBLOCK, &newset, 0);
825     }
826 #endif
827
828     SHOW("in interrupt_internal_error");
829 #if QSHOW == 2
830     /* Display some rudimentary debugging information about the
831      * error, so that even if the Lisp error handler gets badly
832      * confused, we have a chance to determine what's going on. */
833     describe_internal_error(context);
834 #endif
835     funcall2(StaticSymbolFunction(INTERNAL_ERROR), context_sap,
836              continuable ? T : NIL);
837
838     undo_fake_foreign_function_call(context); /* blocks signals again */
839     if (continuable)
840         arch_skip_instruction(context);
841 }
842
843 boolean
844 interrupt_handler_pending_p(void)
845 {
846     struct thread *thread = arch_os_get_current_thread();
847     struct interrupt_data *data = thread->interrupt_data;
848     return (data->pending_handler != 0);
849 }
850
851 void
852 interrupt_handle_pending(os_context_t *context)
853 {
854     /* There are three ways we can get here. First, if an interrupt
855      * occurs within pseudo-atomic, it will be deferred, and we'll
856      * trap to here at the end of the pseudo-atomic block. Second, if
857      * the GC (in alloc()) decides that a GC is required, it will set
858      * *GC-PENDING* and pseudo-atomic-interrupted if not *GC-INHIBIT*,
859      * and alloc() is always called from within pseudo-atomic, and
860      * thus we end up here again. Third, when calling GC-ON or at the
861      * end of a WITHOUT-GCING, MAYBE-HANDLE-PENDING-GC will trap to
862      * here if there is a pending GC. Fourth, ahem, at the end of
863      * WITHOUT-INTERRUPTS (bar complications with nesting).
864      *
865      * A fourth way happens with safepoints: In addition to a stop for
866      * GC that is pending, there are thruptions.  Both mechanisms are
867      * mostly signal-free, yet also of an asynchronous nature, so it makes
868      * sense to let interrupt_handle_pending take care of running them:
869      * It gets run precisely at those places where it is safe to process
870      * pending asynchronous tasks. */
871
872     struct thread *thread = arch_os_get_current_thread();
873     struct interrupt_data *data = thread->interrupt_data;
874
875     if (arch_pseudo_atomic_atomic(context)) {
876         lose("Handling pending interrupt in pseudo atomic.");
877     }
878
879     FSHOW_SIGNAL((stderr, "/entering interrupt_handle_pending\n"));
880
881     check_blockables_blocked_or_lose(0);
882 #ifndef LISP_FEATURE_SB_SAFEPOINT
883     /*
884      * (On safepoint builds, there is no gc_blocked_deferrables nor
885      * SIG_STOP_FOR_GC.)
886      */
887     /* If GC/SIG_STOP_FOR_GC struck during PA and there was no pending
888      * handler, then the pending mask was saved and
889      * gc_blocked_deferrables set. Hence, there can be no pending
890      * handler and it's safe to restore the pending mask.
891      *
892      * Note, that if gc_blocked_deferrables is false we may still have
893      * to GC. In this case, we are coming out of a WITHOUT-GCING or a
894      * pseudo atomic was interrupt be a deferrable first. */
895     if (data->gc_blocked_deferrables) {
896         if (data->pending_handler)
897             lose("GC blocked deferrables but still got a pending handler.");
898         if (SymbolValue(GC_INHIBIT,thread)!=NIL)
899             lose("GC blocked deferrables while GC is inhibited.");
900         /* Restore the saved signal mask from the original signal (the
901          * one that interrupted us during the critical section) into
902          * the os_context for the signal we're currently in the
903          * handler for. This should ensure that when we return from
904          * the handler the blocked signals are unblocked. */
905 #ifndef LISP_FEATURE_WIN32
906         sigcopyset(os_context_sigmask_addr(context), &data->pending_mask);
907 #endif
908         data->gc_blocked_deferrables = 0;
909     }
910 #endif
911
912     if (SymbolValue(GC_INHIBIT,thread)==NIL) {
913         void *original_pending_handler = data->pending_handler;
914
915 #ifdef LISP_FEATURE_SB_SAFEPOINT
916         /* handles the STOP_FOR_GC_PENDING case, plus THRUPTIONS */
917         if (SymbolValue(STOP_FOR_GC_PENDING,thread) != NIL
918 # ifdef LISP_FEATURE_SB_THRUPTION
919              || (SymbolValue(THRUPTION_PENDING,thread) != NIL
920                  && SymbolValue(INTERRUPTS_ENABLED, thread) != NIL)
921 # endif
922             )
923             /* We ought to take this chance to do a pitstop now. */
924             thread_in_lisp_raised(context);
925 #elif defined(LISP_FEATURE_SB_THREAD)
926         if (SymbolValue(STOP_FOR_GC_PENDING,thread) != NIL) {
927             /* STOP_FOR_GC_PENDING and GC_PENDING are cleared by
928              * the signal handler if it actually stops us. */
929             arch_clear_pseudo_atomic_interrupted(context);
930             sig_stop_for_gc_handler(SIG_STOP_FOR_GC,NULL,context);
931         } else
932 #endif
933          /* Test for T and not for != NIL since the value :IN-PROGRESS
934           * is used in SUB-GC as part of the mechanism to supress
935           * recursive gcs.*/
936         if (SymbolValue(GC_PENDING,thread) == T) {
937
938             /* Two reasons for doing this. First, if there is a
939              * pending handler we don't want to run. Second, we are
940              * going to clear pseudo atomic interrupted to avoid
941              * spurious trapping on every allocation in SUB_GC and
942              * having a pending handler with interrupts enabled and
943              * without pseudo atomic interrupted breaks an
944              * invariant. */
945             if (data->pending_handler) {
946                 bind_variable(ALLOW_WITH_INTERRUPTS, NIL, thread);
947                 bind_variable(INTERRUPTS_ENABLED, NIL, thread);
948             }
949
950             arch_clear_pseudo_atomic_interrupted(context);
951
952             /* GC_PENDING is cleared in SUB-GC, or if another thread
953              * is doing a gc already we will get a SIG_STOP_FOR_GC and
954              * that will clear it.
955              *
956              * If there is a pending handler or gc was triggerred in a
957              * signal handler then maybe_gc won't run POST_GC and will
958              * return normally. */
959             if (!maybe_gc(context))
960                 lose("GC not inhibited but maybe_gc did not GC.");
961
962             if (data->pending_handler) {
963                 unbind(thread);
964                 unbind(thread);
965             }
966         } else if (SymbolValue(GC_PENDING,thread) != NIL) {
967             /* It's not NIL or T so GC_PENDING is :IN-PROGRESS. If
968              * GC-PENDING is not NIL then we cannot trap on pseudo
969              * atomic due to GC (see if(GC_PENDING) logic in
970              * cheneygc.c an gengcgc.c), plus there is a outer
971              * WITHOUT-INTERRUPTS SUB_GC, so how did we end up
972              * here? */
973             lose("Trapping to run pending handler while GC in progress.");
974         }
975
976         check_blockables_blocked_or_lose(0);
977
978         /* No GC shall be lost. If SUB_GC triggers another GC then
979          * that should be handled on the spot. */
980         if (SymbolValue(GC_PENDING,thread) != NIL)
981             lose("GC_PENDING after doing gc.");
982 #ifdef THREADS_USING_GCSIGNAL
983         if (SymbolValue(STOP_FOR_GC_PENDING,thread) != NIL)
984             lose("STOP_FOR_GC_PENDING after doing gc.");
985 #endif
986         /* Check two things. First, that gc does not clobber a handler
987          * that's already pending. Second, that there is no interrupt
988          * lossage: if original_pending_handler was NULL then even if
989          * an interrupt arrived during GC (POST-GC, really) it was
990          * handled. */
991         if (original_pending_handler != data->pending_handler)
992             lose("pending handler changed in gc: %x -> %x.",
993                  original_pending_handler, data->pending_handler);
994     }
995
996 #ifndef LISP_FEATURE_WIN32
997     /* There may be no pending handler, because it was only a gc that
998      * had to be executed or because Lisp is a bit too eager to call
999      * DO-PENDING-INTERRUPT. */
1000     if ((SymbolValue(INTERRUPTS_ENABLED,thread) != NIL) &&
1001         (data->pending_handler))  {
1002         /* No matter how we ended up here, clear both
1003          * INTERRUPT_PENDING and pseudo atomic interrupted. It's safe
1004          * because we checked above that there is no GC pending. */
1005         SetSymbolValue(INTERRUPT_PENDING, NIL, thread);
1006         arch_clear_pseudo_atomic_interrupted(context);
1007         /* Restore the sigmask in the context. */
1008         sigcopyset(os_context_sigmask_addr(context), &data->pending_mask);
1009         run_deferred_handler(data, context);
1010     }
1011 #ifdef LISP_FEATURE_SB_THRUPTION
1012     if (SymbolValue(THRUPTION_PENDING,thread)==T)
1013         /* Special case for the following situation: There is a
1014          * thruption pending, but a signal had been deferred.  The
1015          * pitstop at the top of this function could only take care
1016          * of GC, and skipped the thruption, so we need to try again
1017          * now that INTERRUPT_PENDING and the sigmask have been
1018          * reset. */
1019         while (check_pending_thruptions(context))
1020             ;
1021 #endif
1022 #endif
1023 #ifdef LISP_FEATURE_GENCGC
1024     if (get_pseudo_atomic_interrupted(thread))
1025         lose("pseudo_atomic_interrupted after interrupt_handle_pending\n");
1026 #endif
1027     /* It is possible that the end of this function was reached
1028      * without never actually doing anything, the tests in Lisp for
1029      * when to call receive-pending-interrupt are not exact. */
1030     FSHOW_SIGNAL((stderr, "/exiting interrupt_handle_pending\n"));
1031 }
1032 \f
1033
1034 void
1035 interrupt_handle_now(int signal, siginfo_t *info, os_context_t *context)
1036 {
1037     boolean were_in_lisp;
1038     union interrupt_handler handler;
1039
1040     check_blockables_blocked_or_lose(0);
1041
1042 #if !defined(LISP_FEATURE_WIN32) || defined(LISP_FEATURE_SB_THREAD)
1043     if (sigismember(&deferrable_sigset,signal))
1044         check_interrupts_enabled_or_lose(context);
1045 #endif
1046
1047     handler = interrupt_handlers[signal];
1048
1049     if (ARE_SAME_HANDLER(handler.c, SIG_IGN)) {
1050         return;
1051     }
1052
1053     were_in_lisp = !foreign_function_call_active_p(arch_os_get_current_thread());
1054     if (were_in_lisp)
1055     {
1056         fake_foreign_function_call(context);
1057     }
1058
1059     FSHOW_SIGNAL((stderr,
1060                   "/entering interrupt_handle_now(%d, info, context)\n",
1061                   signal));
1062
1063     if (ARE_SAME_HANDLER(handler.c, SIG_DFL)) {
1064
1065         /* This can happen if someone tries to ignore or default one
1066          * of the signals we need for runtime support, and the runtime
1067          * support decides to pass on it. */
1068         lose("no handler for signal %d in interrupt_handle_now(..)\n", signal);
1069
1070     } else if (lowtag_of(handler.lisp) == FUN_POINTER_LOWTAG) {
1071         /* Once we've decided what to do about contexts in a
1072          * return-elsewhere world (the original context will no longer
1073          * be available; should we copy it or was nobody using it anyway?)
1074          * then we should convert this to return-elsewhere */
1075
1076         /* CMUCL comment said "Allocate the SAPs while the interrupts
1077          * are still disabled.".  I (dan, 2003.08.21) assume this is
1078          * because we're not in pseudoatomic and allocation shouldn't
1079          * be interrupted.  In which case it's no longer an issue as
1080          * all our allocation from C now goes through a PA wrapper,
1081          * but still, doesn't hurt.
1082          *
1083          * Yeah, but non-gencgc platforms don't really wrap allocation
1084          * in PA. MG - 2005-08-29  */
1085
1086         lispobj info_sap, context_sap;
1087         /* Leave deferrable signals blocked, the handler itself will
1088          * allow signals again when it sees fit. */
1089 #ifndef LISP_FEATURE_SB_SAFEPOINT
1090         unblock_gc_signals(0, 0);
1091 #endif
1092         context_sap = alloc_sap(context);
1093         info_sap = alloc_sap(info);
1094
1095         FSHOW_SIGNAL((stderr,"/calling Lisp-level handler\n"));
1096
1097 #ifdef LISP_FEATURE_SB_SAFEPOINT
1098         WITH_GC_AT_SAFEPOINTS_ONLY()
1099 #endif
1100         funcall3(handler.lisp,
1101                  make_fixnum(signal),
1102                  info_sap,
1103                  context_sap);
1104     } else {
1105         /* This cannot happen in sane circumstances. */
1106
1107         FSHOW_SIGNAL((stderr,"/calling C-level handler\n"));
1108
1109 #if !defined(LISP_FEATURE_WIN32) || defined(LISP_FEATURE_SB_THREAD)
1110         /* Allow signals again. */
1111         thread_sigmask(SIG_SETMASK, os_context_sigmask_addr(context), 0);
1112         (*handler.c)(signal, info, context);
1113 #endif
1114     }
1115
1116     if (were_in_lisp)
1117     {
1118         undo_fake_foreign_function_call(context); /* block signals again */
1119     }
1120
1121     FSHOW_SIGNAL((stderr,
1122                   "/returning from interrupt_handle_now(%d, info, context)\n",
1123                   signal));
1124 }
1125
1126 /* This is called at the end of a critical section if the indications
1127  * are that some signal was deferred during the section.  Note that as
1128  * far as C or the kernel is concerned we dealt with the signal
1129  * already; we're just doing the Lisp-level processing now that we
1130  * put off then */
1131 static void
1132 run_deferred_handler(struct interrupt_data *data, os_context_t *context)
1133 {
1134     /* The pending_handler may enable interrupts and then another
1135      * interrupt may hit, overwrite interrupt_data, so reset the
1136      * pending handler before calling it. Trust the handler to finish
1137      * with the siginfo before enabling interrupts. */
1138     void (*pending_handler) (int, siginfo_t*, os_context_t*) =
1139         data->pending_handler;
1140
1141     data->pending_handler=0;
1142     FSHOW_SIGNAL((stderr, "/running deferred handler %p\n", pending_handler));
1143     (*pending_handler)(data->pending_signal,&(data->pending_info), context);
1144 }
1145
1146 #ifndef LISP_FEATURE_WIN32
1147 boolean
1148 maybe_defer_handler(void *handler, struct interrupt_data *data,
1149                     int signal, siginfo_t *info, os_context_t *context)
1150 {
1151     struct thread *thread=arch_os_get_current_thread();
1152
1153     check_blockables_blocked_or_lose(0);
1154
1155     if (SymbolValue(INTERRUPT_PENDING,thread) != NIL)
1156         lose("interrupt already pending\n");
1157     if (thread->interrupt_data->pending_handler)
1158         lose("there is a pending handler already (PA)\n");
1159     if (data->gc_blocked_deferrables)
1160         lose("maybe_defer_handler: gc_blocked_deferrables true\n");
1161     check_interrupt_context_or_lose(context);
1162     /* If interrupts are disabled then INTERRUPT_PENDING is set and
1163      * not PSEDUO_ATOMIC_INTERRUPTED. This is important for a pseudo
1164      * atomic section inside a WITHOUT-INTERRUPTS.
1165      *
1166      * Also, if in_leaving_without_gcing_race_p then
1167      * interrupt_handle_pending is going to be called soon, so
1168      * stashing the signal away is safe.
1169      */
1170     if ((SymbolValue(INTERRUPTS_ENABLED,thread) == NIL) ||
1171         in_leaving_without_gcing_race_p(thread)) {
1172         FSHOW_SIGNAL((stderr,
1173                       "/maybe_defer_handler(%x,%d): deferred (RACE=%d)\n",
1174                       (unsigned int)handler,signal,
1175                       in_leaving_without_gcing_race_p(thread)));
1176         store_signal_data_for_later(data,handler,signal,info,context);
1177         SetSymbolValue(INTERRUPT_PENDING, T,thread);
1178         check_interrupt_context_or_lose(context);
1179         return 1;
1180     }
1181     /* a slightly confusing test. arch_pseudo_atomic_atomic() doesn't
1182      * actually use its argument for anything on x86, so this branch
1183      * may succeed even when context is null (gencgc alloc()) */
1184     if (arch_pseudo_atomic_atomic(context)) {
1185         FSHOW_SIGNAL((stderr,
1186                       "/maybe_defer_handler(%x,%d): deferred(PA)\n",
1187                       (unsigned int)handler,signal));
1188         store_signal_data_for_later(data,handler,signal,info,context);
1189         arch_set_pseudo_atomic_interrupted(context);
1190         check_interrupt_context_or_lose(context);
1191         return 1;
1192     }
1193     FSHOW_SIGNAL((stderr,
1194                   "/maybe_defer_handler(%x,%d): not deferred\n",
1195                   (unsigned int)handler,signal));
1196     return 0;
1197 }
1198
1199 static void
1200 store_signal_data_for_later (struct interrupt_data *data, void *handler,
1201                              int signal,
1202                              siginfo_t *info, os_context_t *context)
1203 {
1204     if (data->pending_handler)
1205         lose("tried to overwrite pending interrupt handler %x with %x\n",
1206              data->pending_handler, handler);
1207     if (!handler)
1208         lose("tried to defer null interrupt handler\n");
1209     data->pending_handler = handler;
1210     data->pending_signal = signal;
1211     if(info)
1212         memcpy(&(data->pending_info), info, sizeof(siginfo_t));
1213
1214     FSHOW_SIGNAL((stderr, "/store_signal_data_for_later: signal: %d\n",
1215                   signal));
1216
1217     if(!context)
1218         lose("Null context");
1219
1220     /* the signal mask in the context (from before we were
1221      * interrupted) is copied to be restored when run_deferred_handler
1222      * happens. Then the usually-blocked signals are added to the mask
1223      * in the context so that we are running with blocked signals when
1224      * the handler returns */
1225     sigcopyset(&(data->pending_mask),os_context_sigmask_addr(context));
1226     sigaddset_deferrable(os_context_sigmask_addr(context));
1227 }
1228
1229 static void
1230 maybe_now_maybe_later(int signal, siginfo_t *info, void *void_context)
1231 {
1232     SAVE_ERRNO(signal,context,void_context);
1233     struct thread *thread = arch_os_get_current_thread();
1234     struct interrupt_data *data = thread->interrupt_data;
1235     if(!maybe_defer_handler(interrupt_handle_now,data,signal,info,context))
1236         interrupt_handle_now(signal, info, context);
1237     RESTORE_ERRNO;
1238 }
1239
1240 static void
1241 low_level_interrupt_handle_now(int signal, siginfo_t *info,
1242                                os_context_t *context)
1243 {
1244     /* No FP control fixage needed, caller has done that. */
1245     check_blockables_blocked_or_lose(0);
1246     check_interrupts_enabled_or_lose(context);
1247     (*interrupt_low_level_handlers[signal])(signal, info, context);
1248     /* No Darwin context fixage needed, caller does that. */
1249 }
1250
1251 static void
1252 low_level_maybe_now_maybe_later(int signal, siginfo_t *info, void *void_context)
1253 {
1254     SAVE_ERRNO(signal,context,void_context);
1255     struct thread *thread = arch_os_get_current_thread();
1256     struct interrupt_data *data = thread->interrupt_data;
1257
1258     if(!maybe_defer_handler(low_level_interrupt_handle_now,data,
1259                             signal,info,context))
1260         low_level_interrupt_handle_now(signal, info, context);
1261     RESTORE_ERRNO;
1262 }
1263 #endif
1264
1265 #ifdef THREADS_USING_GCSIGNAL
1266
1267 /* This function must not cons, because that may trigger a GC. */
1268 void
1269 sig_stop_for_gc_handler(int signal, siginfo_t *info, os_context_t *context)
1270 {
1271     struct thread *thread=arch_os_get_current_thread();
1272     boolean was_in_lisp;
1273
1274     /* Test for GC_INHIBIT _first_, else we'd trap on every single
1275      * pseudo atomic until gc is finally allowed. */
1276     if (SymbolValue(GC_INHIBIT,thread) != NIL) {
1277         FSHOW_SIGNAL((stderr, "sig_stop_for_gc deferred (*GC-INHIBIT*)\n"));
1278         SetSymbolValue(STOP_FOR_GC_PENDING,T,thread);
1279         return;
1280     } else if (arch_pseudo_atomic_atomic(context)) {
1281         FSHOW_SIGNAL((stderr,"sig_stop_for_gc deferred (PA)\n"));
1282         SetSymbolValue(STOP_FOR_GC_PENDING,T,thread);
1283         arch_set_pseudo_atomic_interrupted(context);
1284         maybe_save_gc_mask_and_block_deferrables
1285             (os_context_sigmask_addr(context));
1286         return;
1287     }
1288
1289     FSHOW_SIGNAL((stderr, "/sig_stop_for_gc_handler\n"));
1290
1291     /* Not PA and GC not inhibited -- we can stop now. */
1292
1293     was_in_lisp = !foreign_function_call_active_p(arch_os_get_current_thread());
1294
1295     if (was_in_lisp) {
1296         /* need the context stored so it can have registers scavenged */
1297         fake_foreign_function_call(context);
1298     }
1299
1300     /* Not pending anymore. */
1301     SetSymbolValue(GC_PENDING,NIL,thread);
1302     SetSymbolValue(STOP_FOR_GC_PENDING,NIL,thread);
1303
1304     /* Consider this: in a PA section GC is requested: GC_PENDING,
1305      * pseudo_atomic_interrupted and gc_blocked_deferrables are set,
1306      * deferrables are blocked then pseudo_atomic_atomic is cleared,
1307      * but a SIG_STOP_FOR_GC arrives before trapping to
1308      * interrupt_handle_pending. Here, GC_PENDING is cleared but
1309      * pseudo_atomic_interrupted is not and we go on running with
1310      * pseudo_atomic_interrupted but without a pending interrupt or
1311      * GC. GC_BLOCKED_DEFERRABLES is also left at 1. So let's tidy it
1312      * up. */
1313     if (thread->interrupt_data->gc_blocked_deferrables) {
1314         FSHOW_SIGNAL((stderr,"cleaning up after gc_blocked_deferrables\n"));
1315         clear_pseudo_atomic_interrupted(thread);
1316         sigcopyset(os_context_sigmask_addr(context),
1317                    &thread->interrupt_data->pending_mask);
1318         thread->interrupt_data->gc_blocked_deferrables = 0;
1319     }
1320
1321     if(thread_state(thread)!=STATE_RUNNING) {
1322         lose("sig_stop_for_gc_handler: wrong thread state: %ld\n",
1323              fixnum_value(thread->state));
1324     }
1325
1326     set_thread_state(thread,STATE_STOPPED);
1327     FSHOW_SIGNAL((stderr,"suspended\n"));
1328
1329     /* While waiting for gc to finish occupy ourselves with zeroing
1330      * the unused portion of the control stack to reduce conservatism.
1331      * On hypothetic platforms with threads and exact gc it is
1332      * actually a must. */
1333     scrub_control_stack();
1334
1335     wait_for_thread_state_change(thread, STATE_STOPPED);
1336     FSHOW_SIGNAL((stderr,"resumed\n"));
1337
1338     if(thread_state(thread)!=STATE_RUNNING) {
1339         lose("sig_stop_for_gc_handler: wrong thread state on wakeup: %ld\n",
1340              fixnum_value(thread_state(thread)));
1341     }
1342
1343     if (was_in_lisp) {
1344         undo_fake_foreign_function_call(context);
1345     }
1346 }
1347
1348 #endif
1349
1350 void
1351 interrupt_handle_now_handler(int signal, siginfo_t *info, void *void_context)
1352 {
1353     SAVE_ERRNO(signal,context,void_context);
1354 #ifndef LISP_FEATURE_WIN32
1355     if ((signal == SIGILL) || (signal == SIGBUS)
1356 #ifndef LISP_FEATURE_LINUX
1357         || (signal == SIGEMT)
1358 #endif
1359         )
1360         corruption_warning_and_maybe_lose("Signal %d received", signal);
1361 #endif
1362     interrupt_handle_now(signal, info, context);
1363     RESTORE_ERRNO;
1364 }
1365
1366 /* manipulate the signal context and stack such that when the handler
1367  * returns, it will call function instead of whatever it was doing
1368  * previously
1369  */
1370
1371 #if (defined(LISP_FEATURE_X86) || defined(LISP_FEATURE_X86_64))
1372 extern int *context_eflags_addr(os_context_t *context);
1373 #endif
1374
1375 extern lispobj call_into_lisp(lispobj fun, lispobj *args, int nargs);
1376 extern void post_signal_tramp(void);
1377 extern void call_into_lisp_tramp(void);
1378
1379 void
1380 arrange_return_to_c_function(os_context_t *context,
1381                              call_into_lisp_lookalike funptr,
1382                              lispobj function)
1383 {
1384 #if !(defined(LISP_FEATURE_WIN32) || defined(LISP_FEATURE_SB_SAFEPOINT))
1385     check_gc_signals_unblocked_or_lose
1386         (os_context_sigmask_addr(context));
1387 #endif
1388 #if !(defined(LISP_FEATURE_X86) || defined(LISP_FEATURE_X86_64))
1389     void * fun=native_pointer(function);
1390     void *code = &(((struct simple_fun *) fun)->code);
1391 #endif
1392
1393     /* Build a stack frame showing `interrupted' so that the
1394      * user's backtrace makes (as much) sense (as usual) */
1395
1396     /* fp state is saved and restored by call_into_lisp */
1397     /* FIXME: errno is not restored, but since current uses of this
1398      * function only call Lisp code that signals an error, it's not
1399      * much of a problem. In other words, running out of the control
1400      * stack between a syscall and (GET-ERRNO) may clobber errno if
1401      * something fails during signalling or in the handler. But I
1402      * can't see what can go wrong as long as there is no CONTINUE
1403      * like restart on them. */
1404 #ifdef LISP_FEATURE_X86
1405     /* Suppose the existence of some function that saved all
1406      * registers, called call_into_lisp, then restored GP registers and
1407      * returned.  It would look something like this:
1408
1409      push   ebp
1410      mov    ebp esp
1411      pushfl
1412      pushal
1413      push   $0
1414      push   $0
1415      pushl  {address of function to call}
1416      call   0x8058db0 <call_into_lisp>
1417      addl   $12,%esp
1418      popal
1419      popfl
1420      leave
1421      ret
1422
1423      * What we do here is set up the stack that call_into_lisp would
1424      * expect to see if it had been called by this code, and frob the
1425      * signal context so that signal return goes directly to call_into_lisp,
1426      * and when that function (and the lisp function it invoked) returns,
1427      * it returns to the second half of this imaginary function which
1428      * restores all registers and returns to C
1429
1430      * For this to work, the latter part of the imaginary function
1431      * must obviously exist in reality.  That would be post_signal_tramp
1432      */
1433
1434     u32 *sp=(u32 *)*os_context_register_addr(context,reg_ESP);
1435
1436 #if defined(LISP_FEATURE_DARWIN)
1437     u32 *register_save_area = (u32 *)os_validate(0, 0x40);
1438
1439     FSHOW_SIGNAL((stderr, "/arrange_return_to_lisp_function: preparing to go to function %x, sp: %x\n", function, sp));
1440     FSHOW_SIGNAL((stderr, "/arrange_return_to_lisp_function: context: %x, &context %x\n", context, &context));
1441
1442     /* 1. os_validate (malloc/mmap) register_save_block
1443      * 2. copy register state into register_save_block
1444      * 3. put a pointer to register_save_block in a register in the context
1445      * 4. set the context's EIP to point to a trampoline which:
1446      *    a. builds the fake stack frame from the block
1447      *    b. frees the block
1448      *    c. calls the function
1449      */
1450
1451     *register_save_area = *os_context_pc_addr(context);
1452     *(register_save_area + 1) = function;
1453     *(register_save_area + 2) = *os_context_register_addr(context,reg_EDI);
1454     *(register_save_area + 3) = *os_context_register_addr(context,reg_ESI);
1455     *(register_save_area + 4) = *os_context_register_addr(context,reg_EDX);
1456     *(register_save_area + 5) = *os_context_register_addr(context,reg_ECX);
1457     *(register_save_area + 6) = *os_context_register_addr(context,reg_EBX);
1458     *(register_save_area + 7) = *os_context_register_addr(context,reg_EAX);
1459     *(register_save_area + 8) = *context_eflags_addr(context);
1460
1461     *os_context_pc_addr(context) =
1462       (os_context_register_t) funptr;
1463     *os_context_register_addr(context,reg_ECX) =
1464       (os_context_register_t) register_save_area;
1465 #else
1466
1467     /* return address for call_into_lisp: */
1468     *(sp-15) = (u32)post_signal_tramp;
1469     *(sp-14) = function;        /* args for call_into_lisp : function*/
1470     *(sp-13) = 0;               /*                           arg array */
1471     *(sp-12) = 0;               /*                           no. args */
1472     /* this order matches that used in POPAD */
1473     *(sp-11)=*os_context_register_addr(context,reg_EDI);
1474     *(sp-10)=*os_context_register_addr(context,reg_ESI);
1475
1476     *(sp-9)=*os_context_register_addr(context,reg_ESP)-8;
1477     /* POPAD ignores the value of ESP:  */
1478     *(sp-8)=0;
1479     *(sp-7)=*os_context_register_addr(context,reg_EBX);
1480
1481     *(sp-6)=*os_context_register_addr(context,reg_EDX);
1482     *(sp-5)=*os_context_register_addr(context,reg_ECX);
1483     *(sp-4)=*os_context_register_addr(context,reg_EAX);
1484     *(sp-3)=*context_eflags_addr(context);
1485     *(sp-2)=*os_context_register_addr(context,reg_EBP);
1486     *(sp-1)=*os_context_pc_addr(context);
1487
1488 #endif
1489
1490 #elif defined(LISP_FEATURE_X86_64)
1491     u64 *sp=(u64 *)*os_context_register_addr(context,reg_RSP);
1492
1493     /* return address for call_into_lisp: */
1494     *(sp-18) = (u64)post_signal_tramp;
1495
1496     *(sp-17)=*os_context_register_addr(context,reg_R15);
1497     *(sp-16)=*os_context_register_addr(context,reg_R14);
1498     *(sp-15)=*os_context_register_addr(context,reg_R13);
1499     *(sp-14)=*os_context_register_addr(context,reg_R12);
1500     *(sp-13)=*os_context_register_addr(context,reg_R11);
1501     *(sp-12)=*os_context_register_addr(context,reg_R10);
1502     *(sp-11)=*os_context_register_addr(context,reg_R9);
1503     *(sp-10)=*os_context_register_addr(context,reg_R8);
1504     *(sp-9)=*os_context_register_addr(context,reg_RDI);
1505     *(sp-8)=*os_context_register_addr(context,reg_RSI);
1506     /* skip RBP and RSP */
1507     *(sp-7)=*os_context_register_addr(context,reg_RBX);
1508     *(sp-6)=*os_context_register_addr(context,reg_RDX);
1509     *(sp-5)=*os_context_register_addr(context,reg_RCX);
1510     *(sp-4)=*os_context_register_addr(context,reg_RAX);
1511     *(sp-3)=*context_eflags_addr(context);
1512     *(sp-2)=*os_context_register_addr(context,reg_RBP);
1513     *(sp-1)=*os_context_pc_addr(context);
1514
1515     *os_context_register_addr(context,reg_RDI) =
1516         (os_context_register_t)function; /* function */
1517     *os_context_register_addr(context,reg_RSI) = 0;        /* arg. array */
1518     *os_context_register_addr(context,reg_RDX) = 0;        /* no. args */
1519 #else
1520     struct thread *th=arch_os_get_current_thread();
1521     build_fake_control_stack_frames(th,context);
1522 #endif
1523
1524 #ifdef LISP_FEATURE_X86
1525
1526 #if !defined(LISP_FEATURE_DARWIN)
1527     *os_context_pc_addr(context) = (os_context_register_t)funptr;
1528     *os_context_register_addr(context,reg_ECX) = 0;
1529     *os_context_register_addr(context,reg_EBP) = (os_context_register_t)(sp-2);
1530 #ifdef __NetBSD__
1531     *os_context_register_addr(context,reg_UESP) =
1532         (os_context_register_t)(sp-15);
1533 #else
1534     *os_context_register_addr(context,reg_ESP) = (os_context_register_t)(sp-15);
1535 #endif /* __NETBSD__ */
1536 #endif /* LISP_FEATURE_DARWIN */
1537
1538 #elif defined(LISP_FEATURE_X86_64)
1539     *os_context_pc_addr(context) = (os_context_register_t)funptr;
1540     *os_context_register_addr(context,reg_RCX) = 0;
1541     *os_context_register_addr(context,reg_RBP) = (os_context_register_t)(sp-2);
1542     *os_context_register_addr(context,reg_RSP) = (os_context_register_t)(sp-18);
1543 #else
1544     /* this much of the calling convention is common to all
1545        non-x86 ports */
1546     *os_context_pc_addr(context) = (os_context_register_t)(unsigned long)code;
1547     *os_context_register_addr(context,reg_NARGS) = 0;
1548     *os_context_register_addr(context,reg_LIP) =
1549         (os_context_register_t)(unsigned long)code;
1550     *os_context_register_addr(context,reg_CFP) =
1551         (os_context_register_t)(unsigned long)access_control_frame_pointer(th);
1552 #endif
1553 #ifdef ARCH_HAS_NPC_REGISTER
1554     *os_context_npc_addr(context) =
1555         4 + *os_context_pc_addr(context);
1556 #endif
1557 #ifdef LISP_FEATURE_SPARC
1558     *os_context_register_addr(context,reg_CODE) =
1559         (os_context_register_t)(fun + FUN_POINTER_LOWTAG);
1560 #endif
1561     FSHOW((stderr, "/arranged return to Lisp function (0x%lx)\n",
1562            (long)function));
1563 }
1564
1565 void
1566 arrange_return_to_lisp_function(os_context_t *context, lispobj function)
1567 {
1568 #if defined(LISP_FEATURE_DARWIN) && defined(LISP_FEATURE_X86)
1569     arrange_return_to_c_function(context, call_into_lisp_tramp, function);
1570 #else
1571     arrange_return_to_c_function(context, call_into_lisp, function);
1572 #endif
1573 }
1574
1575 /* KLUDGE: Theoretically the approach we use for undefined alien
1576  * variables should work for functions as well, but on PPC/Darwin
1577  * we get bus error at bogus addresses instead, hence this workaround,
1578  * that has the added benefit of automatically discriminating between
1579  * functions and variables.
1580  */
1581 void
1582 undefined_alien_function(void)
1583 {
1584     funcall0(StaticSymbolFunction(UNDEFINED_ALIEN_FUNCTION_ERROR));
1585 }
1586
1587 void lower_thread_control_stack_guard_page(struct thread *th)
1588 {
1589     protect_control_stack_guard_page(0, th);
1590     protect_control_stack_return_guard_page(1, th);
1591     th->control_stack_guard_page_protected = NIL;
1592     fprintf(stderr, "INFO: Control stack guard page unprotected\n");
1593 }
1594
1595 void reset_thread_control_stack_guard_page(struct thread *th)
1596 {
1597     memset(CONTROL_STACK_GUARD_PAGE(th), 0, os_vm_page_size);
1598     protect_control_stack_guard_page(1, th);
1599     protect_control_stack_return_guard_page(0, th);
1600     th->control_stack_guard_page_protected = T;
1601     fprintf(stderr, "INFO: Control stack guard page reprotected\n");
1602 }
1603
1604 /* Called from the REPL, too. */
1605 void reset_control_stack_guard_page(void)
1606 {
1607     struct thread *th=arch_os_get_current_thread();
1608     if (th->control_stack_guard_page_protected == NIL) {
1609         reset_thread_control_stack_guard_page(th);
1610     }
1611 }
1612
1613 void lower_control_stack_guard_page(void)
1614 {
1615     lower_thread_control_stack_guard_page(arch_os_get_current_thread());
1616 }
1617
1618 boolean
1619 handle_guard_page_triggered(os_context_t *context,os_vm_address_t addr)
1620 {
1621     struct thread *th=arch_os_get_current_thread();
1622
1623     if(addr >= CONTROL_STACK_HARD_GUARD_PAGE(th) &&
1624        addr < CONTROL_STACK_HARD_GUARD_PAGE(th) + os_vm_page_size) {
1625         lose("Control stack exhausted");
1626     }
1627     else if(addr >= CONTROL_STACK_GUARD_PAGE(th) &&
1628             addr < CONTROL_STACK_GUARD_PAGE(th) + os_vm_page_size) {
1629         /* We hit the end of the control stack: disable guard page
1630          * protection so the error handler has some headroom, protect the
1631          * previous page so that we can catch returns from the guard page
1632          * and restore it. */
1633         if (th->control_stack_guard_page_protected == NIL)
1634             lose("control_stack_guard_page_protected NIL");
1635         lower_control_stack_guard_page();
1636 #ifdef LISP_FEATURE_C_STACK_IS_CONTROL_STACK
1637         /* For the unfortunate case, when the control stack is
1638          * exhausted in a signal handler. */
1639         unblock_signals_in_context_and_maybe_warn(context);
1640 #endif
1641         arrange_return_to_lisp_function
1642             (context, StaticSymbolFunction(CONTROL_STACK_EXHAUSTED_ERROR));
1643         return 1;
1644     }
1645     else if(addr >= CONTROL_STACK_RETURN_GUARD_PAGE(th) &&
1646             addr < CONTROL_STACK_RETURN_GUARD_PAGE(th) + os_vm_page_size) {
1647         /* We're returning from the guard page: reprotect it, and
1648          * unprotect this one. This works even if we somehow missed
1649          * the return-guard-page, and hit it on our way to new
1650          * exhaustion instead. */
1651         if (th->control_stack_guard_page_protected != NIL)
1652             lose("control_stack_guard_page_protected not NIL");
1653         reset_control_stack_guard_page();
1654         return 1;
1655     }
1656     else if(addr >= BINDING_STACK_HARD_GUARD_PAGE(th) &&
1657             addr < BINDING_STACK_HARD_GUARD_PAGE(th) + os_vm_page_size) {
1658         lose("Binding stack exhausted");
1659     }
1660     else if(addr >= BINDING_STACK_GUARD_PAGE(th) &&
1661             addr < BINDING_STACK_GUARD_PAGE(th) + os_vm_page_size) {
1662         protect_binding_stack_guard_page(0, NULL);
1663         protect_binding_stack_return_guard_page(1, NULL);
1664         fprintf(stderr, "INFO: Binding stack guard page unprotected\n");
1665
1666         /* For the unfortunate case, when the binding stack is
1667          * exhausted in a signal handler. */
1668         unblock_signals_in_context_and_maybe_warn(context);
1669         arrange_return_to_lisp_function
1670             (context, StaticSymbolFunction(BINDING_STACK_EXHAUSTED_ERROR));
1671         return 1;
1672     }
1673     else if(addr >= BINDING_STACK_RETURN_GUARD_PAGE(th) &&
1674             addr < BINDING_STACK_RETURN_GUARD_PAGE(th) + os_vm_page_size) {
1675         protect_binding_stack_guard_page(1, NULL);
1676         protect_binding_stack_return_guard_page(0, NULL);
1677         fprintf(stderr, "INFO: Binding stack guard page reprotected\n");
1678         return 1;
1679     }
1680     else if(addr >= ALIEN_STACK_HARD_GUARD_PAGE(th) &&
1681             addr < ALIEN_STACK_HARD_GUARD_PAGE(th) + os_vm_page_size) {
1682         lose("Alien stack exhausted");
1683     }
1684     else if(addr >= ALIEN_STACK_GUARD_PAGE(th) &&
1685             addr < ALIEN_STACK_GUARD_PAGE(th) + os_vm_page_size) {
1686         protect_alien_stack_guard_page(0, NULL);
1687         protect_alien_stack_return_guard_page(1, NULL);
1688         fprintf(stderr, "INFO: Alien stack guard page unprotected\n");
1689
1690         /* For the unfortunate case, when the alien stack is
1691          * exhausted in a signal handler. */
1692         unblock_signals_in_context_and_maybe_warn(context);
1693         arrange_return_to_lisp_function
1694             (context, StaticSymbolFunction(ALIEN_STACK_EXHAUSTED_ERROR));
1695         return 1;
1696     }
1697     else if(addr >= ALIEN_STACK_RETURN_GUARD_PAGE(th) &&
1698             addr < ALIEN_STACK_RETURN_GUARD_PAGE(th) + os_vm_page_size) {
1699         protect_alien_stack_guard_page(1, NULL);
1700         protect_alien_stack_return_guard_page(0, NULL);
1701         fprintf(stderr, "INFO: Alien stack guard page reprotected\n");
1702         return 1;
1703     }
1704     else if (addr >= undefined_alien_address &&
1705              addr < undefined_alien_address + os_vm_page_size) {
1706         arrange_return_to_lisp_function
1707             (context, StaticSymbolFunction(UNDEFINED_ALIEN_VARIABLE_ERROR));
1708         return 1;
1709     }
1710     else return 0;
1711 }
1712 \f
1713 /*
1714  * noise to install handlers
1715  */
1716
1717 #ifndef LISP_FEATURE_WIN32
1718 /* In Linux 2.4 synchronous signals (sigtrap & co) can be delivered if
1719  * they are blocked, in Linux 2.6 the default handler is invoked
1720  * instead that usually coredumps. One might hastily think that adding
1721  * SA_NODEFER helps, but until ~2.6.13 if SA_NODEFER is specified then
1722  * the whole sa_mask is ignored and instead of not adding the signal
1723  * in question to the mask. That means if it's not blockable the
1724  * signal must be unblocked at the beginning of signal handlers.
1725  *
1726  * It turns out that NetBSD's SA_NODEFER doesn't DTRT in a different
1727  * way: if SA_NODEFER is set and the signal is in sa_mask, the signal
1728  * will be unblocked in the sigmask during the signal handler.  -- RMK
1729  * X-mas day, 2005
1730  */
1731 static volatile int sigaction_nodefer_works = -1;
1732
1733 #define SA_NODEFER_TEST_BLOCK_SIGNAL SIGABRT
1734 #define SA_NODEFER_TEST_KILL_SIGNAL SIGUSR1
1735
1736 static void
1737 sigaction_nodefer_test_handler(int signal, siginfo_t *info, void *void_context)
1738 {
1739     sigset_t current;
1740     int i;
1741     get_current_sigmask(&current);
1742     /* There should be exactly two blocked signals: the two we added
1743      * to sa_mask when setting up the handler.  NetBSD doesn't block
1744      * the signal we're handling when SA_NODEFER is set; Linux before
1745      * 2.6.13 or so also doesn't block the other signal when
1746      * SA_NODEFER is set. */
1747     for(i = 1; i < NSIG; i++)
1748         if (sigismember(&current, i) !=
1749             (((i == SA_NODEFER_TEST_BLOCK_SIGNAL) || (i == signal)) ? 1 : 0)) {
1750             FSHOW_SIGNAL((stderr, "SA_NODEFER doesn't work, signal %d\n", i));
1751             sigaction_nodefer_works = 0;
1752         }
1753     if (sigaction_nodefer_works == -1)
1754         sigaction_nodefer_works = 1;
1755 }
1756
1757 static void
1758 see_if_sigaction_nodefer_works(void)
1759 {
1760     struct sigaction sa, old_sa;
1761
1762     sa.sa_flags = SA_SIGINFO | SA_NODEFER;
1763     sa.sa_sigaction = sigaction_nodefer_test_handler;
1764     sigemptyset(&sa.sa_mask);
1765     sigaddset(&sa.sa_mask, SA_NODEFER_TEST_BLOCK_SIGNAL);
1766     sigaddset(&sa.sa_mask, SA_NODEFER_TEST_KILL_SIGNAL);
1767     sigaction(SA_NODEFER_TEST_KILL_SIGNAL, &sa, &old_sa);
1768     /* Make sure no signals are blocked. */
1769     {
1770         sigset_t empty;
1771         sigemptyset(&empty);
1772         thread_sigmask(SIG_SETMASK, &empty, 0);
1773     }
1774     kill(getpid(), SA_NODEFER_TEST_KILL_SIGNAL);
1775     while (sigaction_nodefer_works == -1);
1776     sigaction(SA_NODEFER_TEST_KILL_SIGNAL, &old_sa, NULL);
1777 }
1778
1779 #undef SA_NODEFER_TEST_BLOCK_SIGNAL
1780 #undef SA_NODEFER_TEST_KILL_SIGNAL
1781
1782 #if defined(LISP_FEATURE_SB_SAFEPOINT_STRICTLY) && !defined(LISP_FEATURE_WIN32)
1783
1784 static void *
1785 signal_thread_trampoline(void *pthread_arg)
1786 {
1787     int signo = (int) pthread_arg;
1788     os_context_t fake_context;
1789     siginfo_t fake_info;
1790 #ifdef LISP_FEATURE_PPC
1791     mcontext_t uc_regs;
1792 #endif
1793
1794     memset(&fake_info, 0, sizeof(fake_info));
1795     memset(&fake_context, 0, sizeof(fake_context));
1796 #ifdef LISP_FEATURE_PPC
1797     memset(&uc_regs, 0, sizeof(uc_regs));
1798     fake_context.uc_mcontext.uc_regs = &uc_regs;
1799 #endif
1800
1801     *os_context_pc_addr(&fake_context) = &signal_thread_trampoline;
1802 #ifdef ARCH_HAS_STACK_POINTER /* aka x86(-64) */
1803     *os_context_sp_addr(&fake_context) = __builtin_frame_address(0);
1804 #endif
1805
1806     signal_handler_callback(interrupt_handlers[signo].lisp,
1807                             signo, &fake_info, &fake_context);
1808     return 0;
1809 }
1810
1811 static void
1812 sigprof_handler_trampoline(int signal, siginfo_t *info, void *void_context)
1813 {
1814     SAVE_ERRNO(signal,context,void_context);
1815     struct thread *self = arch_os_get_current_thread();
1816
1817     /* alloc() is not re-entrant and still uses pseudo atomic (even though
1818      * inline allocation does not).  In this case, give up. */
1819     if (get_pseudo_atomic_atomic(self))
1820         goto cleanup;
1821
1822     struct alloc_region tmp = self->alloc_region;
1823     self->alloc_region = self->sprof_alloc_region;
1824     self->sprof_alloc_region = tmp;
1825
1826     interrupt_handle_now_handler(signal, info, void_context);
1827
1828     /* And we're back.  We know that the SIGPROF handler never unwinds
1829      * non-locally, and can simply swap things back: */
1830
1831     tmp = self->alloc_region;
1832     self->alloc_region = self->sprof_alloc_region;
1833     self->sprof_alloc_region = tmp;
1834
1835 cleanup:
1836     ; /* Dear C compiler, it's OK to have a label here. */
1837     RESTORE_ERRNO;
1838 }
1839
1840 static void
1841 spawn_signal_thread_handler(int signal, siginfo_t *info, void *void_context)
1842 {
1843     SAVE_ERRNO(signal,context,void_context);
1844
1845     pthread_attr_t attr;
1846     pthread_t th;
1847
1848     if (pthread_attr_init(&attr))
1849         goto lost;
1850     if (pthread_attr_setstacksize(&attr, thread_control_stack_size))
1851         goto lost;
1852     if (pthread_create(&th, &attr, &signal_thread_trampoline, (void*) signal))
1853         goto lost;
1854     if (pthread_attr_destroy(&attr))
1855         goto lost;
1856
1857     RESTORE_ERRNO;
1858     return;
1859
1860 lost:
1861     lose("spawn_signal_thread_handler");
1862 }
1863 #endif
1864
1865 static void
1866 unblock_me_trampoline(int signal, siginfo_t *info, void *void_context)
1867 {
1868     SAVE_ERRNO(signal,context,void_context);
1869     sigset_t unblock;
1870
1871     sigemptyset(&unblock);
1872     sigaddset(&unblock, signal);
1873     thread_sigmask(SIG_UNBLOCK, &unblock, 0);
1874     interrupt_handle_now(signal, info, context);
1875     RESTORE_ERRNO;
1876 }
1877
1878 static void
1879 low_level_unblock_me_trampoline(int signal, siginfo_t *info, void *void_context)
1880 {
1881     SAVE_ERRNO(signal,context,void_context);
1882     sigset_t unblock;
1883
1884     sigemptyset(&unblock);
1885     sigaddset(&unblock, signal);
1886     thread_sigmask(SIG_UNBLOCK, &unblock, 0);
1887     (*interrupt_low_level_handlers[signal])(signal, info, context);
1888     RESTORE_ERRNO;
1889 }
1890
1891 static void
1892 low_level_handle_now_handler(int signal, siginfo_t *info, void *void_context)
1893 {
1894     SAVE_ERRNO(signal,context,void_context);
1895     (*interrupt_low_level_handlers[signal])(signal, info, context);
1896     RESTORE_ERRNO;
1897 }
1898
1899 void
1900 undoably_install_low_level_interrupt_handler (int signal,
1901                                               interrupt_handler_t handler)
1902 {
1903     struct sigaction sa;
1904
1905     if (0 > signal || signal >= NSIG) {
1906         lose("bad signal number %d\n", signal);
1907     }
1908
1909     if (ARE_SAME_HANDLER(handler, SIG_DFL))
1910         sa.sa_sigaction = (void (*)(int, siginfo_t*, void*))handler;
1911     else if (sigismember(&deferrable_sigset,signal))
1912         sa.sa_sigaction = low_level_maybe_now_maybe_later;
1913     else if (!sigaction_nodefer_works &&
1914              !sigismember(&blockable_sigset, signal))
1915         sa.sa_sigaction = low_level_unblock_me_trampoline;
1916     else
1917         sa.sa_sigaction = low_level_handle_now_handler;
1918
1919 #ifdef LISP_FEATURE_SB_THRUPTION
1920     /* It's in `deferrable_sigset' so that we block&unblock it properly,
1921      * but we don't actually want to defer it.  And if we put it only
1922      * into blockable_sigset, we'd have to special-case it around thread
1923      * creation at least. */
1924     if (signal == SIGPIPE)
1925         sa.sa_sigaction = low_level_handle_now_handler;
1926 #endif
1927
1928     sigcopyset(&sa.sa_mask, &blockable_sigset);
1929     sa.sa_flags = SA_SIGINFO | SA_RESTART
1930         | (sigaction_nodefer_works ? SA_NODEFER : 0);
1931 #ifdef LISP_FEATURE_C_STACK_IS_CONTROL_STACK
1932     if(signal==SIG_MEMORY_FAULT) {
1933         sa.sa_flags |= SA_ONSTACK;
1934 # ifdef LISP_FEATURE_SB_SAFEPOINT
1935         sigaddset(&sa.sa_mask, SIGRTMIN);
1936         sigaddset(&sa.sa_mask, SIGRTMIN+1);
1937 # endif
1938     }
1939 #endif
1940
1941     sigaction(signal, &sa, NULL);
1942     interrupt_low_level_handlers[signal] =
1943         (ARE_SAME_HANDLER(handler, SIG_DFL) ? 0 : handler);
1944 }
1945 #endif
1946
1947 /* This is called from Lisp. */
1948 uword_t
1949 install_handler(int signal, void handler(int, siginfo_t*, os_context_t*),
1950                 int synchronous)
1951 {
1952 #ifndef LISP_FEATURE_WIN32
1953     struct sigaction sa;
1954     sigset_t old;
1955     union interrupt_handler oldhandler;
1956
1957     FSHOW((stderr, "/entering POSIX install_handler(%d, ..)\n", signal));
1958
1959     block_blockable_signals(0, &old);
1960
1961     FSHOW((stderr, "/interrupt_low_level_handlers[signal]=%x\n",
1962            (unsigned int)interrupt_low_level_handlers[signal]));
1963     if (interrupt_low_level_handlers[signal]==0) {
1964         if (ARE_SAME_HANDLER(handler, SIG_DFL) ||
1965             ARE_SAME_HANDLER(handler, SIG_IGN))
1966             sa.sa_sigaction = (void (*)(int, siginfo_t*, void*))handler;
1967 #ifdef LISP_FEATURE_SB_SAFEPOINT_STRICTLY
1968         else if (signal == SIGPROF)
1969             sa.sa_sigaction = sigprof_handler_trampoline;
1970         else if (!synchronous)
1971             sa.sa_sigaction = spawn_signal_thread_handler;
1972 #endif
1973         else if (sigismember(&deferrable_sigset, signal))
1974             sa.sa_sigaction = maybe_now_maybe_later;
1975         else if (!sigaction_nodefer_works &&
1976                  !sigismember(&blockable_sigset, signal))
1977             sa.sa_sigaction = unblock_me_trampoline;
1978         else
1979             sa.sa_sigaction = interrupt_handle_now_handler;
1980
1981         sigcopyset(&sa.sa_mask, &blockable_sigset);
1982         sa.sa_flags = SA_SIGINFO | SA_RESTART |
1983             (sigaction_nodefer_works ? SA_NODEFER : 0);
1984         sigaction(signal, &sa, NULL);
1985     }
1986
1987     oldhandler = interrupt_handlers[signal];
1988     interrupt_handlers[signal].c = handler;
1989
1990     thread_sigmask(SIG_SETMASK, &old, 0);
1991
1992     FSHOW((stderr, "/leaving POSIX install_handler(%d, ..)\n", signal));
1993
1994     return (uword_t)oldhandler.lisp;
1995 #else
1996     /* Probably-wrong Win32 hack */
1997     return 0;
1998 #endif
1999 }
2000
2001 /* This must not go through lisp as it's allowed anytime, even when on
2002  * the altstack. */
2003 void
2004 sigabrt_handler(int signal, siginfo_t *info, os_context_t *context)
2005 {
2006     lose("SIGABRT received.\n");
2007 }
2008
2009 void
2010 interrupt_init(void)
2011 {
2012 #if !defined(LISP_FEATURE_WIN32) || defined(LISP_FEATURE_SB_THREAD)
2013     int i;
2014     SHOW("entering interrupt_init()");
2015 #ifndef LISP_FEATURE_WIN32
2016     see_if_sigaction_nodefer_works();
2017 #endif
2018     sigemptyset(&deferrable_sigset);
2019     sigemptyset(&blockable_sigset);
2020     sigemptyset(&gc_sigset);
2021     sigaddset_deferrable(&deferrable_sigset);
2022     sigaddset_blockable(&blockable_sigset);
2023     sigaddset_gc(&gc_sigset);
2024 #endif
2025
2026 #ifndef LISP_FEATURE_WIN32
2027     /* Set up high level handler information. */
2028     for (i = 0; i < NSIG; i++) {
2029         interrupt_handlers[i].c =
2030             /* (The cast here blasts away the distinction between
2031              * SA_SIGACTION-style three-argument handlers and
2032              * signal(..)-style one-argument handlers, which is OK
2033              * because it works to call the 1-argument form where the
2034              * 3-argument form is expected.) */
2035             (void (*)(int, siginfo_t*, os_context_t*))SIG_DFL;
2036     }
2037     undoably_install_low_level_interrupt_handler(SIGABRT, sigabrt_handler);
2038 #endif
2039     SHOW("returning from interrupt_init()");
2040 }
2041
2042 #ifndef LISP_FEATURE_WIN32
2043 int
2044 siginfo_code(siginfo_t *info)
2045 {
2046     return info->si_code;
2047 }
2048 os_vm_address_t current_memory_fault_address;
2049
2050 void
2051 lisp_memory_fault_error(os_context_t *context, os_vm_address_t addr)
2052 {
2053    /* FIXME: This is lossy: if we get another memory fault (eg. from
2054     * another thread) before lisp has read this, we lose the information.
2055     * However, since this is mostly informative, we'll live with that for
2056     * now -- some address is better then no address in this case.
2057     */
2058     current_memory_fault_address = addr;
2059     /* To allow debugging memory faults in signal handlers and such. */
2060     corruption_warning_and_maybe_lose("Memory fault at %x (pc=%p, sp=%p)",
2061                                       addr,
2062                                       *os_context_pc_addr(context),
2063 #ifdef ARCH_HAS_STACK_POINTER
2064                                       *os_context_sp_addr(context)
2065 #else
2066                                       0
2067 #endif
2068                                       );
2069     unblock_signals_in_context_and_maybe_warn(context);
2070 #ifdef LISP_FEATURE_C_STACK_IS_CONTROL_STACK
2071     arrange_return_to_lisp_function(context,
2072                                     StaticSymbolFunction(MEMORY_FAULT_ERROR));
2073 #else
2074     funcall0(StaticSymbolFunction(MEMORY_FAULT_ERROR));
2075 #endif
2076 }
2077 #endif
2078
2079 static void
2080 unhandled_trap_error(os_context_t *context)
2081 {
2082     lispobj context_sap;
2083     fake_foreign_function_call(context);
2084 #ifndef LISP_FEATURE_SB_SAFEPOINT
2085     unblock_gc_signals(0, 0);
2086 #endif
2087     context_sap = alloc_sap(context);
2088 #if !defined(LISP_FEATURE_WIN32) || defined(LISP_FEATURE_SB_THREAD)
2089     thread_sigmask(SIG_SETMASK, os_context_sigmask_addr(context), 0);
2090 #endif
2091     funcall1(StaticSymbolFunction(UNHANDLED_TRAP_ERROR), context_sap);
2092     lose("UNHANDLED-TRAP-ERROR fell through");
2093 }
2094
2095 /* Common logic for trapping instructions. How we actually handle each
2096  * case is highly architecture dependent, but the overall shape is
2097  * this. */
2098 void
2099 handle_trap(os_context_t *context, int trap)
2100 {
2101     switch(trap) {
2102 #if !(defined(LISP_FEATURE_WIN32) && defined(LISP_FEATURE_SB_THREAD))
2103     case trap_PendingInterrupt:
2104         FSHOW((stderr, "/<trap pending interrupt>\n"));
2105         arch_skip_instruction(context);
2106         interrupt_handle_pending(context);
2107         break;
2108 #endif
2109     case trap_Error:
2110     case trap_Cerror:
2111         FSHOW((stderr, "/<trap error/cerror %d>\n", trap));
2112         interrupt_internal_error(context, trap==trap_Cerror);
2113         break;
2114     case trap_Breakpoint:
2115         arch_handle_breakpoint(context);
2116         break;
2117     case trap_FunEndBreakpoint:
2118         arch_handle_fun_end_breakpoint(context);
2119         break;
2120 #ifdef trap_AfterBreakpoint
2121     case trap_AfterBreakpoint:
2122         arch_handle_after_breakpoint(context);
2123         break;
2124 #endif
2125 #ifdef trap_SingleStepAround
2126     case trap_SingleStepAround:
2127     case trap_SingleStepBefore:
2128         arch_handle_single_step_trap(context, trap);
2129         break;
2130 #endif
2131 #ifdef trap_GlobalSafepoint
2132     case trap_GlobalSafepoint:
2133         fake_foreign_function_call(context);
2134         thread_in_lisp_raised(context);
2135         undo_fake_foreign_function_call(context);
2136         arch_skip_instruction(context);
2137         break;
2138     case trap_CspSafepoint:
2139         fake_foreign_function_call(context);
2140         thread_in_safety_transition(context);
2141         undo_fake_foreign_function_call(context);
2142         arch_skip_instruction(context);
2143         break;
2144 #endif
2145 #if defined(LISP_FEATURE_SPARC) && defined(LISP_FEATURE_GENCGC)
2146     case trap_Allocation:
2147         arch_handle_allocation_trap(context);
2148         arch_skip_instruction(context);
2149         break;
2150 #endif
2151     case trap_Halt:
2152         fake_foreign_function_call(context);
2153         lose("%%PRIMITIVE HALT called; the party is over.\n");
2154     default:
2155         unhandled_trap_error(context);
2156     }
2157 }