1.0.41.21: runtime: Current stack and frame pointers are per-thread data.
[sbcl.git] / src / runtime / x86-arch.c
index 3c556c4..cbb6fb4 100644 (file)
@@ -9,17 +9,13 @@
  * files for more information.
  */
 
-/*
- * $Header$
- */
-
 #include <stdio.h>
 
+#include "sbcl.h"
 #include "runtime.h"
 #include "globals.h"
 #include "validate.h"
 #include "os.h"
-#include "sbcl.h"
 #include "arch.h"
 #include "lispregs.h"
 #include "signal.h"
 #include "interrupt.h"
 #include "interr.h"
 #include "breakpoint.h"
+#include "thread.h"
+#include "pseudo-atomic.h"
 
-#define BREAKPOINT_INST 0xcc   /* INT3 */
+#include "genesis/static-symbols.h"
+#include "genesis/symbol.h"
+
+#define BREAKPOINT_INST 0xcc    /* INT3 */
+#define UD2_INST 0x0b0f         /* UD2 */
+
+#ifndef LISP_FEATURE_UD2_BREAKPOINTS
+#define BREAKPOINT_WIDTH 1
+#else
+#define BREAKPOINT_WIDTH 2
+#endif
 
 unsigned long fast_random_state = 1;
 
 void arch_init(void)
 {}
+
+#ifndef LISP_FEATURE_WIN32
+os_vm_address_t
+arch_get_bad_addr(int sig, siginfo_t *code, os_context_t *context)
+{
+    return (os_vm_address_t)code->si_addr;
+}
+#endif
+
 \f
 /*
  * hacking signal contexts
@@ -45,7 +62,7 @@ void arch_init(void)
 int *
 context_eflags_addr(os_context_t *context)
 {
-#if defined __linux__
+#if defined __linux__ || defined __sun
     /* KLUDGE: As of kernel 2.2.14 on Red Hat 6.2, there's code in the
      * <sys/ucontext.h> file to define symbolic names for offsets into
      * gregs[], but it's conditional on __USE_GNU and not defined, so
@@ -56,6 +73,12 @@ context_eflags_addr(os_context_t *context)
     return &context->uc_mcontext.mc_eflags;
 #elif defined __OpenBSD__
     return &context->sc_eflags;
+#elif defined LISP_FEATURE_DARWIN
+    return (int *)(&context->uc_mcontext->SS.EFLAGS);
+#elif defined __NetBSD__
+    return &(context->uc_mcontext.__gregs[_REG_EFL]);
+#elif defined LISP_FEATURE_WIN32
+    return (int *)&context->EFlags;
 #else
 #error unsupported OS
 #endif
@@ -71,39 +94,40 @@ void arch_skip_instruction(os_context_t *context)
     int vlen;
     int code;
 
-    FSHOW((stderr, "[arch_skip_inst at %x]\n", *os_context_pc_addr(context)));
 
     /* Get and skip the Lisp interrupt code. */
     code = *(char*)(*os_context_pc_addr(context))++;
     switch (code)
-       {
-       case trap_Error:
-       case trap_Cerror:
-           /* Lisp error arg vector length */
-           vlen = *(char*)(*os_context_pc_addr(context))++;
-           /* Skip Lisp error arg data bytes. */
-           while (vlen-- > 0) {
-               (char*)(*os_context_pc_addr(context))++;
-           }
-           break;
-
-       case trap_Breakpoint:           /* not tested */
-       case trap_FunctionEndBreakpoint: /* not tested */
-           break;
-
-       case trap_PendingInterrupt:
-       case trap_Halt:
-           /* only needed to skip the Code */
-           break;
-
-       default:
-           fprintf(stderr,"[arch_skip_inst invalid code %d\n]\n",code);
-           break;
-       }
+        {
+        case trap_Error:
+        case trap_Cerror:
+            /* Lisp error arg vector length */
+            vlen = *(char*)(*os_context_pc_addr(context))++;
+            /* Skip Lisp error arg data bytes. */
+            while (vlen-- > 0) {
+                ++*os_context_pc_addr(context);
+            }
+            break;
+
+        case trap_Breakpoint:           /* not tested */
+        case trap_FunEndBreakpoint: /* not tested */
+            break;
+
+        case trap_PendingInterrupt:
+        case trap_Halt:
+        case trap_SingleStepAround:
+        case trap_SingleStepBefore:
+            /* only needed to skip the Code */
+            break;
+
+        default:
+            fprintf(stderr,"[arch_skip_inst invalid code %d\n]\n",code);
+            break;
+        }
 
     FSHOW((stderr,
-          "[arch_skip_inst resuming at %x]\n",
-          *os_context_pc_addr(context)));
+           "/[arch_skip_inst resuming at %x]\n",
+           *os_context_pc_addr(context)));
 }
 
 unsigned char *
