include/llvm/Support/Allocator.h

   1 //===--- Allocator.h - Simple memory allocation abstraction -----*- C++ -*-===//
   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 /// \file
  10 ///
  11 /// This file defines the MallocAllocator and BumpPtrAllocator interfaces. Both
  12 /// of these conform to an LLVM "Allocator" concept which consists of an
  13 /// Allocate method accepting a size and alignment, and a Deallocate accepting
  14 /// a pointer and size. Further, the LLVM "Allocator" concept has overloads of
  15 /// Allocate and Deallocate for setting size and alignment based on the final
  16 /// type. These overloads are typically provided by a base class template \c
  17 /// AllocatorBase.
  18 ///
  19 //===----------------------------------------------------------------------===//
  20
  21 #ifndef LLVM_SUPPORT_ALLOCATOR_H
  22 #define LLVM_SUPPORT_ALLOCATOR_H
  23
  24 #include "llvm/ADT/SmallVector.h"
  25 #include "llvm/Support/AlignOf.h"
  26 #include "llvm/Support/DataTypes.h"
  27 #include "llvm/Support/MathExtras.h"
  28 #include "llvm/Support/Memory.h"
  29 #include <algorithm>
  30 #include <cassert>
  31 #include <cstddef>
  32 #include <cstdlib>
  33
  34 namespace llvm {
  35 template <typename T> struct ReferenceAdder {
  36   typedef T &result;
  37 };
  38 template <typename T> struct ReferenceAdder<T &> {
  39   typedef T result;
  40 };
  41
  42 /// \brief CRTP base class providing obvious overloads for the core \c
  43 /// Allocate() methods of LLVM-style allocators.
  44 ///
  45 /// This base class both documents the full public interface exposed by all
  46 /// LLVM-style allocators, and redirects all of the overloads to a single core
  47 /// set of methods which the derived class must define.
  48 template <typename DerivedT> class AllocatorBase {
  49 public:
  50   /// \brief Allocate \a Size bytes of \a Alignment aligned memory. This method
  51   /// must be implemented by \c DerivedT.
  52   void *Allocate(size_t Size, size_t Alignment) {
  53 #ifdef __clang__
  54     static_assert(static_cast<void *(AllocatorBase::*)(size_t, size_t)>(
  55                       &AllocatorBase::Allocate) !=
  56                       static_cast<void *(DerivedT::*)(size_t, size_t)>(
  57                           &DerivedT::Allocate),
  58                   "Class derives from AllocatorBase without implementing the "
  59                   "core Allocate(size_t, size_t) overload!");
  60 #endif
  61     return static_cast<DerivedT *>(this)->Allocate(Size, Alignment);
  62   }
  63
  64   /// \brief Deallocate \a Ptr to \a Size bytes of memory allocated by this
  65   /// allocator.
  66   void Deallocate(const void *Ptr, size_t Size) {
  67 #ifdef __clang__
  68     static_assert(static_cast<void (AllocatorBase::*)(const void *, size_t)>(
  69                       &AllocatorBase::Deallocate) !=
  70                       static_cast<void (DerivedT::*)(const void *, size_t)>(
  71                           &DerivedT::Deallocate),
  72                   "Class derives from AllocatorBase without implementing the "
  73                   "core Deallocate(void *) overload!");
  74 #endif
  75     return static_cast<DerivedT *>(this)->Deallocate(Ptr, Size);
  76   }
  77
  78   // The rest of these methods are helpers that redirect to one of the above
  79   // core methods.
  80
  81   /// \brief Allocate space for a sequence of objects without constructing them.
  82   template <typename T> T *Allocate(size_t Num = 1) {
  83     return static_cast<T *>(Allocate(Num * sizeof(T), AlignOf<T>::Alignment));
  84   }
  85
  86   /// \brief Deallocate space for a sequence of objects without constructing them.
  87   template <typename T>
  88   typename std::enable_if<
  89       !std::is_same<typename std::remove_cv<T>::type, void>::value, void>::type
  90   Deallocate(T *Ptr, size_t Num = 1) {
  91     Deallocate(static_cast<const void *>(Ptr), Num * sizeof(T));
  92   }
  93 };
  94
  95 class MallocAllocator : public AllocatorBase<MallocAllocator> {
  96 public:
  97   void Reset() {}
  98
  99   void *Allocate(size_t Size, size_t /*Alignment*/) { return malloc(Size); }
 100
 101   // Pull in base class overloads.
 102   using AllocatorBase<MallocAllocator>::Allocate;
 103
 104   void Deallocate(const void *Ptr, size_t /*Size*/) {
 105     free(const_cast<void *>(Ptr));
 106   }
 107
 108   // Pull in base class overloads.
 109   using AllocatorBase<MallocAllocator>::Deallocate;
 110
 111   void PrintStats() const {}
 112 };
 113
 114 namespace detail {
 115
 116 // We call out to an external function to actually print the message as the
 117 // printing code uses Allocator.h in its implementation.
 118 void printBumpPtrAllocatorStats(unsigned NumSlabs, size_t BytesAllocated,
 119                                 size_t TotalMemory);
 120 } // End namespace detail.
 121
 122 /// \brief Allocate memory in an ever growing pool, as if by bump-pointer.
 123 ///
 124 /// This isn't strictly a bump-pointer allocator as it uses backing slabs of
 125 /// memory rather than relying on boundless contiguous heap. However, it has
 126 /// bump-pointer semantics in that is a monotonically growing pool of memory
 127 /// where every allocation is found by merely allocating the next N bytes in
 128 /// the slab, or the next N bytes in the next slab.
 129 ///
 130 /// Note that this also has a threshold for forcing allocations above a certain
 131 /// size into their own slab.
 132 ///
 133 /// The BumpPtrAllocatorImpl template defaults to using a MallocAllocator
 134 /// object, which wraps malloc, to allocate memory, but it can be changed to
 135 /// use a custom allocator.
 136 template <typename AllocatorT = MallocAllocator, size_t SlabSize = 4096,
 137           size_t SizeThreshold = SlabSize>
 138 class BumpPtrAllocatorImpl
 139     : public AllocatorBase<
 140           BumpPtrAllocatorImpl<AllocatorT, SlabSize, SizeThreshold>> {
 141   BumpPtrAllocatorImpl(const BumpPtrAllocatorImpl &) LLVM_DELETED_FUNCTION;
 142   void operator=(const BumpPtrAllocatorImpl &) LLVM_DELETED_FUNCTION;
 143
 144 public:
 145   static_assert(SizeThreshold <= SlabSize,
 146                 "The SizeThreshold must be at most the SlabSize to ensure "
 147                 "that objects larger than a slab go into their own memory "
 148                 "allocation.");
 149
 150   BumpPtrAllocatorImpl()
 151       : CurPtr(nullptr), End(nullptr), BytesAllocated(0), Allocator() {}
 152   template <typename T>
 153   BumpPtrAllocatorImpl(T &&Allocator)
 154       : CurPtr(nullptr), End(nullptr), BytesAllocated(0),
 155         Allocator(std::forward<T &&>(Allocator)) {}
 156   ~BumpPtrAllocatorImpl() {
 157     DeallocateSlabs(Slabs.begin(), Slabs.end());
 158     DeallocateCustomSizedSlabs();
 159   }
 160
 161   /// \brief Deallocate all but the current slab and reset the current pointer
 162   /// to the beginning of it, freeing all memory allocated so far.
 163   void Reset() {
 164     if (Slabs.empty())
 165       return;
 166
 167     // Reset the state.
 168     BytesAllocated = 0;
 169     CurPtr = (char *)Slabs.front();
 170     End = CurPtr + SlabSize;
 171
 172     // Deallocate all but the first slab, and all custome sized slabs.
 173     DeallocateSlabs(std::next(Slabs.begin()), Slabs.end());
 174     Slabs.erase(std::next(Slabs.begin()), Slabs.end());
 175     DeallocateCustomSizedSlabs();
 176     CustomSizedSlabs.clear();
 177   }
 178
 179   /// \brief Allocate space at the specified alignment.
 180   void *Allocate(size_t Size, size_t Alignment) {
 181     if (!CurPtr) // Start a new slab if we haven't allocated one already.
 182       StartNewSlab();
 183
 184     // Keep track of how many bytes we've allocated.
 185     BytesAllocated += Size;
 186
 187     // 0-byte alignment means 1-byte alignment.
 188     if (Alignment == 0)
 189       Alignment = 1;
 190
 191     // Allocate the aligned space, going forwards from CurPtr.
 192     char *Ptr = alignPtr(CurPtr, Alignment);
 193
 194     // Check if we can hold it.
 195     if (Ptr + Size <= End) {
 196       CurPtr = Ptr + Size;
 197       // Update the allocation point of this memory block in MemorySanitizer.
 198       // Without this, MemorySanitizer messages for values originated from here
 199       // will point to the allocation of the entire slab.
 200       __msan_allocated_memory(Ptr, Size);
 201       return Ptr;
 202     }
 203
 204     // If Size is really big, allocate a separate slab for it.
 205     size_t PaddedSize = Size + Alignment - 1;
 206     if (PaddedSize > SizeThreshold) {
 207       void *NewSlab = Allocator.Allocate(PaddedSize, 0);
 208       CustomSizedSlabs.push_back(std::make_pair(NewSlab, PaddedSize));
 209
 210       Ptr = alignPtr((char *)NewSlab, Alignment);
 211       assert((uintptr_t)Ptr + Size <= (uintptr_t)NewSlab + PaddedSize);
 212       __msan_allocated_memory(Ptr, Size);
 213       return Ptr;
 214     }
 215
 216     // Otherwise, start a new slab and try again.
 217     StartNewSlab();
 218     Ptr = alignPtr(CurPtr, Alignment);
 219     CurPtr = Ptr + Size;
 220     assert(CurPtr <= End && "Unable to allocate memory!");
 221     __msan_allocated_memory(Ptr, Size);
 222     return Ptr;
 223   }
 224
 225   // Pull in base class overloads.
 226   using AllocatorBase<BumpPtrAllocatorImpl>::Allocate;
 227
 228   void Deallocate(const void * /*Ptr*/, size_t /*Size*/) {}
 229
 230   // Pull in base class overloads.
 231   using AllocatorBase<BumpPtrAllocatorImpl>::Deallocate;
 232
 233   size_t GetNumSlabs() const { return Slabs.size() + CustomSizedSlabs.size(); }
 234
 235   size_t getTotalMemory() const {
 236     size_t TotalMemory = 0;
 237     for (auto I = Slabs.begin(), E = Slabs.end(); I != E; ++I)
 238       TotalMemory += computeSlabSize(std::distance(Slabs.begin(), I));
 239     for (auto &PtrAndSize : CustomSizedSlabs)
 240       TotalMemory += PtrAndSize.second;
 241     return TotalMemory;
 242   }
 243
 244   void PrintStats() const {
 245     detail::printBumpPtrAllocatorStats(Slabs.size(), BytesAllocated,
 246                                        getTotalMemory());
 247   }
 248
 249 private:
 250   /// \brief The current pointer into the current slab.
 251   ///
 252   /// This points to the next free byte in the slab.
 253   char *CurPtr;
 254
 255   /// \brief The end of the current slab.
 256   char *End;
 257
 258   /// \brief The slabs allocated so far.
 259   SmallVector<void *, 4> Slabs;
 260
 261   /// \brief Custom-sized slabs allocated for too-large allocation requests.
 262   SmallVector<std::pair<void *, size_t>, 0> CustomSizedSlabs;
 263
 264   /// \brief How many bytes we've allocated.
 265   ///
 266   /// Used so that we can compute how much space was wasted.
 267   size_t BytesAllocated;
 268
 269   /// \brief The allocator instance we use to get slabs of memory.
 270   AllocatorT Allocator;
 271
 272   static size_t computeSlabSize(unsigned SlabIdx) {
 273     // Scale the actual allocated slab size based on the number of slabs
 274     // allocated. Every 128 slabs allocated, we double the allocated size to
 275     // reduce allocation frequency, but saturate at multiplying the slab size by
 276     // 2^30.
 277     return SlabSize * ((size_t)1 << std::min<size_t>(30, SlabIdx / 128));
 278   }
 279
 280   /// \brief Allocate a new slab and move the bump pointers over into the new
 281   /// slab, modifying CurPtr and End.
 282   void StartNewSlab() {
 283     size_t AllocatedSlabSize = computeSlabSize(Slabs.size());
 284
 285     void *NewSlab = Allocator.Allocate(AllocatedSlabSize, 0);
 286     Slabs.push_back(NewSlab);
 287     CurPtr = (char *)(NewSlab);
 288     End = ((char *)NewSlab) + AllocatedSlabSize;
 289   }
 290
 291   /// \brief Deallocate a sequence of slabs.
 292   void DeallocateSlabs(SmallVectorImpl<void *>::iterator I,
 293                        SmallVectorImpl<void *>::iterator E) {
 294     for (; I != E; ++I) {
 295       size_t AllocatedSlabSize =
 296           computeSlabSize(std::distance(Slabs.begin(), I));
 297 #ifndef NDEBUG
 298       // Poison the memory so stale pointers crash sooner.  Note we must
 299       // preserve the Size and NextPtr fields at the beginning.
 300       sys::Memory::setRangeWritable(*I, AllocatedSlabSize);
 301       memset(*I, 0xCD, AllocatedSlabSize);
 302 #endif
 303       Allocator.Deallocate(*I, AllocatedSlabSize);
 304     }
 305   }
 306
 307   /// \brief Deallocate all memory for custom sized slabs.
 308   void DeallocateCustomSizedSlabs() {
 309     for (auto &PtrAndSize : CustomSizedSlabs) {
 310       void *Ptr = PtrAndSize.first;
 311       size_t Size = PtrAndSize.second;
 312 #ifndef NDEBUG
 313       // Poison the memory so stale pointers crash sooner.  Note we must
 314       // preserve the Size and NextPtr fields at the beginning.
 315       sys::Memory::setRangeWritable(Ptr, Size);
 316       memset(Ptr, 0xCD, Size);
 317 #endif
 318       Allocator.Deallocate(Ptr, Size);
 319     }
 320   }
 321
 322   template <typename T> friend class SpecificBumpPtrAllocator;
 323 };
 324
 325 /// \brief The standard BumpPtrAllocator which just uses the default template
 326 /// paramaters.
 327 typedef BumpPtrAllocatorImpl<> BumpPtrAllocator;
 328
 329 /// \brief A BumpPtrAllocator that allows only elements of a specific type to be
 330 /// allocated.
 331 ///
 332 /// This allows calling the destructor in DestroyAll() and when the allocator is
 333 /// destroyed.
 334 template <typename T> class SpecificBumpPtrAllocator {
 335   BumpPtrAllocator Allocator;
 336
 337 public:
 338   SpecificBumpPtrAllocator() : Allocator() {}
 339
 340   ~SpecificBumpPtrAllocator() { DestroyAll(); }
 341
 342   /// Call the destructor of each allocated object and deallocate all but the
 343   /// current slab and reset the current pointer to the beginning of it, freeing
 344   /// all memory allocated so far.
 345   void DestroyAll() {
 346     auto DestroyElements = [](char *Begin, char *End) {
 347       assert(Begin == alignPtr(Begin, alignOf<T>()));
 348       for (char *Ptr = Begin; Ptr + sizeof(T) <= End; Ptr += sizeof(T))
 349         reinterpret_cast<T *>(Ptr)->~T();
 350     };
 351
 352     for (auto I = Allocator.Slabs.begin(), E = Allocator.Slabs.end(); I != E;
 353          ++I) {
 354       size_t AllocatedSlabSize = BumpPtrAllocator::computeSlabSize(
 355           std::distance(Allocator.Slabs.begin(), I));
 356       char *Begin = alignPtr((char *)*I, alignOf<T>());
 357       char *End = *I == Allocator.Slabs.back() ? Allocator.CurPtr
 358                                                : (char *)*I + AllocatedSlabSize;
 359
 360       DestroyElements(Begin, End);
 361     }
 362
 363     for (auto &PtrAndSize : Allocator.CustomSizedSlabs) {
 364       void *Ptr = PtrAndSize.first;
 365       size_t Size = PtrAndSize.second;
 366       DestroyElements(alignPtr((char *)Ptr, alignOf<T>()), (char *)Ptr + Size);
 367     }
 368
 369     Allocator.Reset();
 370   }
 371
 372   /// \brief Allocate space for an array of objects without constructing them.
 373   T *Allocate(size_t num = 1) { return Allocator.Allocate<T>(num); }
 374
 375 private:
 376 };
 377
 378 }  // end namespace llvm
 379
 380 template <typename AllocatorT, size_t SlabSize, size_t SizeThreshold>
 381 void *operator new(size_t Size,
 382                    llvm::BumpPtrAllocatorImpl<AllocatorT, SlabSize,
 383                                               SizeThreshold> &Allocator) {
 384   struct S {
 385     char c;
 386     union {
 387       double D;
 388       long double LD;
 389       long long L;
 390       void *P;
 391     } x;
 392   };
 393   return Allocator.Allocate(
 394       Size, std::min((size_t)llvm::NextPowerOf2(Size), offsetof(S, x)));
 395 }
 396
 397 template <typename AllocatorT, size_t SlabSize, size_t SizeThreshold>
 398 void operator delete(
 399     void *, llvm::BumpPtrAllocatorImpl<AllocatorT, SlabSize, SizeThreshold> &) {
 400 }
 401
 402 #endif // LLVM_SUPPORT_ALLOCATOR_H