src/runtime/x86-64-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 "sbcl.h"
  20 #include "arch.h"
  21 #include "lispregs.h"
  22 #include "signal.h"
  23 #include "alloc.h"
  24 #include "interrupt.h"
  25 #include "interr.h"
  26 #include "breakpoint.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 os_vm_address_t
  40 arch_get_bad_addr(int sig, siginfo_t *code, os_context_t *context)
  41 {
  42     return (os_vm_address_t)code->si_addr;
  43 }
  44
  45 \f
  46 /*
  47  * hacking signal contexts
  48  *
  49  * (This depends both on architecture, which determines what we might
  50  * want to get to, and on OS, which determines how we get to it.)
  51  */
  52
  53 os_context_register_t *
  54 context_eflags_addr(os_context_t *context)
  55 {
  56 #if defined __linux__
  57     /* KLUDGE: As of kernel 2.2.14 on Red Hat 6.2, there's code in the
  58      * <sys/ucontext.h> file to define symbolic names for offsets into
  59      * gregs[], but it's conditional on __USE_GNU and not defined, so
  60      * we need to do this nasty absolute index magic number thing
  61      * instead. */
  62     return &context->uc_mcontext.gregs[17];
  63 #elif defined __FreeBSD__
  64     return &context->uc_mcontext.mc_rflags;
  65 #elif defined LISP_FEATURE_DARWIN
  66     return &context->uc_mcontext->ss.rflags;
  67 #elif defined __OpenBSD__
  68     return &context->sc_eflags;
  69 #else
  70 #error unsupported OS
  71 #endif
  72 }
  73 \f
  74 void arch_skip_instruction(os_context_t *context)
  75 {
  76     /* Assuming we get here via an INT3 xxx instruction, the PC now
  77      * points to the interrupt code (a Lisp value) so we just move
  78      * past it. Skip the code; after that, if the code is an
  79      * error-trap or cerror-trap then skip the data bytes that follow. */
  80
  81     int vlen;
  82     long code;
  83
  84
  85     /* Get and skip the Lisp interrupt code. */
  86     code = *(char*)(*os_context_pc_addr(context))++;
  87     switch (code)
  88         {
  89         case trap_Error:
  90         case trap_Cerror:
  91             /* Lisp error arg vector length */
  92             vlen = *(char*)(*os_context_pc_addr(context))++;
  93             /* Skip Lisp error arg data bytes. */
  94             while (vlen-- > 0) {
  95                 ++*os_context_pc_addr(context);
  96             }
  97             break;
  98
  99         case trap_Breakpoint:           /* not tested */
 100         case trap_FunEndBreakpoint: /* not tested */
 101             break;
 102
 103         case trap_PendingInterrupt:
 104         case trap_Halt:
 105         case trap_SingleStepAround:
 106         case trap_SingleStepBefore:
 107             /* only needed to skip the Code */
 108             break;
 109
 110         default:
 111             fprintf(stderr,"[arch_skip_inst invalid code %ld\n]\n",code);
 112             break;
 113         }
 114
 115     FSHOW((stderr,
 116            "/[arch_skip_inst resuming at %x]\n",
 117            *os_context_pc_addr(context)));
 118 }
 119
 120 unsigned char *
 121 arch_internal_error_arguments(os_context_t *context)
 122 {
 123     return 1 + (unsigned char *)(*os_context_pc_addr(context));
 124 }
 125
 126 boolean
 127 arch_pseudo_atomic_atomic(os_context_t *context)
 128 {
 129     return get_pseudo_atomic_atomic(arch_os_get_current_thread());
 130 }
 131
 132 void
 133 arch_set_pseudo_atomic_interrupted(os_context_t *context)
 134 {
 135     struct thread *thread = arch_os_get_current_thread();
 136     set_pseudo_atomic_interrupted(thread);
 137 }
 138
 139 void
 140 arch_clear_pseudo_atomic_interrupted(os_context_t *context)
 141 {
 142     struct thread *thread = arch_os_get_current_thread();
 143     clear_pseudo_atomic_interrupted(thread);
 144 }
 145 \f
 146 /*
 147  * This stuff seems to get called for TRACE and debug activity.
 148  */
 149
 150 unsigned int
 151 arch_install_breakpoint(void *pc)
 152 {
 153     unsigned int result = *(unsigned int*)pc;
 154
 155     *(char*)pc = BREAKPOINT_INST;               /* x86 INT3       */
 156     *((char*)pc+1) = trap_Breakpoint;           /* Lisp trap code */
 157
 158     return result;
 159 }
 160
 161 void
 162 arch_remove_breakpoint(void *pc, unsigned int orig_inst)
 163 {
 164     *((char *)pc) = orig_inst & 0xff;
 165     *((char *)pc + 1) = (orig_inst & 0xff00) >> 8;
 166 }
 167 \f
 168 /* When single stepping, single_stepping holds the original instruction
 169  * PC location. */
 170 unsigned int *single_stepping = NULL;
 171 #ifdef CANNOT_GET_TO_SINGLE_STEP_FLAG
 172 unsigned int  single_step_save1;
 173 unsigned int  single_step_save2;
 174 unsigned int  single_step_save3;
 175 #endif
 176
 177 void
 178 arch_do_displaced_inst(os_context_t *context, unsigned int orig_inst)
 179 {
 180     unsigned int *pc = (unsigned int*)(*os_context_pc_addr(context));
 181
 182     /* Put the original instruction back. */
 183     *((char *)pc) = orig_inst & 0xff;
 184     *((char *)pc + 1) = (orig_inst & 0xff00) >> 8;
 185
 186 #ifdef CANNOT_GET_TO_SINGLE_STEP_FLAG
 187     /* Install helper instructions for the single step:
 188      * pushf; or [esp],0x100; popf. */
 189     single_step_save1 = *(pc-3);
 190     single_step_save2 = *(pc-2);
 191     single_step_save3 = *(pc-1);
 192     *(pc-3) = 0x9c909090;
 193     *(pc-2) = 0x00240c81;
 194     *(pc-1) = 0x9d000001;
 195 #else
 196     *context_eflags_addr(context) |= 0x100;
 197 #endif
 198
 199     single_stepping = pc;
 200
 201 #ifdef CANNOT_GET_TO_SINGLE_STEP_FLAG
 202     *os_context_pc_addr(context) = (os_context_register_t)((char *)pc - 9);
 203 #endif
 204 }
 205
 206 void
 207 arch_handle_breakpoint(os_context_t *context)
 208 {
 209     --*os_context_pc_addr(context);
 210     handle_breakpoint(context);
 211 }
 212
 213 void
 214 arch_handle_fun_end_breakpoint(os_context_t *context)
 215 {
 216     --*os_context_pc_addr(context);
 217     *os_context_pc_addr(context) =
 218         (unsigned long)handle_fun_end_breakpoint(context);
 219 }
 220
 221 void
 222 arch_handle_single_step_trap(os_context_t *context, int trap)
 223 {
 224     arch_skip_instruction(context);
 225     /* On x86-64 the fdefn / function is always in RAX, so we pass
 226      * 0 as the register_offset. */
 227     handle_single_step_trap(context, trap, 0);
 228 }
 229
 230 \f
 231 void
 232 sigtrap_handler(int signal, siginfo_t *info, void *void_context)
 233 {
 234     int code = info->si_code;
 235     os_context_t *context = (os_context_t*)void_context;
 236     unsigned int trap;
 237
 238     if (single_stepping && (signal==SIGTRAP))
 239     {
 240 #ifdef CANNOT_GET_TO_SINGLE_STEP_FLAG
 241         /* Un-install single step helper instructions. */
 242         *(single_stepping-3) = single_step_save1;
 243         *(single_stepping-2) = single_step_save2;
 244         *(single_stepping-1) = single_step_save3;
 245 #else
 246         *context_eflags_addr(context) ^= 0x100;
 247 #endif
 248         /* Re-install the breakpoint if possible. */
 249         if ((char *)*os_context_pc_addr(context) ==
 250             (char *)single_stepping + 1) {
 251             fprintf(stderr, "warning: couldn't reinstall breakpoint\n");
 252         } else {
 253             *((char *)single_stepping) = BREAKPOINT_INST;       /* x86 INT3 */
 254             *((char *)single_stepping+1) = trap_Breakpoint;
 255         }
 256
 257         single_stepping = NULL;
 258         return;
 259     }
 260
 261     /* This is just for info in case the monitor wants to print an
 262      * approximation. */
 263     current_control_stack_pointer =
 264         (lispobj *)*os_context_sp_addr(context);
 265
 266     /* FIXME: CMUCL puts the float control restoration code here.
 267        Thus, it seems to me that single-stepping won't restore the
 268        float control.  Since SBCL currently doesn't support
 269        single-stepping (as far as I can tell) this is somewhat moot,
 270        but it might be worth either moving this code up or deleting
 271        the single-stepping code entirely.  -- CSR, 2002-07-15 */
 272 #if defined(LISP_FEATURE_LINUX) || defined(RESTORE_FP_CONTROL_FROM_CONTEXT)
 273     os_restore_fp_control(context);
 274 #endif
 275
 276     /* On entry %eip points just after the INT3 byte and aims at the
 277      * 'kind' value (eg trap_Cerror). For error-trap and Cerror-trap a
 278      * number of bytes will follow, the first is the length of the byte
 279      * arguments to follow. */
 280     trap = *(unsigned char *)(*os_context_pc_addr(context));
 281
 282     if (!maybe_handle_trap(context, trap))
 283         interrupt_handle_now(signal, info, context);
 284 }
 285
 286 void
 287 sigill_handler(int signal, siginfo_t *siginfo, void *void_context) {
 288     os_context_t *context = (os_context_t*)void_context;
 289
 290     /* Triggering SIGTRAP using int3 is unreliable on OS X/x86, so
 291      * we need to use illegal instructions for traps.
 292      */
 293 #if defined(LISP_FEATURE_DARWIN) && !defined(LISP_FEATURE_MACH_EXCEPTION_HANDLER)
 294     if (*((unsigned short *)*os_context_pc_addr(context)) == 0x0b0f) {
 295         *os_context_pc_addr(context) += 2;
 296         return sigtrap_handler(signal, siginfo, void_context);
 297     }
 298 #endif
 299
 300     fake_foreign_function_call(context);
 301     lose("fake_foreign_function_call fell through");
 302 }
 303
 304 #ifdef X86_64_SIGFPE_FIXUP
 305 #define MXCSR_IE (0x01)         /* Invalid Operation */
 306 #define MXCSR_DE (0x02)         /* Denormal */
 307 #define MXCSR_ZE (0x04)         /* Devide-by-Zero */
 308 #define MXCSR_OE (0x08)         /* Overflow */
 309 #define MXCSR_UE (0x10)         /* Underflow */
 310 #define MXCSR_PE (0x20)         /* Precision */
 311
 312 static inline int
 313 mxcsr_to_code(unsigned int mxcsr)
 314 {
 315     /* Extract unmasked exception bits. */
 316     mxcsr &= ~(mxcsr >> 7) & 0x3F;
 317
 318     /* This order is defined at "Intel 64 and IA-32 Architectures
 319      * Software Developerfs Manual" Volume 1: "Basic Architecture",
 320      * 4.9.2 "Floating-Point Exception Priority". */
 321     if (mxcsr & MXCSR_IE)
 322         return FPE_FLTINV;
 323     else if (mxcsr & MXCSR_ZE)
 324         return FPE_FLTDIV;
 325     else if (mxcsr & MXCSR_DE)
 326         return FPE_FLTUND;
 327     else if (mxcsr & MXCSR_OE)
 328         return FPE_FLTOVF;
 329     else if (mxcsr & MXCSR_UE)
 330         return FPE_FLTUND;
 331     else if (mxcsr & MXCSR_PE)
 332         return FPE_FLTRES;
 333
 334     return 0;
 335 }
 336
 337 static void
 338 sigfpe_handler(int signal, siginfo_t *siginfo, void *void_context)
 339 {
 340     os_context_t *context = arch_os_get_context(&void_context);
 341     unsigned int *mxcsr = arch_os_context_mxcsr_addr(context);
 342
 343     if (siginfo->si_code == 0) { /* XMM exception */
 344         siginfo->si_code = mxcsr_to_code(*mxcsr);
 345
 346         /* Clear sticky exception flag. */
 347         *mxcsr &= ~0x3F;
 348     }
 349
 350     interrupt_handle_now(signal, siginfo, context);
 351 }
 352 #endif
 353
 354 void
 355 arch_install_interrupt_handlers()
 356 {
 357     SHOW("entering arch_install_interrupt_handlers()");
 358
 359     /* Note: The old CMU CL code here used sigtrap_handler() to handle
 360      * SIGILL as well as SIGTRAP. I couldn't see any reason to do
 361      * things that way. So, I changed to separate handlers when
 362      * debugging a problem on OpenBSD, where SBCL wasn't catching
 363      * SIGILL properly, but was instead letting the process be
 364      * terminated with an "Illegal instruction" output. If this change
 365      * turns out to break something (maybe breakpoint handling on some
 366      * OS I haven't tested on?) and we have to go back to the old CMU
 367      * CL way, I hope there will at least be a comment to explain
 368      * why.. -- WHN 2001-06-07 */
 369 #if !defined(LISP_FEATURE_MACH_EXCEPTION_HANDLER)
 370     undoably_install_low_level_interrupt_handler(SIGILL , sigill_handler);
 371     undoably_install_low_level_interrupt_handler(SIGTRAP, sigtrap_handler);
 372 #endif
 373
 374 #ifdef X86_64_SIGFPE_FIXUP
 375     undoably_install_low_level_interrupt_handler(SIGFPE, sigfpe_handler);
 376 #endif
 377
 378     SHOW("returning from arch_install_interrupt_handlers()");
 379 }
 380 \f
 381 /* This is implemented in assembly language and called from C: */
 382 extern lispobj
 383 call_into_lisp(lispobj fun, lispobj *args, int nargs);
 384
 385 /* These functions are an interface to the Lisp call-in facility.
 386  * Since this is C we can know nothing about the calling environment.
 387  * The control stack might be the C stack if called from the monitor
 388  * or the Lisp stack if called as a result of an interrupt or maybe
 389  * even a separate stack. The args are most likely on that stack but
 390  * could be in registers depending on what the compiler likes. So we
 391  * copy the args into a portable vector and let the assembly language
 392  * call-in function figure it out. */
 393
 394 lispobj
 395 funcall0(lispobj function)
 396 {
 397     lispobj *args = NULL;
 398
 399     FSHOW((stderr, "/entering funcall0(0x%lx)\n", (long)function));
 400     return call_into_lisp(function, args, 0);
 401 }
 402 lispobj
 403 funcall1(lispobj function, lispobj arg0)
 404 {
 405     lispobj args[1];
 406     args[0] = arg0;
 407     return call_into_lisp(function, args, 1);
 408 }
 409 lispobj
 410 funcall2(lispobj function, lispobj arg0, lispobj arg1)
 411 {
 412     lispobj args[2];
 413     args[0] = arg0;
 414     args[1] = arg1;
 415     return call_into_lisp(function, args, 2);
 416 }
 417 lispobj
 418 funcall3(lispobj function, lispobj arg0, lispobj arg1, lispobj arg2)
 419 {
 420     lispobj args[3];
 421     args[0] = arg0;
 422     args[1] = arg1;
 423     args[2] = arg2;
 424     return call_into_lisp(function, args, 3);
 425 }
 426
 427
 428 #ifdef LISP_FEATURE_LINKAGE_TABLE
 429 /* FIXME: It might be cleaner to generate these from the lisp side of
 430  * things.
 431  */
 432
 433 void
 434 arch_write_linkage_table_jmp(char * reloc, void * fun)
 435 {
 436     unsigned long addr = (unsigned long) fun;
 437     int i;
 438
 439     *reloc++ = 0xFF; /* Opcode for near jump to absolute reg/mem64. */
 440     *reloc++ = 0x25; /* ModRM #b00 100 101, i.e. RIP-relative. */
 441     *reloc++ = 0x00; /* 32-bit displacement field = 0 */
 442     *reloc++ = 0x00; /* ... */
 443     *reloc++ = 0x00; /* ... */
 444     *reloc++ = 0x00; /* ... */
 445
 446     for (i = 0; i < 8; i++) {
 447         *reloc++ = addr & 0xff;
 448         addr >>= 8;
 449     }
 450
 451     /* write a nop for good measure. */
 452     *reloc = 0x90;
 453 }
 454
 455 void
 456 arch_write_linkage_table_ref(void * reloc, void * data)
 457 {
 458     *(unsigned long *)reloc = (unsigned long)data;
 459 }
 460
 461 #endif
 462
 463 /* These setup and check *both* the sse2 and x87 FPUs. While lisp code
 464    only uses the sse2 FPU, other code (such as libc) may use the x87 FPU.
 465  */
 466
 467 unsigned int
 468 arch_get_fp_modes()
 469 {
 470     unsigned int temp;
 471     unsigned int result;
 472     /* return the x87 exception flags ored in with the sse2
 473      * control+status flags */
 474     asm ("fnstsw %0" : "=m" (temp));
 475     result = temp;
 476     result &= 0x3F;
 477     asm ("stmxcsr %0" : "=m" (temp));
 478     result |= temp;
 479     /* flip exception mask bits */
 480     return result ^ (0x3F << 7);
 481 }
 482
 483 struct fpenv
 484 {
 485     unsigned short cw;
 486     unsigned short unused1;
 487     unsigned short sw;
 488     unsigned short unused2;
 489     unsigned int other_regs[5];
 490 };
 491
 492 void
 493 arch_set_fp_modes(unsigned int mxcsr)
 494 {
 495     struct fpenv f_env;
 496     unsigned int temp;
 497
 498     /* turn trap enable bits into exception mask */
 499     mxcsr ^= 0x3F << 7;
 500
 501     /* set x87 modes */
 502     asm ("fnstenv %0" : "=m" (f_env));
 503     /* set control word: always long double precision
 504      * get traps and rounding from mxcsr word */
 505     f_env.cw = 0x300 | ((mxcsr >> 7) & 0x3F) | (((mxcsr >> 13) & 0x3) << 10);
 506     /* set status word: only override exception flags, from mxcsr */
 507     f_env.sw &= ~0x3F;
 508     f_env.sw |= (mxcsr & 0x3F);
 509
 510     asm ("fldenv %0" : : "m" (f_env));
 511
 512     /* now, simply, load up the mxcsr register */
 513     temp = mxcsr;
 514     asm ("ldmxcsr %0" : : "m" (temp));
 515 }