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