@@ -115,58 +139,72 @@ arch_internal_error_arguments(os_context_t *context)
 boolean
 arch_pseudo_atomic_atomic(os_context_t *context)
 {
-    return SymbolValue(PSEUDO_ATOMIC_ATOMIC);
+    return get_pseudo_atomic_atomic(arch_os_get_current_thread());
 }
 
 void
 arch_set_pseudo_atomic_interrupted(os_context_t *context)
 {
-    SetSymbolValue(PSEUDO_ATOMIC_INTERRUPTED, make_fixnum(1));
+    struct thread *thread = arch_os_get_current_thread();
+    set_pseudo_atomic_interrupted(thread);
+}
+
+void
+arch_clear_pseudo_atomic_interrupted(os_context_t *context)
+{
+    struct thread *thread = arch_os_get_current_thread();
+    clear_pseudo_atomic_interrupted(thread);
 }
 \f
 /*
  * This stuff seems to get called for TRACE and debug activity.
  */
 
-unsigned long
+unsigned int
 arch_install_breakpoint(void *pc)
 {
-    unsigned long result = *(unsigned long*)pc;
+    unsigned int result = *(unsigned int*)pc;
 
-    *(char*)pc = BREAKPOINT_INST;              /* x86 INT3       */
-    *((char*)pc+1) = trap_Breakpoint;          /* Lisp trap code */
+#ifndef LISP_FEATURE_UD2_BREAKPOINTS
+    *(char*)pc = BREAKPOINT_INST;               /* x86 INT3       */
+    *((char*)pc+1) = trap_Breakpoint;           /* Lisp trap code */
+#else
+    *(char*)pc = UD2_INST & 0xff;
+    *((char*)pc+1) = UD2_INST >> 8;
+    *((char*)pc+2) = trap_Breakpoint;
+#endif
 
     return result;
 }
 
 void
-arch_remove_breakpoint(void *pc, unsigned long orig_inst)
+arch_remove_breakpoint(void *pc, unsigned int orig_inst)
 {
     *((char *)pc) = orig_inst & 0xff;
     *((char *)pc + 1) = (orig_inst & 0xff00) >> 8;
+#if BREAKPOINT_WIDTH > 1
+    *((char *)pc + 2) = (orig_inst & 0xff0000) >> 16;
+#endif
 }
 \f
 /* When single stepping, single_stepping holds the original instruction
  * PC location. */
-unsigned int *single_stepping=NULL;
-#ifndef __linux__
+unsigned int *single_stepping = NULL;
+#ifdef CANNOT_GET_TO_SINGLE_STEP_FLAG
 unsigned int  single_step_save1;
 unsigned int  single_step_save2;
 unsigned int  single_step_save3;
 #endif
 
 void
-arch_do_displaced_inst(os_context_t *context, unsigned long orig_inst)
+arch_do_displaced_inst(os_context_t *context, unsigned int orig_inst)
 {
     unsigned int *pc = (unsigned int*)(*os_context_pc_addr(context));
 
     /* Put the original instruction back. */
-    *((char *)pc) = orig_inst & 0xff;
-    *((char *)pc + 1) = (orig_inst & 0xff00) >> 8;
+    arch_remove_breakpoint(pc, orig_inst);
 
-#ifdef __linux__
-    *context_eflags_addr(context) |= 0x100;
-#else
+#ifdef CANNOT_GET_TO_SINGLE_STEP_FLAG
     /* Install helper instructions for the single step:
      * pushf; or [esp],0x100; popf. */
     single_step_save1 = *(pc-3);
@@ -175,145 +213,168 @@ arch_do_displaced_inst(os_context_t *context, unsigned long orig_inst)
     *(pc-3) = 0x9c909090;
     *(pc-2) = 0x00240c81;
     *(pc-1) = 0x9d000001;
+#else
+    *context_eflags_addr(context) |= 0x100;
 #endif
 
-    single_stepping = (unsigned int*)pc;
+    single_stepping = pc;
 
-#ifndef __linux__
-    *os_context_pc_addr(context) = (char *)pc - 9;
+#ifdef CANNOT_GET_TO_SINGLE_STEP_FLAG
+    *os_context_pc_addr(context) = (os_context_register_t)((char *)pc - 9);
 #endif
 }
 \f
 void
