lib/Target/X86/X86JITInfo.cpp

   1 //===-- X86JITInfo.cpp - Implement the JIT interfaces for the X86 target --===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements the JIT interfaces for the X86 target.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #define DEBUG_TYPE "jit"
  15 #include "X86JITInfo.h"
  16 #include "X86Relocations.h"
  17 #include "X86Subtarget.h"
  18 #include "llvm/CodeGen/MachineCodeEmitter.h"
  19 #include "llvm/Config/alloca.h"
  20 #include <cstdlib>
  21 using namespace llvm;
  22
  23 #ifdef _MSC_VER
  24   extern "C" void *_AddressOfReturnAddress(void);
  25   #pragma intrinsic(_AddressOfReturnAddress)
  26 #endif
  27
  28 void X86JITInfo::replaceMachineCodeForFunction(void *Old, void *New) {
  29   unsigned char *OldByte = (unsigned char *)Old;
  30   *OldByte++ = 0xE9;                // Emit JMP opcode.
  31   unsigned *OldWord = (unsigned *)OldByte;
  32   unsigned NewAddr = (intptr_t)New;
  33   unsigned OldAddr = (intptr_t)OldWord;
  34   *OldWord = NewAddr - OldAddr - 4; // Emit PC-relative addr of New code.
  35 }
  36
  37
  38 /// JITCompilerFunction - This contains the address of the JIT function used to
  39 /// compile a function lazily.
  40 static TargetJITInfo::JITCompilerFn JITCompilerFunction;
  41
  42 // Get the ASMPREFIX for the current host.  This is often '_'.
  43 #ifndef __USER_LABEL_PREFIX__
  44 #define __USER_LABEL_PREFIX__
  45 #endif
  46 #define GETASMPREFIX2(X) #X
  47 #define GETASMPREFIX(X) GETASMPREFIX2(X)
  48 #define ASMPREFIX GETASMPREFIX(__USER_LABEL_PREFIX__)
  49
  50 // Provide a convenient way for disabling usage of CFI directives.
  51 // This is needed for old/broken assemblers (for example, gas on
  52 // Darwin is pretty old and doesn't support these directives)
  53 #if defined(__APPLE__)
  54 # define CFI(x)
  55 #else
  56 # define CFI(x) x
  57 #endif
  58
  59 // Provide a wrapper for X86CompilationCallback2 that saves non-traditional
  60 // callee saved registers, for the fastcc calling convention.
  61 extern "C" {
  62 #if defined(__x86_64__)
  63   // No need to save EAX/EDX for X86-64.
  64   void X86CompilationCallback(void);
  65   asm(
  66     ".text\n"
  67     ".align 8\n"
  68     ".globl " ASMPREFIX "X86CompilationCallback\n"
  69   ASMPREFIX "X86CompilationCallback:\n"
  70     CFI(".cfi_startproc\n")
  71     // Save RBP
  72     "pushq   %rbp\n"
  73     CFI(".cfi_def_cfa_offset 16\n")
  74     CFI(".cfi_offset %rbp, -16\n")
  75     // Save RSP
  76     "movq    %rsp, %rbp\n"
  77     CFI(".cfi_def_cfa_register %rbp\n")
  78     // Save all int arg registers
  79     "pushq   %rdi\n"
  80     CFI(".cfi_rel_offset %rdi, 0\n")
  81     "pushq   %rsi\n"
  82     CFI(".cfi_rel_offset %rsi, 8\n")
  83     "pushq   %rdx\n"
  84     CFI(".cfi_rel_offset %rdx, 16\n")
  85     "pushq   %rcx\n"
  86     CFI(".cfi_rel_offset %rcx, 24\n")
  87     "pushq   %r8\n"
  88     CFI(".cfi_rel_offset %r8, 32\n")
  89     "pushq   %r9\n"
  90     CFI(".cfi_rel_offset %r9, 40\n")
  91     // Align stack on 16-byte boundary. ESP might not be properly aligned
  92     // (8 byte) if this is called from an indirect stub.
  93     "andq    $-16, %rsp\n"
  94     // Save all XMM arg registers
  95     "subq    $128, %rsp\n"
  96     "movaps  %xmm0, (%rsp)\n"
  97     "movaps  %xmm1, 16(%rsp)\n"
  98     "movaps  %xmm2, 32(%rsp)\n"
  99     "movaps  %xmm3, 48(%rsp)\n"
 100     "movaps  %xmm4, 64(%rsp)\n"
 101     "movaps  %xmm5, 80(%rsp)\n"
 102     "movaps  %xmm6, 96(%rsp)\n"
 103     "movaps  %xmm7, 112(%rsp)\n"
 104     // JIT callee
 105     "movq    %rbp, %rdi\n"    // Pass prev frame and return address
 106     "movq    8(%rbp), %rsi\n"
 107     "call    " ASMPREFIX "X86CompilationCallback2\n"
 108     // Restore all XMM arg registers
 109     "movaps  112(%rsp), %xmm7\n"
 110     "movaps  96(%rsp), %xmm6\n"
 111     "movaps  80(%rsp), %xmm5\n"
 112     "movaps  64(%rsp), %xmm4\n"
 113     "movaps  48(%rsp), %xmm3\n"
 114     "movaps  32(%rsp), %xmm2\n"
 115     "movaps  16(%rsp), %xmm1\n"
 116     "movaps  (%rsp), %xmm0\n"
 117     // Restore RSP
 118     "movq    %rbp, %rsp\n"
 119     CFI(".cfi_def_cfa_register esp\n")
 120     // Restore all int arg registers
 121     "subq    $48, %rsp\n"
 122     CFI(".cfi_adjust_cfa_offset 48\n")
 123     "popq    %r9\n"
 124     CFI(".cfi_adjust_cfa_offset -8\n")
 125     CFI(".cfi_restore %r9\n")
 126     "popq    %r8\n"
 127     CFI(".cfi_adjust_cfa_offset -8\n")
 128     CFI(".cfi_restore %r8\n")
 129     "popq    %rcx\n"
 130     CFI(".cfi_adjust_cfa_offset -8\n")
 131     CFI(".cfi_restore %rcx\n")
 132     "popq    %rdx\n"
 133     CFI(".cfi_adjust_cfa_offset -8\n")
 134     CFI(".cfi_restore %rdx\n")
 135     "popq    %rsi\n"
 136     CFI(".cfi_adjust_cfa_offset -8\n")
 137     CFI(".cfi_restore %rsi\n")
 138     "popq    %rdi\n"
 139     CFI(".cfi_adjust_cfa_offset -8\n")
 140     CFI(".cfi_restore %rdi\n")
 141     // Restore RBP
 142     "popq    %rbp\n"
 143     CFI(".cfi_adjust_cfa_offset -8\n")
 144     CFI(".cfi_restore %rbp\n")
 145     "ret\n"
 146     CFI(".cfi_endproc\n")
 147   );
 148 #elif defined(__i386__) || defined(i386) || defined(_M_IX86)
 149 #ifndef _MSC_VER
 150   void X86CompilationCallback(void);
 151   asm(
 152     ".text\n"
 153     ".align 8\n"
 154     ".globl " ASMPREFIX  "X86CompilationCallback\n"
 155   ASMPREFIX "X86CompilationCallback:\n"
 156     CFI(".cfi_startproc\n")
 157     "pushl   %ebp\n"
 158     CFI(".cfi_def_cfa_offset 8\n")
 159     CFI(".cfi_offset %ebp, -8\n")
 160     "movl    %esp, %ebp\n"    // Standard prologue
 161     CFI(".cfi_def_cfa_register %ebp\n")
 162     "pushl   %eax\n"
 163     CFI(".cfi_rel_offset %eax, 0\n")
 164     "pushl   %edx\n"          // Save EAX/EDX/ECX
 165     CFI(".cfi_rel_offset %edx, 4\n")
 166     "pushl   %ecx\n"
 167     CFI(".cfi_rel_offset %ecx, 8\n")
 168 #if defined(__APPLE__)
 169     "andl    $-16, %esp\n"    // Align ESP on 16-byte boundary
 170 #endif
 171     "subl    $16, %esp\n"
 172     "movl    4(%ebp), %eax\n" // Pass prev frame and return address
 173     "movl    %eax, 4(%esp)\n"
 174     "movl    %ebp, (%esp)\n"
 175     "call    " ASMPREFIX "X86CompilationCallback2\n"
 176     "movl    %ebp, %esp\n"    // Restore ESP
 177     CFI(".cfi_def_cfa_register %esp\n")
 178     "subl    $12, %esp\n"
 179     CFI(".cfi_adjust_cfa_offset 12\n")
 180     "popl    %ecx\n"
 181     CFI(".cfi_adjust_cfa_offset -4\n")
 182     CFI(".cfi_restore %ecx\n")
 183     "popl    %edx\n"
 184     CFI(".cfi_adjust_cfa_offset -4\n")
 185     CFI(".cfi_restore %edx\n")
 186     "popl    %eax\n"
 187     CFI(".cfi_adjust_cfa_offset -4\n")
 188     CFI(".cfi_restore %eax\n")
 189     "popl    %ebp\n"
 190     CFI(".cfi_adjust_cfa_offset -4\n")
 191     CFI(".cfi_restore %ebp\n")
 192     "ret\n"
 193     CFI(".cfi_endproc\n")
 194   );
 195
 196   // Same as X86CompilationCallback but also saves XMM argument registers.
 197   void X86CompilationCallback_SSE(void);
 198   asm(
 199     ".text\n"
 200     ".align 8\n"
 201     ".globl " ASMPREFIX  "X86CompilationCallback_SSE\n"
 202   ASMPREFIX "X86CompilationCallback_SSE:\n"
 203     CFI(".cfi_startproc\n")
 204     "pushl   %ebp\n"
 205     CFI(".cfi_def_cfa_offset 8\n")
 206     CFI(".cfi_offset %ebp, -8\n")
 207     "movl    %esp, %ebp\n"    // Standard prologue
 208     CFI(".cfi_def_cfa_register %ebp\n")
 209     "pushl   %eax\n"
 210     CFI(".cfi_rel_offset %eax, 0\n")
 211     "pushl   %edx\n"          // Save EAX/EDX/ECX
 212     CFI(".cfi_rel_offset %edx, 4\n")
 213     "pushl   %ecx\n"
 214     CFI(".cfi_rel_offset %ecx, 8\n")
 215     "andl    $-16, %esp\n"    // Align ESP on 16-byte boundary
 216     // Save all XMM arg registers
 217     "subl    $64, %esp\n"
 218     // FIXME: provide frame move information for xmm registers.
 219     // This can be tricky, because CFA register is ebp (unaligned)
 220     // and we need to produce offsets relative to it.
 221     "movaps  %xmm0, (%esp)\n"
 222     "movaps  %xmm1, 16(%esp)\n"
 223     "movaps  %xmm2, 32(%esp)\n"
 224     "movaps  %xmm3, 48(%esp)\n"
 225     "subl    $16, %esp\n"
 226     "movl    4(%ebp), %eax\n" // Pass prev frame and return address
 227     "movl    %eax, 4(%esp)\n"
 228     "movl    %ebp, (%esp)\n"
 229     "call    " ASMPREFIX "X86CompilationCallback2\n"
 230     "addl    $16, %esp\n"
 231     "movaps  48(%esp), %xmm3\n"
 232     CFI(".cfi_restore %xmm3\n")
 233     "movaps  32(%esp), %xmm2\n"
 234     CFI(".cfi_restore %xmm2\n")
 235     "movaps  16(%esp), %xmm1\n"
 236     CFI(".cfi_restore %xmm1\n")
 237     "movaps  (%esp), %xmm0\n"
 238     CFI(".cfi_restore %xmm0\n")
 239     "movl    %ebp, %esp\n"    // Restore ESP
 240     CFI(".cfi_def_cfa_register esp\n")
 241     "subl    $12, %esp\n"
 242     CFI(".cfi_adjust_cfa_offset 12\n")
 243     "popl    %ecx\n"
 244     CFI(".cfi_adjust_cfa_offset -4\n")
 245     CFI(".cfi_restore %ecx\n")
 246     "popl    %edx\n"
 247     CFI(".cfi_adjust_cfa_offset -4\n")
 248     CFI(".cfi_restore %edx\n")
 249     "popl    %eax\n"
 250     CFI(".cfi_adjust_cfa_offset -4\n")
 251     CFI(".cfi_restore %eax\n")
 252     "popl    %ebp\n"
 253     CFI(".cfi_adjust_cfa_offset -4\n")
 254     CFI(".cfi_restore %ebp\n")
 255     "ret\n"
 256     CFI(".cfi_endproc\n")
 257   );
 258 #else
 259   void X86CompilationCallback2(void);
 260
 261   _declspec(naked) void X86CompilationCallback(void) {
 262     __asm {
 263       push  eax
 264       push  edx
 265       push  ecx
 266       call  X86CompilationCallback2
 267       pop   ecx
 268       pop   edx
 269       pop   eax
 270       ret
 271     }
 272   }
 273 #endif // _MSC_VER
 274
 275 #else // Not an i386 host
 276   void X86CompilationCallback() {
 277     assert(0 && "Cannot call X86CompilationCallback() on a non-x86 arch!\n");
 278     abort();
 279   }
 280 #endif
 281 }
 282
 283 /// X86CompilationCallback - This is the target-specific function invoked by the
 284 /// function stub when we did not know the real target of a call.  This function
 285 /// must locate the start of the stub or call site and pass it into the JIT
 286 /// compiler function.
 287 #ifdef _MSC_VER
 288 extern "C" void X86CompilationCallback2() {
 289   assert(sizeof(size_t) == 4); // FIXME: handle Win64
 290   intptr_t *RetAddrLoc = (intptr_t *)_AddressOfReturnAddress();
 291   RetAddrLoc += 4;  // skip over ret addr, edx, eax, ecx
 292   intptr_t RetAddr = *RetAddrLoc;
 293 #else
 294 extern "C" void X86CompilationCallback2(intptr_t *StackPtr, intptr_t RetAddr) {
 295   intptr_t *RetAddrLoc = &StackPtr[1];
 296 #endif
 297   assert(*RetAddrLoc == RetAddr &&
 298          "Could not find return address on the stack!");
 299
 300   // It's a stub if there is an interrupt marker after the call.
 301   bool isStub = ((unsigned char*)RetAddr)[0] == 0xCD;
 302
 303   // The call instruction should have pushed the return value onto the stack...
 304 #ifdef __x86_64__
 305   RetAddr--;     // Backtrack to the reference itself...
 306 #else
 307   RetAddr -= 4;  // Backtrack to the reference itself...
 308 #endif
 309
 310 #if 0
 311   DOUT << "In callback! Addr=" << (void*)RetAddr
 312        << " ESP=" << (void*)StackPtr
 313        << ": Resolving call to function: "
 314        << TheVM->getFunctionReferencedName((void*)RetAddr) << "\n";
 315 #endif
 316
 317   // Sanity check to make sure this really is a call instruction.
 318 #ifdef __x86_64__
 319   assert(((unsigned char*)RetAddr)[-2] == 0x41 &&"Not a call instr!");
 320   assert(((unsigned char*)RetAddr)[-1] == 0xFF &&"Not a call instr!");
 321 #else
 322   assert(((unsigned char*)RetAddr)[-1] == 0xE8 &&"Not a call instr!");
 323 #endif
 324
 325   intptr_t NewVal = (intptr_t)JITCompilerFunction((void*)RetAddr);
 326
 327   // Rewrite the call target... so that we don't end up here every time we
 328   // execute the call.
 329 #ifdef __x86_64__
 330   *(intptr_t *)(RetAddr - 0xa) = NewVal;
 331 #else
 332   *(intptr_t *)RetAddr = (intptr_t)(NewVal-RetAddr-4);
 333 #endif
 334
 335   if (isStub) {
 336     // If this is a stub, rewrite the call into an unconditional branch
 337     // instruction so that two return addresses are not pushed onto the stack
 338     // when the requested function finally gets called.  This also makes the
 339     // 0xCD byte (interrupt) dead, so the marker doesn't effect anything.
 340 #ifdef __x86_64__
 341     ((unsigned char*)RetAddr)[0] = (2 | (4 << 3) | (3 << 6));
 342 #else
 343     ((unsigned char*)RetAddr)[-1] = 0xE9;
 344 #endif
 345   }
 346
 347   // Change the return address to reexecute the call instruction...
 348 #ifdef __x86_64__
 349   *RetAddrLoc -= 0xd;
 350 #else
 351   *RetAddrLoc -= 5;
 352 #endif
 353 }
 354
 355 TargetJITInfo::LazyResolverFn
 356 X86JITInfo::getLazyResolverFunction(JITCompilerFn F) {
 357   JITCompilerFunction = F;
 358
 359 #if (defined(__i386__) || defined(i386) || defined(_M_IX86)) && \
 360   !defined(_MSC_VER) && !defined(__x86_64__)
 361   unsigned EAX = 0, EBX = 0, ECX = 0, EDX = 0;
 362   union {
 363     unsigned u[3];
 364     char     c[12];
 365   } text;
 366
 367   if (!X86::GetCpuIDAndInfo(0, &EAX, text.u+0, text.u+2, text.u+1)) {
 368     // FIXME: support for AMD family of processors.
 369     if (memcmp(text.c, "GenuineIntel", 12) == 0) {
 370       X86::GetCpuIDAndInfo(0x1, &EAX, &EBX, &ECX, &EDX);
 371       if ((EDX >> 25) & 0x1)
 372         return X86CompilationCallback_SSE;
 373     }
 374   }
 375 #endif
 376
 377   return X86CompilationCallback;
 378 }
 379
 380 void *X86JITInfo::emitFunctionStub(void *Fn, MachineCodeEmitter &MCE) {
 381   // Note, we cast to intptr_t here to silence a -pedantic warning that
 382   // complains about casting a function pointer to a normal pointer.
 383 #if (defined(__i386__) || defined(i386) || defined(_M_IX86)) && \
 384   !defined(_MSC_VER) && !defined(__x86_64__)
 385   bool NotCC = (Fn != (void*)(intptr_t)X86CompilationCallback &&
 386                 Fn != (void*)(intptr_t)X86CompilationCallback_SSE);
 387 #else
 388   bool NotCC = Fn != (void*)(intptr_t)X86CompilationCallback;
 389 #endif
 390   if (NotCC) {
 391 #ifdef __x86_64__
 392     MCE.startFunctionStub(13, 4);
 393     MCE.emitByte(0x49);          // REX prefix
 394     MCE.emitByte(0xB8+2);        // movabsq r10
 395     MCE.emitWordLE(((unsigned *)&Fn)[0]);
 396     MCE.emitWordLE(((unsigned *)&Fn)[1]);
 397     MCE.emitByte(0x41);          // REX prefix
 398     MCE.emitByte(0xFF);          // jmpq *r10
 399     MCE.emitByte(2 | (4 << 3) | (3 << 6));
 400 #else
 401     MCE.startFunctionStub(5, 4);
 402     MCE.emitByte(0xE9);
 403     MCE.emitWordLE((intptr_t)Fn-MCE.getCurrentPCValue()-4);
 404 #endif
 405     return MCE.finishFunctionStub(0);
 406   }
 407
 408 #ifdef __x86_64__
 409   MCE.startFunctionStub(14, 4);
 410   MCE.emitByte(0x49);          // REX prefix
 411   MCE.emitByte(0xB8+2);        // movabsq r10
 412   MCE.emitWordLE(((unsigned *)&Fn)[0]);
 413   MCE.emitWordLE(((unsigned *)&Fn)[1]);
 414   MCE.emitByte(0x41);          // REX prefix
 415   MCE.emitByte(0xFF);          // callq *r10
 416   MCE.emitByte(2 | (2 << 3) | (3 << 6));
 417 #else
 418   MCE.startFunctionStub(6, 4);
 419   MCE.emitByte(0xE8);   // Call with 32 bit pc-rel destination...
 420
 421   MCE.emitWordLE((intptr_t)Fn-MCE.getCurrentPCValue()-4);
 422 #endif
 423
 424   MCE.emitByte(0xCD);   // Interrupt - Just a marker identifying the stub!
 425   return MCE.finishFunctionStub(0);
 426 }
 427
 428 /// relocate - Before the JIT can run a block of code that has been emitted,
 429 /// it must rewrite the code to contain the actual addresses of any
 430 /// referenced global symbols.
 431 void X86JITInfo::relocate(void *Function, MachineRelocation *MR,
 432                           unsigned NumRelocs, unsigned char* GOTBase) {
 433   for (unsigned i = 0; i != NumRelocs; ++i, ++MR) {
 434     void *RelocPos = (char*)Function + MR->getMachineCodeOffset();
 435     intptr_t ResultPtr = (intptr_t)MR->getResultPointer();
 436     switch ((X86::RelocationType)MR->getRelocationType()) {
 437     case X86::reloc_pcrel_word: {
 438       // PC relative relocation, add the relocated value to the value already in
 439       // memory, after we adjust it for where the PC is.
 440       ResultPtr = ResultPtr-(intptr_t)RelocPos-4-MR->getConstantVal();
 441       *((unsigned*)RelocPos) += (unsigned)ResultPtr;
 442       break;
 443     }
 444     case X86::reloc_absolute_word:
 445       // Absolute relocation, just add the relocated value to the value already
 446       // in memory.
 447       *((unsigned*)RelocPos) += (unsigned)ResultPtr;
 448       break;
 449     case X86::reloc_absolute_dword:
 450       *((intptr_t*)RelocPos) += ResultPtr;
 451       break;
 452     }
 453   }
 454 }