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
 166 void
 167 arch_do_displaced_inst(os_context_t *context, unsigned int orig_inst)
 168 {
 169     unsigned int *pc = (unsigned int*)(*os_context_pc_addr(context));
 170
 171     /* Put the original instruction back. */
 172     *((char *)pc) = orig_inst & 0xff;
 173     *((char *)pc + 1) = (orig_inst & 0xff00) >> 8;
 174 }
 175 \f
 176 void
 177 sigtrap_handler(int signal, siginfo_t *info, void *void_context)
 178 {
 179     int code = info->si_code;
 180     os_context_t *context = (os_context_t*)void_context;
 181     unsigned int trap;
 182
 183     /* This is just for info in case the monitor wants to print an
 184      * approximation. */
 185     current_control_stack_pointer =
 186         (lispobj *)*os_context_sp_addr(context);
 187
 188 #ifdef LISP_FEATURE_LINUX
 189     os_restore_fp_control(context);
 190 #endif
 191
 192     /* On entry %eip points just after the INT3 byte and aims at the
 193      * 'kind' value (eg trap_Cerror). For error-trap and Cerror-trap a
 194      * number of bytes will follow, the first is the length of the byte
 195      * arguments to follow. */
 196     trap = *(unsigned char *)(*os_context_pc_addr(context));
 197     switch (trap) {
 198
 199     case trap_PendingInterrupt:
 200         FSHOW((stderr, "/<trap pending interrupt>\n"));
 201         arch_skip_instruction(context);
 202         interrupt_handle_pending(context);
 203         break;
 204
 205     case trap_Halt:
 206         /* Note: the old CMU CL code tried to save FPU state
 207          * here, and restore it after we do our thing, but there
 208          * seems to be no point in doing that, since we're just
 209          * going to lose(..) anyway. */
 210         fake_foreign_function_call(context);
 211         lose("%%PRIMITIVE HALT called; the party is over.\n");
 212
 213     case trap_Error:
 214     case trap_Cerror:
 215         FSHOW((stderr, "<trap error/cerror %d>\n", code));
 216         interrupt_internal_error(signal, info, context, code==trap_Cerror);
 217         break;
 218
 219     case trap_Breakpoint:
 220         --*os_context_pc_addr(context);
 221         handle_breakpoint(signal, info, context);
 222         break;
 223
 224     case trap_FunEndBreakpoint:
 225         --*os_context_pc_addr(context);
 226         *os_context_pc_addr(context) =
 227             (unsigned long)handle_fun_end_breakpoint(signal, info, context);
 228         break;
 229
 230     default:
 231         FSHOW((stderr,"/[C--trap default %d %d %x]\n",
 232                signal, code, context));
 233         interrupt_handle_now(signal, info, context);
 234         break;
 235     }
 236 }
 237
 238 static void
 239 sigill_handler(int signal, siginfo_t *siginfo, void *void_context) {
 240     os_context_t *context = (os_context_t*)void_context;
 241     fake_foreign_function_call(context);
 242     monitor_or_something();
 243 }
 244
 245 void
 246 arch_install_interrupt_handlers()
 247 {
 248     SHOW("entering arch_install_interrupt_handlers()");
 249
 250     /* Note: The old CMU CL code here used sigtrap_handler() to handle
 251      * SIGILL as well as SIGTRAP. I couldn't see any reason to do
 252      * things that way. So, I changed to separate handlers when
 253      * debugging a problem on OpenBSD, where SBCL wasn't catching
 254      * SIGILL properly, but was instead letting the process be
 255      * terminated with an "Illegal instruction" output. If this change
 256      * turns out to break something (maybe breakpoint handling on some
 257      * OS I haven't tested on?) and we have to go back to the old CMU
 258      * CL way, I hope there will at least be a comment to explain
 259      * why.. -- WHN 2001-06-07 */
 260     undoably_install_low_level_interrupt_handler(SIGILL , sigill_handler);
 261     undoably_install_low_level_interrupt_handler(SIGTRAP, sigtrap_handler);
 262
 263     SHOW("returning from arch_install_interrupt_handlers()");
 264 }
 265 \f
 266 /* This is implemented in assembly language and called from C: */
 267 extern lispobj
 268 call_into_lisp(lispobj fun, lispobj *args, int nargs);
 269
 270 /* These functions are an interface to the Lisp call-in facility.
 271  * Since this is C we can know nothing about the calling environment.
 272  * The control stack might be the C stack if called from the monitor
 273  * or the Lisp stack if called as a result of an interrupt or maybe
 274  * even a separate stack. The args are most likely on that stack but
 275  * could be in registers depending on what the compiler likes. So we
 276  * copy the args into a portable vector and let the assembly language
 277  * call-in function figure it out. */
 278
 279 lispobj
 280 funcall0(lispobj function)
 281 {
 282     lispobj *args = NULL;
 283
 284     FSHOW((stderr, "/entering funcall0(0x%lx)\n", (long)function));
 285     return call_into_lisp(function, args, 0);
 286 }
 287 lispobj
 288 funcall1(lispobj function, lispobj arg0)
 289 {
 290     lispobj args[1];
 291     args[0] = arg0;
 292     return call_into_lisp(function, args, 1);
 293 }
 294 lispobj
 295 funcall2(lispobj function, lispobj arg0, lispobj arg1)
 296 {
 297     lispobj args[2];
 298     args[0] = arg0;
 299     args[1] = arg1;
 300     return call_into_lisp(function, args, 2);
 301 }
 302 lispobj
 303 funcall3(lispobj function, lispobj arg0, lispobj arg1, lispobj arg2)
 304 {
 305     lispobj args[3];
 306     args[0] = arg0;
 307     args[1] = arg1;
 308     args[2] = arg2;
 309     return call_into_lisp(function, args, 3);
 310 }
 311
 312
 313 #ifdef LISP_FEATURE_LINKAGE_TABLE
 314 /* FIXME: It might be cleaner to generate these from the lisp side of
 315  * things.
 316  */
 317
 318 void
 319 arch_write_linkage_table_jmp(char * reloc, void * fun)
 320 {
 321     unsigned long addr = (unsigned long) fun;
 322     int i;
 323
 324     *reloc++ = 0xFF; /* Opcode for near jump to absolute reg/mem64. */
 325     *reloc++ = 0x25; /* ModRM #b00 100 101, i.e. RIP-relative. */
 326     *reloc++ = 0x00; /* 32-bit displacement field = 0 */
 327     *reloc++ = 0x00; /* ... */
 328     *reloc++ = 0x00; /* ... */
 329     *reloc++ = 0x00; /* ... */
 330
 331     for (i = 0; i < 8; i++) {
 332         *reloc++ = addr & 0xff;
 333         addr >>= 8;
 334     }
 335
 336     /* write a nop for good measure. */
 337     *reloc = 0x90;
 338 }
 339
 340 void
 341 arch_write_linkage_table_ref(void * reloc, void * data)
 342 {
 343     *(unsigned long *)reloc = (unsigned long)data;
 344 }
 345
 346 #endif
 347
 348 /* These setup and check *both* the sse2 and x87 FPUs. While lisp code
 349    only uses the sse2 FPU, other code (such as libc) may use the x87 FPU.
 350  */
 351
 352 unsigned int
 353 arch_get_fp_modes()
 354 {
 355     unsigned int temp;
 356     unsigned int result;
 357     /* return the x87 exception flags ored in with the sse2
 358      * control+status flags */
 359     asm ("fnstsw %0" : "=m" (temp));
 360     result = temp;
 361     result &= 0x3F;
 362     asm ("stmxcsr %0" : "=m" (temp));
 363     result |= temp;
 364     /* flip exception mask bits */
 365     return result ^ (0x3F << 7);
 366 }
 367
 368 struct fpenv
 369 {
 370     unsigned short cw;
 371     unsigned short unused1;
 372     unsigned short sw;
 373     unsigned short unused2;
 374     unsigned int other_regs[5];
 375 };
 376
 377 void
 378 arch_set_fp_modes(unsigned int mxcsr)
 379 {
 380     struct fpenv f_env;
 381     unsigned int temp;
 382
 383     /* turn trap enable bits into exception mask */
 384     mxcsr ^= 0x3F << 7;
 385
 386     /* set x87 modes */
 387     asm ("fnstenv %0" : "=m" (f_env));
 388     /* set control word: always long double precision
 389      * get traps and rounding from mxcsr word */
 390     f_env.cw = 0x300 | ((mxcsr >> 7) & 0x3F) | (((mxcsr >> 13) & 0x3) << 10);
 391     /* set status word: only override exception flags, from mxcsr */
 392     f_env.sw &= ~0x3F;
 393     f_env.sw |= (mxcsr & 0x3F);
 394
 395     asm ("fldenv %0" : : "m" (f_env));
 396
 397     /* now, simply, load up the mxcsr register */
 398     temp = mxcsr;
 399     asm ("ldmxcsr %0" : : "m" (temp));
 400 }