src/runtime/x86-arch.c

   1 /*
   2  * This software is part of the SBCL system. See the README file for
   3  * more information.
   4  *
   5  * This software is derived from the CMU CL system, which was
   6  * written at Carnegie Mellon University and released into the
   7  * public domain. The software is in the public domain and is
   8  * provided with absolutely no warranty. See the COPYING and CREDITS
   9  * files for more information.
  10  */
  11
  12 #include <stdio.h>
  13
  14 #include "sbcl.h"
  15 #include "runtime.h"
  16 #include "globals.h"
  17 #include "validate.h"
  18 #include "os.h"
  19 #include "arch.h"
  20 #include "lispregs.h"
  21 #include "signal.h"
  22 #include "alloc.h"
  23 #include "interrupt.h"
  24 #include "interr.h"
  25 #include "breakpoint.h"
  26 #include "monitor.h"
  27 #include "thread.h"
  28
  29 #include "genesis/static-symbols.h"
  30 #include "genesis/symbol.h"
  31
  32 #define BREAKPOINT_INST 0xcc    /* INT3 */
  33
  34 unsigned long fast_random_state = 1;
  35
  36 void arch_init(void)
  37 {}
  38
  39 #ifndef LISP_FEATURE_WIN32
  40 os_vm_address_t
  41 arch_get_bad_addr(int sig, siginfo_t *code, os_context_t *context)
  42 {
  43     return (os_vm_address_t)code->si_addr;
  44 }
  45 #endif
  46
  47 \f
  48 /*
  49  * hacking signal contexts
  50  *
  51  * (This depends both on architecture, which determines what we might
  52  * want to get to, and on OS, which determines how we get to it.)
  53  */
  54
  55 int *
  56 context_eflags_addr(os_context_t *context)
  57 {
  58 #if defined __linux__ || defined __sun
  59     /* KLUDGE: As of kernel 2.2.14 on Red Hat 6.2, there's code in the
  60      * <sys/ucontext.h> file to define symbolic names for offsets into
  61      * gregs[], but it's conditional on __USE_GNU and not defined, so
  62      * we need to do this nasty absolute index magic number thing
  63      * instead. */
  64     return &context->uc_mcontext.gregs[16];
  65 #elif defined __FreeBSD__
  66     return &context->uc_mcontext.mc_eflags;
  67 #elif defined __OpenBSD__
  68     return &context->sc_eflags;
  69 #elif defined LISP_FEATURE_DARWIN
  70     return &context->uc_mcontext->ss.eflags;
  71 #elif defined __NetBSD__
  72     return &(context->uc_mcontext.__gregs[_REG_EFL]);
  73 #elif defined LISP_FEATURE_WIN32
  74     return (int *)&context->EFlags;
  75 #else
  76 #error unsupported OS
  77 #endif
  78 }
  79 \f
  80 void arch_skip_instruction(os_context_t *context)
  81 {
  82     /* Assuming we get here via an INT3 xxx instruction, the PC now
  83      * points to the interrupt code (a Lisp value) so we just move
  84      * past it. Skip the code; after that, if the code is an
  85      * error-trap or cerror-trap then skip the data bytes that follow. */
  86
  87     int vlen;
  88     int code;
  89
  90
  91     /* Get and skip the Lisp interrupt code. */
  92     code = *(char*)(*os_context_pc_addr(context))++;
  93     switch (code)
  94         {
  95         case trap_Error:
  96         case trap_Cerror:
  97             /* Lisp error arg vector length */
  98             vlen = *(char*)(*os_context_pc_addr(context))++;
  99             /* Skip Lisp error arg data bytes. */
 100             while (vlen-- > 0) {
 101                 ++*os_context_pc_addr(context);
 102             }
 103             break;
 104
 105         case trap_Breakpoint:           /* not tested */
 106         case trap_FunEndBreakpoint: /* not tested */
 107             break;
 108
 109         case trap_PendingInterrupt:
 110         case trap_Halt:
 111             /* only needed to skip the Code */
 112             break;
 113
 114         default:
 115             fprintf(stderr,"[arch_skip_inst invalid code %d\n]\n",code);
 116             break;
 117         }
 118
 119     FSHOW((stderr,
 120            "/[arch_skip_inst resuming at %x]\n",
 121            *os_context_pc_addr(context)));
 122 }
 123
 124 unsigned char *
 125 arch_internal_error_arguments(os_context_t *context)
 126 {
 127     return 1 + (unsigned char *)(*os_context_pc_addr(context));
 128 }
 129
 130 boolean
 131 arch_pseudo_atomic_atomic(os_context_t *context)
 132 {
 133     return SymbolValue(PSEUDO_ATOMIC_ATOMIC,arch_os_get_current_thread());
 134 }
 135
 136 void
 137 arch_set_pseudo_atomic_interrupted(os_context_t *context)
 138 {
 139     SetSymbolValue(PSEUDO_ATOMIC_INTERRUPTED, make_fixnum(1),
 140                    arch_os_get_current_thread());
 141 }
 142
 143 void
 144 arch_clear_pseudo_atomic_interrupted(os_context_t *context)
 145 {
 146     SetSymbolValue(PSEUDO_ATOMIC_INTERRUPTED, make_fixnum(0),
 147                    arch_os_get_current_thread());
 148 }
 149 \f
 150 /*
 151  * This stuff seems to get called for TRACE and debug activity.
 152  */
 153
 154 unsigned int
 155 arch_install_breakpoint(void *pc)
 156 {
 157     unsigned int result = *(unsigned int*)pc;
 158
 159     *(char*)pc = BREAKPOINT_INST;               /* x86 INT3       */
 160     *((char*)pc+1) = trap_Breakpoint;           /* Lisp trap code */
 161
 162     return result;
 163 }
 164
 165 void
 166 arch_remove_breakpoint(void *pc, unsigned int orig_inst)
 167 {
 168     *((char *)pc) = orig_inst & 0xff;
 169     *((char *)pc + 1) = (orig_inst & 0xff00) >> 8;
 170 }
 171 \f
 172 /* When single stepping, single_stepping holds the original instruction
 173  * PC location. */
 174 unsigned int *single_stepping = NULL;
 175 #ifdef CANNOT_GET_TO_SINGLE_STEP_FLAG
 176 unsigned int  single_step_save1;
 177 unsigned int  single_step_save2;
 178 unsigned int  single_step_save3;
 179 #endif
 180
 181 void
 182 arch_do_displaced_inst(os_context_t *context, unsigned int orig_inst)
 183 {
 184     unsigned int *pc = (unsigned int*)(*os_context_pc_addr(context));
 185
 186     /* Put the original instruction back. */
 187     *((char *)pc) = orig_inst & 0xff;
 188     *((char *)pc + 1) = (orig_inst & 0xff00) >> 8;
 189
 190 #ifdef CANNOT_GET_TO_SINGLE_STEP_FLAG
 191     /* Install helper instructions for the single step:
 192      * pushf; or [esp],0x100; popf. */
 193     single_step_save1 = *(pc-3);
 194     single_step_save2 = *(pc-2);
 195     single_step_save3 = *(pc-1);
 196     *(pc-3) = 0x9c909090;
 197     *(pc-2) = 0x00240c81;
 198     *(pc-1) = 0x9d000001;
 199 #else
 200     *context_eflags_addr(context) |= 0x100;
 201 #endif
 202
 203     single_stepping = pc;
 204
 205 #ifdef CANNOT_GET_TO_SINGLE_STEP_FLAG
 206     *os_context_pc_addr(context) = (char *)pc - 9;
 207 #endif
 208 }
 209 \f
 210 void
 211 sigtrap_handler(int signal, siginfo_t *info, void *void_context)
 212 {
 213     os_context_t *context = (os_context_t*)void_context;
 214     unsigned int trap;
 215
 216 #ifndef LISP_FEATURE_WIN32
 217     if (single_stepping && (signal==SIGTRAP))
 218     {
 219         /* fprintf(stderr,"* single step trap %x\n", single_stepping); */
 220
 221 #ifdef CANNOT_GET_TO_SINGLE_STEP_FLAG
 222         /* Un-install single step helper instructions. */
 223         *(single_stepping-3) = single_step_save1;
 224         *(single_stepping-2) = single_step_save2;
 225         *(single_stepping-1) = single_step_save3;
 226 #else
 227         *context_eflags_addr(context) &= ~0x100;
 228 #endif
 229         /* Re-install the breakpoint if possible. */
 230         if (*os_context_pc_addr(context) == (int)single_stepping + 1) {
 231             fprintf(stderr, "warning: couldn't reinstall breakpoint\n");
 232         } else {
 233             *((char *)single_stepping) = BREAKPOINT_INST;       /* x86 INT3 */
 234             *((char *)single_stepping+1) = trap_Breakpoint;
 235         }
 236
 237         single_stepping = NULL;
 238         return;
 239     }
 240 #endif
 241
 242     /* This is just for info in case the monitor wants to print an
 243      * approximation. */
 244     current_control_stack_pointer =
 245         (lispobj *)*os_context_sp_addr(context);
 246
 247     /* FIXME: CMUCL puts the float control restoration code here.
 248        Thus, it seems to me that single-stepping won't restore the
 249        float control.  Since SBCL currently doesn't support
 250        single-stepping (as far as I can tell) this is somewhat moot,
 251        but it might be worth either moving this code up or deleting
 252        the single-stepping code entirely.  -- CSR, 2002-07-15 */
 253 #ifdef LISP_FEATURE_LINUX
 254     os_restore_fp_control(context);
 255 #endif
 256
 257
 258 #ifdef LISP_FEATURE_SUNOS
 259     /* For some reason the breakpoints that :ENCAPSULATE NIL tracing sets up
 260      * cause a trace trap (i.e. processor single-stepping trap) on the following
 261      * instruction on Solaris 10/x86. -- JES, 2006-04-07
 262      */
 263     if (info->si_code == TRAP_TRACE) {
 264         lose("foo");
 265         return;
 266     }
 267 #endif
 268
 269     /* On entry %eip points just after the INT3 byte and aims at the
 270      * 'kind' value (eg trap_Cerror). For error-trap and Cerror-trap a
 271      * number of bytes will follow, the first is the length of the byte
 272      * arguments to follow. */
 273     trap = *(unsigned char *)(*os_context_pc_addr(context));
 274     /* FSHOW((stderr, "/<sigtrap trap %d at pc_addr: %p>\n", trap, *os_context_pc_addr(context))); */
 275     switch (trap) {
 276
 277     case trap_PendingInterrupt:
 278         FSHOW((stderr, "/<trap pending interrupt>\n"));
 279         arch_skip_instruction(context);
 280         interrupt_handle_pending(context);
 281         break;
 282
 283     case trap_Halt:
 284         /* Note: the old CMU CL code tried to save FPU state
 285          * here, and restore it after we do our thing, but there
 286          * seems to be no point in doing that, since we're just
 287          * going to lose(..) anyway. */
 288         fake_foreign_function_call(context);
 289         lose("%%PRIMITIVE HALT called; the party is over.\n");
 290
 291     case trap_Error:
 292     case trap_Cerror:
 293         FSHOW((stderr, "<trap error/cerror %d>\n", trap));
 294         interrupt_internal_error(signal, info, context, trap==trap_Cerror);
 295         break;
 296
 297     case trap_Breakpoint:
 298         --*os_context_pc_addr(context);
 299         handle_breakpoint(signal, info, context);
 300         break;
 301
 302     case trap_FunEndBreakpoint:
 303         --*os_context_pc_addr(context);
 304         *os_context_pc_addr(context) =
 305             (int)handle_fun_end_breakpoint(signal, info, context);
 306         break;
 307
 308     default:
 309         FSHOW((stderr,"/[C--trap default %d %d %x]\n",
 310                signal, trap, context));
 311         interrupt_handle_now(signal, info, context);
 312         break;
 313     }
 314 }
 315
 316 static void
 317 sigill_handler(int signal, siginfo_t *siginfo, void *void_context) {
 318     os_context_t *context = (os_context_t*)void_context;
 319
 320 #if defined(LISP_FEATURE_DARWIN)
 321     if (*((unsigned short *)*os_context_pc_addr(context)) == 0x0b0f) {
 322         *os_context_pc_addr(context) += 2;
 323         return sigtrap_handler(signal, siginfo, void_context);
 324     }
 325 #endif
 326
 327     fake_foreign_function_call(context);
 328     monitor_or_something();
 329 }
 330
 331 void
 332 arch_install_interrupt_handlers()
 333 {
 334     SHOW("entering arch_install_interrupt_handlers()");
 335
 336     /* Note: The old CMU CL code here used sigtrap_handler() to handle
 337      * SIGILL as well as SIGTRAP. I couldn't see any reason to do
 338      * things that way. So, I changed to separate handlers when
 339      * debugging a problem on OpenBSD, where SBCL wasn't catching
 340      * SIGILL properly, but was instead letting the process be
 341      * terminated with an "Illegal instruction" output. If this change
 342      * turns out to break something (maybe breakpoint handling on some
 343      * OS I haven't tested on?) and we have to go back to the old CMU
 344      * CL way, I hope there will at least be a comment to explain
 345      * why.. -- WHN 2001-06-07 */
 346 #ifndef LISP_FEATURE_WIN32
 347     undoably_install_low_level_interrupt_handler(SIGILL , sigill_handler);
 348     undoably_install_low_level_interrupt_handler(SIGTRAP, sigtrap_handler);
 349 #endif
 350
 351     SHOW("returning from arch_install_interrupt_handlers()");
 352 }
 353 \f
 354 /* This is implemented in assembly language and called from C: */
 355 extern lispobj
 356 call_into_lisp(lispobj fun, lispobj *args, int nargs);
 357
 358 /* These functions are an interface to the Lisp call-in facility.
 359  * Since this is C we can know nothing about the calling environment.
 360  * The control stack might be the C stack if called from the monitor
 361  * or the Lisp stack if called as a result of an interrupt or maybe
 362  * even a separate stack. The args are most likely on that stack but
 363  * could be in registers depending on what the compiler likes. So we
 364  * copy the args into a portable vector and let the assembly language
 365  * call-in function figure it out. */
 366
 367 lispobj
 368 funcall0(lispobj function)
 369 {
 370     lispobj *args = NULL;
 371
 372     FSHOW((stderr, "/entering funcall0(0x%lx)\n", (long)function));
 373     return call_into_lisp(function, args, 0);
 374 }
 375 lispobj
 376 funcall1(lispobj function, lispobj arg0)
 377 {
 378     lispobj args[1];
 379     args[0] = arg0;
 380     return call_into_lisp(function, args, 1);
 381 }
 382 lispobj
 383 funcall2(lispobj function, lispobj arg0, lispobj arg1)
 384 {
 385     lispobj args[2];
 386     args[0] = arg0;
 387     args[1] = arg1;
 388     return call_into_lisp(function, args, 2);
 389 }
 390 lispobj
 391 funcall3(lispobj function, lispobj arg0, lispobj arg1, lispobj arg2)
 392 {
 393     lispobj args[3];
 394     args[0] = arg0;
 395     args[1] = arg1;
 396     args[2] = arg2;
 397     return call_into_lisp(function, args, 3);
 398 }
 399
 400 #ifdef LISP_FEATURE_LINKAGE_TABLE
 401 /* FIXME: It might be cleaner to generate these from the lisp side of
 402  * things.
 403  */
 404
 405 void
 406 arch_write_linkage_table_jmp(char * reloc, void * fun)
 407 {
 408     /* Make JMP to function entry. JMP offset is calculated from next
 409      * instruction.
 410      */
 411     long offset = (char *)fun - (reloc + 5);
 412     int i;
 413
 414     *reloc++ = 0xe9;            /* opcode for JMP rel32 */
 415     for (i = 0; i < 4; i++) {
 416         *reloc++ = offset & 0xff;
 417         offset >>= 8;
 418     }
 419
 420     /* write a nop for good measure. */
 421     *reloc = 0x90;
 422 }
 423
 424 void
 425 arch_write_linkage_table_ref(void * reloc, void * data)
 426 {
 427     *(unsigned long *)reloc = (unsigned long)data;
 428 }
 429
 430 #endif