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