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. the SIGSEGV (for
  77  * Linux) or SIGBUS (for FreeBSD) used by the garbage collector to
  78  * detect violations of write protection, because some cases of such
  79  * signals (e.g. GC-related violations of write protection) are
  80  * handled at C level and never passed on to Lisp. For such signals,
  81  * we still store any Lisp-level handler in interrupt_handlers[..],
  82  * but for the outermost handle we use the value from
  83  * interrupt_low_level_handlers[..], instead of the ordinary
  84  * interrupt_handle_now(..) or interrupt_handle_later(..).
  85  *
  86  * -- WHN 20000728 */
  87 void (*interrupt_low_level_handlers[NSIG]) (int, siginfo_t*, void*) = {0};
  88 union interrupt_handler interrupt_handlers[NSIG];
  89
  90 /* signal number, siginfo_t, and old mask information for pending signal
  91  *
  92  * pending_signal=0 when there is no pending signal. */
  93 static int pending_signal = 0;
  94 static siginfo_t pending_info;
  95 static sigset_t pending_mask;
  96
  97 static boolean maybe_gc_pending = 0;
  98 \f
  99 /*
 100  * utility routines used by various signal handlers
 101  */
 102
 103 void
 104 fake_foreign_function_call(os_context_t *context)
 105 {
 106     int context_index;
 107 #ifndef __i386__
 108     lispobj oldcont;
 109 #endif
 110
 111     /* Get current Lisp state from context. */
 112 #ifdef reg_ALLOC
 113     dynamic_space_free_pointer =
 114         (lispobj *)(*os_context_register_addr(context, reg_ALLOC));
 115 #ifdef alpha
 116     if ((long)dynamic_space_free_pointer & 1) {
 117         lose("dead in fake_foreign_function_call, context = %x", context);
 118     }
 119 #endif
 120 #endif
 121 #ifdef reg_BSP
 122     current_binding_stack_pointer =
 123         (lispobj *)(*os_context_register_addr(context, reg_BSP));
 124 #endif
 125
 126 #ifndef __i386__
 127     /* Build a fake stack frame. */
 128     current_control_frame_pointer =
 129         (lispobj *)(*os_context_register_addr(context, reg_CSP));
 130     if ((lispobj *)(*os_context_register_addr(context, reg_CFP))
 131         == current_control_frame_pointer) {
 132         /* There is a small window during call where the callee's
 133          * frame isn't built yet. */
 134         if (LowtagOf(*os_context_register_addr(context, reg_CODE))
 135             == type_FunctionPointer) {
 136             /* We have called, but not built the new frame, so
 137              * build it for them. */
 138             current_control_frame_pointer[0] =
 139                 *os_context_register_addr(context, reg_OCFP);
 140             current_control_frame_pointer[1] =
 141                 *os_context_register_addr(context, reg_LRA);
 142             current_control_frame_pointer += 8;
 143             /* Build our frame on top of it. */
 144             oldcont = (lispobj)(*os_context_register_addr(context, reg_CFP));
 145         }
 146         else {
 147             /* We haven't yet called, build our frame as if the
 148              * partial frame wasn't there. */
 149             oldcont = (lispobj)(*os_context_register_addr(context, reg_OCFP));
 150         }
 151     }
 152     /* ### We can't tell whether we are still in the caller if it had
 153      * to reg_ALLOCate the stack frame due to stack arguments. */
 154     /* ### Can anything strange happen during return? */
 155     else {
 156         /* normal case */
 157         oldcont = (lispobj)(*os_context_register_addr(context, reg_CFP));
 158     }
 159
 160     current_control_stack_pointer = current_control_frame_pointer + 8;
 161
 162     current_control_frame_pointer[0] = oldcont;
 163     current_control_frame_pointer[1] = NIL;
 164     current_control_frame_pointer[2] =
 165         (lispobj)(*os_context_register_addr(context, reg_CODE));
 166 #endif
 167
 168     /* Do dynamic binding of the active interrupt context index
 169      * and save the context in the context array. */
 170     context_index = SymbolValue(FREE_INTERRUPT_CONTEXT_INDEX)>>2;
 171     /* FIXME: Ick! Why use abstract "make_fixnum" in some places if
 172      * you're going to convert from fixnum by bare >>2 in other
 173      * places? Use fixnum_value(..) here, and look for other places
 174      * which do bare >> and << for fixnum_value and make_fixnum. */
 175
 176     if (context_index >= MAX_INTERRUPTS) {
 177         lose("maximum interrupt nesting depth (%d) exceeded",
 178              MAX_INTERRUPTS);
 179     }
 180
 181     bind_variable(FREE_INTERRUPT_CONTEXT_INDEX,
 182                   make_fixnum(context_index + 1));
 183
 184     lisp_interrupt_contexts[context_index] = context;
 185
 186     /* no longer in Lisp now */
 187     foreign_function_call_active = 1;
 188 }
 189
 190 void
 191 undo_fake_foreign_function_call(os_context_t *context)
 192 {
 193     /* Block all blockable signals. */
 194     sigset_t block;
 195     sigemptyset(&block);
 196     sigaddset_blockable(&block);
 197     sigprocmask(SIG_BLOCK, &block, 0);
 198
 199     /* going back into Lisp */
 200     foreign_function_call_active = 0;
 201
 202     /* Undo dynamic binding. */
 203     /* ### Do I really need to unbind_to_here()? */
 204     /* FIXME: Is this to undo the binding of
 205      * FREE_INTERRUPT_CONTEXT_INDEX? If so, we should say so. And
 206      * perhaps yes, unbind_to_here() really would be clearer and less
 207      * fragile.. */
 208     unbind();
 209
 210 #ifdef reg_ALLOC
 211     /* Put the dynamic space free pointer back into the context. */
 212     *os_context_register_addr(context, reg_ALLOC) =
 213         (unsigned long) dynamic_space_free_pointer;
 214 #endif
 215 }
 216
 217 /* a handler for the signal caused by execution of a trap opcode
 218  * signalling an internal error */
 219 void
 220 interrupt_internal_error(int signal, siginfo_t *info, os_context_t *context,
 221                          boolean continuable)
 222 {
 223     lispobj context_sap;
 224
 225     fake_foreign_function_call(context);
 226
 227     /* Allocate the SAP object while the interrupts are still
 228      * disabled. */
 229     if (internal_errors_enabled) {
 230         context_sap = alloc_sap(context);
 231     }
 232
 233     sigprocmask(SIG_SETMASK, os_context_sigmask_addr(context), 0);
 234
 235     if (internal_errors_enabled) {
 236         SHOW("in interrupt_internal_error");
 237 #if QSHOW
 238         /* Display some rudimentary debugging information about the
 239          * error, so that even if the Lisp error handler gets badly
 240          * confused, we have a chance to determine what's going on. */
 241         describe_internal_error(context);
 242 #endif
 243         funcall2(SymbolFunction(INTERNAL_ERROR), context_sap,
 244                  continuable ? T : NIL);
 245     } else {
 246         describe_internal_error(context);
 247         /* There's no good way to recover from an internal error
 248          * before the Lisp error handling mechanism is set up. */
 249         lose("internal error too early in init, can't recover");
 250     }
 251     undo_fake_foreign_function_call(context);
 252     if (continuable) {
 253         arch_skip_instruction(context);
 254     }
 255 }
 256
 257 void
 258 interrupt_handle_pending(os_context_t *context)
 259 {
 260     boolean were_in_lisp = !foreign_function_call_active;
 261
 262     SetSymbolValue(INTERRUPT_PENDING, NIL);
 263
 264     if (maybe_gc_pending) {
 265         maybe_gc_pending = 0;
 266 #ifndef __i386__
 267         if (were_in_lisp)
 268 #endif
 269         {
 270             fake_foreign_function_call(context);
 271         }
 272         funcall0(SymbolFunction(MAYBE_GC));
 273 #ifndef __i386__
 274         if (were_in_lisp)
 275 #endif
 276         {
 277             undo_fake_foreign_function_call(context);
 278         }
 279     }
 280
 281     /* FIXME: How come we unconditionally copy from pending_mask into
 282      * the context, and then test whether pending_signal is set? If
 283      * pending_signal wasn't set, how could pending_mask be valid? */
 284     memcpy(os_context_sigmask_addr(context), &pending_mask, sizeof(sigset_t));
 285     sigemptyset(&pending_mask);
 286     if (pending_signal) {
 287         int signal = pending_signal;
 288         siginfo_t info;
 289         memcpy(&info, &pending_info, sizeof(siginfo_t));
 290         pending_signal = 0;
 291         interrupt_handle_now(signal, &info, context);
 292     }
 293 }
 294 \f
 295 /*
 296  * the two main signal handlers:
 297  *   interrupt_handle_now(..)
 298  *   maybe_now_maybe_later(..)
 299  */
 300
 301 void
 302 interrupt_handle_now(int signal, siginfo_t *info, void *void_context)
 303 {
 304     os_context_t *context = (os_context_t*)void_context;
 305     int were_in_lisp;
 306     union interrupt_handler handler;
 307
 308 #ifdef __linux__
 309     SET_FPU_CONTROL_WORD(context->__fpregs_mem.cw);
 310 #endif
 311
 312     handler = interrupt_handlers[signal];
 313
 314     if (ARE_SAME_HANDLER(handler.c, SIG_IGN)) {
 315         return;
 316     }
 317
 318     were_in_lisp = !foreign_function_call_active;
 319 #ifndef __i386__
 320     if (were_in_lisp)
 321 #endif
 322     {
 323         fake_foreign_function_call(context);
 324     }
 325
 326 #ifdef QSHOW_SIGNALS
 327     FSHOW((stderr, "in interrupt_handle_now(%d, info, context)\n", signal));
 328 #endif
 329
 330     if (ARE_SAME_HANDLER(handler.c, SIG_DFL)) {
 331
 332         /* This can happen if someone tries to ignore or default one
 333          * of the signals we need for runtime support, and the runtime
 334          * support decides to pass on it. */
 335         lose("no handler for signal %d in interrupt_handle_now(..)", signal);
 336
 337     } else if (LowtagOf(handler.lisp) == type_FunctionPointer) {
 338
 339         /* Allocate the SAPs while the interrupts are still disabled.
 340          * (FIXME: Why? This is the way it was done in CMU CL, and it
 341          * even had the comment noting that this is the way it was
 342          * done, but no motivation..) */
 343         lispobj context_sap = alloc_sap(context);
 344         lispobj info_sap = alloc_sap(info);
 345
 346         /* Allow signals again. */
 347         sigprocmask(SIG_SETMASK, os_context_sigmask_addr(context), 0);
 348
 349 #ifdef QSHOW_SIGNALS
 350         SHOW("calling Lisp-level handler");
 351 #endif
 352
 353         funcall3(handler.lisp,
 354                  make_fixnum(signal),
 355                  info_sap,
 356                  context_sap);
 357     } else {
 358
 359 #ifdef QSHOW_SIGNALS
 360         SHOW("calling C-level handler");
 361 #endif
 362
 363         /* Allow signals again. */
 364         sigprocmask(SIG_SETMASK, os_context_sigmask_addr(context), 0);
 365
 366         (*handler.c)(signal, info, void_context);
 367     }
 368
 369 #ifndef __i386__
 370     if (were_in_lisp)
 371 #endif
 372     {
 373         undo_fake_foreign_function_call(context);
 374     }
 375 }
 376
 377 static void
 378 maybe_now_maybe_later(int signal, siginfo_t *info, void *void_context)
 379 {
 380     os_context_t *context = (os_context_t*)void_context;
 381
 382     /* FIXME: See Debian cmucl 2.4.17, and mail from DTC on the CMU CL
 383      * mailing list 23 Oct 1999, for changes in FPU handling at
 384      * interrupt time which should be ported into SBCL.
 385      *
 386      * (Is this related to the way that it seems that if we do decide
 387      * to handle the interrupt later, we've now screwed up the FPU
 388      * control word?) */
 389 #ifdef __linux__
 390     SET_FPU_CONTROL_WORD(context->__fpregs_mem.cw);
 391 #endif
 392
 393     if (SymbolValue(INTERRUPTS_ENABLED) == NIL) {
 394
 395         /* FIXME: This code is exactly the same as the code in the
 396          * other leg of the if(..), and should be factored out into
 397          * a shared function. */
 398         pending_signal = signal;
 399         memcpy(&pending_info, info, sizeof(siginfo_t));
 400         memcpy(&pending_mask,
 401                os_context_sigmask_addr(context),
 402                sizeof(sigset_t));
 403         sigaddset_blockable(os_context_sigmask_addr(context));
 404
 405         SetSymbolValue(INTERRUPT_PENDING, T);
 406
 407     } else if (
 408 #ifndef __i386__
 409                (!foreign_function_call_active) &&
 410 #endif
 411                arch_pseudo_atomic_atomic(context)) {
 412
 413         /* FIXME: It would probably be good to replace these bare
 414          * memcpy(..) calls with calls to cpy_siginfo_t and
 415          * cpy_sigset_t, so that we only have to get the sizeof
 416          * expressions right in one place, and after that static type
 417          * checking takes over. */
 418         pending_signal = signal;
 419         memcpy(&pending_info, info, sizeof(siginfo_t));
 420         memcpy(&pending_mask,
 421                os_context_sigmask_addr(context),
 422                sizeof(sigset_t));
 423         sigaddset_blockable(os_context_sigmask_addr(context));
 424
 425         arch_set_pseudo_atomic_interrupted(context);
 426
 427     } else {
 428         interrupt_handle_now(signal, info, context);
 429     }
 430 }
 431 \f
 432 /*
 433  * stuff to detect and handle hitting the GC trigger
 434  */
 435
 436 #ifndef INTERNAL_GC_TRIGGER
 437 static boolean
 438 gc_trigger_hit(int signal, siginfo_t *info, os_context_t *context)
 439 {
 440     if (current_auto_gc_trigger == NULL)
 441         return 0;
 442     else{
 443         lispobj *badaddr=(lispobj *)arch_get_bad_addr(signal,
 444                                                       info,
 445                                                       context);
 446
 447         return (badaddr >= current_auto_gc_trigger &&
 448                 badaddr < DYNAMIC_SPACE_START + DYNAMIC_SPACE_SIZE);
 449     }
 450 }
 451 #endif
 452
 453 #ifndef __i386__
 454 boolean
 455 interrupt_maybe_gc(int signal, siginfo_t *info, os_context_t *context)
 456 {
 457     if (!foreign_function_call_active
 458 #ifndef INTERNAL_GC_TRIGGER
 459         && gc_trigger_hit(signal, info, context)
 460 #endif
 461         ) {
 462 #ifndef INTERNAL_GC_TRIGGER
 463         clear_auto_gc_trigger();
 464 #endif
 465
 466         if (arch_pseudo_atomic_atomic(context)) {
 467             maybe_gc_pending = 1;
 468             if (pending_signal == 0) {
 469                 /* FIXME: This copy-pending_mask-then-sigaddset_blockable
 470                  * idiom occurs over and over. It should be factored out
 471                  * into a function with a descriptive name. */
 472                 memcpy(&pending_mask,
 473                        os_context_sigmask_addr(context),
 474                        sizeof(sigset_t));
 475                 sigaddset_blockable(os_context_sigmask_addr(context));
 476             }
 477             arch_set_pseudo_atomic_interrupted(context);
 478         }
 479         else {
 480             fake_foreign_function_call(context);
 481             funcall0(SymbolFunction(MAYBE_GC));
 482             undo_fake_foreign_function_call(context);
 483         }
 484
 485         return 1;
 486     } else {
 487         return 0;
 488     }
 489 }
 490 #endif
 491 \f
 492 /*
 493  * noise to install handlers
 494  */
 495
 496 /* Install a special low-level handler for signal; or if handler is
 497  * SIG_DFL, remove any special handling for signal. */
 498 void
 499 interrupt_install_low_level_handler (int signal,
 500                                      void handler(int, siginfo_t*, void*))
 501 {
 502     struct sigaction sa;
 503
 504     sa.sa_sigaction = handler;
 505     sigemptyset(&sa.sa_mask);
 506     sigaddset_blockable(&sa.sa_mask);
 507     sa.sa_flags = SA_SIGINFO | SA_RESTART;
 508
 509     sigaction(signal, &sa, NULL);
 510     interrupt_low_level_handlers[signal] =
 511         (ARE_SAME_HANDLER(handler,SIG_DFL) ? 0 : handler);
 512 }
 513
 514 /* This is called from Lisp. */
 515 unsigned long
 516 install_handler(int signal, void handler(int, siginfo_t*, void*))
 517 {
 518     struct sigaction sa;
 519     sigset_t old, new;
 520     union interrupt_handler oldhandler;
 521
 522     FSHOW((stderr, "entering POSIX install_handler(%d, ..)\n", signal));
 523
 524     sigemptyset(&new);
 525     sigaddset(&new, signal);
 526     sigprocmask(SIG_BLOCK, &new, &old);
 527
 528     sigemptyset(&new);
 529     sigaddset_blockable(&new);
 530
 531     FSHOW((stderr, "interrupt_low_level_handlers[signal]=%d\n",
 532            interrupt_low_level_handlers[signal]));
 533     if (interrupt_low_level_handlers[signal]==0) {
 534         if (ARE_SAME_HANDLER(handler, SIG_DFL) ||
 535             ARE_SAME_HANDLER(handler, SIG_IGN)) {
 536             sa.sa_sigaction = handler;
 537         } else if (sigismember(&new, signal)) {
 538             sa.sa_sigaction = maybe_now_maybe_later;
 539         } else {
 540             sa.sa_sigaction = interrupt_handle_now;
 541         }
 542
 543         sigemptyset(&sa.sa_mask);
 544         sigaddset_blockable(&sa.sa_mask);
 545         sa.sa_flags = SA_SIGINFO | SA_RESTART;
 546
 547         sigaction(signal, &sa, NULL);
 548     }
 549
 550     oldhandler = interrupt_handlers[signal];
 551     interrupt_handlers[signal].c = handler;
 552
 553     sigprocmask(SIG_SETMASK, &old, 0);
 554
 555     FSHOW((stderr, "leaving POSIX install_handler(%d, ..)\n", signal));
 556
 557     return (unsigned long)oldhandler.lisp;
 558 }
 559
 560 void
 561 interrupt_init(void)
 562 {
 563     int i;
 564
 565     for (i = 0; i < NSIG; i++) {
 566         interrupt_handlers[i].c =
 567             /* (The cast here blasts away the distinction between
 568              * SA_SIGACTION-style three-argument handlers and
 569              * signal(..)-style one-argument handlers, which is OK
 570              * because it works to call the 1-argument form where the
 571              * 3-argument form is expected.) */
 572             (void (*)(int, siginfo_t*, void*))SIG_DFL;
 573     }
 574 }