Allocate memory in an ever growing pool, as if by bump-pointer. More...
#include "llvm/Support/Allocator.h"
Public Member Functions | |
| BumpPtrAllocatorImpl ()=default | |
| template<typename T > | |
| BumpPtrAllocatorImpl (T &&Allocator) | |
| BumpPtrAllocatorImpl (BumpPtrAllocatorImpl &&Old) | |
| ~BumpPtrAllocatorImpl () | |
| BumpPtrAllocatorImpl & | operator= (BumpPtrAllocatorImpl &&RHS) |
| void | Reset () |
| Deallocate all but the current slab and reset the current pointer to the beginning of it, freeing all memory allocated so far. More... | |
| LLVM_ATTRIBUTE_RETURNS_NONNULL void * | Allocate (size_t Size, Align Alignment) |
| Allocate space at the specified alignment. More... | |
| LLVM_ATTRIBUTE_RETURNS_NONNULL void * | Allocate (size_t Size, size_t Alignment) |
| void | Deallocate (const void *Ptr, size_t Size, size_t) |
| size_t | GetNumSlabs () const |
| llvm::Optional< int64_t > | identifyObject (const void *Ptr) |
| int64_t | identifyKnownObject (const void *Ptr) |
| A wrapper around identifyObject that additionally asserts that the object is indeed within the allocator. More... | |
| template<typename T > | |
| int64_t | identifyKnownAlignedObject (const void *Ptr) |
| A wrapper around identifyKnownObject. More... | |
| size_t | getTotalMemory () const |
| size_t | getBytesAllocated () const |
| void | setRedZoneSize (size_t NewSize) |
| void | PrintStats () const |
 Public Member Functions inherited from llvm::AllocatorBase< BumpPtrAllocatorImpl< MallocAllocator, 4096, 4096, 128 > > | |