-sigtrap_handler(int signal, siginfo_t *info, void *void_context)
+restore_breakpoint_from_single_step(os_context_t * context)
 {
-    int code = info->si_code;
-    os_context_t *context = (os_context_t*)void_context;
-    unsigned int trap;
-
-    if (single_stepping && (signal==SIGTRAP))
-    {
-       /* fprintf(stderr,"* single step trap %x\n", single_stepping); */
-
-#ifndef __linux__
-       /* Un-install single step helper instructions. */
-       *(single_stepping-3) = single_step_save1;
-       *(single_stepping-2) = single_step_save2;
-       *(single_stepping-1) = single_step_save3;
+    /* fprintf(stderr,"* single step trap %x\n", single_stepping); */
+#ifdef CANNOT_GET_TO_SINGLE_STEP_FLAG
+    /* Un-install single step helper instructions. */
+    *(single_stepping-3) = single_step_save1;
+    *(single_stepping-2) = single_step_save2;
+    *(single_stepping-1) = single_step_save3;
 #else
-       *context_eflags_addr(context) ^= 0x100;
+    *context_eflags_addr(context) &= ~0x100;
 #endif
-       /* Re-install the breakpoint if possible. */
-       if (*os_context_pc_addr(context) == (int)single_stepping + 1) {
-           fprintf(stderr, "warning: couldn't reinstall breakpoint\n");
-       } else {
-           char *ptr = (char*)single_stepping;
-           *((char *)single_stepping) = BREAKPOINT_INST;       /* x86 INT3 */
-           *((char *)single_stepping+1) = trap_Breakpoint;
-       }
-
-       single_stepping = NULL;
-       return;
+    /* Re-install the breakpoint if possible. */
+    if (((char *)*os_context_pc_addr(context) >
+         (char *)single_stepping) &&
+        ((char *)*os_context_pc_addr(context) <=
+         (char *)single_stepping + BREAKPOINT_WIDTH)) {
+        fprintf(stderr, "warning: couldn't reinstall breakpoint\n");
+    } else {
+        arch_install_breakpoint(single_stepping);
+    }
+
+    single_stepping = NULL;
+    return;
+}
+
+void
+arch_handle_breakpoint(os_context_t *context)
+{
+    *os_context_pc_addr(context) -= BREAKPOINT_WIDTH;
+    handle_breakpoint(context);
+}
+
+void
+arch_handle_fun_end_breakpoint(os_context_t *context)
+{
+    *os_context_pc_addr(context) -= BREAKPOINT_WIDTH;
+    *os_context_pc_addr(context) =
+        (int)handle_fun_end_breakpoint(context);
+}
+
+void
+arch_handle_single_step_trap(os_context_t *context, int trap)
+{
+    arch_skip_instruction(context);
+    /* On x86 the fdefn / function is always in EAX, so we pass 0
+     * as the register_offset. */
+    handle_single_step_trap(context, trap, 0);
+}
+
+#ifndef LISP_FEATURE_WIN32
+void
+sigtrap_handler(int signal, siginfo_t *info, os_context_t *context)
+{
+    unsigned int trap;
+
+    if (single_stepping) {
+        restore_breakpoint_from_single_step(context);
+        return;
     }
 
     /* This is just for info in case the monitor wants to print an
      * approximation. */
-    current_control_stack_pointer =
-       (lispobj*)*os_context_sp_addr(context);
+    access_control_stack_pointer(arch_os_get_current_thread()) =
+        (lispobj *)*os_context_sp_addr(context);
+
+#ifdef LISP_FEATURE_SUNOS
+    /* For some reason the breakpoints that :ENCAPSULATE NIL tracing sets up
+     * cause a trace trap (i.e. processor single-stepping trap) on the following
+     * instruction on Solaris 10/x86. -- JES, 2006-04-07
+     */
+    if (info->si_code == TRAP_TRACE) {
+        lose("foo");
+        return;
+    }
+#endif
 
     /* On entry %eip points just after the INT3 byte and aims at the
      * 'kind' value (eg trap_Cerror). For error-trap and Cerror-trap a
      * number of bytes will follow, the first is the length of the byte
      * arguments to follow. */
     trap = *(unsigned char *)(*os_context_pc_addr(context));
-    switch (trap) {
-
-    case trap_PendingInterrupt:
-       FSHOW((stderr, "<trap pending interrupt>\n"));
-       arch_skip_instruction(context);
-       interrupt_handle_pending(context);
-       break;
-
-    case trap_Halt:
-       /* Note: the old CMU CL code tried to save FPU state
-        * here, and restore it after we do our thing, but there
-        * seems to be no point in doing that, since we're just
-        * going to lose(..) anyway. */
-       fake_foreign_function_call(context);
-       lose("%%primitive halt called; the party is over.");
-
-    case trap_Error:
-    case trap_Cerror:
-       FSHOW((stderr, "<trap error/cerror %d>\n", code));
-       interrupt_internal_error(signal, info, context, code==trap_Cerror);
-       break;
-
-    case trap_Breakpoint:
-       (char*)(*os_context_pc_addr(context)) -= 1;
-       handle_breakpoint(signal, info, context);
-       break;
-
-    case trap_FunctionEndBreakpoint:
-       (char*)(*os_context_pc_addr(context)) -= 1;
-       *os_context_pc_addr(context) =
-           (int)handle_function_end_breakpoint(signal, info, context);
-       break;
-
-    default:
-       FSHOW((stderr,"[C--trap default %d %d %x]\n",
-              signal, code, context));
-       interrupt_handle_now(signal, info, context);
-       break;
+    handle_trap(context, trap);
+}
+
+void
+sigill_handler(int signal, siginfo_t *siginfo, os_context_t *context) {
+    /* Triggering SIGTRAP using int3 is unreliable on OS X/x86, so
+     * we need to use illegal instructions for traps.
+     */
+#if defined(LISP_FEATURE_UD2_BREAKPOINTS) && !defined(LISP_FEATURE_MACH_EXCEPTION_HANDLER)
+    if (*((unsigned short *)*os_context_pc_addr(context)) == UD2_INST) {
+        *os_context_pc_addr(context) += 2;
+        return sigtrap_handler(signal, siginfo, context);
     }
+#endif
+    fake_foreign_function_call(context);
+    lose("Unhandled SIGILL");
 }
+#endif /* not LISP_FEATURE_WIN32 */
 
 void
 arch_install_interrupt_handlers()
 {
-    interrupt_install_low_level_handler(SIGILL , sigtrap_handler);
-    interrupt_install_low_level_handler(SIGTRAP, sigtrap_handler);
+    SHOW("entering arch_install_interrupt_handlers()");
+
+    /* Note: The old CMU CL code here used sigtrap_handler() to handle
+     * SIGILL as well as SIGTRAP. I couldn't see any reason to do
+     * things that way. So, I changed to separate handlers when
+     * debugging a problem on OpenBSD, where SBCL wasn't catching
+     * SIGILL properly, but was instead letting the process be
+     * terminated with an "Illegal instruction" output. If this change
+     * turns out to break something (maybe breakpoint handling on some
+     * OS I haven't tested on?) and we have to go back to the old CMU
+     * CL way, I hope there will at least be a comment to explain
+     * why.. -- WHN 2001-06-07 */
+#if !defined(LISP_FEATURE_WIN32) && !defined(LISP_FEATURE_MACH_EXCEPTION_HANDLER)
+    undoably_install_low_level_interrupt_handler(SIGILL , sigill_handler);
+    undoably_install_low_level_interrupt_handler(SIGTRAP, sigtrap_handler);
+#endif
+    SHOW("returning from arch_install_interrupt_handlers()");
 }
 \f
-/* This is implemented in assembly language and called from C: */
-extern lispobj
-call_into_lisp(lispobj fun, lispobj *args, int nargs);
-
-/* These functions are an interface to the Lisp call-in facility.
- * Since this is C we can know nothing about the calling environment.
- * The control stack might be the C stack if called from the monitor
- * or the Lisp stack if called as a result of an interrupt or maybe
- * even a separate stack. The args are most likely on that stack but
- * could be in registers depending on what the compiler likes. So we
- * copy the args into a portable vector and let the assembly language
- * call-in function figure it out. */
-lispobj
-funcall0(lispobj function)
-{
-    lispobj *args = NULL;
+#ifdef LISP_FEATURE_LINKAGE_TABLE
+/* FIXME: It might be cleaner to generate these from the lisp side of
+ * things.
+ */
 
-    return call_into_lisp(function, args, 0);
-}
-lispobj
-funcall1(lispobj function, lispobj arg0)
-{
-    lispobj args[1];
-    args[0] = arg0;
-    return call_into_lisp(function, args, 1);
-}
-lispobj
-funcall2(lispobj function, lispobj arg0, lispobj arg1)
+void
+arch_write_linkage_table_jmp(char * reloc, void * fun)
 {
-    lispobj args[2];
-    args[0] = arg0;
-    args[1] = arg1;
-    return call_into_lisp(function, args, 2);
+    /* Make JMP to function entry. JMP offset is calculated from next
+     * instruction.
+     */
+    long offset = (char *)fun - (reloc + 5);
+    int i;
+
+    *reloc++ = 0xe9;            /* opcode for JMP rel32 */
+    for (i = 0; i < 4; i++) {
+        *reloc++ = offset & 0xff;
+        offset >>= 8;
+    }
+
+    /* write a nop for good measure. */
+    *reloc = 0x90;
 }
-lispobj
-funcall3(lispobj function, lispobj arg0, lispobj arg1, lispobj arg2)
+
+void
+arch_write_linkage_table_ref(void * reloc, void * data)
 {
-    lispobj args[3];
-    args[0] = arg0;
-    args[1] = arg1;
-    args[2] = arg2;
-    return call_into_lisp(function, args, 3);
+    *(unsigned long *)reloc = (unsigned long)data;
 }
+
+#endif