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