| void * | Allocate (size_t Size, size_t Alignment) |
| Allocate Size bytes of Alignment aligned memory. More... | |
| T * | Allocate (size_t Num=1) |
| Allocate space for a sequence of objects without constructing them. More... | |
| void | Deallocate (const void *Ptr, size_t Size, size_t Alignment) |
| Deallocate Ptr to Size bytes of memory allocated by this allocator. More... | |
| std::enable_if_t<!std::is_same< std::remove_cv_t< T >, void >::value, void > | Deallocate (T *Ptr, size_t Num=1) |
| Deallocate space for a sequence of objects without constructing them. More... | |
Friends | |
| template<typename T > | |
| class | SpecificBumpPtrAllocator |
Detailed Description
template<typename AllocatorT = MallocAllocator, size_t SlabSize = 4096, size_t SizeThreshold = SlabSize, size_t GrowthDelay = 128>
class llvm::BumpPtrAllocatorImpl< AllocatorT, SlabSize, SizeThreshold, GrowthDelay >
Allocate memory in an ever growing pool, as if by bump-pointer.
This isn't strictly a bump-pointer allocator as it uses backing slabs of memory rather than relying on a boundless contiguous heap. However, it has bump-pointer semantics in that it is a monotonically growing pool of memory where every allocation is found by merely allocating the next N bytes in the slab, or the next N bytes in the next slab.
Note that this also has a threshold for forcing allocations above a certain size into their own slab.
The BumpPtrAllocatorImpl template defaults to using a MallocAllocator object, which wraps malloc, to allocate memory, but it can be changed to use a custom allocator.
The GrowthDelay specifies after how many allocated slabs the allocator increases the size of the slabs.
Definition at line 63 of file Allocator.h.
Constructor & Destructor Documentation
◆ BumpPtrAllocatorImpl() [1/3]
|
default |
◆ BumpPtrAllocatorImpl() [2/3]
|
inline |
Definition at line 79 of file Allocator.h.
◆ BumpPtrAllocatorImpl() [3/3]
|
inline |
Definition at line 84 of file Allocator.h.
◆ ~BumpPtrAllocatorImpl()
|
inline |
Definition at line 95 of file Allocator.h.
Member Function Documentation
◆ Allocate() [1/2]
|
inline |
Allocate space at the specified alignment.
Definition at line 146 of file Allocator.h.
Referenced by llvm::jitlink::LinkGraph::addAbsoluteSymbol(), llvm::jitlink::LinkGraph::addAnonymousSymbol(), llvm::jitlink::LinkGraph::addCommonSymbol(), llvm::jitlink::LinkGraph::addDefinedSymbol(), llvm::jitlink::LinkGraph::addExternalSymbol(), llvm::BumpPtrAllocatorImpl< MallocAllocator, 65536 >::Allocate(), llvm::jitlink::LinkGraph::allocateBuffer(), llvm::jitlink::LinkGraph::allocateContent(), llvm::MachineFunction::allocateRegMask(), llvm::MachineFunction::allocateShuffleMask(), llvm::jitlink::LinkGraph::allocateString(), llvm::MachineFunction::createExternalSymbolName(), llvm::pdb::TpiStreamBuilder::finalizeMsfLayout(), llvm::msf::MSFBuilder::generateLayout(), llvm::FunctionType::get(), llvm::Attribute::get(), llvm::RecordRecTy::get(), llvm::BitsInit::get(), llvm::ListInit::get(), llvm::CondOpInit::get(), llvm::VarDefInit::get(), llvm::DagInit::get(), llvm::ScalarEvolution::getMinMaxExpr(), llvm::ScalarEvolution::getSequentialMinMaxExpr(), llvm::SelectionDAG::getVectorShuffle(), llvm::SelectionDAG::getVTList(), llvm::codeview::GlobalTypeTableBuilder::insertRecordAs(), llvm::StringSaver::save(), stabilize(), and llvm::codeview::SymbolSerializer::visitSymbolEnd().
◆ Allocate() [2/2]
|
inline |
Definition at line 205 of file Allocator.h.
◆ Deallocate()
|
inline |
Definition at line 216 of file Allocator.h.
◆ getBytesAllocated()
|
inline |
Definition at line 288 of file Allocator.h.
◆ GetNumSlabs()
|
inline |
Definition at line 223 of file Allocator.h.
◆ getTotalMemory()
|
inline |
Definition at line 279 of file Allocator.h.
Referenced by llvm::BumpPtrAllocatorImpl< MallocAllocator, 65536 >::PrintStats().
◆ identifyKnownAlignedObject()
|
inline |
A wrapper around identifyKnownObject.
Accepts type information about the object and produces a smaller identifier by relying on the alignment information. Note that sub-classes may have different alignment, so the most base class should be passed as template parameter in order to obtain correct results. For that reason automatic template parameter deduction is disabled.
- Returns
- An index uniquely and reproducibly identifying an input pointer
Ptrin the given allocator. This identifier is different from the ones produced by identifyObject and identifyAlignedObject.
Definition at line 273 of file Allocator.h.
◆ identifyKnownObject()
|
inline |
A wrapper around identifyObject that additionally asserts that the object is indeed within the allocator.
- Returns
- An index uniquely and reproducibly identifying an input pointer
Ptrin the given allocator.
Definition at line 256 of file Allocator.h.
Referenced by llvm::BumpPtrAllocatorImpl< MallocAllocator, 65536 >::identifyKnownAlignedObject().
◆ identifyObject()
|
inline |
- Returns
- An index uniquely and reproducibly identifying an input pointer
Ptrin the given allocator. The returned value is negative iff the object is inside a custom-size slab. Returns an empty optional if the pointer is not found in the allocator.
Definition at line 230 of file Allocator.h.
Referenced by llvm::BumpPtrAllocatorImpl< MallocAllocator, 65536 >::identifyKnownObject().
◆ operator=()
|
inline |
Definition at line 100 of file Allocator.h.
◆ PrintStats()
|
inline |
Definition at line 294 of file Allocator.h.
◆ Reset()
|
inline |
Deallocate all but the current slab and reset the current pointer to the beginning of it, freeing all memory allocated so far.
Definition at line 121 of file Allocator.h.
Referenced by llvm::rdf::NodeAllocator::clear(), llvm::SelectionDAG::clear(), llvm::LiveStacks::releaseMemory(), llvm::GISelCSEInfo::releaseMemory(), llvm::LiveIntervals::releaseMemory(), llvm::SlotIndexes::releaseMemory(), and llvm::MCContext::reset().
◆ setRedZoneSize()
|
inline |
Definition at line 290 of file Allocator.h.
Friends And Related Function Documentation
◆ SpecificBumpPtrAllocator
|
friend |
Definition at line 367 of file Allocator.h.
The documentation for this class was generated from the following file:
- include/llvm/Support/Allocator.h
