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