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