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