lib/ExecutionEngine/JIT/JITEmitter.cpp

   1 //===-- JITEmitter.cpp - Write machine code to executable memory ----------===//
   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 defines a MachineCodeEmitter object that is used by the JIT to
  11 // write machine code to memory and remember where relocatable values are.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #define DEBUG_TYPE "jit"
  16 #include "JIT.h"
  17 #include "llvm/Constant.h"
  18 #include "llvm/Module.h"
  19 #include "llvm/CodeGen/MachineCodeEmitter.h"
  20 #include "llvm/CodeGen/MachineFunction.h"
  21 #include "llvm/CodeGen/MachineConstantPool.h"
  22 #include "llvm/CodeGen/MachineRelocation.h"
  23 #include "llvm/Target/TargetData.h"
  24 #include "llvm/Target/TargetJITInfo.h"
  25 #include "llvm/Support/Debug.h"
  26 #include "llvm/ADT/Statistic.h"
  27 #include "llvm/System/Memory.h"
  28 using namespace llvm;
  29
  30 namespace {
  31   Statistic<> NumBytes("jit", "Number of bytes of machine code compiled");
  32   JIT *TheJIT = 0;
  33 }
  34
  35
  36 //===----------------------------------------------------------------------===//
  37 // JITMemoryManager code.
  38 //
  39 namespace {
  40   /// JITMemoryManager - Manage memory for the JIT code generation in a logical,
  41   /// sane way.  This splits a large block of MAP_NORESERVE'd memory into two
  42   /// sections, one for function stubs, one for the functions themselves.  We
  43   /// have to do this because we may need to emit a function stub while in the
  44   /// middle of emitting a function, and we don't know how large the function we
  45   /// are emitting is.  This never bothers to release the memory, because when
  46   /// we are ready to destroy the JIT, the program exits.
  47   class JITMemoryManager {
  48     sys::MemoryBlock  MemBlock;  // Virtual memory block allocated RWX
  49     unsigned char *MemBase;      // Base of block of memory, start of stub mem
  50     unsigned char *FunctionBase; // Start of the function body area
  51     unsigned char *ConstantPool; // Memory allocated for constant pools
  52     unsigned char *CurStubPtr, *CurFunctionPtr, *CurConstantPtr;
  53   public:
  54     JITMemoryManager();
  55     ~JITMemoryManager();
  56
  57     inline unsigned char *allocateStub(unsigned StubSize);
  58     inline unsigned char *allocateConstant(unsigned ConstantSize,
  59                                            unsigned Alignment);
  60     inline unsigned char *startFunctionBody();
  61     inline void endFunctionBody(unsigned char *FunctionEnd);
  62   };
  63 }
  64
  65 JITMemoryManager::JITMemoryManager() {
  66   // Allocate a 16M block of memory...
  67   MemBlock = sys::Memory::AllocateRWX((16 << 20));
  68   MemBase = reinterpret_cast<unsigned char*>(MemBlock.base());
  69   FunctionBase = MemBase + 512*1024; // Use 512k for stubs
  70
  71   // Allocate stubs backwards from the function base, allocate functions forward
  72   // from the function base.
  73   CurStubPtr = CurFunctionPtr = FunctionBase;
  74
  75   ConstantPool = new unsigned char [512*1024]; // Use 512k for constant pools
  76   CurConstantPtr = ConstantPool + 512*1024;
  77 }
  78
  79 JITMemoryManager::~JITMemoryManager() {
  80   sys::Memory::ReleaseRWX(MemBlock);
  81   delete[] ConstantPool;
  82 }
  83
  84 unsigned char *JITMemoryManager::allocateStub(unsigned StubSize) {
  85   CurStubPtr -= StubSize;
  86   if (CurStubPtr < MemBase) {
  87     std::cerr << "JIT ran out of memory for function stubs!\n";
  88     abort();
  89   }
  90   return CurStubPtr;
  91 }
  92
  93 unsigned char *JITMemoryManager::allocateConstant(unsigned ConstantSize,
  94                                                   unsigned Alignment) {
  95   // Reserve space and align pointer.
  96   CurConstantPtr -= ConstantSize;
  97   CurConstantPtr =
  98     (unsigned char *)((intptr_t)CurConstantPtr & ~((intptr_t)Alignment - 1));
  99
 100   if (CurConstantPtr < ConstantPool) {
 101     std::cerr << "JIT ran out of memory for constant pools!\n";
 102     abort();
 103   }
 104   return CurConstantPtr;
 105 }
 106
 107 unsigned char *JITMemoryManager::startFunctionBody() {
 108   // Round up to an even multiple of 8 bytes, this should eventually be target
 109   // specific.
 110   return (unsigned char*)(((intptr_t)CurFunctionPtr + 7) & ~7);
 111 }
 112
 113 void JITMemoryManager::endFunctionBody(unsigned char *FunctionEnd) {
 114   assert(FunctionEnd > CurFunctionPtr);
 115   CurFunctionPtr = FunctionEnd;
 116 }
 117
 118 //===----------------------------------------------------------------------===//
 119 // JIT lazy compilation code.
 120 //
 121 namespace {
 122   /// JITResolver - Keep track of, and resolve, call sites for functions that
 123   /// have not yet been compiled.
 124   class JITResolver {
 125     /// MCE - The MachineCodeEmitter to use to emit stubs with.
 126     MachineCodeEmitter &MCE;
 127
 128     /// LazyResolverFn - The target lazy resolver function that we actually
 129     /// rewrite instructions to use.
 130     TargetJITInfo::LazyResolverFn LazyResolverFn;
 131
 132     // FunctionToStubMap - Keep track of the stub created for a particular
 133     // function so that we can reuse them if necessary.
 134     std::map<Function*, void*> FunctionToStubMap;
 135
 136     // StubToFunctionMap - Keep track of the function that each stub corresponds
 137     // to.
 138     std::map<void*, Function*> StubToFunctionMap;
 139
 140   public:
 141     JITResolver(MachineCodeEmitter &mce) : MCE(mce) {
 142       LazyResolverFn =
 143         TheJIT->getJITInfo().getLazyResolverFunction(JITCompilerFn);
 144     }
 145
 146     /// getFunctionStub - This returns a pointer to a function stub, creating
 147     /// one on demand as needed.
 148     void *getFunctionStub(Function *F);
 149
 150     /// AddCallbackAtLocation - If the target is capable of rewriting an
 151     /// instruction without the use of a stub, record the location of the use so
 152     /// we know which function is being used at the location.
 153     void *AddCallbackAtLocation(Function *F, void *Location) {
 154       /// Get the target-specific JIT resolver function.
 155       StubToFunctionMap[Location] = F;
 156       return (void*)LazyResolverFn;
 157     }
 158
 159     /// JITCompilerFn - This function is called to resolve a stub to a compiled
 160     /// address.  If the LLVM Function corresponding to the stub has not yet
 161     /// been compiled, this function compiles it first.
 162     static void *JITCompilerFn(void *Stub);
 163   };
 164 }
 165
 166 /// getJITResolver - This function returns the one instance of the JIT resolver.
 167 ///
 168 static JITResolver &getJITResolver(MachineCodeEmitter *MCE = 0) {
 169   static JITResolver TheJITResolver(*MCE);
 170   return TheJITResolver;
 171 }
 172
 173 /// getFunctionStub - This returns a pointer to a function stub, creating
 174 /// one on demand as needed.
 175 void *JITResolver::getFunctionStub(Function *F) {
 176   // If we already have a stub for this function, recycle it.
 177   void *&Stub = FunctionToStubMap[F];
 178   if (Stub) return Stub;
 179
 180   // Call the lazy resolver function unless we already KNOW it is an external
 181   // function, in which case we just skip the lazy resolution step.
 182   void *Actual = (void*)LazyResolverFn;
 183   if (F->hasExternalLinkage())
 184     Actual = TheJIT->getPointerToFunction(F);
 185
 186   // Otherwise, codegen a new stub.  For now, the stub will call the lazy
 187   // resolver function.
 188   Stub = TheJIT->getJITInfo().emitFunctionStub(Actual, MCE);
 189
 190   if (F->hasExternalLinkage()) {
 191     // If we are getting the stub for an external function, we really want the
 192     // address of the stub in the GlobalAddressMap for the JIT, not the address
 193     // of the external function.
 194     TheJIT->updateGlobalMapping(F, Stub);
 195   }
 196
 197   DEBUG(std::cerr << "JIT: Stub emitted at [" << Stub << "] for function '"
 198                   << F->getName() << "'\n");
 199
 200   // Finally, keep track of the stub-to-Function mapping so that the
 201   // JITCompilerFn knows which function to compile!
 202   StubToFunctionMap[Stub] = F;
 203   return Stub;
 204 }
 205
 206 /// JITCompilerFn - This function is called when a lazy compilation stub has
 207 /// been entered.  It looks up which function this stub corresponds to, compiles
 208 /// it if necessary, then returns the resultant function pointer.
 209 void *JITResolver::JITCompilerFn(void *Stub) {
 210   JITResolver &JR = getJITResolver();
 211
 212   // The address given to us for the stub may not be exactly right, it might be
 213   // a little bit after the stub.  As such, use upper_bound to find it.
 214   std::map<void*, Function*>::iterator I =
 215     JR.StubToFunctionMap.upper_bound(Stub);
 216   assert(I != JR.StubToFunctionMap.begin() && "This is not a known stub!");
 217   Function *F = (--I)->second;
 218
 219   // The target function will rewrite the stub so that the compilation callback
 220   // function is no longer called from this stub.
 221   JR.StubToFunctionMap.erase(I);
 222
 223   DEBUG(std::cerr << "JIT: Lazily resolving function '" << F->getName()
 224                   << "' In stub ptr = " << Stub << " actual ptr = "
 225                   << I->first << "\n");
 226
 227   void *Result = TheJIT->getPointerToFunction(F);
 228
 229   // We don't need to reuse this stub in the future, as F is now compiled.
 230   JR.FunctionToStubMap.erase(F);
 231
 232   // FIXME: We could rewrite all references to this stub if we knew them.
 233   return Result;
 234 }
 235
 236
 237 // getPointerToFunctionOrStub - If the specified function has been
 238 // code-gen'd, return a pointer to the function.  If not, compile it, or use
 239 // a stub to implement lazy compilation if available.
 240 //
 241 void *JIT::getPointerToFunctionOrStub(Function *F) {
 242   // If we have already code generated the function, just return the address.
 243   if (void *Addr = getPointerToGlobalIfAvailable(F))
 244     return Addr;
 245
 246   // Get a stub if the target supports it
 247   return getJITResolver(MCE).getFunctionStub(F);
 248 }
 249
 250
 251
 252 //===----------------------------------------------------------------------===//
 253 // JITEmitter code.
 254 //
 255 namespace {
 256   /// JITEmitter - The JIT implementation of the MachineCodeEmitter, which is
 257   /// used to output functions to memory for execution.
 258   class JITEmitter : public MachineCodeEmitter {
 259     JITMemoryManager MemMgr;
 260
 261     // CurBlock - The start of the current block of memory.  CurByte - The
 262     // current byte being emitted to.
 263     unsigned char *CurBlock, *CurByte;
 264
 265     // When outputting a function stub in the context of some other function, we
 266     // save CurBlock and CurByte here.
 267     unsigned char *SavedCurBlock, *SavedCurByte;
 268
 269     // ConstantPoolAddresses - Contains the location for each entry in the
 270     // constant pool.
 271     std::vector<void*> ConstantPoolAddresses;
 272
 273     /// Relocations - These are the relocations that the function needs, as
 274     /// emitted.
 275     std::vector<MachineRelocation> Relocations;
 276   public:
 277     JITEmitter(JIT &jit) { TheJIT = &jit; }
 278
 279     virtual void startFunction(MachineFunction &F);
 280     virtual void finishFunction(MachineFunction &F);
 281     virtual void emitConstantPool(MachineConstantPool *MCP);
 282     virtual void startFunctionStub(unsigned StubSize);
 283     virtual void* finishFunctionStub(const Function *F);
 284     virtual void emitByte(unsigned char B);
 285     virtual void emitWord(unsigned W);
 286     virtual void emitWordAt(unsigned W, unsigned *Ptr);
 287
 288     virtual void addRelocation(const MachineRelocation &MR) {
 289       Relocations.push_back(MR);
 290     }
 291
 292     virtual uint64_t getCurrentPCValue();
 293     virtual uint64_t getCurrentPCOffset();
 294     virtual uint64_t getConstantPoolEntryAddress(unsigned Entry);
 295
 296   private:
 297     void *getPointerToGlobal(GlobalValue *GV, void *Reference, bool NoNeedStub);
 298   };
 299 }
 300
 301 MachineCodeEmitter *JIT::createEmitter(JIT &jit) {
 302   return new JITEmitter(jit);
 303 }
 304
 305 void *JITEmitter::getPointerToGlobal(GlobalValue *V, void *Reference,
 306                                      bool DoesntNeedStub) {
 307   if (GlobalVariable *GV = dyn_cast<GlobalVariable>(V)) {
 308     /// FIXME: If we straightened things out, this could actually emit the
 309     /// global immediately instead of queuing it for codegen later!
 310     return TheJIT->getOrEmitGlobalVariable(GV);
 311   }
 312
 313   // If we have already compiled the function, return a pointer to its body.
 314   Function *F = cast<Function>(V);
 315   void *ResultPtr = TheJIT->getPointerToGlobalIfAvailable(F);
 316   if (ResultPtr) return ResultPtr;
 317
 318   if (F->hasExternalLinkage() && F->isExternal()) {
 319     // If this is an external function pointer, we can force the JIT to
 320     // 'compile' it, which really just adds it to the map.
 321     if (DoesntNeedStub)
 322       return TheJIT->getPointerToFunction(F);
 323
 324     return getJITResolver(this).getFunctionStub(F);
 325   }
 326
 327   // Okay, the function has not been compiled yet, if the target callback
 328   // mechanism is capable of rewriting the instruction directly, prefer to do
 329   // that instead of emitting a stub.
 330   if (DoesntNeedStub)
 331     return getJITResolver(this).AddCallbackAtLocation(F, Reference);
 332
 333   // Otherwise, we have to emit a lazy resolving stub.
 334   return getJITResolver(this).getFunctionStub(F);
 335 }
 336
 337 void JITEmitter::startFunction(MachineFunction &F) {
 338   CurByte = CurBlock = MemMgr.startFunctionBody();
 339   TheJIT->addGlobalMapping(F.getFunction(), CurBlock);
 340 }
 341
 342 void JITEmitter::finishFunction(MachineFunction &F) {
 343   MemMgr.endFunctionBody(CurByte);
 344   ConstantPoolAddresses.clear();
 345   NumBytes += CurByte-CurBlock;
 346
 347   if (!Relocations.empty()) {
 348     // Resolve the relocations to concrete pointers.
 349     for (unsigned i = 0, e = Relocations.size(); i != e; ++i) {
 350       MachineRelocation &MR = Relocations[i];
 351       void *ResultPtr;
 352       if (MR.isString())
 353         ResultPtr = TheJIT->getPointerToNamedFunction(MR.getString());
 354       else
 355         ResultPtr = getPointerToGlobal(MR.getGlobalValue(),
 356                                        CurBlock+MR.getMachineCodeOffset(),
 357                                        MR.doesntNeedFunctionStub());
 358       MR.setResultPointer(ResultPtr);
 359     }
 360
 361     TheJIT->getJITInfo().relocate(CurBlock, &Relocations[0],
 362                                   Relocations.size());
 363   }
 364
 365   DEBUG(std::cerr << "JIT: Finished CodeGen of [" << (void*)CurBlock
 366                   << "] Function: " << F.getFunction()->getName()
 367                   << ": " << CurByte-CurBlock << " bytes of text, "
 368                   << Relocations.size() << " relocations\n");
 369   Relocations.clear();
 370 }
 371
 372 void JITEmitter::emitConstantPool(MachineConstantPool *MCP) {
 373   const std::vector<Constant*> &Constants = MCP->getConstants();
 374   if (Constants.empty()) return;
 375
 376   for (unsigned i = 0, e = Constants.size(); i != e; ++i) {
 377     const Type *Ty = Constants[i]->getType();
 378     unsigned Size      = (unsigned)TheJIT->getTargetData().getTypeSize(Ty);
 379     unsigned Alignment = TheJIT->getTargetData().getTypeAlignment(Ty);
 380
 381     void *Addr = MemMgr.allocateConstant(Size, Alignment);
 382     TheJIT->InitializeMemory(Constants[i], Addr);
 383     ConstantPoolAddresses.push_back(Addr);
 384   }
 385 }
 386
 387 void JITEmitter::startFunctionStub(unsigned StubSize) {
 388   SavedCurBlock = CurBlock;  SavedCurByte = CurByte;
 389   CurByte = CurBlock = MemMgr.allocateStub(StubSize);
 390 }
 391
 392 void *JITEmitter::finishFunctionStub(const Function *F) {
 393   NumBytes += CurByte-CurBlock;
 394   std::swap(CurBlock, SavedCurBlock);
 395   CurByte = SavedCurByte;
 396   return SavedCurBlock;
 397 }
 398
 399 void JITEmitter::emitByte(unsigned char B) {
 400   *CurByte++ = B;   // Write the byte to memory
 401 }
 402
 403 void JITEmitter::emitWord(unsigned W) {
 404   // This won't work if the endianness of the host and target don't agree!  (For
 405   // a JIT this can't happen though.  :)
 406   *(unsigned*)CurByte = W;
 407   CurByte += sizeof(unsigned);
 408 }
 409
 410 void JITEmitter::emitWordAt(unsigned W, unsigned *Ptr) {
 411   *Ptr = W;
 412 }
 413
 414 // getConstantPoolEntryAddress - Return the address of the 'ConstantNum' entry
 415 // in the constant pool that was last emitted with the 'emitConstantPool'
 416 // method.
 417 //
 418 uint64_t JITEmitter::getConstantPoolEntryAddress(unsigned ConstantNum) {
 419   assert(ConstantNum < ConstantPoolAddresses.size() &&
 420          "Invalid ConstantPoolIndex!");
 421   return (intptr_t)ConstantPoolAddresses[ConstantNum];
 422 }
 423
 424 // getCurrentPCValue - This returns the address that the next emitted byte
 425 // will be output to.
 426 //
 427 uint64_t JITEmitter::getCurrentPCValue() {
 428   return (intptr_t)CurByte;
 429 }
 430
 431 uint64_t JITEmitter::getCurrentPCOffset() {
 432   return (intptr_t)CurByte-(intptr_t)CurBlock;
 433 }
 434
 435 // getPointerToNamedFunction - This function is used as a global wrapper to
 436 // JIT::getPointerToNamedFunction for the purpose of resolving symbols when
 437 // bugpoint is debugging the JIT. In that scenario, we are loading an .so and
 438 // need to resolve function(s) that are being mis-codegenerated, so we need to
 439 // resolve their addresses at runtime, and this is the way to do it.
 440 extern "C" {
 441   void *getPointerToNamedFunction(const char *Name) {
 442     Module &M = TheJIT->getModule();
 443     if (Function *F = M.getNamedFunction(Name))
 444       return TheJIT->getPointerToFunction(F);
 445     return TheJIT->getPointerToNamedFunction(Name);
 446   }
 447 }