0.8.4.1
[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
44 #include <stdio.h>
45 #include <stdlib.h>
46 #include <string.h>
47 #include <signal.h>
48
49 #include "runtime.h"
50 #include "arch.h"
51 #include "sbcl.h"
52 #include "os.h"
53 #include "interrupt.h"
54 #include "globals.h"
55 #include "lispregs.h"
56 #include "validate.h"
57 #include "monitor.h"
58 #include "gc.h"
59 #include "alloc.h"
60 #include "dynbind.h"
61 #include "interr.h"
62 #include "genesis/fdefn.h"
63 #include "genesis/simple-fun.h"
64
65 void run_deferred_handler(struct interrupt_data *data, void *v_context) ;
66 static void store_signal_data_for_later (struct interrupt_data *data, 
67                                          void *handler, int signal,
68                                          siginfo_t *info, 
69                                          os_context_t *context);
70 boolean interrupt_maybe_gc_int(int signal, siginfo_t *info, void *v_context);
71
72 extern lispobj all_threads_lock;
73 extern volatile int countdown_to_gc;
74
75 /*
76  * This is a workaround for some slightly silly Linux/GNU Libc
77  * behaviour: glibc defines sigset_t to support 1024 signals, which is
78  * more than the kernel.  This is usually not a problem, but becomes
79  * one when we want to save a signal mask from a ucontext, and restore
80  * it later into another ucontext: the ucontext is allocated on the
81  * stack by the kernel, so copying a libc-sized sigset_t into it will
82  * overflow and cause other data on the stack to be corrupted */
83
84 #define REAL_SIGSET_SIZE_BYTES ((NSIG/8))
85
86 void sigaddset_blockable(sigset_t *s)
87 {
88     sigaddset(s, SIGHUP);
89     sigaddset(s, SIGINT);
90     sigaddset(s, SIGQUIT);
91     sigaddset(s, SIGPIPE);
92     sigaddset(s, SIGALRM);
93     sigaddset(s, SIGURG);
94     sigaddset(s, SIGFPE);
95     sigaddset(s, SIGTSTP);
96     sigaddset(s, SIGCHLD);
97     sigaddset(s, SIGIO);
98     sigaddset(s, SIGXCPU);
99     sigaddset(s, SIGXFSZ);
100     sigaddset(s, SIGVTALRM);
101     sigaddset(s, SIGPROF);
102     sigaddset(s, SIGWINCH);
103     sigaddset(s, SIGUSR1);
104     sigaddset(s, SIGUSR2);
105 #ifdef LISP_FEATURE_SB_THREAD
106     sigaddset(s, SIG_STOP_FOR_GC);
107     sigaddset(s, SIG_INTERRUPT_THREAD);
108 #endif
109 }
110
111 /* When we catch an internal error, should we pass it back to Lisp to
112  * be handled in a high-level way? (Early in cold init, the answer is
113  * 'no', because Lisp is still too brain-dead to handle anything.
114  * After sufficient initialization has been completed, the answer
115  * becomes 'yes'.) */
116 boolean internal_errors_enabled = 0;
117
118 struct interrupt_data * global_interrupt_data;
119
120 \f
121 /*
122  * utility routines used by various signal handlers
123  */
124
125 void 
126 build_fake_control_stack_frames(struct thread *th,os_context_t *context)
127 {
128 #ifndef LISP_FEATURE_X86
129     
130     lispobj oldcont;
131
132     /* Build a fake stack frame or frames */
133
134     current_control_frame_pointer =
135         (lispobj *)(*os_context_register_addr(context, reg_CSP));
136     if ((lispobj *)(*os_context_register_addr(context, reg_CFP))
137         == current_control_frame_pointer) {
138         /* There is a small window during call where the callee's
139          * frame isn't built yet. */
140         if (lowtag_of(*os_context_register_addr(context, reg_CODE))
141             == FUN_POINTER_LOWTAG) {
142             /* We have called, but not built the new frame, so
143              * build it for them. */
144             current_control_frame_pointer[0] =
145                 *os_context_register_addr(context, reg_OCFP);
146             current_control_frame_pointer[1] =
147                 *os_context_register_addr(context, reg_LRA);
148             current_control_frame_pointer += 8;
149             /* Build our frame on top of it. */
150             oldcont = (lispobj)(*os_context_register_addr(context, reg_CFP));
151         }
152         else {
153             /* We haven't yet called, build our frame as if the
154              * partial frame wasn't there. */
155             oldcont = (lispobj)(*os_context_register_addr(context, reg_OCFP));
156         }
157     }
158     /* We can't tell whether we are still in the caller if it had to
159      * allocate a stack frame due to stack arguments. */
160     /* This observation provoked some past CMUCL maintainer to ask
161      * "Can anything strange happen during return?" */
162     else {
163         /* normal case */
164         oldcont = (lispobj)(*os_context_register_addr(context, reg_CFP));
165     }
166
167     current_control_stack_pointer = current_control_frame_pointer + 8;
168
169     current_control_frame_pointer[0] = oldcont;
170     current_control_frame_pointer[1] = NIL;
171     current_control_frame_pointer[2] =
172         (lispobj)(*os_context_register_addr(context, reg_CODE));
173 #endif
174 }
175
176 void
177 fake_foreign_function_call(os_context_t *context)
178 {
179     int context_index;
180     struct thread *thread=arch_os_get_current_thread();
181
182     /* Get current Lisp state from context. */
183 #ifdef reg_ALLOC
184     dynamic_space_free_pointer =
185         (lispobj *)(*os_context_register_addr(context, reg_ALLOC));
186 #ifdef alpha
187     if ((long)dynamic_space_free_pointer & 1) {
188         lose("dead in fake_foreign_function_call, context = %x", context);
189     }
190 #endif
191 #endif
192 #ifdef reg_BSP
193     current_binding_stack_pointer =
194         (lispobj *)(*os_context_register_addr(context, reg_BSP));
195 #endif
196
197     build_fake_control_stack_frames(thread,context);
198
199     /* Do dynamic binding of the active interrupt context index
200      * and save the context in the context array. */
201     context_index =
202         fixnum_value(SymbolValue(FREE_INTERRUPT_CONTEXT_INDEX,thread));
203     
204     if (context_index >= MAX_INTERRUPTS) {
205         lose("maximum interrupt nesting depth (%d) exceeded", MAX_INTERRUPTS);
206     }
207
208     bind_variable(FREE_INTERRUPT_CONTEXT_INDEX,
209                   make_fixnum(context_index + 1),thread);
210
211     thread->interrupt_contexts[context_index] = context;
212
213     /* no longer in Lisp now */
214     foreign_function_call_active = 1;
215 }
216
217 /* blocks all blockable signals.  If you are calling from a signal handler,
218  * the usual signal mask will be restored from the context when the handler 
219  * finishes.  Otherwise, be careful */
220
221 void
222 undo_fake_foreign_function_call(os_context_t *context)
223 {
224     struct thread *thread=arch_os_get_current_thread();
225     /* Block all blockable signals. */
226     sigset_t block;
227     sigemptyset(&block);
228     sigaddset_blockable(&block);
229     sigprocmask(SIG_BLOCK, &block, 0);
230
231     /* going back into Lisp */
232     foreign_function_call_active = 0;
233
234     /* Undo dynamic binding of FREE_INTERRUPT_CONTEXT_INDEX */
235     unbind(thread);
236
237 #ifdef reg_ALLOC
238     /* Put the dynamic space free pointer back into the context. */
239     *os_context_register_addr(context, reg_ALLOC) =
240         (unsigned long) dynamic_space_free_pointer;
241 #endif
242 }
243
244 /* a handler for the signal caused by execution of a trap opcode
245  * signalling an internal error */
246 void
247 interrupt_internal_error(int signal, siginfo_t *info, os_context_t *context,
248                          boolean continuable)
249 {
250     lispobj context_sap = 0;
251
252     fake_foreign_function_call(context);
253
254     /* Allocate the SAP object while the interrupts are still
255      * disabled. */
256     if (internal_errors_enabled) {
257         context_sap = alloc_sap(context);
258     }
259
260     sigprocmask(SIG_SETMASK, os_context_sigmask_addr(context), 0);
261
262     if (internal_errors_enabled) {
263         SHOW("in interrupt_internal_error");
264 #if QSHOW
265         /* Display some rudimentary debugging information about the
266          * error, so that even if the Lisp error handler gets badly
267          * confused, we have a chance to determine what's going on. */
268         describe_internal_error(context);
269 #endif
270         funcall2(SymbolFunction(INTERNAL_ERROR), context_sap,
271                  continuable ? T : NIL);
272     } else {
273         describe_internal_error(context);
274         /* There's no good way to recover from an internal error
275          * before the Lisp error handling mechanism is set up. */
276         lose("internal error too early in init, can't recover");
277     }
278     undo_fake_foreign_function_call(context); /* blocks signals again */
279     if (continuable) {
280         arch_skip_instruction(context);
281     }
282 }
283
284 void
285 interrupt_handle_pending(os_context_t *context)
286 {
287     struct thread *thread;
288     struct interrupt_data *data;
289
290     thread=arch_os_get_current_thread();
291     data=thread->interrupt_data;
292     /* FIXME I'm not altogether sure this is appropriate if we're
293      * here as the result of a pseudo-atomic */
294     SetSymbolValue(INTERRUPT_PENDING, NIL,thread);
295
296     /* restore the saved signal mask from the original signal (the
297      * one that interrupted us during the critical section) into the
298      * os_context for the signal we're currently in the handler for.
299      * This should ensure that when we return from the handler the
300      * blocked signals are unblocked */
301
302     memcpy(os_context_sigmask_addr(context), &data->pending_mask, 
303            REAL_SIGSET_SIZE_BYTES);
304
305     sigemptyset(&data->pending_mask);
306     /* This will break on sparc linux: the deferred handler really wants
307      * to be called with a void_context */
308     run_deferred_handler(data,(void *)context); 
309 }
310 \f
311 /*
312  * the two main signal handlers:
313  *   interrupt_handle_now(..)
314  *   maybe_now_maybe_later(..)
315  *
316  * to which we have added interrupt_handle_now_handler(..).  Why?
317  * Well, mostly because the SPARC/Linux platform doesn't quite do
318  * signals the way we want them done.  The third argument in the
319  * handler isn't filled in by the kernel properly, so we fix it up
320  * ourselves in the arch_os_get_context(..) function; however, we only
321  * want to do this when we first hit the handler, and not when
322  * interrupt_handle_now(..) is being called from some other handler
323  * (when the fixup will already have been done). -- CSR, 2002-07-23
324  */
325
326 void
327 interrupt_handle_now(int signal, siginfo_t *info, void *void_context)
328 {
329     os_context_t *context = (os_context_t*)void_context;
330     struct thread *thread=arch_os_get_current_thread();
331 #ifndef LISP_FEATURE_X86
332     boolean were_in_lisp;
333 #endif
334     union interrupt_handler handler;
335
336 #ifdef LISP_FEATURE_LINUX
337     /* Under Linux on some architectures, we appear to have to restore
338        the FPU control word from the context, as after the signal is
339        delivered we appear to have a null FPU control word. */
340     os_restore_fp_control(context);
341 #endif 
342     handler = thread->interrupt_data->interrupt_handlers[signal];
343
344     if (ARE_SAME_HANDLER(handler.c, SIG_IGN)) {
345         return;
346     }
347     
348 #ifndef LISP_FEATURE_X86
349     were_in_lisp = !foreign_function_call_active;
350     if (were_in_lisp)
351 #endif
352     {
353         fake_foreign_function_call(context);
354     }
355
356 #ifdef QSHOW_SIGNALS
357     FSHOW((stderr,
358            "/entering interrupt_handle_now(%d, info, context)\n",
359            signal));
360 #endif
361
362     if (ARE_SAME_HANDLER(handler.c, SIG_DFL)) {
363
364         /* This can happen if someone tries to ignore or default one
365          * of the signals we need for runtime support, and the runtime
366          * support decides to pass on it. */
367         lose("no handler for signal %d in interrupt_handle_now(..)", signal);
368
369     } else if (lowtag_of(handler.lisp) == FUN_POINTER_LOWTAG) {
370         /* Once we've decided what to do about contexts in a 
371          * return-elsewhere world (the original context will no longer
372          * be available; should we copy it or was nobody using it anyway?)
373          * then we should convert this to return-elsewhere */
374
375         /* CMUCL comment said "Allocate the SAPs while the interrupts
376          * are still disabled.".  I (dan, 2003.08.21) assume this is 
377          * because we're not in pseudoatomic and allocation shouldn't
378          * be interrupted.  In which case it's no longer an issue as
379          * all our allocation from C now goes through a PA wrapper,
380          * but still, doesn't hurt */
381
382         lispobj info_sap,context_sap = alloc_sap(context);
383         info_sap = alloc_sap(info);
384         /* Allow signals again. */
385         sigprocmask(SIG_SETMASK, os_context_sigmask_addr(context), 0);
386
387 #ifdef QSHOW_SIGNALS
388         SHOW("calling Lisp-level handler");
389 #endif
390
391         funcall3(handler.lisp,
392                  make_fixnum(signal),
393                  info_sap,
394                  context_sap);
395     } else {
396
397 #ifdef QSHOW_SIGNALS
398         SHOW("calling C-level handler");
399 #endif
400
401         /* Allow signals again. */
402         sigprocmask(SIG_SETMASK, os_context_sigmask_addr(context), 0);
403         
404         (*handler.c)(signal, info, void_context);
405     }
406
407 #ifndef LISP_FEATURE_X86
408     if (were_in_lisp)
409 #endif
410     {
411         undo_fake_foreign_function_call(context); /* block signals again */
412     }
413
414 #ifdef QSHOW_SIGNALS
415     FSHOW((stderr,
416            "/returning from interrupt_handle_now(%d, info, context)\n",
417            signal));
418 #endif
419 }
420
421 /* This is called at the end of a critical section if the indications
422  * are that some signal was deferred during the section.  Note that as
423  * far as C or the kernel is concerned we dealt with the signal
424  * already; we're just doing the Lisp-level processing now that we
425  * put off then */
426
427 void
428 run_deferred_handler(struct interrupt_data *data, void *v_context) {
429     (*(data->pending_handler))
430         (data->pending_signal,&(data->pending_info), v_context);
431     data->pending_handler=0;
432 }
433
434 boolean
435 maybe_defer_handler(void *handler, struct interrupt_data *data,
436                     int signal, siginfo_t *info, os_context_t *context)
437 {
438     struct thread *thread=arch_os_get_current_thread();
439     if (SymbolValue(INTERRUPTS_ENABLED,thread) == NIL) {
440         store_signal_data_for_later(data,handler,signal,info,context);
441         SetSymbolValue(INTERRUPT_PENDING, T,thread);
442         return 1;
443     } 
444     /* a slightly confusing test.  arch_pseudo_atomic_atomic() doesn't
445      * actually use its argument for anything on x86, so this branch
446      * may succeed even when context is null (gencgc alloc()) */
447     if (
448 #ifndef LISP_FEATURE_X86
449         (!foreign_function_call_active) &&
450 #endif
451         arch_pseudo_atomic_atomic(context)) {
452         store_signal_data_for_later(data,handler,signal,info,context);
453         arch_set_pseudo_atomic_interrupted(context);
454         return 1;
455     }
456     return 0;
457 }
458 static void
459 store_signal_data_for_later (struct interrupt_data *data, void *handler,
460                              int signal, 
461                              siginfo_t *info, os_context_t *context)
462 {
463     data->pending_handler = handler;
464     data->pending_signal = signal;
465     if(info)
466         memcpy(&(data->pending_info), info, sizeof(siginfo_t));
467     if(context) {
468         /* the signal mask in the context (from before we were
469          * interrupted) is copied to be restored when
470          * run_deferred_handler happens.  Then the usually-blocked
471          * signals are added to the mask in the context so that we are
472          * running with blocked signals when the handler returns */
473         sigemptyset(&(data->pending_mask));
474         memcpy(&(data->pending_mask),
475                os_context_sigmask_addr(context),
476                REAL_SIGSET_SIZE_BYTES);
477         sigaddset_blockable(os_context_sigmask_addr(context));
478     } else {
479         /* this is also called from gencgc alloc(), in which case
480          * there has been no signal and is therefore no context. */
481         sigset_t new;
482         sigemptyset(&new);
483         sigaddset_blockable(&new);
484         sigprocmask(SIG_BLOCK,&new,&(data->pending_mask));
485     }
486 }
487
488
489 static void
490 maybe_now_maybe_later(int signal, siginfo_t *info, void *void_context)
491 {
492     os_context_t *context = arch_os_get_context(&void_context);
493     struct thread *thread=arch_os_get_current_thread();
494     struct interrupt_data *data=thread->interrupt_data;
495 #ifdef LISP_FEATURE_LINUX
496     os_restore_fp_control(context);
497 #endif 
498     if(maybe_defer_handler(interrupt_handle_now,data,
499                            signal,info,context))
500         return;
501     interrupt_handle_now(signal, info, context);
502 }
503
504 void
505 sig_stop_for_gc_handler(int signal, siginfo_t *info, void *void_context)
506 {
507     os_context_t *context = arch_os_get_context(&void_context);
508     struct thread *thread=arch_os_get_current_thread();
509     struct interrupt_data *data=thread->interrupt_data;
510
511     
512     if(maybe_defer_handler(sig_stop_for_gc_handler,data,
513                            signal,info,context)){
514         return;
515     }
516     /* need the context stored so it can have registers scavenged */
517     fake_foreign_function_call(context); 
518
519     get_spinlock(&all_threads_lock,thread->pid);
520     countdown_to_gc--;
521     release_spinlock(&all_threads_lock);
522     kill(thread->pid,SIGSTOP);
523
524     undo_fake_foreign_function_call(context);
525 }
526
527 void
528 interrupt_handle_now_handler(int signal, siginfo_t *info, void *void_context)
529 {
530     os_context_t *context = arch_os_get_context(&void_context);
531     interrupt_handle_now(signal, info, context);
532 }
533
534 /*
535  * stuff to detect and handle hitting the GC trigger
536  */
537
538 #ifndef LISP_FEATURE_GENCGC 
539 /* since GENCGC has its own way to record trigger */
540 static boolean
541 gc_trigger_hit(int signal, siginfo_t *info, os_context_t *context)
542 {
543     if (current_auto_gc_trigger == NULL)
544         return 0;
545     else{
546         void *badaddr=arch_get_bad_addr(signal,info,context);
547         return (badaddr >= (void *)current_auto_gc_trigger &&
548                 badaddr <((void *)current_dynamic_space + DYNAMIC_SPACE_SIZE));
549     }
550 }
551 #endif
552
553 /* manipulate the signal context and stack such that when the handler
554  * returns, it will call function instead of whatever it was doing
555  * previously
556  */
557
558 extern lispobj call_into_lisp(lispobj fun, lispobj *args, int nargs);
559 extern void post_signal_tramp(void);
560 void arrange_return_to_lisp_function(os_context_t *context, lispobj function)
561 {
562     void * fun=native_pointer(function);
563     char *code = &(((struct simple_fun *) fun)->code);
564     
565     /* Build a stack frame showing `interrupted' so that the
566      * user's backtrace makes (as much) sense (as usual) */
567 #ifdef LISP_FEATURE_X86
568     /* Suppose the existence of some function that saved all
569      * registers, called call_into_lisp, then restored GP registers and
570      * returned.  We shortcut this: fake the stack that call_into_lisp
571      * would see, then arrange to have it called directly.  post_signal_tramp
572      * is the second half of this function
573      */
574     u32 *sp=(u32 *)*os_context_register_addr(context,reg_ESP);
575
576     *(sp-14) = post_signal_tramp; /* return address for call_into_lisp */
577     *(sp-13) = function;        /* args for call_into_lisp : function*/
578     *(sp-12) = 0;               /*                           arg array */
579     *(sp-11) = 0;               /*                           no. args */
580     /* this order matches that used in POPAD */
581     *(sp-10)=*os_context_register_addr(context,reg_EDI);
582     *(sp-9)=*os_context_register_addr(context,reg_ESI);
583     /* this gets overwritten again before it's used, anyway */
584     *(sp-8)=*os_context_register_addr(context,reg_EBP);
585     *(sp-7)=0 ; /* POPAD doesn't set ESP, but expects a gap for it anyway */
586     *(sp-6)=*os_context_register_addr(context,reg_EBX);
587
588     *(sp-5)=*os_context_register_addr(context,reg_EDX);
589     *(sp-4)=*os_context_register_addr(context,reg_ECX);
590     *(sp-3)=*os_context_register_addr(context,reg_EAX);
591     *(sp-2)=*os_context_register_addr(context,reg_EBP);
592     *(sp-1)=*os_context_pc_addr(context);
593
594 #else 
595     struct thread *th=arch_os_get_current_thread();
596     build_fake_control_stack_frames(th,context);
597 #endif
598
599 #ifdef LISP_FEATURE_X86
600     *os_context_pc_addr(context) = call_into_lisp;
601     *os_context_register_addr(context,reg_ECX) = 0; 
602     *os_context_register_addr(context,reg_EBP) = sp-2;
603     *os_context_register_addr(context,reg_ESP) = sp-14;
604 #else
605     /* this much of the calling convention is common to all
606        non-x86 ports */
607     *os_context_pc_addr(context) = code;
608     *os_context_register_addr(context,reg_NARGS) = 0; 
609     *os_context_register_addr(context,reg_LIP) = code;
610     *os_context_register_addr(context,reg_CFP) = 
611         current_control_frame_pointer;
612 #endif
613 #ifdef ARCH_HAS_NPC_REGISTER
614     *os_context_npc_addr(context) =
615         4 + *os_context_pc_addr(context);
616 #endif
617 #ifdef LISP_FEATURE_SPARC
618     *os_context_register_addr(context,reg_CODE) = 
619         fun + FUN_POINTER_LOWTAG;
620 #endif
621 }
622
623 #ifdef LISP_FEATURE_SB_THREAD
624 void handle_rt_signal(int num, siginfo_t *info, void *v_context)
625 {
626     os_context_t *context = (os_context_t*)arch_os_get_context(&v_context);
627     struct thread *th=arch_os_get_current_thread();
628     struct interrupt_data *data=
629         th ? th->interrupt_data : global_interrupt_data;
630     if(maybe_defer_handler(handle_rt_signal,data,num,info,context)){
631         return ;
632     }
633     arrange_return_to_lisp_function(context,info->si_value.sival_int);
634 }
635 #endif
636
637 boolean handle_control_stack_guard_triggered(os_context_t *context,void *addr){
638     struct thread *th=arch_os_get_current_thread();
639     /* note the os_context hackery here.  When the signal handler returns, 
640      * it won't go back to what it was doing ... */
641     if(addr>=(void *)CONTROL_STACK_GUARD_PAGE(th) && 
642        addr<(void *)(CONTROL_STACK_GUARD_PAGE(th)+os_vm_page_size)) {
643         /* we hit the end of the control stack.  disable protection
644          * temporarily so the error handler has some headroom */
645         protect_control_stack_guard_page(th->pid,0L);
646         
647         arrange_return_to_lisp_function
648             (context, SymbolFunction(CONTROL_STACK_EXHAUSTED_ERROR));
649         return 1;
650     }
651     else return 0;
652 }
653
654 #ifndef LISP_FEATURE_GENCGC
655 /* This function gets called from the SIGSEGV (for e.g. Linux or
656  * OpenBSD) or SIGBUS (for e.g. FreeBSD) handler. Here we check
657  * whether the signal was due to treading on the mprotect()ed zone -
658  * and if so, arrange for a GC to happen. */
659 extern unsigned long bytes_consed_between_gcs; /* gc-common.c */
660
661 boolean
662 interrupt_maybe_gc(int signal, siginfo_t *info, void *void_context)
663 {
664     os_context_t *context=(os_context_t *) void_context;
665     struct thread *th=arch_os_get_current_thread();
666     struct interrupt_data *data=
667         th ? th->interrupt_data : global_interrupt_data;
668
669     if(!foreign_function_call_active && gc_trigger_hit(signal, info, context)){
670         clear_auto_gc_trigger();
671         if(!maybe_defer_handler
672            (interrupt_maybe_gc_int,data,signal,info,void_context))
673             interrupt_maybe_gc_int(signal,info,void_context);
674         return 1;
675     }
676     return 0;
677 }
678
679 #endif
680
681 /* this is also used by gencgc, in alloc() */
682 boolean
683 interrupt_maybe_gc_int(int signal, siginfo_t *info, void *void_context)
684 {
685     sigset_t new;
686     os_context_t *context=(os_context_t *) void_context;
687     fake_foreign_function_call(context);
688     /* SUB-GC may return without GCing if *GC-INHIBIT* is set, in
689      * which case we will be running with no gc trigger barrier
690      * thing for a while.  But it shouldn't be long until the end
691      * of WITHOUT-GCING. */
692
693     sigemptyset(&new);
694     sigaddset_blockable(&new);
695     /* enable signals before calling into Lisp */
696     sigprocmask(SIG_UNBLOCK,&new,0);
697     funcall0(SymbolFunction(SUB_GC));
698     undo_fake_foreign_function_call(context);
699     return 1;
700 }
701
702 \f
703 /*
704  * noise to install handlers
705  */
706
707 void
708 undoably_install_low_level_interrupt_handler (int signal,
709                                               void handler(int,
710                                                            siginfo_t*,
711                                                            void*))
712 {
713     struct sigaction sa;
714     struct thread *th=arch_os_get_current_thread();
715     struct interrupt_data *data=
716         th ? th->interrupt_data : global_interrupt_data;
717
718     if (0 > signal || signal >= NSIG) {
719         lose("bad signal number %d", signal);
720     }
721
722     sa.sa_sigaction = handler;
723     sigemptyset(&sa.sa_mask);
724     sigaddset_blockable(&sa.sa_mask);
725     sa.sa_flags = SA_SIGINFO | SA_RESTART;
726 #ifdef LISP_FEATURE_C_STACK_IS_CONTROL_STACK
727     if((signal==SIG_MEMORY_FAULT) 
728 #ifdef SIG_INTERRUPT_THREAD
729        || (signal==SIG_INTERRUPT_THREAD)
730 #endif
731        )
732         sa.sa_flags|= SA_ONSTACK;
733 #endif
734     
735     sigaction(signal, &sa, NULL);
736     data->interrupt_low_level_handlers[signal] =
737         (ARE_SAME_HANDLER(handler, SIG_DFL) ? 0 : handler);
738 }
739
740 /* This is called from Lisp. */
741 unsigned long
742 install_handler(int signal, void handler(int, siginfo_t*, void*))
743 {
744     struct sigaction sa;
745     sigset_t old, new;
746     union interrupt_handler oldhandler;
747     struct thread *th=arch_os_get_current_thread();
748     struct interrupt_data *data=
749         th ? th->interrupt_data : global_interrupt_data;
750
751     FSHOW((stderr, "/entering POSIX install_handler(%d, ..)\n", signal));
752
753     sigemptyset(&new);
754     sigaddset(&new, signal);
755     sigprocmask(SIG_BLOCK, &new, &old);
756
757     sigemptyset(&new);
758     sigaddset_blockable(&new);
759
760     FSHOW((stderr, "/interrupt_low_level_handlers[signal]=%d\n",
761            interrupt_low_level_handlers[signal]));
762     if (data->interrupt_low_level_handlers[signal]==0) {
763         if (ARE_SAME_HANDLER(handler, SIG_DFL) ||
764             ARE_SAME_HANDLER(handler, SIG_IGN)) {
765             sa.sa_sigaction = handler;
766         } else if (sigismember(&new, signal)) {
767             sa.sa_sigaction = maybe_now_maybe_later;
768         } else {
769             sa.sa_sigaction = interrupt_handle_now_handler;
770         }
771
772         sigemptyset(&sa.sa_mask);
773         sigaddset_blockable(&sa.sa_mask);
774         sa.sa_flags = SA_SIGINFO | SA_RESTART;
775         sigaction(signal, &sa, NULL);
776     }
777
778     oldhandler = data->interrupt_handlers[signal];
779     data->interrupt_handlers[signal].c = handler;
780
781     sigprocmask(SIG_SETMASK, &old, 0);
782
783     FSHOW((stderr, "/leaving POSIX install_handler(%d, ..)\n", signal));
784
785     return (unsigned long)oldhandler.lisp;
786 }
787
788 void
789 interrupt_init()
790 {
791     int i;
792     SHOW("entering interrupt_init()");
793     global_interrupt_data=calloc(sizeof(struct interrupt_data), 1);
794
795     /* Set up high level handler information. */
796     for (i = 0; i < NSIG; i++) {
797         global_interrupt_data->interrupt_handlers[i].c =
798             /* (The cast here blasts away the distinction between
799              * SA_SIGACTION-style three-argument handlers and
800              * signal(..)-style one-argument handlers, which is OK
801              * because it works to call the 1-argument form where the
802              * 3-argument form is expected.) */
803             (void (*)(int, siginfo_t*, void*))SIG_DFL;
804     }
805
806     SHOW("returning from interrupt_init()");
807 }