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 "llvm/CodeGen/MachineCodeEmitter.h"
  18 #include "llvm/Config/alloca.h"
  19 #include <cstdlib>
  20 #include <iostream>
  21 using namespace llvm;
  22
  23 void X86JITInfo::replaceMachineCodeForFunction(void *Old, void *New) {
  24   unsigned char *OldByte = (unsigned char *)Old;
  25   *OldByte++ = 0xE9;                // Emit JMP opcode.
  26   unsigned *OldWord = (unsigned *)OldByte;
  27   unsigned NewAddr = (intptr_t)New;
  28   unsigned OldAddr = (intptr_t)OldWord;
  29   *OldWord = NewAddr - OldAddr - 4; // Emit PC-relative addr of New code.
  30 }
  31
  32
  33 /// JITCompilerFunction - This contains the address of the JIT function used to
  34 /// compile a function lazily.
  35 static TargetJITInfo::JITCompilerFn JITCompilerFunction;
  36
  37 // Provide a wrapper for X86CompilationCallback2 that saves non-traditional
  38 // callee saved registers, for the fastcc calling convention.
  39 extern "C" {
  40 #if defined(__i386__) || defined(i386) || defined(_M_IX86)
  41 #ifndef _MSC_VER
  42   void X86CompilationCallback(void);
  43   asm(
  44     ".text\n"
  45     ".align 8\n"
  46     ".globl X86CompilationCallback\n"
  47   "X86CompilationCallback:\n"
  48     "pushl   %ebp\n"
  49     "movl    %esp, %ebp\n"    // Standard prologue
  50     "pushl   %eax\n"
  51     "pushl   %edx\n"          // save EAX/EDX
  52     "call X86CompilationCallback2\n"
  53     "popl    %edx\n"
  54     "popl    %eax\n"
  55     "popl    %ebp\n"
  56     "ret\n");
  57 #else
  58   extern "C" void *_AddressOfReturnAddress(void);
  59   #pragma intrinsic(_AddressOfReturnAddress)
  60
  61   void X86CompilationCallback2(void);
  62
  63   _declspec(naked) void X86CompilationCallback(void) {
  64     __asm {
  65       push  eax
  66       push  edx
  67       call  X86CompilationCallback2
  68       pop   edx
  69       pop   eax
  70       ret
  71     }
  72   }
  73 #endif // _MSC_VER
  74
  75 #else // Not an i386 host
  76   void X86CompilationCallback() {
  77     std::cerr << "Cannot call X86CompilationCallback() on a non-x86 arch!\n";
  78     abort();
  79   }
  80 #endif
  81 }
  82
  83 /// X86CompilationCallback - This is the target-specific function invoked by the
  84 /// function stub when we did not know the real target of a call.  This function
  85 /// must locate the start of the stub or call site and pass it into the JIT
  86 /// compiler function.
  87 extern "C" void X86CompilationCallback2() {
  88 #ifdef _MSC_VER
  89   assert(sizeof(size_t) == 4); // FIXME: handle Win64
  90   unsigned *RetAddrLoc = (unsigned *)_AddressOfReturnAddress();
  91   RetAddrLoc += 3;  // skip over ret addr, edx, eax
  92   unsigned RetAddr = *RetAddrLoc;
  93 #else
  94   unsigned *StackPtr = (unsigned*)__builtin_frame_address(1);
  95   unsigned RetAddr = (unsigned)(intptr_t)__builtin_return_address(1);
  96   unsigned *RetAddrLoc = &StackPtr[1];
  97
  98   // NOTE: __builtin_frame_address doesn't work if frame pointer elimination has
  99   // been performed.  Having a variable sized alloca disables frame pointer
 100   // elimination currently, even if it's dead.  This is a gross hack.
 101   alloca(10+(RetAddr >> 31));
 102
 103 #endif
 104   assert(*RetAddrLoc == RetAddr &&
 105          "Could not find return address on the stack!");
 106
 107   // It's a stub if there is an interrupt marker after the call.
 108   bool isStub = ((unsigned char*)(intptr_t)RetAddr)[0] == 0xCD;
 109
 110   // The call instruction should have pushed the return value onto the stack...
 111   RetAddr -= 4;  // Backtrack to the reference itself...
 112
 113 #if 0
 114   DEBUG(std::cerr << "In callback! Addr=" << (void*)RetAddr
 115                   << " ESP=" << (void*)StackPtr
 116                   << ": Resolving call to function: "
 117                   << TheVM->getFunctionReferencedName((void*)RetAddr) << "\n");
 118 #endif
 119
 120   // Sanity check to make sure this really is a call instruction.
 121   assert(((unsigned char*)(intptr_t)RetAddr)[-1] == 0xE8 &&"Not a call instr!");
 122
 123   unsigned NewVal = (intptr_t)JITCompilerFunction((void*)(intptr_t)RetAddr);
 124
 125   // Rewrite the call target... so that we don't end up here every time we
 126   // execute the call.
 127   *(unsigned*)(intptr_t)RetAddr = NewVal-RetAddr-4;
 128
 129   if (isStub) {
 130     // If this is a stub, rewrite the call into an unconditional branch
 131     // instruction so that two return addresses are not pushed onto the stack
 132     // when the requested function finally gets called.  This also makes the
 133     // 0xCD byte (interrupt) dead, so the marker doesn't effect anything.
 134     ((unsigned char*)(intptr_t)RetAddr)[-1] = 0xE9;
 135   }
 136
 137   // Change the return address to reexecute the call instruction...
 138   *RetAddrLoc -= 5;
 139 }
 140
 141 TargetJITInfo::LazyResolverFn
 142 X86JITInfo::getLazyResolverFunction(JITCompilerFn F) {
 143   JITCompilerFunction = F;
 144   return X86CompilationCallback;
 145 }
 146
 147 void *X86JITInfo::emitFunctionStub(void *Fn, MachineCodeEmitter &MCE) {
 148   if (Fn != X86CompilationCallback) {
 149     MCE.startFunctionStub(5);
 150     MCE.emitByte(0xE9);
 151     MCE.emitWord((intptr_t)Fn-MCE.getCurrentPCValue()-4);
 152     return MCE.finishFunctionStub(0);
 153   }
 154
 155   MCE.startFunctionStub(6);
 156   MCE.emitByte(0xE8);   // Call with 32 bit pc-rel destination...
 157
 158   MCE.emitWord((intptr_t)Fn-MCE.getCurrentPCValue()-4);
 159
 160   MCE.emitByte(0xCD);   // Interrupt - Just a marker identifying the stub!
 161   return MCE.finishFunctionStub(0);
 162 }
 163
 164 /// relocate - Before the JIT can run a block of code that has been emitted,
 165 /// it must rewrite the code to contain the actual addresses of any
 166 /// referenced global symbols.
 167 void X86JITInfo::relocate(void *Function, MachineRelocation *MR,
 168                           unsigned NumRelocs) {
 169   for (unsigned i = 0; i != NumRelocs; ++i, ++MR) {
 170     void *RelocPos = (char*)Function + MR->getMachineCodeOffset();
 171     intptr_t ResultPtr = (intptr_t)MR->getResultPointer();
 172     switch ((X86::RelocationType)MR->getRelocationType()) {
 173     case X86::reloc_pcrel_word:
 174       // PC relative relocation, add the relocated value to the value already in
 175       // memory, after we adjust it for where the PC is.
 176       ResultPtr = ResultPtr-(intptr_t)RelocPos-4;
 177       *((intptr_t*)RelocPos) += ResultPtr;
 178       break;
 179     case X86::reloc_absolute_word:
 180       // Absolute relocation, just add the relocated value to the value already
 181       // in memory.
 182       *((intptr_t*)RelocPos) += ResultPtr;
 183       break;
 184     }
 185   }
 186 }