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 #include <stdio.h>
  17
  18 #include <signal.h>
  19 #ifdef mach /* KLUDGE: #ifdef on lowercase symbols? Ick. -- WHN 19990904 */
  20 #ifdef mips
  21 #include <mips/cpu.h>
  22 #endif
  23 #endif
  24
  25 #include "runtime.h"
  26 #include "arch.h"
  27 #include "sbcl.h"
  28 #include "os.h"
  29 #include "interrupt.h"
  30 #include "globals.h"
  31 #include "lispregs.h"
  32 #include "validate.h"
  33 #include "monitor.h"
  34 #include "gc.h"
  35 #include "alloc.h"
  36 #include "dynbind.h"
  37 #include "interr.h"
  38
  39 void sigaddset_blockable(sigset_t *s)
  40 {
  41     sigaddset(s, SIGHUP);
  42     sigaddset(s, SIGINT);
  43     sigaddset(s, SIGQUIT);
  44     sigaddset(s, SIGPIPE);
  45     sigaddset(s, SIGALRM);
  46     sigaddset(s, SIGURG);
  47     sigaddset(s, SIGTSTP);
  48     sigaddset(s, SIGCHLD);
  49     sigaddset(s, SIGIO);
  50     sigaddset(s, SIGXCPU);
  51     sigaddset(s, SIGXFSZ);
  52     sigaddset(s, SIGVTALRM);
  53     sigaddset(s, SIGPROF);
  54     sigaddset(s, SIGWINCH);
  55     sigaddset(s, SIGUSR1);
  56     sigaddset(s, SIGUSR2);
  57 }
  58
  59 /* When we catch an internal error, should we pass it back to Lisp to
  60  * be handled in a high-level way? (Early in cold init, the answer is
  61  * 'no', because Lisp is still too brain-dead to handle anything.
  62  * After sufficient initialization has been completed, the answer
  63  * becomes 'yes'.) */
  64 boolean internal_errors_enabled = 0;
  65
  66 os_context_t *lisp_interrupt_contexts[MAX_INTERRUPTS];
  67
  68 /* As far as I can tell, what's going on here is:
  69  *
  70  * In the case of most signals, when Lisp asks us to handle the
  71  * signal, the outermost handler (the one actually passed to UNIX) is
  72  * either interrupt_handle_now(..) or interrupt_handle_later(..).
  73  * In that case, the Lisp-level handler is stored in interrupt_handlers[..]
  74  * and interrupt_low_level_handlers[..] is cleared.
  75  *
  76  * However, some signals need special handling, e.g.
  77  *
  78  * o the SIGSEGV (for Linux) or SIGBUS (for FreeBSD) used by the
  79  *   garbage collector to detect violations of write protection,
  80  *   because some cases of such signals (e.g. GC-related violations of
  81  *   write protection) are handled at C level and never passed on to
  82  *   Lisp. For such signals, we still store any Lisp-level handler
  83  *   in interrupt_handlers[..], but for the outermost handle we use
  84  *   the value from interrupt_low_level_handlers[..], instead of the
  85  *   ordinary interrupt_handle_now(..) or interrupt_handle_later(..).
  86  *
  87  * o the SIGTRAP (Linux/Alpha) which Lisp code uses to handle breakpoints,
  88  *   pseudo-atomic sections, and some classes of error (e.g. "function
  89  *   not defined").  This never goes anywhere near the Lisp handlers at all.
  90  *   See runtime/alpha-arch.c and code/signal.lisp
  91  *
  92  * - WHN 20000728, dan 20010128 */
  93
  94
  95 void (*interrupt_low_level_handlers[NSIG]) (int, siginfo_t*, void*) = {0};
  96 union interrupt_handler interrupt_handlers[NSIG];
  97
  98 /* signal number, siginfo_t, and old mask information for pending signal
  99  *
 100  * pending_signal=0 when there is no pending signal. */
 101 static int pending_signal = 0;
 102 static siginfo_t pending_info;
 103 static sigset_t pending_mask;
 104
 105 static boolean maybe_gc_pending = 0;
 106 \f
 107 /*
 108  * utility routines used by various signal handlers
 109  */
 110
 111 void
 112 fake_foreign_function_call(os_context_t *context)
 113 {
 114     int context_index;
 115 #ifndef __i386__
 116     lispobj oldcont;
 117 #endif
 118
 119     /* Get current Lisp state from context. */
 120 #ifdef reg_ALLOC
 121     dynamic_space_free_pointer =
 122         (lispobj *)(*os_context_register_addr(context, reg_ALLOC));
 123 #ifdef alpha
 124     if ((long)dynamic_space_free_pointer & 1) {
 125         lose("dead in fake_foreign_function_call, context = %x", context);
 126     }
 127 #endif
 128 #endif
 129 #ifdef reg_BSP
 130     current_binding_stack_pointer =
 131         (lispobj *)(*os_context_register_addr(context, reg_BSP));
 132 #endif
 133
 134 #ifndef __i386__
 135     /* Build a fake stack frame. */
 136     current_control_frame_pointer =
 137         (lispobj *)(*os_context_register_addr(context, reg_CSP));
 138     if ((lispobj *)(*os_context_register_addr(context, reg_CFP))
 139         == current_control_frame_pointer) {
 140         /* There is a small window during call where the callee's
 141          * frame isn't built yet. */
 142         if (LowtagOf(*os_context_register_addr(context, reg_CODE))
 143             == type_FunctionPointer) {
 144             /* We have called, but not built the new frame, so
 145              * build it for them. */
 146             current_control_frame_pointer[0] =
 147                 *os_context_register_addr(context, reg_OCFP);
 148             current_control_frame_pointer[1] =
 149                 *os_context_register_addr(context, reg_LRA);
 150             current_control_frame_pointer += 8;
 151             /* Build our frame on top of it. */
 152             oldcont = (lispobj)(*os_context_register_addr(context, reg_CFP));
 153         }
 154         else {
 155             /* We haven't yet called, build our frame as if the
 156              * partial frame wasn't there. */
 157             oldcont = (lispobj)(*os_context_register_addr(context, reg_OCFP));
 158         }
 159     }
 160     /* ### We can't tell whether we are still in the caller if it had
 161      * to reg_ALLOCate the stack frame due to stack arguments. */
 162     /* ### Can anything strange happen during return? */
 163     else {
 164         /* normal case */
 165         oldcont = (lispobj)(*os_context_register_addr(context, reg_CFP));
 166     }
 167
 168     current_control_stack_pointer = current_control_frame_pointer + 8;
 169
 170     current_control_frame_pointer[0] = oldcont;
 171     current_control_frame_pointer[1] = NIL;
 172     current_control_frame_pointer[2] =
 173         (lispobj)(*os_context_register_addr(context, reg_CODE));
 174 #endif
 175
 176     /* Do dynamic binding of the active interrupt context index
 177      * and save the context in the context array. */
 178     context_index = SymbolValue(FREE_INTERRUPT_CONTEXT_INDEX)>>2;
 179     /* FIXME: Ick! Why use abstract "make_fixnum" in some places if
 180      * you're going to convert from fixnum by bare >>2 in other
 181      * places? Use fixnum_value(..) here, and look for other places
 182      * which do bare >> and << for fixnum_value and make_fixnum. */
 183
 184     if (context_index >= MAX_INTERRUPTS) {
 185         lose("maximum interrupt nesting depth (%d) exceeded",
 186              MAX_INTERRUPTS);
 187     }
 188
 189     bind_variable(FREE_INTERRUPT_CONTEXT_INDEX,
 190                   make_fixnum(context_index + 1));
 191
 192     lisp_interrupt_contexts[context_index] = context;
 193
 194     /* no longer in Lisp now */
 195     foreign_function_call_active = 1;
 196 }
 197
 198 void
 199 undo_fake_foreign_function_call(os_context_t *context)
 200 {
 201     /* Block all blockable signals. */
 202     sigset_t block;
 203     sigemptyset(&block);
 204     sigaddset_blockable(&block);
 205     sigprocmask(SIG_BLOCK, &block, 0);
 206
 207     /* going back into Lisp */
 208     foreign_function_call_active = 0;
 209
 210     /* Undo dynamic binding. */
 211     /* ### Do I really need to unbind_to_here()? */
 212     /* FIXME: Is this to undo the binding of
 213      * FREE_INTERRUPT_CONTEXT_INDEX? If so, we should say so. And
 214      * perhaps yes, unbind_to_here() really would be clearer and less
 215      * fragile.. */
 216     unbind();
 217
 218 #ifdef reg_ALLOC
 219     /* Put the dynamic space free pointer back into the context. */
 220     *os_context_register_addr(context, reg_ALLOC) =
 221         (unsigned long) dynamic_space_free_pointer;
 222 #endif
 223 }
 224
 225 /* a handler for the signal caused by execution of a trap opcode
 226  * signalling an internal error */
 227 void
 228 interrupt_internal_error(int signal, siginfo_t *info, os_context_t *context,
 229                          boolean continuable)
 230 {
 231     lispobj context_sap = 0;
 232
 233     fake_foreign_function_call(context);
 234
 235     /* Allocate the SAP object while the interrupts are still
 236      * disabled. */
 237     if (internal_errors_enabled) {
 238         context_sap = alloc_sap(context);
 239     }
 240
 241     sigprocmask(SIG_SETMASK, os_context_sigmask_addr(context), 0);
 242
 243     if (internal_errors_enabled) {
 244         SHOW("in interrupt_internal_error");
 245 #if QSHOW
 246         /* Display some rudimentary debugging information about the
 247          * error, so that even if the Lisp error handler gets badly
 248          * confused, we have a chance to determine what's going on. */
 249         describe_internal_error(context);
 250 #endif
 251         funcall2(SymbolFunction(INTERNAL_ERROR), context_sap,
 252                  continuable ? T : NIL);
 253     } else {
 254         describe_internal_error(context);
 255         /* There's no good way to recover from an internal error
 256          * before the Lisp error handling mechanism is set up. */
 257         lose("internal error too early in init, can't recover");
 258     }
 259     undo_fake_foreign_function_call(context);
 260     if (continuable) {
 261         arch_skip_instruction(context);
 262     }
 263 }
 264
 265 /* This function handles pending interrupts.  Note that in C/kernel
 266  * terms we dealt with the signal already; we just haven't decided
 267  * whether to call a Lisp handler or do a GC or something like that.
 268  * If it helps, you can think of pending_{signal,mask,info} as a
 269  * one-element queue of signals that we have acknowledged but not
 270  * processed */
 271
 272 void
 273 interrupt_handle_pending(os_context_t *context)
 274 {
 275 #ifndef __i386__
 276     boolean were_in_lisp = !foreign_function_call_active;
 277 #endif
 278
 279     SetSymbolValue(INTERRUPT_PENDING, NIL);
 280
 281     if (maybe_gc_pending) {
 282         maybe_gc_pending = 0;
 283 #ifndef __i386__
 284         if (were_in_lisp)
 285 #endif
 286         {
 287             fake_foreign_function_call(context);
 288         }
 289         funcall0(SymbolFunction(MAYBE_GC));
 290 #ifndef __i386__
 291         if (were_in_lisp)
 292 #endif
 293         {
 294             undo_fake_foreign_function_call(context);
 295         }
 296     }
 297
 298     /* FIXME: This isn't very clear. It would be good to reverse
 299      * engineer it and rewrite the code more clearly, or write a clear
 300      * explanation of what's going on in the comments, or both.
 301      *
 302      * WHN's question 1a: How come we unconditionally copy from
 303      * pending_mask into the context, and then test whether
 304      * pending_signal is set?
 305      *
 306      * WHN's question 1b: If pending_signal wasn't set, how could
 307      * pending_mask be valid?
 308      *
 309      * Dan Barlow's reply (sbcl-devel 2001-03-13): And the answer is -
 310      * or appears to be - because interrupt_maybe_gc set it that way
 311      * (look in the #ifndef __i386__ bit). We can't GC during a
 312      * pseudo-atomic, so we set maybe_gc_pending=1 and
 313      * arch_set_pseudo_atomic_interrupted(..) When we come out of
 314      * pseudo_atomic we're marked as interrupted, so we call
 315      * interrupt_handle_pending, which does the GC using the pending
 316      * context (it needs a context so that it has registers to use as
 317      * GC roots) then notices there's no actual interrupt handler to
 318      * call, so doesn't. That's the second question [1b] answered,
 319      * anyway. Why we still need to copy the pending_mask into the
 320      * context given that we're now done with the context anyway, I
 321      * couldn't say. */
 322     memcpy(os_context_sigmask_addr(context), &pending_mask, sizeof(sigset_t));
 323     sigemptyset(&pending_mask);
 324     if (pending_signal) {
 325         int signal = pending_signal;
 326         siginfo_t info;
 327         memcpy(&info, &pending_info, sizeof(siginfo_t));
 328         pending_signal = 0;
 329         interrupt_handle_now(signal, &info, context);
 330     }
 331 }
 332 \f
 333 /*
 334  * the two main signal handlers:
 335  *   interrupt_handle_now(..)
 336  *   maybe_now_maybe_later(..)
 337  */
 338
 339 void
 340 interrupt_handle_now(int signal, siginfo_t *info, void *void_context)
 341 {
 342     os_context_t *context = (os_context_t*)void_context;
 343 #ifndef __i386__
 344     boolean were_in_lisp;
 345 #endif
 346     union interrupt_handler handler;
 347
 348     /* FIXME: The CMU CL we forked off of had this Linux-only
 349      * operation here. Newer CMU CLs (e.g. 18c) have hairier
 350      * Linux/i386-only logic here. SBCL seems to be more reliable
 351      * without anything here. However, if we start supporting code
 352      * which sets the rounding mode, then we may want to do something
 353      * special to force the rounding mode back to some standard value
 354      * here, so that ISRs can have a standard environment. (OTOH, if
 355      * rounding modes are under user control, then perhaps we should
 356      * leave this up to the user.)
 357      *
 358      * In the absence of a test case to show that this is really a
 359      * problem, we just suppress this code completely (just like the
 360      * parallel code in maybe_now_maybe_later).
 361      * #ifdef __linux__
 362      *    SET_FPU_CONTROL_WORD(context->__fpregs_mem.cw);
 363      * #endif */
 364
 365     handler = interrupt_handlers[signal];
 366
 367     if (ARE_SAME_HANDLER(handler.c, SIG_IGN)) {
 368         return;
 369     }
 370
 371 #ifndef __i386__
 372     were_in_lisp = !foreign_function_call_active;
 373     if (were_in_lisp)
 374 #endif
 375     {
 376         fake_foreign_function_call(context);
 377     }
 378
 379 #ifdef QSHOW_SIGNALS
 380     FSHOW((stderr, "in interrupt_handle_now(%d, info, context)\n", signal));
 381 #endif
 382
 383     if (ARE_SAME_HANDLER(handler.c, SIG_DFL)) {
 384
 385         /* This can happen if someone tries to ignore or default one
 386          * of the signals we need for runtime support, and the runtime
 387          * support decides to pass on it. */
 388         lose("no handler for signal %d in interrupt_handle_now(..)", signal);
 389
 390     } else if (LowtagOf(handler.lisp) == type_FunctionPointer) {
 391
 392         /* Allocate the SAPs while the interrupts are still disabled.
 393          * (FIXME: Why? This is the way it was done in CMU CL, and it
 394          * even had the comment noting that this is the way it was
 395          * done, but no motivation..) */
 396         lispobj info_sap,context_sap = alloc_sap(context);
 397         info_sap = alloc_sap(info);
 398         /* Allow signals again. */
 399         sigprocmask(SIG_SETMASK, os_context_sigmask_addr(context), 0);
 400
 401 #ifdef QSHOW_SIGNALS
 402         SHOW("calling Lisp-level handler");
 403 #endif
 404
 405         funcall3(handler.lisp,
 406                  make_fixnum(signal),
 407                  info_sap,
 408                  context_sap);
 409     } else {
 410
 411 #ifdef QSHOW_SIGNALS
 412         SHOW("calling C-level handler");
 413 #endif
 414
 415         /* Allow signals again. */
 416         sigprocmask(SIG_SETMASK, os_context_sigmask_addr(context), 0);
 417
 418         (*handler.c)(signal, info, void_context);
 419     }
 420
 421 #ifndef __i386__
 422     if (were_in_lisp)
 423 #endif
 424     {
 425         undo_fake_foreign_function_call(context);
 426     }
 427 }
 428
 429 static void
 430 maybe_now_maybe_later(int signal, siginfo_t *info, void *void_context)
 431 {
 432     os_context_t *context = (os_context_t*)void_context;
 433
 434     /* FIXME: See Debian cmucl 2.4.17, and mail from DTC on the CMU CL
 435      * mailing list 23 Oct 1999, for changes in FPU handling at
 436      * interrupt time which should be ported into SBCL. Also see the
 437      * analogous logic at the head of interrupt_handle_now for
 438      * more related FIXME stuff.
 439      *
 440      * For now, we just suppress this code completely.
 441      * #ifdef __linux__
 442      *    SET_FPU_CONTROL_WORD(context->__fpregs_mem.cw);
 443      * #endif */
 444
 445     /* see comments at top of code/signal.lisp for what's going on here
 446      * with INTERRUPTS_ENABLED/INTERRUPT_HANDLE_NOW
 447      */
 448     if (SymbolValue(INTERRUPTS_ENABLED) == NIL) {
 449
 450         /* FIXME: This code is exactly the same as the code in the
 451          * other leg of the if(..), and should be factored out into
 452          * a shared function. */
 453         pending_signal = signal;
 454         memcpy(&pending_info, info, sizeof(siginfo_t));
 455         memcpy(&pending_mask,
 456                os_context_sigmask_addr(context),
 457                sizeof(sigset_t));
 458         sigaddset_blockable(os_context_sigmask_addr(context));
 459         SetSymbolValue(INTERRUPT_PENDING, T);
 460
 461     } else if (
 462 #ifndef __i386__
 463                (!foreign_function_call_active) &&
 464 #endif
 465                arch_pseudo_atomic_atomic(context)) {
 466
 467         /* FIXME: It would probably be good to replace these bare
 468          * memcpy(..) calls with calls to cpy_siginfo_t and
 469          * cpy_sigset_t, so that we only have to get the sizeof
 470          * expressions right in one place, and after that static type
 471          * checking takes over. */
 472         pending_signal = signal;
 473         memcpy(&pending_info, info, sizeof(siginfo_t));
 474         memcpy(&pending_mask,
 475                os_context_sigmask_addr(context),
 476                sizeof(sigset_t));
 477         sigaddset_blockable(os_context_sigmask_addr(context));
 478
 479         arch_set_pseudo_atomic_interrupted(context);
 480
 481     } else {
 482         interrupt_handle_now(signal, info, context);
 483     }
 484 }
 485 \f
 486 /*
 487  * stuff to detect and handle hitting the GC trigger
 488  */
 489
 490 #ifndef INTERNAL_GC_TRIGGER
 491 static boolean
 492 gc_trigger_hit(int signal, siginfo_t *info, os_context_t *context)
 493 {
 494     if (current_auto_gc_trigger == NULL)
 495         return 0;
 496     else{
 497         lispobj *badaddr=(lispobj *)arch_get_bad_addr(signal,
 498                                                       info,
 499                                                       context);
 500
 501         return (badaddr >= current_auto_gc_trigger &&
 502                 badaddr < current_dynamic_space + DYNAMIC_SPACE_SIZE);
 503     }
 504 }
 505 #endif
 506
 507 #ifndef __i386__
 508 /* This function gets called from the SIGSEGV (Linux) or SIGBUS (BSD)
 509  * handler.  Here we check whether the signal was due to treading on
 510  * the mprotect()ed zone - and if so, arrange for a GC to happen.
 511  */
 512 boolean
 513 interrupt_maybe_gc(int signal, siginfo_t *info, void *void_context)
 514 {
 515     os_context_t *context=(os_context_t *) void_context;
 516
 517     if (!foreign_function_call_active
 518 #ifndef INTERNAL_GC_TRIGGER
 519         && gc_trigger_hit(signal, info, context)
 520 #endif
 521         ) {
 522 #ifndef INTERNAL_GC_TRIGGER
 523         clear_auto_gc_trigger();
 524 #endif
 525
 526         if (arch_pseudo_atomic_atomic(context)) {
 527             /* don't GC during an atomic operation.  Instead, copy the
 528              * signal mask somewhere safe.  interrupt_handle_pending
 529              * will detect pending_signal==0 and know to do a GC with the
 530              * signal context instead of calling a Lisp-level handler */
 531             maybe_gc_pending = 1;
 532             if (pending_signal == 0) {
 533                 /* FIXME: This copy-pending_mask-then-sigaddset_blockable
 534                  * idiom occurs over and over. It should be factored out
 535                  * into a function with a descriptive name. */
 536                 memcpy(&pending_mask,
 537                        os_context_sigmask_addr(context),
 538                        sizeof(sigset_t));
 539                 sigaddset_blockable(os_context_sigmask_addr(context));
 540             }
 541             arch_set_pseudo_atomic_interrupted(context);
 542         }
 543         else {
 544             fake_foreign_function_call(context);
 545             funcall0(SymbolFunction(MAYBE_GC));
 546             undo_fake_foreign_function_call(context);
 547         }
 548
 549         return 1;
 550     } else {
 551         return 0;
 552     }
 553 }
 554 #endif
 555 \f
 556 /*
 557  * noise to install handlers
 558  */
 559
 560 /* Install a special low-level handler for signal; or if handler is
 561  * SIG_DFL, remove any special handling for signal. */
 562 void
 563 interrupt_install_low_level_handler (int signal,
 564                                      void handler(int, siginfo_t*, void*))
 565 {
 566     struct sigaction sa;
 567
 568     sa.sa_sigaction = handler;
 569     sigemptyset(&sa.sa_mask);
 570     sigaddset_blockable(&sa.sa_mask);
 571     sa.sa_flags = SA_SIGINFO | SA_RESTART;
 572
 573     sigaction(signal, &sa, NULL);
 574     interrupt_low_level_handlers[signal] =
 575         (ARE_SAME_HANDLER(handler,SIG_DFL) ? 0 : handler);
 576 }
 577
 578 /* This is called from Lisp. */
 579 unsigned long
 580 install_handler(int signal, void handler(int, siginfo_t*, void*))
 581 {
 582     struct sigaction sa;
 583     sigset_t old, new;
 584     union interrupt_handler oldhandler;
 585
 586     FSHOW((stderr, "entering POSIX install_handler(%d, ..)\n", signal));
 587
 588     sigemptyset(&new);
 589     sigaddset(&new, signal);
 590     sigprocmask(SIG_BLOCK, &new, &old);
 591
 592     sigemptyset(&new);
 593     sigaddset_blockable(&new);
 594
 595     FSHOW((stderr, "interrupt_low_level_handlers[signal]=%d\n",
 596            interrupt_low_level_handlers[signal]));
 597     if (interrupt_low_level_handlers[signal]==0) {
 598         if (ARE_SAME_HANDLER(handler, SIG_DFL) ||
 599             ARE_SAME_HANDLER(handler, SIG_IGN)) {
 600             sa.sa_sigaction = handler;
 601         } else if (sigismember(&new, signal)) {
 602             sa.sa_sigaction = maybe_now_maybe_later;
 603         } else {
 604             sa.sa_sigaction = interrupt_handle_now;
 605         }
 606
 607         sigemptyset(&sa.sa_mask);
 608         sigaddset_blockable(&sa.sa_mask);
 609         sa.sa_flags = SA_SIGINFO | SA_RESTART;
 610
 611         sigaction(signal, &sa, NULL);
 612     }
 613
 614     oldhandler = interrupt_handlers[signal];
 615     interrupt_handlers[signal].c = handler;
 616
 617     sigprocmask(SIG_SETMASK, &old, 0);
 618
 619     FSHOW((stderr, "leaving POSIX install_handler(%d, ..)\n", signal));
 620
 621     return (unsigned long)oldhandler.lisp;
 622 }
 623
 624 void
 625 interrupt_init(void)
 626 {
 627     int i;
 628
 629     for (i = 0; i < NSIG; i++) {
 630         interrupt_handlers[i].c =
 631             /* (The cast here blasts away the distinction between
 632              * SA_SIGACTION-style three-argument handlers and
 633              * signal(..)-style one-argument handlers, which is OK
 634              * because it works to call the 1-argument form where the
 635              * 3-argument form is expected.) */
 636             (void (*)(int, siginfo_t*, void*))SIG_DFL;
 637     }
 638 }