src/runtime/interrupt.h

   1 /*
   2  * This software is part of the SBCL system. See the README file for
   3  * more information.
   4  *
   5  * This software is derived from the CMU CL system, which was
   6  * written at Carnegie Mellon University and released into the
   7  * public domain. The software is in the public domain and is
   8  * provided with absolutely no warranty. See the COPYING and CREDITS
   9  * files for more information.
  10  */
  11
  12 #if !defined(_INCLUDE_INTERRUPT_H_)
  13 #define _INCLUDE_INTERRUPT_H_
  14
  15 #include <signal.h>
  16 #include <string.h>
  17
  18 /*
  19  * This is a workaround for some slightly silly Linux/GNU Libc
  20  * behaviour: glibc defines sigset_t to support 1024 signals, which is
  21  * more than the kernel.  This is usually not a problem, but becomes
  22  * one when we want to save a signal mask from a ucontext, and restore
  23  * it later into another ucontext: the ucontext is allocated on the
  24  * stack by the kernel, so copying a libc-sized sigset_t into it will
  25  * overflow and cause other data on the stack to be corrupted */
  26 /* FIXME: do not rely on NSIG being a multiple of 8 */
  27 #define REAL_SIGSET_SIZE_BYTES ((NSIG/8))
  28
  29 extern void check_blockables_blocked_or_lose(void);
  30 extern void check_gc_signals_unblocked_or_lose(void);
  31 extern void unblock_gc_signals(void);
  32
  33 static inline void
  34 sigcopyset(sigset_t *new, sigset_t *old)
  35 {
  36     memcpy(new, old, REAL_SIGSET_SIZE_BYTES);
  37 }
  38
  39 /* maximum signal nesting depth
  40  *
  41  * FIXME: In CMUCL this was 4096, and it was first scaled down to 256
  42  * and then 32, until finally Stumpwm broke: it is possible to receive
  43  * interrupts in sufficiently quick succession that handler nesting
  44  * can become preposterous. Scaling this back up to 1024 is a bandaid:
  45  * for a real fix we should consider the following things:
  46  *
  47  *   We should almost certainly always use
  48  *   arrange_return_to_lisp_function, though it needs to be thought
  49  *   about arguments, and it needs to be able to pass a frobbable
  50  *   context to the callee...
  51  *
  52  *   There are cases when nesting handlers is exactly what we want:
  53  *   eg. SIGINT.
  54  *
  55  *   There are cases when we probably want to drop duplicate signals
  56  *   on the floor if they arrive before the previous one has been handled.
  57  *   Eg. SIGPROF.
  58  *
  59  *   There are cases when we probably want to handle duplicate signals
  60  *   after the previous handler has returned, not before. Eg. SIGALARM.
  61  *
  62  * -- NS 2007-01-29
  63  */
  64 #define MAX_INTERRUPTS 1024
  65
  66 union interrupt_handler {
  67     lispobj lisp;
  68     void (*c)(int, siginfo_t*, void*);
  69 };
  70
  71 extern union interrupt_handler interrupt_handlers[NSIG];
  72
  73 struct interrupt_data {
  74     /* signal information for pending signal.  pending_signal=0 when there
  75      * is no pending signal. */
  76     void (*pending_handler) (int, siginfo_t*, void*) ;
  77     int pending_signal;
  78     siginfo_t pending_info;
  79     sigset_t pending_mask;
  80 };
  81
  82
  83 extern void interrupt_init(void);
  84 extern void fake_foreign_function_call(os_context_t* context);
  85 extern void undo_fake_foreign_function_call(os_context_t* context);
  86 extern void arrange_return_to_lisp_function(os_context_t *, lispobj);
  87 extern void interrupt_handle_now(int, siginfo_t*, os_context_t*);
  88 extern void interrupt_handle_pending(os_context_t*);
  89 extern void interrupt_internal_error(os_context_t*, boolean continuable);
  90 extern boolean handle_guard_page_triggered(os_context_t *,os_vm_address_t);
  91 extern boolean maybe_defer_handler(void *handler, struct interrupt_data *data,
  92                                    int signal, siginfo_t *info,
  93                                    os_context_t *context);
  94 #if defined LISP_FEATURE_GENCGC
  95 /* assembly language stub that executes trap_PendingInterrupt */
  96 extern void do_pending_interrupt(void);
  97 #endif
  98
  99 #ifdef LISP_FEATURE_SB_THREAD
 100 extern void interrupt_thread_handler(int, siginfo_t*, void*);
 101 extern void sig_stop_for_gc_handler(int, siginfo_t*, void*);
 102 #endif
 103 typedef void (*interrupt_handler_t)(int, siginfo_t *, void *);
 104 extern void undoably_install_low_level_interrupt_handler (
 105                         int signal,
 106                         interrupt_handler_t handler);
 107 extern unsigned long install_handler(int signal,
 108                                      interrupt_handler_t handler);
 109
 110 extern union interrupt_handler interrupt_handlers[NSIG];
 111
 112 /* Set all deferrable signals into *s. */
 113 extern void sigaddset_deferrable(sigset_t *s);
 114 /* Set all blockable signals into *s. */
 115 extern void sigaddset_blockable(sigset_t *s);
 116
 117 extern void block_blockable_signals(void);
 118
 119 /* The void* casting here avoids having to mess with the various types
 120  * of function argument lists possible for signal handlers:
 121  * SA_SIGACTION handlers have one signature, and the default old-style
 122  * signal(..) handlers have another, and attempting to represent them
 123  * "cleanly" with union types is in fact a mess. */
 124 #define ARE_SAME_HANDLER(x, y) ((void*)(x) == (void*)(y))
 125
 126 extern void handle_trap(os_context_t *context, int trap);
 127
 128 #ifndef LISP_FEATURE_WIN32
 129 extern void lisp_memory_fault_error(os_context_t *context,
 130                                     os_vm_address_t addr);
 131 #endif
 132
 133 #endif