lib/ExecutionEngine/JIT/JITMemoryManager.cpp

   1 //===-- JITMemoryManager.cpp - Memory Allocator for JIT'd code ------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file defines the DefaultJITMemoryManager class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/GlobalValue.h"
  15 #include "llvm/ExecutionEngine/JITMemoryManager.h"
  16 #include "llvm/Support/Compiler.h"
  17 #include "llvm/System/Memory.h"
  18 #include <map>
  19 #include <vector>
  20 #include <cassert>
  21 #include <climits>
  22 #include <cstdio>
  23 #include <cstdlib>
  24 #include <cstring>
  25 using namespace llvm;
  26
  27
  28 JITMemoryManager::~JITMemoryManager() {}
  29
  30 //===----------------------------------------------------------------------===//
  31 // Memory Block Implementation.
  32 //===----------------------------------------------------------------------===//
  33
  34 namespace {
  35   /// MemoryRangeHeader - For a range of memory, this is the header that we put
  36   /// on the block of memory.  It is carefully crafted to be one word of memory.
  37   /// Allocated blocks have just this header, free'd blocks have FreeRangeHeader
  38   /// which starts with this.
  39   struct FreeRangeHeader;
  40   struct MemoryRangeHeader {
  41     /// ThisAllocated - This is true if this block is currently allocated.  If
  42     /// not, this can be converted to a FreeRangeHeader.
  43     unsigned ThisAllocated : 1;
  44
  45     /// PrevAllocated - Keep track of whether the block immediately before us is
  46     /// allocated.  If not, the word immediately before this header is the size
  47     /// of the previous block.
  48     unsigned PrevAllocated : 1;
  49
  50     /// BlockSize - This is the size in bytes of this memory block,
  51     /// including this header.
  52     uintptr_t BlockSize : (sizeof(intptr_t)*CHAR_BIT - 2);
  53
  54
  55     /// getBlockAfter - Return the memory block immediately after this one.
  56     ///
  57     MemoryRangeHeader &getBlockAfter() const {
  58       return *(MemoryRangeHeader*)((char*)this+BlockSize);
  59     }
  60
  61     /// getFreeBlockBefore - If the block before this one is free, return it,
  62     /// otherwise return null.
  63     FreeRangeHeader *getFreeBlockBefore() const {
  64       if (PrevAllocated) return 0;
  65       intptr_t PrevSize = ((intptr_t *)this)[-1];
  66       return (FreeRangeHeader*)((char*)this-PrevSize);
  67     }
  68
  69     /// FreeBlock - Turn an allocated block into a free block, adjusting
  70     /// bits in the object headers, and adding an end of region memory block.
  71     FreeRangeHeader *FreeBlock(FreeRangeHeader *FreeList);
  72
  73     /// TrimAllocationToSize - If this allocated block is significantly larger
  74     /// than NewSize, split it into two pieces (where the former is NewSize
  75     /// bytes, including the header), and add the new block to the free list.
  76     FreeRangeHeader *TrimAllocationToSize(FreeRangeHeader *FreeList,
  77                                           uint64_t NewSize);
  78   };
  79
  80   /// FreeRangeHeader - For a memory block that isn't already allocated, this
  81   /// keeps track of the current block and has a pointer to the next free block.
  82   /// Free blocks are kept on a circularly linked list.
  83   struct FreeRangeHeader : public MemoryRangeHeader {
  84     FreeRangeHeader *Prev;
  85     FreeRangeHeader *Next;
  86
  87     /// getMinBlockSize - Get the minimum size for a memory block.  Blocks
  88     /// smaller than this size cannot be created.
  89     static unsigned getMinBlockSize() {
  90       return sizeof(FreeRangeHeader)+sizeof(intptr_t);
  91     }
  92
  93     /// SetEndOfBlockSizeMarker - The word at the end of every free block is
  94     /// known to be the size of the free block.  Set it for this block.
  95     void SetEndOfBlockSizeMarker() {
  96       void *EndOfBlock = (char*)this + BlockSize;
  97       ((intptr_t *)EndOfBlock)[-1] = BlockSize;
  98     }
  99
 100     FreeRangeHeader *RemoveFromFreeList() {
 101       assert(Next->Prev == this && Prev->Next == this && "Freelist broken!");
 102       Next->Prev = Prev;
 103       return Prev->Next = Next;
 104     }
 105
 106     void AddToFreeList(FreeRangeHeader *FreeList) {
 107       Next = FreeList;
 108       Prev = FreeList->Prev;
 109       Prev->Next = this;
 110       Next->Prev = this;
 111     }
 112
 113     /// GrowBlock - The block after this block just got deallocated.  Merge it
 114     /// into the current block.
 115     void GrowBlock(uintptr_t NewSize);
 116
 117     /// AllocateBlock - Mark this entire block allocated, updating freelists
 118     /// etc.  This returns a pointer to the circular free-list.
 119     FreeRangeHeader *AllocateBlock();
 120   };
 121 }
 122
 123
 124 /// AllocateBlock - Mark this entire block allocated, updating freelists
 125 /// etc.  This returns a pointer to the circular free-list.
 126 FreeRangeHeader *FreeRangeHeader::AllocateBlock() {
 127   assert(!ThisAllocated && !getBlockAfter().PrevAllocated &&
 128          "Cannot allocate an allocated block!");
 129   // Mark this block allocated.
 130   ThisAllocated = 1;
 131   getBlockAfter().PrevAllocated = 1;
 132
 133   // Remove it from the free list.
 134   return RemoveFromFreeList();
 135 }
 136
 137 /// FreeBlock - Turn an allocated block into a free block, adjusting
 138 /// bits in the object headers, and adding an end of region memory block.
 139 /// If possible, coalesce this block with neighboring blocks.  Return the
 140 /// FreeRangeHeader to allocate from.
 141 FreeRangeHeader *MemoryRangeHeader::FreeBlock(FreeRangeHeader *FreeList) {
 142   MemoryRangeHeader *FollowingBlock = &getBlockAfter();
 143   assert(ThisAllocated && "This block is already allocated!");
 144   assert(FollowingBlock->PrevAllocated && "Flags out of sync!");
 145
 146   FreeRangeHeader *FreeListToReturn = FreeList;
 147
 148   // If the block after this one is free, merge it into this block.
 149   if (!FollowingBlock->ThisAllocated) {
 150     FreeRangeHeader &FollowingFreeBlock = *(FreeRangeHeader *)FollowingBlock;
 151     // "FreeList" always needs to be a valid free block.  If we're about to
 152     // coalesce with it, update our notion of what the free list is.
 153     if (&FollowingFreeBlock == FreeList) {
 154       FreeList = FollowingFreeBlock.Next;
 155       FreeListToReturn = 0;
 156       assert(&FollowingFreeBlock != FreeList && "No tombstone block?");
 157     }
 158     FollowingFreeBlock.RemoveFromFreeList();
 159
 160     // Include the following block into this one.
 161     BlockSize += FollowingFreeBlock.BlockSize;
 162     FollowingBlock = &FollowingFreeBlock.getBlockAfter();
 163
 164     // Tell the block after the block we are coalescing that this block is
 165     // allocated.
 166     FollowingBlock->PrevAllocated = 1;
 167   }
 168
 169   assert(FollowingBlock->ThisAllocated && "Missed coalescing?");
 170
 171   if (FreeRangeHeader *PrevFreeBlock = getFreeBlockBefore()) {
 172     PrevFreeBlock->GrowBlock(PrevFreeBlock->BlockSize + BlockSize);
 173     return FreeListToReturn ? FreeListToReturn : PrevFreeBlock;
 174   }
 175
 176   // Otherwise, mark this block free.
 177   FreeRangeHeader &FreeBlock = *(FreeRangeHeader*)this;
 178   FollowingBlock->PrevAllocated = 0;
 179   FreeBlock.ThisAllocated = 0;
 180
 181   // Link this into the linked list of free blocks.
 182   FreeBlock.AddToFreeList(FreeList);
 183
 184   // Add a marker at the end of the block, indicating the size of this free
 185   // block.
 186   FreeBlock.SetEndOfBlockSizeMarker();
 187   return FreeListToReturn ? FreeListToReturn : &FreeBlock;
 188 }
 189
 190 /// GrowBlock - The block after this block just got deallocated.  Merge it
 191 /// into the current block.
 192 void FreeRangeHeader::GrowBlock(uintptr_t NewSize) {
 193   assert(NewSize > BlockSize && "Not growing block?");
 194   BlockSize = NewSize;
 195   SetEndOfBlockSizeMarker();
 196   getBlockAfter().PrevAllocated = 0;
 197 }
 198
 199 /// TrimAllocationToSize - If this allocated block is significantly larger
 200 /// than NewSize, split it into two pieces (where the former is NewSize
 201 /// bytes, including the header), and add the new block to the free list.
 202 FreeRangeHeader *MemoryRangeHeader::
 203 TrimAllocationToSize(FreeRangeHeader *FreeList, uint64_t NewSize) {
 204   assert(ThisAllocated && getBlockAfter().PrevAllocated &&
 205          "Cannot deallocate part of an allocated block!");
 206
 207   // Don't allow blocks to be trimmed below minimum required size
 208   NewSize = std::max<uint64_t>(FreeRangeHeader::getMinBlockSize(), NewSize);
 209
 210   // Round up size for alignment of header.
 211   unsigned HeaderAlign = __alignof(FreeRangeHeader);
 212   NewSize = (NewSize+ (HeaderAlign-1)) & ~(HeaderAlign-1);
 213
 214   // Size is now the size of the block we will remove from the start of the
 215   // current block.
 216   assert(NewSize <= BlockSize &&
 217          "Allocating more space from this block than exists!");
 218
 219   // If splitting this block will cause the remainder to be too small, do not
 220   // split the block.
 221   if (BlockSize <= NewSize+FreeRangeHeader::getMinBlockSize())
 222     return FreeList;
 223
 224   // Otherwise, we splice the required number of bytes out of this block, form
 225   // a new block immediately after it, then mark this block allocated.
 226   MemoryRangeHeader &FormerNextBlock = getBlockAfter();
 227
 228   // Change the size of this block.
 229   BlockSize = NewSize;
 230
 231   // Get the new block we just sliced out and turn it into a free block.
 232   FreeRangeHeader &NewNextBlock = (FreeRangeHeader &)getBlockAfter();
 233   NewNextBlock.BlockSize = (char*)&FormerNextBlock - (char*)&NewNextBlock;
 234   NewNextBlock.ThisAllocated = 0;
 235   NewNextBlock.PrevAllocated = 1;
 236   NewNextBlock.SetEndOfBlockSizeMarker();
 237   FormerNextBlock.PrevAllocated = 0;
 238   NewNextBlock.AddToFreeList(FreeList);
 239   return &NewNextBlock;
 240 }
 241
 242 //===----------------------------------------------------------------------===//
 243 // Memory Block Implementation.
 244 //===----------------------------------------------------------------------===//
 245
 246 namespace {
 247   /// DefaultJITMemoryManager - Manage memory for the JIT code generation.
 248   /// This splits a large block of MAP_NORESERVE'd memory into two
 249   /// sections, one for function stubs, one for the functions themselves.  We
 250   /// have to do this because we may need to emit a function stub while in the
 251   /// middle of emitting a function, and we don't know how large the function we
 252   /// are emitting is.
 253   class VISIBILITY_HIDDEN DefaultJITMemoryManager : public JITMemoryManager {
 254     std::vector<sys::MemoryBlock> Blocks; // Memory blocks allocated by the JIT
 255     FreeRangeHeader *FreeMemoryList;      // Circular list of free blocks.
 256
 257     // When emitting code into a memory block, this is the block.
 258     MemoryRangeHeader *CurBlock;
 259
 260     unsigned char *CurStubPtr, *StubBase;
 261     unsigned char *GOTBase;      // Target Specific reserved memory
 262     void *DlsymTable;            // Stub external symbol information
 263
 264     // Centralize memory block allocation.
 265     sys::MemoryBlock getNewMemoryBlock(unsigned size);
 266
 267     std::map<const Function*, MemoryRangeHeader*> FunctionBlocks;
 268     std::map<const Function*, MemoryRangeHeader*> TableBlocks;
 269   public:
 270     DefaultJITMemoryManager();
 271     ~DefaultJITMemoryManager();
 272
 273     void AllocateGOT();
 274     void SetDlsymTable(void *);
 275
 276     unsigned char *allocateStub(const GlobalValue* F, unsigned StubSize,
 277                                 unsigned Alignment);
 278
 279     /// startFunctionBody - When a function starts, allocate a block of free
 280     /// executable memory, returning a pointer to it and its actual size.
 281     unsigned char *startFunctionBody(const Function *F, uintptr_t &ActualSize) {
 282
 283       FreeRangeHeader* candidateBlock = FreeMemoryList;
 284       FreeRangeHeader* head = FreeMemoryList;
 285       FreeRangeHeader* iter = head->Next;
 286
 287       uintptr_t largest = candidateBlock->BlockSize;
 288
 289       // Search for the largest free block
 290       while (iter != head) {
 291           if (iter->BlockSize > largest) {
 292               largest = iter->BlockSize;
 293               candidateBlock = iter;
 294           }
 295           iter = iter->Next;
 296       }
 297
 298       // Select this candidate block for allocation
 299       CurBlock = candidateBlock;
 300
 301       // Allocate the entire memory block.
 302       FreeMemoryList = candidateBlock->AllocateBlock();
 303       ActualSize = CurBlock->BlockSize-sizeof(MemoryRangeHeader);
 304       return (unsigned char *)(CurBlock+1);
 305     }
 306
 307     /// endFunctionBody - The function F is now allocated, and takes the memory
 308     /// in the range [FunctionStart,FunctionEnd).
 309     void endFunctionBody(const Function *F, unsigned char *FunctionStart,
 310                          unsigned char *FunctionEnd) {
 311       assert(FunctionEnd > FunctionStart);
 312       assert(FunctionStart == (unsigned char *)(CurBlock+1) &&
 313              "Mismatched function start/end!");
 314
 315       uintptr_t BlockSize = FunctionEnd - (unsigned char *)CurBlock;
 316       FunctionBlocks[F] = CurBlock;
 317
 318       // Release the memory at the end of this block that isn't needed.
 319       FreeMemoryList =CurBlock->TrimAllocationToSize(FreeMemoryList, BlockSize);
 320     }
 321
 322     /// allocateSpace - Allocate a memory block of the given size.
 323     unsigned char *allocateSpace(intptr_t Size, unsigned Alignment) {
 324       CurBlock = FreeMemoryList;
 325       FreeMemoryList = FreeMemoryList->AllocateBlock();
 326
 327       unsigned char *result = (unsigned char *)CurBlock+1;
 328
 329       if (Alignment == 0) Alignment = 1;
 330       result = (unsigned char*)(((intptr_t)result+Alignment-1) &
 331                ~(intptr_t)(Alignment-1));
 332
 333       uintptr_t BlockSize = result + Size - (unsigned char *)CurBlock;
 334       FreeMemoryList =CurBlock->TrimAllocationToSize(FreeMemoryList, BlockSize);
 335
 336       return result;
 337     }
 338
 339     /// startExceptionTable - Use startFunctionBody to allocate memory for the
 340     /// function's exception table.
 341     unsigned char* startExceptionTable(const Function* F,
 342                                        uintptr_t &ActualSize) {
 343       return startFunctionBody(F, ActualSize);
 344     }
 345
 346     /// endExceptionTable - The exception table of F is now allocated,
 347     /// and takes the memory in the range [TableStart,TableEnd).
 348     void endExceptionTable(const Function *F, unsigned char *TableStart,
 349                            unsigned char *TableEnd,
 350                            unsigned char* FrameRegister) {
 351       assert(TableEnd > TableStart);
 352       assert(TableStart == (unsigned char *)(CurBlock+1) &&
 353              "Mismatched table start/end!");
 354
 355       uintptr_t BlockSize = TableEnd - (unsigned char *)CurBlock;
 356       TableBlocks[F] = CurBlock;
 357
 358       // Release the memory at the end of this block that isn't needed.
 359       FreeMemoryList =CurBlock->TrimAllocationToSize(FreeMemoryList, BlockSize);
 360     }
 361
 362     unsigned char *getGOTBase() const {
 363       return GOTBase;
 364     }
 365
 366     void *getDlsymTable() const {
 367       return DlsymTable;
 368     }
 369
 370     /// deallocateMemForFunction - Deallocate all memory for the specified
 371     /// function body.
 372     void deallocateMemForFunction(const Function *F) {
 373       std::map<const Function*, MemoryRangeHeader*>::iterator
 374         I = FunctionBlocks.find(F);
 375       if (I == FunctionBlocks.end()) return;
 376
 377       // Find the block that is allocated for this function.
 378       MemoryRangeHeader *MemRange = I->second;
 379       assert(MemRange->ThisAllocated && "Block isn't allocated!");
 380
 381       // Fill the buffer with garbage!
 382 #ifndef NDEBUG
 383       memset(MemRange+1, 0xCD, MemRange->BlockSize-sizeof(*MemRange));
 384 #endif
 385
 386       // Free the memory.
 387       FreeMemoryList = MemRange->FreeBlock(FreeMemoryList);
 388
 389       // Finally, remove this entry from FunctionBlocks.
 390       FunctionBlocks.erase(I);
 391
 392       I = TableBlocks.find(F);
 393       if (I == TableBlocks.end()) return;
 394
 395       // Find the block that is allocated for this function.
 396       MemRange = I->second;
 397       assert(MemRange->ThisAllocated && "Block isn't allocated!");
 398
 399       // Fill the buffer with garbage!
 400 #ifndef NDEBUG
 401       memset(MemRange+1, 0xCD, MemRange->BlockSize-sizeof(*MemRange));
 402 #endif
 403
 404       // Free the memory.
 405       FreeMemoryList = MemRange->FreeBlock(FreeMemoryList);
 406
 407       // Finally, remove this entry from TableBlocks.
 408       TableBlocks.erase(I);
 409     }
 410
 411     /// setMemoryWritable - When code generation is in progress,
 412     /// the code pages may need permissions changed.
 413     void setMemoryWritable(void)
 414     {
 415       for (unsigned i = 0, e = Blocks.size(); i != e; ++i)
 416         sys::Memory::setWritable(Blocks[i]);
 417     }
 418     /// setMemoryExecutable - When code generation is done and we're ready to
 419     /// start execution, the code pages may need permissions changed.
 420     void setMemoryExecutable(void)
 421     {
 422       for (unsigned i = 0, e = Blocks.size(); i != e; ++i)
 423         sys::Memory::setExecutable(Blocks[i]);
 424     }
 425   };
 426 }
 427
 428 DefaultJITMemoryManager::DefaultJITMemoryManager() {
 429   // Allocate a 16M block of memory for functions.
 430 #if defined(__APPLE__) && defined(__arm__)
 431   sys::MemoryBlock MemBlock = getNewMemoryBlock(4 << 20);
 432 #else
 433   sys::MemoryBlock MemBlock = getNewMemoryBlock(16 << 20);
 434 #endif
 435
 436   unsigned char *MemBase = static_cast<unsigned char*>(MemBlock.base());
 437
 438   // Allocate stubs backwards from the base, allocate functions forward
 439   // from the base.
 440   StubBase   = MemBase;
 441   CurStubPtr = MemBase + 512*1024; // Use 512k for stubs, working backwards.
 442
 443   // We set up the memory chunk with 4 mem regions, like this:
 444   //  [ START
 445   //    [ Free      #0 ] -> Large space to allocate functions from.
 446   //    [ Allocated #1 ] -> Tiny space to separate regions.
 447   //    [ Free      #2 ] -> Tiny space so there is always at least 1 free block.
 448   //    [ Allocated #3 ] -> Tiny space to prevent looking past end of block.
 449   //  END ]
 450   //
 451   // The last three blocks are never deallocated or touched.
 452
 453   // Add MemoryRangeHeader to the end of the memory region, indicating that
 454   // the space after the block of memory is allocated.  This is block #3.
 455   MemoryRangeHeader *Mem3 = (MemoryRangeHeader*)(MemBase+MemBlock.size())-1;
 456   Mem3->ThisAllocated = 1;
 457   Mem3->PrevAllocated = 0;
 458   Mem3->BlockSize     = 0;
 459
 460   /// Add a tiny free region so that the free list always has one entry.
 461   FreeRangeHeader *Mem2 =
 462     (FreeRangeHeader *)(((char*)Mem3)-FreeRangeHeader::getMinBlockSize());
 463   Mem2->ThisAllocated = 0;
 464   Mem2->PrevAllocated = 1;
 465   Mem2->BlockSize     = FreeRangeHeader::getMinBlockSize();
 466   Mem2->SetEndOfBlockSizeMarker();
 467   Mem2->Prev = Mem2;   // Mem2 *is* the free list for now.
 468   Mem2->Next = Mem2;
 469
 470   /// Add a tiny allocated region so that Mem2 is never coalesced away.
 471   MemoryRangeHeader *Mem1 = (MemoryRangeHeader*)Mem2-1;
 472   Mem1->ThisAllocated = 1;
 473   Mem1->PrevAllocated = 0;
 474   Mem1->BlockSize     = (char*)Mem2 - (char*)Mem1;
 475
 476   // Add a FreeRangeHeader to the start of the function body region, indicating
 477   // that the space is free.  Mark the previous block allocated so we never look
 478   // at it.
 479   FreeRangeHeader *Mem0 = (FreeRangeHeader*)CurStubPtr;
 480   Mem0->ThisAllocated = 0;
 481   Mem0->PrevAllocated = 1;
 482   Mem0->BlockSize = (char*)Mem1-(char*)Mem0;
 483   Mem0->SetEndOfBlockSizeMarker();
 484   Mem0->AddToFreeList(Mem2);
 485
 486   // Start out with the freelist pointing to Mem0.
 487   FreeMemoryList = Mem0;
 488
 489   GOTBase = NULL;
 490   DlsymTable = NULL;
 491 }
 492
 493 void DefaultJITMemoryManager::AllocateGOT() {
 494   assert(GOTBase == 0 && "Cannot allocate the got multiple times");
 495   GOTBase = new unsigned char[sizeof(void*) * 8192];
 496   HasGOT = true;
 497 }
 498
 499 void DefaultJITMemoryManager::SetDlsymTable(void *ptr) {
 500   DlsymTable = ptr;
 501 }
 502
 503 DefaultJITMemoryManager::~DefaultJITMemoryManager() {
 504   for (unsigned i = 0, e = Blocks.size(); i != e; ++i)
 505     sys::Memory::ReleaseRWX(Blocks[i]);
 506
 507   delete[] GOTBase;
 508   Blocks.clear();
 509 }
 510
 511 unsigned char *DefaultJITMemoryManager::allocateStub(const GlobalValue* F,
 512                                                      unsigned StubSize,
 513                                                      unsigned Alignment) {
 514   CurStubPtr -= StubSize;
 515   CurStubPtr = (unsigned char*)(((intptr_t)CurStubPtr) &
 516                                 ~(intptr_t)(Alignment-1));
 517   if (CurStubPtr < StubBase) {
 518     // FIXME: allocate a new block
 519     fprintf(stderr, "JIT ran out of memory for function stubs!\n");
 520     abort();
 521   }
 522   return CurStubPtr;
 523 }
 524
 525 sys::MemoryBlock DefaultJITMemoryManager::getNewMemoryBlock(unsigned size) {
 526   // Allocate a new block close to the last one.
 527   const sys::MemoryBlock *BOld = Blocks.empty() ? 0 : &Blocks.front();
 528   std::string ErrMsg;
 529   sys::MemoryBlock B = sys::Memory::AllocateRWX(size, BOld, &ErrMsg);
 530   if (B.base() == 0) {
 531     fprintf(stderr,
 532             "Allocation failed when allocating new memory in the JIT\n%s\n",
 533             ErrMsg.c_str());
 534     abort();
 535   }
 536   Blocks.push_back(B);
 537   return B;
 538 }
 539
 540
 541 JITMemoryManager *JITMemoryManager::CreateDefaultMemManager() {
 542   return new DefaultJITMemoryManager();
 543 }