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