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 #include <sys/types.h>
  49 #include <sys/wait.h>
  50 #include <errno.h>
  51
  52 #include "sbcl.h"
  53 #include "runtime.h"
  54 #include "arch.h"
  55 #include "os.h"
  56 #include "interrupt.h"
  57 #include "globals.h"
  58 #include "lispregs.h"
  59 #include "validate.h"
  60 #include "monitor.h"
  61 #include "gc.h"
  62 #include "alloc.h"
  63 #include "dynbind.h"
  64 #include "interr.h"
  65 #include "genesis/fdefn.h"
  66 #include "genesis/simple-fun.h"
  67 #include "genesis/cons.h"
  68
  69
  70
  71 void run_deferred_handler(struct interrupt_data *data, void *v_context) ;
  72 static void store_signal_data_for_later (struct interrupt_data *data,
  73                                          void *handler, int signal,
  74                                          siginfo_t *info,
  75                                          os_context_t *context);
  76 boolean interrupt_maybe_gc_int(int signal, siginfo_t *info, void *v_context);
  77
  78 void sigaddset_deferrable(sigset_t *s)
  79 {
  80     sigaddset(s, SIGHUP);
  81     sigaddset(s, SIGINT);
  82     sigaddset(s, SIGQUIT);
  83     sigaddset(s, SIGPIPE);
  84     sigaddset(s, SIGALRM);
  85     sigaddset(s, SIGURG);
  86     sigaddset(s, SIGTSTP);
  87     sigaddset(s, SIGCHLD);
  88     sigaddset(s, SIGIO);
  89     sigaddset(s, SIGXCPU);
  90     sigaddset(s, SIGXFSZ);
  91     sigaddset(s, SIGVTALRM);
  92     sigaddset(s, SIGPROF);
  93     sigaddset(s, SIGWINCH);
  94     sigaddset(s, SIGUSR1);
  95     sigaddset(s, SIGUSR2);
  96 #ifdef LISP_FEATURE_SB_THREAD
  97     sigaddset(s, SIG_INTERRUPT_THREAD);
  98 #endif
  99 }
 100
 101 void sigaddset_blockable(sigset_t *s)
 102 {
 103     sigaddset_deferrable(s);
 104 #ifdef LISP_FEATURE_SB_THREAD
 105     sigaddset(s, SIG_STOP_FOR_GC);
 106 #endif
 107 }
 108
 109 /* initialized in interrupt_init */
 110 static sigset_t deferrable_sigset;
 111 static sigset_t blockable_sigset;
 112
 113 inline static void check_blockables_blocked_or_lose()
 114 {
 115     /* Get the current sigmask, by blocking the empty set. */
 116     sigset_t empty,current;
 117     int i;
 118     sigemptyset(&empty);
 119     thread_sigmask(SIG_BLOCK, &empty, &current);
 120     for(i=0;i<NSIG;i++) {
 121         if (sigismember(&blockable_sigset, i) && !sigismember(&current, i))
 122             lose("blockable signal %d not blocked",i);
 123     }
 124 }
 125
 126 inline static void check_interrupts_enabled_or_lose(os_context_t *context)
 127 {
 128     struct thread *thread=arch_os_get_current_thread();
 129     if (SymbolValue(INTERRUPTS_ENABLED,thread) == NIL)
 130         lose("interrupts not enabled");
 131     if (
 132 #if !defined(LISP_FEATURE_X86) && !defined(LISP_FEATURE_X86_64)
 133         (!foreign_function_call_active) &&
 134 #endif
 135         arch_pseudo_atomic_atomic(context))
 136         lose ("in pseudo atomic section");
 137 }
 138
 139 /* When we catch an internal error, should we pass it back to Lisp to
 140  * be handled in a high-level way? (Early in cold init, the answer is
 141  * 'no', because Lisp is still too brain-dead to handle anything.
 142  * After sufficient initialization has been completed, the answer
 143  * becomes 'yes'.) */
 144 boolean internal_errors_enabled = 0;
 145
 146 static void (*interrupt_low_level_handlers[NSIG]) (int, siginfo_t*, void*);
 147 union interrupt_handler interrupt_handlers[NSIG];
 148
 149 /* At the toplevel repl we routinely call this function.  The signal
 150  * mask ought to be clear anyway most of the time, but may be non-zero
 151  * if we were interrupted e.g. while waiting for a queue.  */
 152
 153 void reset_signal_mask ()
 154 {
 155     sigset_t new;
 156     sigemptyset(&new);
 157     thread_sigmask(SIG_SETMASK,&new,0);
 158 }
 159
 160 void block_blockable_signals ()
 161 {
 162     sigset_t block;
 163     sigemptyset(&block);
 164     sigaddset_blockable(&block);
 165     thread_sigmask(SIG_BLOCK, &block, 0);
 166 }
 167
 168 \f
 169 /*
 170  * utility routines used by various signal handlers
 171  */
 172
 173 void
 174 build_fake_control_stack_frames(struct thread *th,os_context_t *context)
 175 {
 176 #ifndef LISP_FEATURE_C_STACK_IS_CONTROL_STACK
 177
 178     lispobj oldcont;
 179
 180     /* Build a fake stack frame or frames */
 181
 182     current_control_frame_pointer =
 183         (lispobj *)(*os_context_register_addr(context, reg_CSP));
 184     if ((lispobj *)(*os_context_register_addr(context, reg_CFP))
 185         == current_control_frame_pointer) {
 186         /* There is a small window during call where the callee's
 187          * frame isn't built yet. */
 188         if (lowtag_of(*os_context_register_addr(context, reg_CODE))
 189             == FUN_POINTER_LOWTAG) {
 190             /* We have called, but not built the new frame, so
 191              * build it for them. */
 192             current_control_frame_pointer[0] =
 193                 *os_context_register_addr(context, reg_OCFP);
 194             current_control_frame_pointer[1] =
 195                 *os_context_register_addr(context, reg_LRA);
 196             current_control_frame_pointer += 8;
 197             /* Build our frame on top of it. */
 198             oldcont = (lispobj)(*os_context_register_addr(context, reg_CFP));
 199         }
 200         else {
 201             /* We haven't yet called, build our frame as if the
 202              * partial frame wasn't there. */
 203             oldcont = (lispobj)(*os_context_register_addr(context, reg_OCFP));
 204         }
 205     }
 206     /* We can't tell whether we are still in the caller if it had to
 207      * allocate a stack frame due to stack arguments. */
 208     /* This observation provoked some past CMUCL maintainer to ask
 209      * "Can anything strange happen during return?" */
 210     else {
 211         /* normal case */
 212         oldcont = (lispobj)(*os_context_register_addr(context, reg_CFP));
 213     }
 214
 215     current_control_stack_pointer = current_control_frame_pointer + 8;
 216
 217     current_control_frame_pointer[0] = oldcont;
 218     current_control_frame_pointer[1] = NIL;
 219     current_control_frame_pointer[2] =
 220         (lispobj)(*os_context_register_addr(context, reg_CODE));
 221 #endif
 222 }
 223
 224 void
 225 fake_foreign_function_call(os_context_t *context)
 226 {
 227     int context_index;
 228     struct thread *thread=arch_os_get_current_thread();
 229
 230     /* context_index incrementing must not be interrupted */
 231     check_blockables_blocked_or_lose();
 232
 233     /* Get current Lisp state from context. */
 234 #ifdef reg_ALLOC
 235     dynamic_space_free_pointer =
 236         (lispobj *)(*os_context_register_addr(context, reg_ALLOC));
 237 #if defined(LISP_FEATURE_ALPHA)
 238     if ((long)dynamic_space_free_pointer & 1) {
 239         lose("dead in fake_foreign_function_call, context = %x", context);
 240     }
 241 #endif
 242 #endif
 243 #ifdef reg_BSP
 244     current_binding_stack_pointer =
 245         (lispobj *)(*os_context_register_addr(context, reg_BSP));
 246 #endif
 247
 248     build_fake_control_stack_frames(thread,context);
 249
 250     /* Do dynamic binding of the active interrupt context index
 251      * and save the context in the context array. */
 252     context_index =
 253         fixnum_value(SymbolValue(FREE_INTERRUPT_CONTEXT_INDEX,thread));
 254
 255     if (context_index >= MAX_INTERRUPTS) {
 256         lose("maximum interrupt nesting depth (%d) exceeded", MAX_INTERRUPTS);
 257     }
 258
 259     bind_variable(FREE_INTERRUPT_CONTEXT_INDEX,
 260                   make_fixnum(context_index + 1),thread);
 261
 262     thread->interrupt_contexts[context_index] = context;
 263
 264     /* no longer in Lisp now */
 265     foreign_function_call_active = 1;
 266 }
 267
 268 /* blocks all blockable signals.  If you are calling from a signal handler,
 269  * the usual signal mask will be restored from the context when the handler
 270  * finishes.  Otherwise, be careful */
 271
 272 void
 273 undo_fake_foreign_function_call(os_context_t *context)
 274 {
 275     struct thread *thread=arch_os_get_current_thread();
 276     /* Block all blockable signals. */
 277     block_blockable_signals();
 278
 279     /* going back into Lisp */
 280     foreign_function_call_active = 0;
 281
 282     /* Undo dynamic binding of FREE_INTERRUPT_CONTEXT_INDEX */
 283     unbind(thread);
 284
 285 #ifdef reg_ALLOC
 286     /* Put the dynamic space free pointer back into the context. */
 287     *os_context_register_addr(context, reg_ALLOC) =
 288         (unsigned long) dynamic_space_free_pointer;
 289 #endif
 290 }
 291
 292 /* a handler for the signal caused by execution of a trap opcode
 293  * signalling an internal error */
 294 void
 295 interrupt_internal_error(int signal, siginfo_t *info, os_context_t *context,
 296                          boolean continuable)
 297 {
 298     lispobj context_sap = 0;
 299
 300     check_blockables_blocked_or_lose();
 301     fake_foreign_function_call(context);
 302
 303     /* Allocate the SAP object while the interrupts are still
 304      * disabled. */
 305     if (internal_errors_enabled) {
 306         context_sap = alloc_sap(context);
 307     }
 308
 309     thread_sigmask(SIG_SETMASK, os_context_sigmask_addr(context), 0);
 310
 311     if (internal_errors_enabled) {
 312         SHOW("in interrupt_internal_error");
 313 #ifdef QSHOW
 314         /* Display some rudimentary debugging information about the
 315          * error, so that even if the Lisp error handler gets badly
 316          * confused, we have a chance to determine what's going on. */
 317         describe_internal_error(context);
 318 #endif
 319         funcall2(SymbolFunction(INTERNAL_ERROR), context_sap,
 320                  continuable ? T : NIL);
 321     } else {
 322         describe_internal_error(context);
 323         /* There's no good way to recover from an internal error
 324          * before the Lisp error handling mechanism is set up. */
 325         lose("internal error too early in init, can't recover");
 326     }
 327     undo_fake_foreign_function_call(context); /* blocks signals again */
 328     if (continuable) {
 329         arch_skip_instruction(context);
 330     }
 331 }
 332
 333 void
 334 interrupt_handle_pending(os_context_t *context)
 335 {
 336     struct thread *thread;
 337     struct interrupt_data *data;
 338
 339     check_blockables_blocked_or_lose();
 340
 341     thread=arch_os_get_current_thread();
 342     data=thread->interrupt_data;
 343
 344     if (SymbolValue(GC_INHIBIT,thread)==NIL) {
 345 #ifdef LISP_FEATURE_SB_THREAD
 346         if (SymbolValue(STOP_FOR_GC_PENDING,thread) != NIL) {
 347             /* another thread has already initiated a gc, this attempt
 348              * might as well be cancelled */
 349             SetSymbolValue(GC_PENDING,NIL,thread);
 350             SetSymbolValue(STOP_FOR_GC_PENDING,NIL,thread);
 351             sig_stop_for_gc_handler(SIG_STOP_FOR_GC,NULL,context);
 352         } else
 353 #endif
 354         if (SymbolValue(GC_PENDING,thread) != NIL) {
 355             /* GC_PENDING is cleared in SUB-GC, or if another thread
 356              * is doing a gc already we will get a SIG_STOP_FOR_GC and
 357              * that will clear it. */
 358             interrupt_maybe_gc_int(0,NULL,context);
 359         }
 360         check_blockables_blocked_or_lose();
 361     }
 362
 363     /* we may be here only to do the gc stuff, if interrupts are
 364      * enabled run the pending handler */
 365     if (!((SymbolValue(INTERRUPTS_ENABLED,thread) == NIL) ||
 366           (
 367 #if !defined(LISP_FEATURE_X86) && !defined(LISP_FEATURE_X86_64)
 368            (!foreign_function_call_active) &&
 369 #endif
 370            arch_pseudo_atomic_atomic(context)))) {
 371
 372         /* There may be no pending handler, because it was only a gc
 373          * that had to be executed or because pseudo atomic triggered
 374          * twice for a single interrupt. For the interested reader,
 375          * that may happen if an interrupt hits after the interrupted
 376          * flag is cleared but before pseduo-atomic is set and a
 377          * pseudo atomic is interrupted in that interrupt. */
 378         if (data->pending_handler) {
 379
 380             /* If we're here as the result of a pseudo-atomic as opposed
 381              * to WITHOUT-INTERRUPTS, then INTERRUPT_PENDING is already
 382              * NIL, because maybe_defer_handler sets
 383              * PSEUDO_ATOMIC_INTERRUPTED only if interrupts are enabled.*/
 384             SetSymbolValue(INTERRUPT_PENDING, NIL,thread);
 385
 386             /* restore the saved signal mask from the original signal (the
 387              * one that interrupted us during the critical section) into the
 388              * os_context for the signal we're currently in the handler for.
 389              * This should ensure that when we return from the handler the
 390              * blocked signals are unblocked */
 391             sigcopyset(os_context_sigmask_addr(context), &data->pending_mask);
 392
 393             sigemptyset(&data->pending_mask);
 394             /* This will break on sparc linux: the deferred handler really wants
 395              * to be called with a void_context */
 396             run_deferred_handler(data,(void *)context);
 397         }
 398     }
 399 }
 400 \f
 401 /*
 402  * the two main signal handlers:
 403  *   interrupt_handle_now(..)
 404  *   maybe_now_maybe_later(..)
 405  *
 406  * to which we have added interrupt_handle_now_handler(..).  Why?
 407  * Well, mostly because the SPARC/Linux platform doesn't quite do
 408  * signals the way we want them done.  The third argument in the
 409  * handler isn't filled in by the kernel properly, so we fix it up
 410  * ourselves in the arch_os_get_context(..) function; however, we only
 411  * want to do this when we first hit the handler, and not when
 412  * interrupt_handle_now(..) is being called from some other handler
 413  * (when the fixup will already have been done). -- CSR, 2002-07-23
 414  */
 415
 416 void
 417 interrupt_handle_now(int signal, siginfo_t *info, void *void_context)
 418 {
 419     os_context_t *context = (os_context_t*)void_context;
 420 #if !defined(LISP_FEATURE_X86) && !defined(LISP_FEATURE_X86_64)
 421     boolean were_in_lisp;
 422 #endif
 423     union interrupt_handler handler;
 424     check_blockables_blocked_or_lose();
 425     if (sigismember(&deferrable_sigset,signal))
 426         check_interrupts_enabled_or_lose(context);
 427
 428 #ifdef LISP_FEATURE_LINUX
 429     /* Under Linux on some architectures, we appear to have to restore
 430        the FPU control word from the context, as after the signal is
 431        delivered we appear to have a null FPU control word. */
 432     os_restore_fp_control(context);
 433 #endif
 434     handler = interrupt_handlers[signal];
 435
 436     if (ARE_SAME_HANDLER(handler.c, SIG_IGN)) {
 437         return;
 438     }
 439
 440 #if !defined(LISP_FEATURE_X86) && !defined(LISP_FEATURE_X86_64)
 441     were_in_lisp = !foreign_function_call_active;
 442     if (were_in_lisp)
 443 #endif
 444     {
 445         fake_foreign_function_call(context);
 446     }
 447
 448     FSHOW_SIGNAL((stderr,
 449                   "/entering interrupt_handle_now(%d, info, context)\n",
 450                   signal));
 451
 452     if (ARE_SAME_HANDLER(handler.c, SIG_DFL)) {
 453
 454         /* This can happen if someone tries to ignore or default one
 455          * of the signals we need for runtime support, and the runtime
 456          * support decides to pass on it. */
 457         lose("no handler for signal %d in interrupt_handle_now(..)", signal);
 458
 459     } else if (lowtag_of(handler.lisp) == FUN_POINTER_LOWTAG) {
 460         /* Once we've decided what to do about contexts in a
 461          * return-elsewhere world (the original context will no longer
 462          * be available; should we copy it or was nobody using it anyway?)
 463          * then we should convert this to return-elsewhere */
 464
 465         /* CMUCL comment said "Allocate the SAPs while the interrupts
 466          * are still disabled.".  I (dan, 2003.08.21) assume this is
 467          * because we're not in pseudoatomic and allocation shouldn't
 468          * be interrupted.  In which case it's no longer an issue as
 469          * all our allocation from C now goes through a PA wrapper,
 470          * but still, doesn't hurt.
 471          *
 472          * Yeah, but non-gencgc platforms that don't really wrap
 473          * allocation in PA. MG - 2005-08-29  */
 474
 475         lispobj info_sap,context_sap = alloc_sap(context);
 476         info_sap = alloc_sap(info);
 477         /* Allow signals again. */
 478         thread_sigmask(SIG_SETMASK, os_context_sigmask_addr(context), 0);
 479
 480         FSHOW_SIGNAL((stderr,"/calling Lisp-level handler\n"));
 481
 482         funcall3(handler.lisp,
 483                  make_fixnum(signal),
 484                  info_sap,
 485                  context_sap);
 486     } else {
 487
 488         FSHOW_SIGNAL((stderr,"/calling C-level handler\n"));
 489
 490         /* Allow signals again. */
 491         thread_sigmask(SIG_SETMASK, os_context_sigmask_addr(context), 0);
 492
 493         (*handler.c)(signal, info, void_context);
 494     }
 495
 496 #if !defined(LISP_FEATURE_X86) && !defined(LISP_FEATURE_X86_64)
 497     if (were_in_lisp)
 498 #endif
 499     {
 500         undo_fake_foreign_function_call(context); /* block signals again */
 501     }
 502
 503     FSHOW_SIGNAL((stderr,
 504                   "/returning from interrupt_handle_now(%d, info, context)\n",
 505                   signal));
 506 }
 507
 508 /* This is called at the end of a critical section if the indications
 509  * are that some signal was deferred during the section.  Note that as
 510  * far as C or the kernel is concerned we dealt with the signal
 511  * already; we're just doing the Lisp-level processing now that we
 512  * put off then */
 513
 514 void
 515 run_deferred_handler(struct interrupt_data *data, void *v_context) {
 516     /* The pending_handler may enable interrupts and then another
 517      * interrupt may hit, overwrite interrupt_data, so reset the
 518      * pending handler before calling it. Trust the handler to finish
 519      * with the siginfo before enabling interrupts. */
 520     void (*pending_handler) (int, siginfo_t*, void*)=data->pending_handler;
 521     data->pending_handler=0;
 522     (*pending_handler)(data->pending_signal,&(data->pending_info), v_context);
 523 }
 524
 525 boolean
 526 maybe_defer_handler(void *handler, struct interrupt_data *data,
 527                     int signal, siginfo_t *info, os_context_t *context)
 528 {
 529     struct thread *thread=arch_os_get_current_thread();
 530
 531     check_blockables_blocked_or_lose();
 532
 533     if (SymbolValue(INTERRUPT_PENDING,thread) != NIL)
 534         lose("interrupt already pending");
 535     /* If interrupts are disabled then INTERRUPT_PENDING is set and
 536      * not PSEDUO_ATOMIC_INTERRUPTED. This is important for a pseudo
 537      * atomic section inside a WITHOUT-INTERRUPTS.
 538      */
 539     if (SymbolValue(INTERRUPTS_ENABLED,thread) == NIL) {
 540         store_signal_data_for_later(data,handler,signal,info,context);
 541         SetSymbolValue(INTERRUPT_PENDING, T,thread);
 542         FSHOW_SIGNAL((stderr,
 543                       "/maybe_defer_handler(%x,%d),thread=%lu: deferred\n",
 544                       (unsigned int)handler,signal,
 545                       (unsigned long)thread->os_thread));
 546         return 1;
 547     }
 548     /* a slightly confusing test.  arch_pseudo_atomic_atomic() doesn't
 549      * actually use its argument for anything on x86, so this branch
 550      * may succeed even when context is null (gencgc alloc()) */
 551     if (
 552 #if !defined(LISP_FEATURE_X86) && !defined(LISP_FEATURE_X86_64)
 553         /* FIXME: this foreign_function_call_active test is dubious at
 554          * best. If a foreign call is made in a pseudo atomic section
 555          * (?) or more likely a pseudo atomic section is in a foreign
 556          * call then an interrupt is executed immediately. Maybe it
 557          * has to do with C code not maintaining pseudo atomic
 558          * properly. MG - 2005-08-10 */
 559         (!foreign_function_call_active) &&
 560 #endif
 561         arch_pseudo_atomic_atomic(context)) {
 562         store_signal_data_for_later(data,handler,signal,info,context);
 563         arch_set_pseudo_atomic_interrupted(context);
 564         FSHOW_SIGNAL((stderr,
 565                       "/maybe_defer_handler(%x,%d),thread=%lu: deferred(PA)\n",
 566                       (unsigned int)handler,signal,
 567                       (unsigned long)thread->os_thread));
 568         return 1;
 569     }
 570     FSHOW_SIGNAL((stderr,
 571                   "/maybe_defer_handler(%x,%d),thread=%lu: not deferred\n",
 572                   (unsigned int)handler,signal,
 573                   (unsigned long)thread->os_thread));
 574     return 0;
 575 }
 576
 577 static void
 578 store_signal_data_for_later (struct interrupt_data *data, void *handler,
 579                              int signal,
 580                              siginfo_t *info, os_context_t *context)
 581 {
 582     if (data->pending_handler)
 583         lose("tried to overwrite pending interrupt handler %x with %x\n",
 584              data->pending_handler, handler);
 585     if (!handler)
 586         lose("tried to defer null interrupt handler\n");
 587     data->pending_handler = handler;
 588     data->pending_signal = signal;
 589     if(info)
 590         memcpy(&(data->pending_info), info, sizeof(siginfo_t));
 591     if(context) {
 592         /* the signal mask in the context (from before we were
 593          * interrupted) is copied to be restored when
 594          * run_deferred_handler happens.  Then the usually-blocked
 595          * signals are added to the mask in the context so that we are
 596          * running with blocked signals when the handler returns */
 597         sigcopyset(&(data->pending_mask),os_context_sigmask_addr(context));
 598         sigaddset_deferrable(os_context_sigmask_addr(context));
 599     }
 600 }
 601
 602 static void
 603 maybe_now_maybe_later(int signal, siginfo_t *info, void *void_context)
 604 {
 605     os_context_t *context = arch_os_get_context(&void_context);
 606     struct thread *thread=arch_os_get_current_thread();
 607     struct interrupt_data *data=thread->interrupt_data;
 608 #ifdef LISP_FEATURE_LINUX
 609     os_restore_fp_control(context);
 610 #endif
 611     if(maybe_defer_handler(interrupt_handle_now,data,signal,info,context))
 612         return;
 613     interrupt_handle_now(signal, info, context);
 614 #ifdef LISP_FEATURE_DARWIN
 615     /* Work around G5 bug */
 616     DARWIN_FIX_CONTEXT(context);
 617 #endif
 618 }
 619
 620 static void
 621 low_level_interrupt_handle_now(int signal, siginfo_t *info, void *void_context)
 622 {
 623     os_context_t *context = (os_context_t*)void_context;
 624
 625 #ifdef LISP_FEATURE_LINUX
 626     os_restore_fp_control(context);
 627 #endif
 628     check_blockables_blocked_or_lose();
 629     check_interrupts_enabled_or_lose(context);
 630     interrupt_low_level_handlers[signal](signal, info, void_context);
 631 #ifdef LISP_FEATURE_DARWIN
 632     /* Work around G5 bug */
 633     DARWIN_FIX_CONTEXT(context);
 634 #endif
 635 }
 636
 637 static void
 638 low_level_maybe_now_maybe_later(int signal, siginfo_t *info, void *void_context)
 639 {
 640     os_context_t *context = arch_os_get_context(&void_context);
 641     struct thread *thread=arch_os_get_current_thread();
 642     struct interrupt_data *data=thread->interrupt_data;
 643 #ifdef LISP_FEATURE_LINUX
 644     os_restore_fp_control(context);
 645 #endif
 646     if(maybe_defer_handler(low_level_interrupt_handle_now,data,
 647                            signal,info,context))
 648         return;
 649     low_level_interrupt_handle_now(signal, info, context);
 650 #ifdef LISP_FEATURE_DARWIN
 651     /* Work around G5 bug */
 652     DARWIN_FIX_CONTEXT(context);
 653 #endif
 654 }
 655
 656 #ifdef LISP_FEATURE_SB_THREAD
 657
 658 void
 659 sig_stop_for_gc_handler(int signal, siginfo_t *info, void *void_context)
 660 {
 661     os_context_t *context = arch_os_get_context(&void_context);
 662     struct thread *thread=arch_os_get_current_thread();
 663     sigset_t ss;
 664     int i;
 665
 666     if ((arch_pseudo_atomic_atomic(context) ||
 667          SymbolValue(GC_INHIBIT,thread) != NIL)) {
 668         SetSymbolValue(STOP_FOR_GC_PENDING,T,thread);
 669         if (SymbolValue(GC_INHIBIT,thread) == NIL)
 670             arch_set_pseudo_atomic_interrupted(context);
 671         FSHOW_SIGNAL((stderr,"thread=%lu sig_stop_for_gc deferred\n",
 672                       thread->os_thread));
 673     } else {
 674         /* need the context stored so it can have registers scavenged */
 675         fake_foreign_function_call(context);
 676
 677         sigemptyset(&ss);
 678         for(i=1;i<NSIG;i++) sigaddset(&ss,i); /* Block everything. */
 679         thread_sigmask(SIG_BLOCK,&ss,0);
 680
 681         /* The GC can't tell if a thread is a zombie, so this would be a
 682          * good time to let the kernel reap any of our children in that
 683          * awful state, to stop them from being waited for indefinitely.
 684          * Userland reaping is done later when GC is finished  */
 685         if(thread->state!=STATE_RUNNING) {
 686             lose("sig_stop_for_gc_handler: wrong thread state: %ld\n",
 687                  fixnum_value(thread->state));
 688         }
 689         thread->state=STATE_SUSPENDED;
 690         FSHOW_SIGNAL((stderr,"thread=%lu suspended\n",thread->os_thread));
 691
 692         sigemptyset(&ss); sigaddset(&ss,SIG_STOP_FOR_GC);
 693         sigwaitinfo(&ss,0);
 694         FSHOW_SIGNAL((stderr,"thread=%lu resumed\n",thread->os_thread));
 695         if(thread->state!=STATE_RUNNING) {
 696             lose("sig_stop_for_gc_handler: wrong thread state on wakeup: %ld\n",
 697                  fixnum_value(thread->state));
 698         }
 699
 700         undo_fake_foreign_function_call(context);
 701     }
 702 }
 703 #endif
 704
 705 void
 706 interrupt_handle_now_handler(int signal, siginfo_t *info, void *void_context)
 707 {
 708     os_context_t *context = arch_os_get_context(&void_context);
 709     interrupt_handle_now(signal, info, context);
 710 #ifdef LISP_FEATURE_DARWIN
 711     DARWIN_FIX_CONTEXT(context);
 712 #endif
 713 }
 714
 715 /*
 716  * stuff to detect and handle hitting the GC trigger
 717  */
 718
 719 #ifndef LISP_FEATURE_GENCGC
 720 /* since GENCGC has its own way to record trigger */
 721 static boolean
 722 gc_trigger_hit(int signal, siginfo_t *info, os_context_t *context)
 723 {
 724     if (current_auto_gc_trigger == NULL)
 725         return 0;
 726     else{
 727         void *badaddr=arch_get_bad_addr(signal,info,context);
 728         return (badaddr >= (void *)current_auto_gc_trigger &&
 729                 badaddr <((void *)current_dynamic_space + DYNAMIC_SPACE_SIZE));
 730     }
 731 }
 732 #endif
 733
 734 /* manipulate the signal context and stack such that when the handler
 735  * returns, it will call function instead of whatever it was doing
 736  * previously
 737  */
 738
 739 #if (defined(LISP_FEATURE_X86) || defined(LISP_FEATURE_X86_64))
 740 int *context_eflags_addr(os_context_t *context);
 741 #endif
 742
 743 extern lispobj call_into_lisp(lispobj fun, lispobj *args, int nargs);
 744 extern void post_signal_tramp(void);
 745 void arrange_return_to_lisp_function(os_context_t *context, lispobj function)
 746 {
 747 #if !(defined(LISP_FEATURE_X86) || defined(LISP_FEATURE_X86_64))
 748     void * fun=native_pointer(function);
 749     void *code = &(((struct simple_fun *) fun)->code);
 750 #endif
 751
 752     /* Build a stack frame showing `interrupted' so that the
 753      * user's backtrace makes (as much) sense (as usual) */
 754
 755     /* FIXME: what about restoring fp state? */
 756     /* FIXME: what about restoring errno? */
 757 #ifdef LISP_FEATURE_X86
 758     /* Suppose the existence of some function that saved all
 759      * registers, called call_into_lisp, then restored GP registers and
 760      * returned.  It would look something like this:
 761
 762      push   ebp
 763      mov    ebp esp
 764      pushfl
 765      pushal
 766      push   $0
 767      push   $0
 768      pushl  {address of function to call}
 769      call   0x8058db0 <call_into_lisp>
 770      addl   $12,%esp
 771      popal
 772      popfl
 773      leave
 774      ret
 775
 776      * What we do here is set up the stack that call_into_lisp would
 777      * expect to see if it had been called by this code, and frob the
 778      * signal context so that signal return goes directly to call_into_lisp,
 779      * and when that function (and the lisp function it invoked) returns,
 780      * it returns to the second half of this imaginary function which
 781      * restores all registers and returns to C
 782
 783      * For this to work, the latter part of the imaginary function
 784      * must obviously exist in reality.  That would be post_signal_tramp
 785      */
 786
 787     u32 *sp=(u32 *)*os_context_register_addr(context,reg_ESP);
 788
 789     /* return address for call_into_lisp: */
 790     *(sp-15) = (u32)post_signal_tramp;
 791     *(sp-14) = function;        /* args for call_into_lisp : function*/
 792     *(sp-13) = 0;               /*                           arg array */
 793     *(sp-12) = 0;               /*                           no. args */
 794     /* this order matches that used in POPAD */
 795     *(sp-11)=*os_context_register_addr(context,reg_EDI);
 796     *(sp-10)=*os_context_register_addr(context,reg_ESI);
 797
 798     *(sp-9)=*os_context_register_addr(context,reg_ESP)-8;
 799     /* POPAD ignores the value of ESP:  */
 800     *(sp-8)=0;
 801     *(sp-7)=*os_context_register_addr(context,reg_EBX);
 802
 803     *(sp-6)=*os_context_register_addr(context,reg_EDX);
 804     *(sp-5)=*os_context_register_addr(context,reg_ECX);
 805     *(sp-4)=*os_context_register_addr(context,reg_EAX);
 806     *(sp-3)=*context_eflags_addr(context);
 807     *(sp-2)=*os_context_register_addr(context,reg_EBP);
 808     *(sp-1)=*os_context_pc_addr(context);
 809
 810 #elif defined(LISP_FEATURE_X86_64)
 811     u64 *sp=(u64 *)*os_context_register_addr(context,reg_RSP);
 812     /* return address for call_into_lisp: */
 813     *(sp-18) = (u64)post_signal_tramp;
 814
 815     *(sp-17)=*os_context_register_addr(context,reg_R15);
 816     *(sp-16)=*os_context_register_addr(context,reg_R14);
 817     *(sp-15)=*os_context_register_addr(context,reg_R13);
 818     *(sp-14)=*os_context_register_addr(context,reg_R12);
 819     *(sp-13)=*os_context_register_addr(context,reg_R11);
 820     *(sp-12)=*os_context_register_addr(context,reg_R10);
 821     *(sp-11)=*os_context_register_addr(context,reg_R9);
 822     *(sp-10)=*os_context_register_addr(context,reg_R8);
 823     *(sp-9)=*os_context_register_addr(context,reg_RDI);
 824     *(sp-8)=*os_context_register_addr(context,reg_RSI);
 825     /* skip RBP and RSP */
 826     *(sp-7)=*os_context_register_addr(context,reg_RBX);
 827     *(sp-6)=*os_context_register_addr(context,reg_RDX);
 828     *(sp-5)=*os_context_register_addr(context,reg_RCX);
 829     *(sp-4)=*os_context_register_addr(context,reg_RAX);
 830     *(sp-3)=*context_eflags_addr(context);
 831     *(sp-2)=*os_context_register_addr(context,reg_RBP);
 832     *(sp-1)=*os_context_pc_addr(context);
 833
 834     *os_context_register_addr(context,reg_RDI) =
 835         (os_context_register_t)function; /* function */
 836     *os_context_register_addr(context,reg_RSI) = 0;        /* arg. array */
 837     *os_context_register_addr(context,reg_RDX) = 0;        /* no. args */
 838 #else
 839     struct thread *th=arch_os_get_current_thread();
 840     build_fake_control_stack_frames(th,context);
 841 #endif
 842
 843 #ifdef LISP_FEATURE_X86
 844     *os_context_pc_addr(context) = (os_context_register_t)call_into_lisp;
 845     *os_context_register_addr(context,reg_ECX) = 0;
 846     *os_context_register_addr(context,reg_EBP) = (os_context_register_t)(sp-2);
 847 #ifdef __NetBSD__
 848     *os_context_register_addr(context,reg_UESP) =
 849         (os_context_register_t)(sp-15);
 850 #else
 851     *os_context_register_addr(context,reg_ESP) = (os_context_register_t)(sp-15);
 852 #endif
 853 #elif defined(LISP_FEATURE_X86_64)
 854     *os_context_pc_addr(context) = (os_context_register_t)call_into_lisp;
 855     *os_context_register_addr(context,reg_RCX) = 0;
 856     *os_context_register_addr(context,reg_RBP) = (os_context_register_t)(sp-2);
 857     *os_context_register_addr(context,reg_RSP) = (os_context_register_t)(sp-18);
 858 #else
 859     /* this much of the calling convention is common to all
 860        non-x86 ports */
 861     *os_context_pc_addr(context) = (os_context_register_t)code;
 862     *os_context_register_addr(context,reg_NARGS) = 0;
 863     *os_context_register_addr(context,reg_LIP) = (os_context_register_t)code;
 864     *os_context_register_addr(context,reg_CFP) =
 865         (os_context_register_t)current_control_frame_pointer;
 866 #endif
 867 #ifdef ARCH_HAS_NPC_REGISTER
 868     *os_context_npc_addr(context) =
 869         4 + *os_context_pc_addr(context);
 870 #endif
 871 #ifdef LISP_FEATURE_SPARC
 872     *os_context_register_addr(context,reg_CODE) =
 873         (os_context_register_t)(fun + FUN_POINTER_LOWTAG);
 874 #endif
 875 }
 876
 877 #ifdef LISP_FEATURE_SB_THREAD
 878 void interrupt_thread_handler(int num, siginfo_t *info, void *v_context)
 879 {
 880     os_context_t *context = (os_context_t*)arch_os_get_context(&v_context);
 881     /* The order of interrupt execution is peculiar. If thread A
 882      * interrupts thread B with I1, I2 and B for some reason receives
 883      * I1 when FUN2 is already on the list, then it is FUN2 that gets
 884      * to run first. But when FUN2 is run SIG_INTERRUPT_THREAD is
 885      * enabled again and I2 hits pretty soon in FUN2 and run
 886      * FUN1. This is of course just one scenario, and the order of
 887      * thread interrupt execution is undefined. */
 888     struct thread *th=arch_os_get_current_thread();
 889     struct cons *c;
 890     lispobj function;
 891     if (th->state != STATE_RUNNING)
 892         lose("interrupt_thread_handler: thread %lu in wrong state: %d\n",
 893              th->os_thread,fixnum_value(th->state));
 894     get_spinlock(&th->interrupt_fun_lock,(long)th);
 895     c=((struct cons *)native_pointer(th->interrupt_fun));
 896     function=c->car;
 897     th->interrupt_fun=c->cdr;
 898     release_spinlock(&th->interrupt_fun_lock);
 899     if (function==NIL)
 900         lose("interrupt_thread_handler: NIL function\n");
 901     arrange_return_to_lisp_function(context,function);
 902 }
 903
 904 #endif
 905
 906 /* KLUDGE: Theoretically the approach we use for undefined alien
 907  * variables should work for functions as well, but on PPC/Darwin
 908  * we get bus error at bogus addresses instead, hence this workaround,
 909  * that has the added benefit of automatically discriminating between
 910  * functions and variables.
 911  */
 912 void undefined_alien_function() {
 913     funcall0(SymbolFunction(UNDEFINED_ALIEN_FUNCTION_ERROR));
 914 }
 915
 916 boolean handle_guard_page_triggered(os_context_t *context,os_vm_address_t addr)
 917 {
 918     struct thread *th=arch_os_get_current_thread();
 919
 920     /* note the os_context hackery here.  When the signal handler returns,
 921      * it won't go back to what it was doing ... */
 922     if(addr >= CONTROL_STACK_GUARD_PAGE(th) &&
 923        addr < CONTROL_STACK_GUARD_PAGE(th) + os_vm_page_size) {
 924         /* We hit the end of the control stack: disable guard page
 925          * protection so the error handler has some headroom, protect the
 926          * previous page so that we can catch returns from the guard page
 927          * and restore it. */
 928         protect_control_stack_guard_page(th,0);
 929         protect_control_stack_return_guard_page(th,1);
 930
 931         arrange_return_to_lisp_function
 932             (context, SymbolFunction(CONTROL_STACK_EXHAUSTED_ERROR));
 933         return 1;
 934     }
 935     else if(addr >= CONTROL_STACK_RETURN_GUARD_PAGE(th) &&
 936             addr < CONTROL_STACK_RETURN_GUARD_PAGE(th) + os_vm_page_size) {
 937         /* We're returning from the guard page: reprotect it, and
 938          * unprotect this one. This works even if we somehow missed
 939          * the return-guard-page, and hit it on our way to new
 940          * exhaustion instead. */
 941         protect_control_stack_guard_page(th,1);
 942         protect_control_stack_return_guard_page(th,0);
 943         return 1;
 944     }
 945     else if (addr >= undefined_alien_address &&
 946              addr < undefined_alien_address + os_vm_page_size) {
 947         arrange_return_to_lisp_function
 948           (context, SymbolFunction(UNDEFINED_ALIEN_VARIABLE_ERROR));
 949         return 1;
 950     }
 951     else return 0;
 952 }
 953
 954 #ifndef LISP_FEATURE_GENCGC
 955 /* This function gets called from the SIGSEGV (for e.g. Linux, NetBSD, &
 956  * OpenBSD) or SIGBUS (for e.g. FreeBSD) handler. Here we check
 957  * whether the signal was due to treading on the mprotect()ed zone -
 958  * and if so, arrange for a GC to happen. */
 959 extern unsigned long bytes_consed_between_gcs; /* gc-common.c */
 960
 961 boolean
 962 interrupt_maybe_gc(int signal, siginfo_t *info, void *void_context)
 963 {
 964     os_context_t *context=(os_context_t *) void_context;
 965     struct thread *th=arch_os_get_current_thread();
 966     struct interrupt_data *data=th->interrupt_data;
 967
 968     if(!foreign_function_call_active && gc_trigger_hit(signal, info, context)){
 969         struct thread *thread=arch_os_get_current_thread();
 970         clear_auto_gc_trigger();
 971         /* Don't flood the system with interrupts if the need to gc is
 972          * already noted. This can happen for example when SUB-GC
 973          * allocates or after a gc triggered in a WITHOUT-GCING. */
 974         if (SymbolValue(GC_PENDING,thread) == NIL) {
 975             if (SymbolValue(GC_INHIBIT,thread) == NIL) {
 976                 if (arch_pseudo_atomic_atomic(context)) {
 977                     /* set things up so that GC happens when we finish
 978                      * the PA section */
 979                     SetSymbolValue(GC_PENDING,T,thread);
 980                     arch_set_pseudo_atomic_interrupted(context);
 981                 } else {
 982                     interrupt_maybe_gc_int(signal,info,void_context);
 983                 }
 984             } else {
 985                 SetSymbolValue(GC_PENDING,T,thread);
 986             }
 987         }
 988         return 1;
 989     }
 990     return 0;
 991 }
 992
 993 #endif
 994
 995 /* this is also used by gencgc, in alloc() */
 996 boolean
 997 interrupt_maybe_gc_int(int signal, siginfo_t *info, void *void_context)
 998 {
 999     os_context_t *context=(os_context_t *) void_context;
1000     struct thread *thread=arch_os_get_current_thread();
1001
1002     check_blockables_blocked_or_lose();
1003     fake_foreign_function_call(context);
1004
1005     /* SUB-GC may return without GCing if *GC-INHIBIT* is set, in
1006      * which case we will be running with no gc trigger barrier
1007      * thing for a while.  But it shouldn't be long until the end
1008      * of WITHOUT-GCING.
1009      *
1010      * FIXME: It would be good to protect the end of dynamic space
1011      * and signal a storage condition from there.
1012      */
1013
1014     /* Restore the signal mask from the interrupted context before
1015      * calling into Lisp if interrupts are enabled. Why not always?
1016      *
1017      * Suppose there is a WITHOUT-INTERRUPTS block far, far out. If an
1018      * interrupt hits while in SUB-GC, it is deferred and the
1019      * os_context_sigmask of that interrupt is set to block further
1020      * deferrable interrupts (until the first one is
1021      * handled). Unfortunately, that context refers to this place and
1022      * when we return from here the signals will not be blocked.
1023      *
1024      * A kludgy alternative is to propagate the sigmask change to the
1025      * outer context.
1026      */
1027     if(SymbolValue(INTERRUPTS_ENABLED,thread)!=NIL)
1028         thread_sigmask(SIG_SETMASK, os_context_sigmask_addr(context), 0);
1029 #ifdef LISP_FEATURE_SB_THREAD
1030     else {
1031         sigset_t new;
1032         sigaddset(&new,SIG_STOP_FOR_GC);
1033         thread_sigmask(SIG_UNBLOCK,&new,0);
1034     }
1035 #endif
1036     funcall0(SymbolFunction(SUB_GC));
1037
1038     undo_fake_foreign_function_call(context);
1039     return 1;
1040 }
1041
1042 \f
1043 /*
1044  * noise to install handlers
1045  */
1046
1047 void
1048 undoably_install_low_level_interrupt_handler (int signal,
1049                                               void handler(int,
1050                                                            siginfo_t*,
1051                                                            void*))
1052 {
1053     struct sigaction sa;
1054
1055     if (0 > signal || signal >= NSIG) {
1056         lose("bad signal number %d", signal);
1057     }
1058
1059     if (sigismember(&deferrable_sigset,signal))
1060         sa.sa_sigaction = low_level_maybe_now_maybe_later;
1061     else
1062         sa.sa_sigaction = handler;
1063
1064     sigemptyset(&sa.sa_mask);
1065     sigaddset_blockable(&sa.sa_mask);
1066     sa.sa_flags = SA_SIGINFO | SA_RESTART;
1067 #ifdef LISP_FEATURE_C_STACK_IS_CONTROL_STACK
1068     if((signal==SIG_MEMORY_FAULT)
1069 #ifdef SIG_INTERRUPT_THREAD
1070        || (signal==SIG_INTERRUPT_THREAD)
1071 #endif
1072        )
1073         sa.sa_flags|= SA_ONSTACK;
1074 #endif
1075
1076     sigaction(signal, &sa, NULL);
1077     interrupt_low_level_handlers[signal] =
1078         (ARE_SAME_HANDLER(handler, SIG_DFL) ? 0 : handler);
1079 }
1080
1081 /* This is called from Lisp. */
1082 unsigned long
1083 install_handler(int signal, void handler(int, siginfo_t*, void*))
1084 {
1085     struct sigaction sa;
1086     sigset_t old, new;
1087     union interrupt_handler oldhandler;
1088
1089     FSHOW((stderr, "/entering POSIX install_handler(%d, ..)\n", signal));
1090
1091     sigemptyset(&new);
1092     sigaddset(&new, signal);
1093     thread_sigmask(SIG_BLOCK, &new, &old);
1094
1095     FSHOW((stderr, "/interrupt_low_level_handlers[signal]=%x\n",
1096            (unsigned int)interrupt_low_level_handlers[signal]));
1097     if (interrupt_low_level_handlers[signal]==0) {
1098         if (ARE_SAME_HANDLER(handler, SIG_DFL) ||
1099             ARE_SAME_HANDLER(handler, SIG_IGN)) {
1100             sa.sa_sigaction = handler;
1101         } else if (sigismember(&deferrable_sigset, signal)) {
1102             sa.sa_sigaction = maybe_now_maybe_later;
1103         } else {
1104             sa.sa_sigaction = interrupt_handle_now_handler;
1105         }
1106
1107         sigemptyset(&sa.sa_mask);
1108         sigaddset_blockable(&sa.sa_mask);
1109         sa.sa_flags = SA_SIGINFO | SA_RESTART;
1110         sigaction(signal, &sa, NULL);
1111     }
1112
1113     oldhandler = interrupt_handlers[signal];
1114     interrupt_handlers[signal].c = handler;
1115
1116     thread_sigmask(SIG_SETMASK, &old, 0);
1117
1118     FSHOW((stderr, "/leaving POSIX install_handler(%d, ..)\n", signal));
1119
1120     return (unsigned long)oldhandler.lisp;
1121 }
1122
1123 void
1124 interrupt_init()
1125 {
1126     int i;
1127     SHOW("entering interrupt_init()");
1128     sigemptyset(&deferrable_sigset);
1129     sigemptyset(&blockable_sigset);
1130     sigaddset_deferrable(&deferrable_sigset);
1131     sigaddset_blockable(&blockable_sigset);
1132
1133     /* Set up high level handler information. */
1134     for (i = 0; i < NSIG; i++) {
1135         interrupt_handlers[i].c =
1136             /* (The cast here blasts away the distinction between
1137              * SA_SIGACTION-style three-argument handlers and
1138              * signal(..)-style one-argument handlers, which is OK
1139              * because it works to call the 1-argument form where the
1140              * 3-argument form is expected.) */
1141             (void (*)(int, siginfo_t*, void*))SIG_DFL;
1142     }
1143
1144     SHOW("returning from interrupt_init()");
1145 }