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/Type.h"
  20 #include "llvm/CodeGen/MachineCodeEmitter.h"
  21 #include "llvm/CodeGen/MachineFunction.h"
  22 #include "llvm/CodeGen/MachineConstantPool.h"
  23 #include "llvm/CodeGen/MachineJumpTableInfo.h"
  24 #include "llvm/CodeGen/MachineRelocation.h"
  25 #include "llvm/ExecutionEngine/GenericValue.h"
  26 #include "llvm/Target/TargetData.h"
  27 #include "llvm/Target/TargetJITInfo.h"
  28 #include "llvm/Support/Debug.h"
  29 #include "llvm/Support/MutexGuard.h"
  30 #include "llvm/ADT/Statistic.h"
  31 #include "llvm/System/Memory.h"
  32 #include <algorithm>
  33 #include <iostream>
  34 using namespace llvm;
  35
  36 namespace {
  37   Statistic<> NumBytes("jit", "Number of bytes of machine code compiled");
  38   Statistic<> NumRelos("jit", "Number of relocations applied");
  39   JIT *TheJIT = 0;
  40 }
  41
  42
  43 //===----------------------------------------------------------------------===//
  44 // JITMemoryManager code.
  45 //
  46 namespace {
  47   /// MemoryRangeHeader - For a range of memory, this is the header that we put
  48   /// on the block of memory.  It is carefully crafted to be one word of memory.
  49   /// Allocated blocks have just this header, free'd blocks have FreeRangeHeader
  50   /// which starts with this.
  51   struct FreeRangeHeader;
  52   struct MemoryRangeHeader {
  53     /// ThisAllocated - This is true if this block is currently allocated.  If
  54     /// not, this can be converted to a FreeRangeHeader.
  55     intptr_t ThisAllocated : 1;
  56
  57     /// PrevAllocated - Keep track of whether the block immediately before us is
  58     /// allocated.  If not, the word immediately before this header is the size
  59     /// of the previous block.
  60     intptr_t PrevAllocated : 1;
  61
  62     /// BlockSize - This is the size in bytes of this memory block,
  63     /// including this header.
  64     uintptr_t BlockSize : (sizeof(intptr_t)*8 - 2);
  65
  66
  67     /// getBlockAfter - Return the memory block immediately after this one.
  68     ///
  69     MemoryRangeHeader &getBlockAfter() const {
  70       return *(MemoryRangeHeader*)((char*)this+BlockSize);
  71     }
  72
  73     /// getFreeBlockBefore - If the block before this one is free, return it,
  74     /// otherwise return null.
  75     FreeRangeHeader *getFreeBlockBefore() const {
  76       if (PrevAllocated) return 0;
  77       intptr_t PrevSize = ((intptr_t *)this)[-1];
  78       return (FreeRangeHeader*)((char*)this-PrevSize);
  79     }
  80
  81     /// FreeBlock - Turn an allocated block into a free block, adjusting
  82     /// bits in the object headers, and adding an end of region memory block.
  83     FreeRangeHeader *FreeBlock(FreeRangeHeader *FreeList);
  84
  85     /// TrimAllocationToSize - If this allocated block is significantly larger
  86     /// than NewSize, split it into two pieces (where the former is NewSize
  87     /// bytes, including the header), and add the new block to the free list.
  88     FreeRangeHeader *TrimAllocationToSize(FreeRangeHeader *FreeList,
  89                                           uint64_t NewSize);
  90   };
  91
  92   /// FreeRangeHeader - For a memory block that isn't already allocated, this
  93   /// keeps track of the current block and has a pointer to the next free block.
  94   /// Free blocks are kept on a circularly linked list.
  95   struct FreeRangeHeader : public MemoryRangeHeader {
  96     FreeRangeHeader *Prev;
  97     FreeRangeHeader *Next;
  98
  99     /// getMinBlockSize - Get the minimum size for a memory block.  Blocks
 100     /// smaller than this size cannot be created.
 101     static unsigned getMinBlockSize() {
 102       return sizeof(FreeRangeHeader)+sizeof(intptr_t);
 103     }
 104
 105     /// SetEndOfBlockSizeMarker - The word at the end of every free block is
 106     /// known to be the size of the free block.  Set it for this block.
 107     void SetEndOfBlockSizeMarker() {
 108       void *EndOfBlock = (char*)this + BlockSize;
 109       ((intptr_t *)EndOfBlock)[-1] = BlockSize;
 110     }
 111
 112     FreeRangeHeader *RemoveFromFreeList() {
 113       assert(Next->Prev == this && Prev->Next == this && "Freelist broken!");
 114       Next->Prev = Prev;
 115       return Prev->Next = Next;
 116     }
 117
 118     void AddToFreeList(FreeRangeHeader *FreeList) {
 119       Next = FreeList;
 120       Prev = FreeList->Prev;
 121       Prev->Next = this;
 122       Next->Prev = this;
 123     }
 124
 125     /// GrowBlock - The block after this block just got deallocated.  Merge it
 126     /// into the current block.
 127     void GrowBlock(uintptr_t NewSize);
 128
 129     /// AllocateBlock - Mark this entire block allocated, updating freelists
 130     /// etc.  This returns a pointer to the circular free-list.
 131     FreeRangeHeader *AllocateBlock();
 132   };
 133 }
 134
 135
 136 /// AllocateBlock - Mark this entire block allocated, updating freelists
 137 /// etc.  This returns a pointer to the circular free-list.
 138 FreeRangeHeader *FreeRangeHeader::AllocateBlock() {
 139   assert(!ThisAllocated && !getBlockAfter().PrevAllocated &&
 140          "Cannot allocate an allocated block!");
 141   // Mark this block allocated.
 142   ThisAllocated = 1;
 143   getBlockAfter().PrevAllocated = 1;
 144
 145   // Remove it from the free list.
 146   return RemoveFromFreeList();
 147 }
 148
 149 /// FreeBlock - Turn an allocated block into a free block, adjusting
 150 /// bits in the object headers, and adding an end of region memory block.
 151 /// If possible, coallesce this block with neighboring blocks.  Return the
 152 /// FreeRangeHeader to allocate from.
 153 FreeRangeHeader *MemoryRangeHeader::FreeBlock(FreeRangeHeader *FreeList) {
 154   MemoryRangeHeader *FollowingBlock = &getBlockAfter();
 155   assert(ThisAllocated && "This block is already allocated!");
 156   assert(FollowingBlock->PrevAllocated && "Flags out of sync!");
 157
 158   FreeRangeHeader *FreeListToReturn = FreeList;
 159
 160   // If the block after this one is free, merge it into this block.
 161   if (!FollowingBlock->ThisAllocated) {
 162     FreeRangeHeader &FollowingFreeBlock = *(FreeRangeHeader *)FollowingBlock;
 163     // "FreeList" always needs to be a valid free block.  If we're about to
 164     // coallesce with it, update our notion of what the free list is.
 165     if (&FollowingFreeBlock == FreeList) {
 166       FreeList = FollowingFreeBlock.Next;
 167       FreeListToReturn = 0;
 168       assert(&FollowingFreeBlock != FreeList && "No tombstone block?");
 169     }
 170     FollowingFreeBlock.RemoveFromFreeList();
 171
 172     // Include the following block into this one.
 173     BlockSize += FollowingFreeBlock.BlockSize;
 174     FollowingBlock = &FollowingFreeBlock.getBlockAfter();
 175
 176     // Tell the block after the block we are coallescing that this block is
 177     // allocated.
 178     FollowingBlock->PrevAllocated = 1;
 179   }
 180
 181   assert(FollowingBlock->ThisAllocated && "Missed coallescing?");
 182
 183   if (FreeRangeHeader *PrevFreeBlock = getFreeBlockBefore()) {
 184     PrevFreeBlock->GrowBlock(PrevFreeBlock->BlockSize + BlockSize);
 185     return FreeListToReturn ? FreeListToReturn : PrevFreeBlock;
 186   }
 187
 188   // Otherwise, mark this block free.
 189   FreeRangeHeader &FreeBlock = *(FreeRangeHeader*)this;
 190   FollowingBlock->PrevAllocated = 0;
 191   FreeBlock.ThisAllocated = 0;
 192
 193   // Link this into the linked list of free blocks.
 194   FreeBlock.AddToFreeList(FreeList);
 195
 196   // Add a marker at the end of the block, indicating the size of this free
 197   // block.
 198   FreeBlock.SetEndOfBlockSizeMarker();
 199   return FreeListToReturn ? FreeListToReturn : &FreeBlock;
 200 }
 201
 202 /// GrowBlock - The block after this block just got deallocated.  Merge it
 203 /// into the current block.
 204 void FreeRangeHeader::GrowBlock(uintptr_t NewSize) {
 205   assert(NewSize > BlockSize && "Not growing block?");
 206   BlockSize = NewSize;
 207   SetEndOfBlockSizeMarker();
 208   getBlockAfter().PrevAllocated = 0;
 209 }
 210
 211 /// TrimAllocationToSize - If this allocated block is significantly larger
 212 /// than NewSize, split it into two pieces (where the former is NewSize
 213 /// bytes, including the header), and add the new block to the free list.
 214 FreeRangeHeader *MemoryRangeHeader::
 215 TrimAllocationToSize(FreeRangeHeader *FreeList, uint64_t NewSize) {
 216   assert(ThisAllocated && getBlockAfter().PrevAllocated &&
 217          "Cannot deallocate part of an allocated block!");
 218
 219   // Round up size for alignment of header.
 220   unsigned HeaderAlign = __alignof(FreeRangeHeader);
 221   NewSize = (NewSize+ (HeaderAlign-1)) & ~(HeaderAlign-1);
 222
 223   // Size is now the size of the block we will remove from the start of the
 224   // current block.
 225   assert(NewSize <= BlockSize &&
 226          "Allocating more space from this block than exists!");
 227
 228   // If splitting this block will cause the remainder to be too small, do not
 229   // split the block.
 230   if (BlockSize <= NewSize+FreeRangeHeader::getMinBlockSize())
 231     return FreeList;
 232
 233   // Otherwise, we splice the required number of bytes out of this block, form
 234   // a new block immediately after it, then mark this block allocated.
 235   MemoryRangeHeader &FormerNextBlock = getBlockAfter();
 236
 237   // Change the size of this block.
 238   BlockSize = NewSize;
 239
 240   // Get the new block we just sliced out and turn it into a free block.
 241   FreeRangeHeader &NewNextBlock = (FreeRangeHeader &)getBlockAfter();
 242   NewNextBlock.BlockSize = (char*)&FormerNextBlock - (char*)&NewNextBlock;
 243   NewNextBlock.ThisAllocated = 0;
 244   NewNextBlock.PrevAllocated = 1;
 245   NewNextBlock.SetEndOfBlockSizeMarker();
 246   FormerNextBlock.PrevAllocated = 0;
 247   NewNextBlock.AddToFreeList(FreeList);
 248   return &NewNextBlock;
 249 }
 250
 251
 252 namespace {
 253   /// JITMemoryManager - Manage memory for the JIT code generation in a logical,
 254   /// sane way.  This splits a large block of MAP_NORESERVE'd memory into two
 255   /// sections, one for function stubs, one for the functions themselves.  We
 256   /// have to do this because we may need to emit a function stub while in the
 257   /// middle of emitting a function, and we don't know how large the function we
 258   /// are emitting is.  This never bothers to release the memory, because when
 259   /// we are ready to destroy the JIT, the program exits.
 260   class JITMemoryManager {
 261     std::vector<sys::MemoryBlock> Blocks; // Memory blocks allocated by the JIT
 262     FreeRangeHeader *FreeMemoryList;      // Circular list of free blocks.
 263
 264     // When emitting code into a memory block, this is the block.
 265     MemoryRangeHeader *CurBlock;
 266
 267     unsigned char *CurStubPtr, *StubBase;
 268     unsigned char *GOTBase;      // Target Specific reserved memory
 269
 270     // Centralize memory block allocation.
 271     sys::MemoryBlock getNewMemoryBlock(unsigned size);
 272
 273     std::map<const Function*, MemoryRangeHeader*> FunctionBlocks;
 274   public:
 275     JITMemoryManager(bool useGOT);
 276     ~JITMemoryManager();
 277
 278     inline unsigned char *allocateStub(unsigned StubSize);
 279
 280     /// startFunctionBody - When a function starts, allocate a block of free
 281     /// executable memory, returning a pointer to it and its actual size.
 282     unsigned char *startFunctionBody(uintptr_t &ActualSize) {
 283       CurBlock = FreeMemoryList;
 284
 285       // Allocate the entire memory block.
 286       FreeMemoryList = FreeMemoryList->AllocateBlock();
 287       ActualSize = CurBlock->BlockSize-sizeof(MemoryRangeHeader);
 288       return (unsigned char *)(CurBlock+1);
 289     }
 290
 291     /// endFunctionBody - The function F is now allocated, and takes the memory
 292     /// in the range [FunctionStart,FunctionEnd).
 293     void endFunctionBody(const Function *F, unsigned char *FunctionStart,
 294                          unsigned char *FunctionEnd) {
 295       assert(FunctionEnd > FunctionStart);
 296       assert(FunctionStart == (unsigned char *)(CurBlock+1) &&
 297              "Mismatched function start/end!");
 298
 299       uintptr_t BlockSize = FunctionEnd - (unsigned char *)CurBlock;
 300       FunctionBlocks[F] = CurBlock;
 301
 302       // Release the memory at the end of this block that isn't needed.
 303       FreeMemoryList =CurBlock->TrimAllocationToSize(FreeMemoryList, BlockSize);
 304     }
 305
 306     unsigned char *getGOTBase() const {
 307       return GOTBase;
 308     }
 309     bool isManagingGOT() const {
 310       return GOTBase != NULL;
 311     }
 312
 313     /// deallocateMemForFunction - Deallocate all memory for the specified
 314     /// function body.
 315     void deallocateMemForFunction(const Function *F) {
 316       std::map<const Function*, MemoryRangeHeader*>::iterator
 317         I = FunctionBlocks.find(F);
 318       if (I == FunctionBlocks.end()) return;
 319
 320       // Find the block that is allocated for this function.
 321       MemoryRangeHeader *MemRange = I->second;
 322       assert(MemRange->ThisAllocated && "Block isn't allocated!");
 323
 324       // Free the memory.
 325       FreeMemoryList = MemRange->FreeBlock(FreeMemoryList);
 326
 327       // Finally, remove this entry from FunctionBlocks.
 328       FunctionBlocks.erase(I);
 329     }
 330   };
 331 }
 332
 333 JITMemoryManager::JITMemoryManager(bool useGOT) {
 334   // Allocate a 16M block of memory for functions.
 335   sys::MemoryBlock MemBlock = getNewMemoryBlock(16 << 20);
 336
 337   unsigned char *MemBase = reinterpret_cast<unsigned char*>(MemBlock.base());
 338
 339   // Allocate stubs backwards from the base, allocate functions forward
 340   // from the base.
 341   StubBase   = MemBase;
 342   CurStubPtr = MemBase + 512*1024; // Use 512k for stubs, working backwards.
 343
 344   // We set up the memory chunk with 4 mem regions, like this:
 345   //  [ START
 346   //    [ Free      #0 ] -> Large space to allocate functions from.
 347   //    [ Allocated #1 ] -> Tiny space to separate regions.
 348   //    [ Free      #2 ] -> Tiny space so there is always at least 1 free block.
 349   //    [ Allocated #3 ] -> Tiny space to prevent looking past end of block.
 350   //  END ]
 351   //
 352   // The last three blocks are never deallocated or touched.
 353
 354   // Add MemoryRangeHeader to the end of the memory region, indicating that
 355   // the space after the block of memory is allocated.  This is block #3.
 356   MemoryRangeHeader *Mem3 = (MemoryRangeHeader*)(MemBase+MemBlock.size())-1;
 357   Mem3->ThisAllocated = 1;
 358   Mem3->PrevAllocated = 0;
 359   Mem3->BlockSize     = 0;
 360
 361   /// Add a tiny free region so that the free list always has one entry.
 362   FreeRangeHeader *Mem2 =
 363     (FreeRangeHeader *)(((char*)Mem3)-FreeRangeHeader::getMinBlockSize());
 364   Mem2->ThisAllocated = 0;
 365   Mem2->PrevAllocated = 1;
 366   Mem2->BlockSize     = FreeRangeHeader::getMinBlockSize();
 367   Mem2->SetEndOfBlockSizeMarker();
 368   Mem2->Prev = Mem2;   // Mem2 *is* the free list for now.
 369   Mem2->Next = Mem2;
 370
 371   /// Add a tiny allocated region so that Mem2 is never coallesced away.
 372   MemoryRangeHeader *Mem1 = (MemoryRangeHeader*)Mem2-1;
 373   Mem1->ThisAllocated = 1;
 374   Mem1->PrevAllocated = 0;
 375   Mem1->BlockSize     = (char*)Mem2 - (char*)Mem1;
 376
 377   // Add a FreeRangeHeader to the start of the function body region, indicating
 378   // that the space is free.  Mark the previous block allocated so we never look
 379   // at it.
 380   FreeRangeHeader *Mem0 = (FreeRangeHeader*)CurStubPtr;
 381   Mem0->ThisAllocated = 0;
 382   Mem0->PrevAllocated = 1;
 383   Mem0->BlockSize = (char*)Mem1-(char*)Mem0;
 384   Mem0->SetEndOfBlockSizeMarker();
 385   Mem0->AddToFreeList(Mem2);
 386
 387   // Start out with the freelist pointing to Mem0.
 388   FreeMemoryList = Mem0;
 389
 390   // Allocate the GOT.
 391   GOTBase = NULL;
 392   if (useGOT) GOTBase = (unsigned char*)malloc(sizeof(void*) * 8192);
 393 }
 394
 395 JITMemoryManager::~JITMemoryManager() {
 396   for (unsigned i = 0, e = Blocks.size(); i != e; ++i)
 397     sys::Memory::ReleaseRWX(Blocks[i]);
 398   Blocks.clear();
 399 }
 400
 401 unsigned char *JITMemoryManager::allocateStub(unsigned StubSize) {
 402   CurStubPtr -= StubSize;
 403   if (CurStubPtr < StubBase) {
 404     // FIXME: allocate a new block
 405     std::cerr << "JIT ran out of memory for function stubs!\n";
 406     abort();
 407   }
 408   return CurStubPtr;
 409 }
 410
 411 sys::MemoryBlock JITMemoryManager::getNewMemoryBlock(unsigned size) {
 412   try {
 413     // Allocate a new block close to the last one.
 414     const sys::MemoryBlock *BOld = Blocks.empty() ? 0 : &Blocks.front();
 415     sys::MemoryBlock B = sys::Memory::AllocateRWX(size, BOld);
 416     Blocks.push_back(B);
 417     return B;
 418   } catch (std::string &err) {
 419     std::cerr << "Allocation failed when allocating new memory in the JIT\n";
 420     std::cerr << err << "\n";
 421     abort();
 422   }
 423 }
 424
 425 //===----------------------------------------------------------------------===//
 426 // JIT lazy compilation code.
 427 //
 428 namespace {
 429   class JITResolverState {
 430   private:
 431     /// FunctionToStubMap - Keep track of the stub created for a particular
 432     /// function so that we can reuse them if necessary.
 433     std::map<Function*, void*> FunctionToStubMap;
 434
 435     /// StubToFunctionMap - Keep track of the function that each stub
 436     /// corresponds to.
 437     std::map<void*, Function*> StubToFunctionMap;
 438
 439   public:
 440     std::map<Function*, void*>& getFunctionToStubMap(const MutexGuard& locked) {
 441       assert(locked.holds(TheJIT->lock));
 442       return FunctionToStubMap;
 443     }
 444
 445     std::map<void*, Function*>& getStubToFunctionMap(const MutexGuard& locked) {
 446       assert(locked.holds(TheJIT->lock));
 447       return StubToFunctionMap;
 448     }
 449   };
 450
 451   /// JITResolver - Keep track of, and resolve, call sites for functions that
 452   /// have not yet been compiled.
 453   class JITResolver {
 454     /// MCE - The MachineCodeEmitter to use to emit stubs with.
 455     MachineCodeEmitter &MCE;
 456
 457     /// LazyResolverFn - The target lazy resolver function that we actually
 458     /// rewrite instructions to use.
 459     TargetJITInfo::LazyResolverFn LazyResolverFn;
 460
 461     JITResolverState state;
 462
 463     /// ExternalFnToStubMap - This is the equivalent of FunctionToStubMap for
 464     /// external functions.
 465     std::map<void*, void*> ExternalFnToStubMap;
 466
 467     //map addresses to indexes in the GOT
 468     std::map<void*, unsigned> revGOTMap;
 469     unsigned nextGOTIndex;
 470
 471   public:
 472     JITResolver(MachineCodeEmitter &mce) : MCE(mce), nextGOTIndex(0) {
 473       LazyResolverFn =
 474         TheJIT->getJITInfo().getLazyResolverFunction(JITCompilerFn);
 475     }
 476
 477     /// getFunctionStub - This returns a pointer to a function stub, creating
 478     /// one on demand as needed.
 479     void *getFunctionStub(Function *F);
 480
 481     /// getExternalFunctionStub - Return a stub for the function at the
 482     /// specified address, created lazily on demand.
 483     void *getExternalFunctionStub(void *FnAddr);
 484
 485     /// AddCallbackAtLocation - If the target is capable of rewriting an
 486     /// instruction without the use of a stub, record the location of the use so
 487     /// we know which function is being used at the location.
 488     void *AddCallbackAtLocation(Function *F, void *Location) {
 489       MutexGuard locked(TheJIT->lock);
 490       /// Get the target-specific JIT resolver function.
 491       state.getStubToFunctionMap(locked)[Location] = F;
 492       return (void*)LazyResolverFn;
 493     }
 494
 495     /// getGOTIndexForAddress - Return a new or existing index in the GOT for
 496     /// and address.  This function only manages slots, it does not manage the
 497     /// contents of the slots or the memory associated with the GOT.
 498     unsigned getGOTIndexForAddr(void* addr);
 499
 500     /// JITCompilerFn - This function is called to resolve a stub to a compiled
 501     /// address.  If the LLVM Function corresponding to the stub has not yet
 502     /// been compiled, this function compiles it first.
 503     static void *JITCompilerFn(void *Stub);
 504   };
 505 }
 506
 507 /// getJITResolver - This function returns the one instance of the JIT resolver.
 508 ///
 509 static JITResolver &getJITResolver(MachineCodeEmitter *MCE = 0) {
 510   static JITResolver TheJITResolver(*MCE);
 511   return TheJITResolver;
 512 }
 513
 514 /// getFunctionStub - This returns a pointer to a function stub, creating
 515 /// one on demand as needed.
 516 void *JITResolver::getFunctionStub(Function *F) {
 517   MutexGuard locked(TheJIT->lock);
 518
 519   // If we already have a stub for this function, recycle it.
 520   void *&Stub = state.getFunctionToStubMap(locked)[F];
 521   if (Stub) return Stub;
 522
 523   // Call the lazy resolver function unless we already KNOW it is an external
 524   // function, in which case we just skip the lazy resolution step.
 525   void *Actual = (void*)LazyResolverFn;
 526   if (F->isExternal() && F->hasExternalLinkage())
 527     Actual = TheJIT->getPointerToFunction(F);
 528
 529   // Otherwise, codegen a new stub.  For now, the stub will call the lazy
 530   // resolver function.
 531   Stub = TheJIT->getJITInfo().emitFunctionStub(Actual, MCE);
 532
 533   if (Actual != (void*)LazyResolverFn) {
 534     // If we are getting the stub for an external function, we really want the
 535     // address of the stub in the GlobalAddressMap for the JIT, not the address
 536     // of the external function.
 537     TheJIT->updateGlobalMapping(F, Stub);
 538   }
 539
 540   DEBUG(std::cerr << "JIT: Stub emitted at [" << Stub << "] for function '"
 541                   << F->getName() << "'\n");
 542
 543   // Finally, keep track of the stub-to-Function mapping so that the
 544   // JITCompilerFn knows which function to compile!
 545   state.getStubToFunctionMap(locked)[Stub] = F;
 546   return Stub;
 547 }
 548
 549 /// getExternalFunctionStub - Return a stub for the function at the
 550 /// specified address, created lazily on demand.
 551 void *JITResolver::getExternalFunctionStub(void *FnAddr) {
 552   // If we already have a stub for this function, recycle it.
 553   void *&Stub = ExternalFnToStubMap[FnAddr];
 554   if (Stub) return Stub;
 555
 556   Stub = TheJIT->getJITInfo().emitFunctionStub(FnAddr, MCE);
 557   DEBUG(std::cerr << "JIT: Stub emitted at [" << Stub
 558         << "] for external function at '" << FnAddr << "'\n");
 559   return Stub;
 560 }
 561
 562 unsigned JITResolver::getGOTIndexForAddr(void* addr) {
 563   unsigned idx = revGOTMap[addr];
 564   if (!idx) {
 565     idx = ++nextGOTIndex;
 566     revGOTMap[addr] = idx;
 567     DEBUG(std::cerr << "Adding GOT entry " << idx
 568           << " for addr " << addr << "\n");
 569     //    ((void**)MemMgr.getGOTBase())[idx] = addr;
 570   }
 571   return idx;
 572 }
 573
 574 /// JITCompilerFn - This function is called when a lazy compilation stub has
 575 /// been entered.  It looks up which function this stub corresponds to, compiles
 576 /// it if necessary, then returns the resultant function pointer.
 577 void *JITResolver::JITCompilerFn(void *Stub) {
 578   JITResolver &JR = getJITResolver();
 579
 580   MutexGuard locked(TheJIT->lock);
 581
 582   // The address given to us for the stub may not be exactly right, it might be
 583   // a little bit after the stub.  As such, use upper_bound to find it.
 584   std::map<void*, Function*>::iterator I =
 585     JR.state.getStubToFunctionMap(locked).upper_bound(Stub);
 586   assert(I != JR.state.getStubToFunctionMap(locked).begin() &&
 587          "This is not a known stub!");
 588   Function *F = (--I)->second;
 589
 590   // We might like to remove the stub from the StubToFunction map.
 591   // We can't do that! Multiple threads could be stuck, waiting to acquire the
 592   // lock above. As soon as the 1st function finishes compiling the function,
 593   // the next one will be released, and needs to be able to find the function it
 594   // needs to call.
 595   //JR.state.getStubToFunctionMap(locked).erase(I);
 596
 597   DEBUG(std::cerr << "JIT: Lazily resolving function '" << F->getName()
 598                   << "' In stub ptr = " << Stub << " actual ptr = "
 599                   << I->first << "\n");
 600
 601   void *Result = TheJIT->getPointerToFunction(F);
 602
 603   // We don't need to reuse this stub in the future, as F is now compiled.
 604   JR.state.getFunctionToStubMap(locked).erase(F);
 605
 606   // FIXME: We could rewrite all references to this stub if we knew them.
 607
 608   // What we will do is set the compiled function address to map to the
 609   // same GOT entry as the stub so that later clients may update the GOT
 610   // if they see it still using the stub address.
 611   // Note: this is done so the Resolver doesn't have to manage GOT memory
 612   // Do this without allocating map space if the target isn't using a GOT
 613   if(JR.revGOTMap.find(Stub) != JR.revGOTMap.end())
 614     JR.revGOTMap[Result] = JR.revGOTMap[Stub];
 615
 616   return Result;
 617 }
 618
 619
 620 //===----------------------------------------------------------------------===//
 621 // JITEmitter code.
 622 //
 623 namespace {
 624   /// JITEmitter - The JIT implementation of the MachineCodeEmitter, which is
 625   /// used to output functions to memory for execution.
 626   class JITEmitter : public MachineCodeEmitter {
 627     JITMemoryManager MemMgr;
 628
 629     // When outputting a function stub in the context of some other function, we
 630     // save BufferBegin/BufferEnd/CurBufferPtr here.
 631     unsigned char *SavedBufferBegin, *SavedBufferEnd, *SavedCurBufferPtr;
 632
 633     /// Relocations - These are the relocations that the function needs, as
 634     /// emitted.
 635     std::vector<MachineRelocation> Relocations;
 636
 637     /// MBBLocations - This vector is a mapping from MBB ID's to their address.
 638     /// It is filled in by the StartMachineBasicBlock callback and queried by
 639     /// the getMachineBasicBlockAddress callback.
 640     std::vector<intptr_t> MBBLocations;
 641
 642     /// ConstantPool - The constant pool for the current function.
 643     ///
 644     MachineConstantPool *ConstantPool;
 645
 646     /// ConstantPoolBase - A pointer to the first entry in the constant pool.
 647     ///
 648     void *ConstantPoolBase;
 649
 650     /// ConstantPool - The constant pool for the current function.
 651     ///
 652     MachineJumpTableInfo *JumpTable;
 653
 654     /// JumpTableBase - A pointer to the first entry in the jump table.
 655     ///
 656     void *JumpTableBase;
 657 public:
 658     JITEmitter(JIT &jit) : MemMgr(jit.getJITInfo().needsGOT()) {
 659       TheJIT = &jit;
 660       DEBUG(if (MemMgr.isManagingGOT()) std::cerr << "JIT is managing a GOT\n");
 661     }
 662
 663     virtual void startFunction(MachineFunction &F);
 664     virtual bool finishFunction(MachineFunction &F);
 665
 666     void emitConstantPool(MachineConstantPool *MCP);
 667     void initJumpTableInfo(MachineJumpTableInfo *MJTI);
 668     void emitJumpTableInfo(MachineJumpTableInfo *MJTI);
 669
 670     virtual void startFunctionStub(unsigned StubSize);
 671     virtual void* finishFunctionStub(const Function *F);
 672
 673     virtual void addRelocation(const MachineRelocation &MR) {
 674       Relocations.push_back(MR);
 675     }
 676
 677     virtual void StartMachineBasicBlock(MachineBasicBlock *MBB) {
 678       if (MBBLocations.size() <= (unsigned)MBB->getNumber())
 679         MBBLocations.resize((MBB->getNumber()+1)*2);
 680       MBBLocations[MBB->getNumber()] = getCurrentPCValue();
 681     }
 682
 683     virtual intptr_t getConstantPoolEntryAddress(unsigned Entry) const;
 684     virtual intptr_t getJumpTableEntryAddress(unsigned Entry) const;
 685
 686     virtual intptr_t getMachineBasicBlockAddress(MachineBasicBlock *MBB) const {
 687       assert(MBBLocations.size() > (unsigned)MBB->getNumber() &&
 688              MBBLocations[MBB->getNumber()] && "MBB not emitted!");
 689       return MBBLocations[MBB->getNumber()];
 690     }
 691
 692     /// deallocateMemForFunction - Deallocate all memory for the specified
 693     /// function body.
 694     void deallocateMemForFunction(Function *F) {
 695       MemMgr.deallocateMemForFunction(F);
 696     }
 697   private:
 698     void *getPointerToGlobal(GlobalValue *GV, void *Reference, bool NoNeedStub);
 699   };
 700 }
 701
 702 void *JITEmitter::getPointerToGlobal(GlobalValue *V, void *Reference,
 703                                      bool DoesntNeedStub) {
 704   if (GlobalVariable *GV = dyn_cast<GlobalVariable>(V)) {
 705     /// FIXME: If we straightened things out, this could actually emit the
 706     /// global immediately instead of queuing it for codegen later!
 707     return TheJIT->getOrEmitGlobalVariable(GV);
 708   }
 709
 710   // If we have already compiled the function, return a pointer to its body.
 711   Function *F = cast<Function>(V);
 712   void *ResultPtr = TheJIT->getPointerToGlobalIfAvailable(F);
 713   if (ResultPtr) return ResultPtr;
 714
 715   if (F->hasExternalLinkage() && F->isExternal()) {
 716     // If this is an external function pointer, we can force the JIT to
 717     // 'compile' it, which really just adds it to the map.
 718     if (DoesntNeedStub)
 719       return TheJIT->getPointerToFunction(F);
 720
 721     return getJITResolver(this).getFunctionStub(F);
 722   }
 723
 724   // Okay, the function has not been compiled yet, if the target callback
 725   // mechanism is capable of rewriting the instruction directly, prefer to do
 726   // that instead of emitting a stub.
 727   if (DoesntNeedStub)
 728     return getJITResolver(this).AddCallbackAtLocation(F, Reference);
 729
 730   // Otherwise, we have to emit a lazy resolving stub.
 731   return getJITResolver(this).getFunctionStub(F);
 732 }
 733
 734 void JITEmitter::startFunction(MachineFunction &F) {
 735   uintptr_t ActualSize;
 736   BufferBegin = CurBufferPtr = MemMgr.startFunctionBody(ActualSize);
 737   BufferEnd = BufferBegin+ActualSize;
 738
 739   emitConstantPool(F.getConstantPool());
 740   initJumpTableInfo(F.getJumpTableInfo());
 741
 742   // About to start emitting the machine code for the function.
 743   emitAlignment(std::max(F.getFunction()->getAlignment(), 8U));
 744   TheJIT->updateGlobalMapping(F.getFunction(), CurBufferPtr);
 745
 746   MBBLocations.clear();
 747 }
 748
 749 bool JITEmitter::finishFunction(MachineFunction &F) {
 750   if (CurBufferPtr == BufferEnd) {
 751     // FIXME: Allocate more space, then try again.
 752     std::cerr << "JIT: Ran out of space for generated machine code!\n";
 753     abort();
 754   }
 755
 756   emitJumpTableInfo(F.getJumpTableInfo());
 757
 758   MemMgr.endFunctionBody(F.getFunction(), BufferBegin, CurBufferPtr);
 759   NumBytes += getCurrentPCOffset();
 760
 761   if (!Relocations.empty()) {
 762     NumRelos += Relocations.size();
 763
 764     // Resolve the relocations to concrete pointers.
 765     for (unsigned i = 0, e = Relocations.size(); i != e; ++i) {
 766       MachineRelocation &MR = Relocations[i];
 767       void *ResultPtr;
 768       if (MR.isString()) {
 769         ResultPtr = TheJIT->getPointerToNamedFunction(MR.getString());
 770
 771         // If the target REALLY wants a stub for this function, emit it now.
 772         if (!MR.doesntNeedFunctionStub())
 773           ResultPtr = getJITResolver(this).getExternalFunctionStub(ResultPtr);
 774       } else if (MR.isGlobalValue()) {
 775         ResultPtr = getPointerToGlobal(MR.getGlobalValue(),
 776                                        BufferBegin+MR.getMachineCodeOffset(),
 777                                        MR.doesntNeedFunctionStub());
 778       } else {
 779         assert(MR.isConstantPoolIndex());
 780         ResultPtr=(void*)getConstantPoolEntryAddress(MR.getConstantPoolIndex());
 781       }
 782
 783       MR.setResultPointer(ResultPtr);
 784
 785       // if we are managing the GOT and the relocation wants an index,
 786       // give it one
 787       if (MemMgr.isManagingGOT() && MR.isGOTRelative()) {
 788         unsigned idx = getJITResolver(this).getGOTIndexForAddr(ResultPtr);
 789         MR.setGOTIndex(idx);
 790         if (((void**)MemMgr.getGOTBase())[idx] != ResultPtr) {
 791           DEBUG(std::cerr << "GOT was out of date for " << ResultPtr
 792                 << " pointing at " << ((void**)MemMgr.getGOTBase())[idx]
 793                 << "\n");
 794           ((void**)MemMgr.getGOTBase())[idx] = ResultPtr;
 795         }
 796       }
 797     }
 798
 799     TheJIT->getJITInfo().relocate(BufferBegin, &Relocations[0],
 800                                   Relocations.size(), MemMgr.getGOTBase());
 801   }
 802
 803   // Update the GOT entry for F to point to the new code.
 804   if(MemMgr.isManagingGOT()) {
 805     unsigned idx = getJITResolver(this).getGOTIndexForAddr((void*)BufferBegin);
 806     if (((void**)MemMgr.getGOTBase())[idx] != (void*)BufferBegin) {
 807       DEBUG(std::cerr << "GOT was out of date for " << (void*)BufferBegin
 808             << " pointing at " << ((void**)MemMgr.getGOTBase())[idx] << "\n");
 809       ((void**)MemMgr.getGOTBase())[idx] = (void*)BufferBegin;
 810     }
 811   }
 812
 813   DEBUG(std::cerr << "JIT: Finished CodeGen of [" << (void*)BufferBegin
 814                   << "] Function: " << F.getFunction()->getName()
 815                   << ": " << getCurrentPCOffset() << " bytes of text, "
 816                   << Relocations.size() << " relocations\n");
 817   Relocations.clear();
 818   return false;
 819 }
 820
 821 void JITEmitter::emitConstantPool(MachineConstantPool *MCP) {
 822   const std::vector<MachineConstantPoolEntry> &Constants = MCP->getConstants();
 823   if (Constants.empty()) return;
 824
 825   unsigned Size = Constants.back().Offset;
 826   Size += TheJIT->getTargetData()->getTypeSize(Constants.back().Val->getType());
 827
 828   ConstantPoolBase = allocateSpace(Size, 1 << MCP->getConstantPoolAlignment());
 829   ConstantPool = MCP;
 830
 831   if (ConstantPoolBase == 0) return;  // Buffer overflow.
 832
 833   // Initialize the memory for all of the constant pool entries.
 834   for (unsigned i = 0, e = Constants.size(); i != e; ++i) {
 835     void *CAddr = (char*)ConstantPoolBase+Constants[i].Offset;
 836     TheJIT->InitializeMemory(Constants[i].Val, CAddr);
 837   }
 838 }
 839
 840 void JITEmitter::initJumpTableInfo(MachineJumpTableInfo *MJTI) {
 841   const std::vector<MachineJumpTableEntry> &JT = MJTI->getJumpTables();
 842   if (JT.empty()) return;
 843
 844   unsigned NumEntries = 0;
 845   for (unsigned i = 0, e = JT.size(); i != e; ++i)
 846     NumEntries += JT[i].MBBs.size();
 847
 848   unsigned EntrySize = MJTI->getEntrySize();
 849
 850   // Just allocate space for all the jump tables now.  We will fix up the actual
 851   // MBB entries in the tables after we emit the code for each block, since then
 852   // we will know the final locations of the MBBs in memory.
 853   JumpTable = MJTI;
 854   JumpTableBase = allocateSpace(NumEntries * EntrySize, MJTI->getAlignment());
 855 }
 856
 857 void JITEmitter::emitJumpTableInfo(MachineJumpTableInfo *MJTI) {
 858   const std::vector<MachineJumpTableEntry> &JT = MJTI->getJumpTables();
 859   if (JT.empty() || JumpTableBase == 0) return;
 860
 861   unsigned Offset = 0;
 862   assert(MJTI->getEntrySize() == sizeof(void*) && "Cross JIT'ing?");
 863
 864   // For each jump table, map each target in the jump table to the address of
 865   // an emitted MachineBasicBlock.
 866   intptr_t *SlotPtr = (intptr_t*)JumpTableBase;
 867
 868   for (unsigned i = 0, e = JT.size(); i != e; ++i) {
 869     const std::vector<MachineBasicBlock*> &MBBs = JT[i].MBBs;
 870     // Store the address of the basic block for this jump table slot in the
 871     // memory we allocated for the jump table in 'initJumpTableInfo'
 872     for (unsigned mi = 0, me = MBBs.size(); mi != me; ++mi)
 873       *SlotPtr++ = getMachineBasicBlockAddress(MBBs[mi]);
 874   }
 875 }
 876
 877 void JITEmitter::startFunctionStub(unsigned StubSize) {
 878   SavedBufferBegin = BufferBegin;
 879   SavedBufferEnd = BufferEnd;
 880   SavedCurBufferPtr = CurBufferPtr;
 881
 882   BufferBegin = CurBufferPtr = MemMgr.allocateStub(StubSize);
 883   BufferEnd = BufferBegin+StubSize+1;
 884 }
 885
 886 void *JITEmitter::finishFunctionStub(const Function *F) {
 887   NumBytes += getCurrentPCOffset();
 888   std::swap(SavedBufferBegin, BufferBegin);
 889   BufferEnd = SavedBufferEnd;
 890   CurBufferPtr = SavedCurBufferPtr;
 891   return SavedBufferBegin;
 892 }
 893
 894 // getConstantPoolEntryAddress - Return the address of the 'ConstantNum' entry
 895 // in the constant pool that was last emitted with the 'emitConstantPool'
 896 // method.
 897 //
 898 intptr_t JITEmitter::getConstantPoolEntryAddress(unsigned ConstantNum) const {
 899   assert(ConstantNum < ConstantPool->getConstants().size() &&
 900          "Invalid ConstantPoolIndex!");
 901   return (intptr_t)ConstantPoolBase +
 902          ConstantPool->getConstants()[ConstantNum].Offset;
 903 }
 904
 905 // getJumpTableEntryAddress - Return the address of the JumpTable with index
 906 // 'Index' in the jumpp table that was last initialized with 'initJumpTableInfo'
 907 //
 908 intptr_t JITEmitter::getJumpTableEntryAddress(unsigned Index) const {
 909   const std::vector<MachineJumpTableEntry> &JT = JumpTable->getJumpTables();
 910   assert(Index < JT.size() && "Invalid jump table index!");
 911
 912   unsigned Offset = 0;
 913   unsigned EntrySize = JumpTable->getEntrySize();
 914
 915   for (unsigned i = 0; i < Index; ++i)
 916     Offset += JT[i].MBBs.size() * EntrySize;
 917
 918   return (intptr_t)((char *)JumpTableBase + Offset);
 919 }
 920
 921 //===----------------------------------------------------------------------===//
 922 //  Public interface to this file
 923 //===----------------------------------------------------------------------===//
 924
 925 MachineCodeEmitter *JIT::createEmitter(JIT &jit) {
 926   return new JITEmitter(jit);
 927 }
 928
 929 // getPointerToNamedFunction - This function is used as a global wrapper to
 930 // JIT::getPointerToNamedFunction for the purpose of resolving symbols when
 931 // bugpoint is debugging the JIT. In that scenario, we are loading an .so and
 932 // need to resolve function(s) that are being mis-codegenerated, so we need to
 933 // resolve their addresses at runtime, and this is the way to do it.
 934 extern "C" {
 935   void *getPointerToNamedFunction(const char *Name) {
 936     Module &M = TheJIT->getModule();
 937     if (Function *F = M.getNamedFunction(Name))
 938       return TheJIT->getPointerToFunction(F);
 939     return TheJIT->getPointerToNamedFunction(Name);
 940   }
 941 }
 942
 943 // getPointerToFunctionOrStub - If the specified function has been
 944 // code-gen'd, return a pointer to the function.  If not, compile it, or use
 945 // a stub to implement lazy compilation if available.
 946 //
 947 void *JIT::getPointerToFunctionOrStub(Function *F) {
 948   // If we have already code generated the function, just return the address.
 949   if (void *Addr = getPointerToGlobalIfAvailable(F))
 950     return Addr;
 951
 952   // Get a stub if the target supports it
 953   return getJITResolver(MCE).getFunctionStub(F);
 954 }
 955
 956 /// freeMachineCodeForFunction - release machine code memory for given Function.
 957 ///
 958 void JIT::freeMachineCodeForFunction(Function *F) {
 959   // Delete translation for this from the ExecutionEngine, so it will get
 960   // retranslated next time it is used.
 961   updateGlobalMapping(F, 0);
 962
 963   // Free the actual memory for the function body and related stuff.
 964   assert(dynamic_cast<JITEmitter*>(MCE) && "Unexpected MCE?");
 965   dynamic_cast<JITEmitter*>(MCE)->deallocateMemForFunction(F);
 966 }
 967