Allocate memory in an ever growing pool, as if by bump-pointer. More...

#include "llvm/Support/Allocator.h"

Inheritance diagram for llvm::BumpPtrAllocatorImpl< AllocatorT, SlabSize, SizeThreshold, GrowthDelay, MinAlign >:

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.
LLVM_ATTRIBUTE_RETURNS_NONNULL void *	Allocate (size_t Size, Align Alignment)
	Allocate space at the specified alignment.
LLVM_ATTRIBUTE_RETURNS_NONNULL LLVM_ATTRIBUTE_NOINLINE void *	AllocateSlow (size_t Size, size_t SizeToAllocate, Align Alignment)
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
std::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.
template<typename T>
int64_t	identifyKnownAlignedObject (const void *Ptr)
	A wrapper around identifyKnownObject.
size_t	getTotalMemory () const
void	setRedZoneSize (size_t NewSize)
void	PrintStats () const
Public Member Functions inherited from llvm::AllocatorBase< BumpPtrAllocatorImpl< MallocAllocator, 4096, 4096, 128, 8 > >
void *	Allocate (size_t Size, size_t Alignment)
	Allocate Size bytes of Alignment aligned memory.
void	Deallocate (const void *Ptr, size_t Size, size_t Alignment)
	Deallocate Ptr to Size bytes of memory allocated by this allocator.

Friends
template<typename T>
class	SpecificBumpPtrAllocator

Detailed Description

template<typename AllocatorT = MallocAllocator, size_t SlabSize = 4096, size_t SizeThreshold = SlabSize, size_t GrowthDelay = 128, size_t MinAlign = 8>
class llvm::BumpPtrAllocatorImpl< AllocatorT, SlabSize, SizeThreshold, GrowthDelay, MinAlign >

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.

MinAlign keeps the bump pointer aligned between allocations: each size is rounded up to a multiple of MinAlign so the fast path can skip realigning CurPtr when the requested alignment is no greater than MinAlign.

Definition at line 68 of file Allocator.h.

Constructor & Destructor Documentation

◆ BumpPtrAllocatorImpl() [1/3]

template<typename AllocatorT = MallocAllocator, size_t SlabSize = 4096, size_t SizeThreshold = SlabSize, size_t GrowthDelay = 128, size_t MinAlign = 8>

llvm::BumpPtrAllocatorImpl< AllocatorT, SlabSize, SizeThreshold, GrowthDelay, MinAlign >::BumpPtrAllocatorImpl ( )

default

◆ BumpPtrAllocatorImpl() [2/3]

template<typename AllocatorT = MallocAllocator, size_t SlabSize = 4096, size_t SizeThreshold = SlabSize, size_t GrowthDelay = 128, size_t MinAlign = 8>

template<typename T>

llvm::BumpPtrAllocatorImpl< AllocatorT, SlabSize, SizeThreshold, GrowthDelay, MinAlign >::BumpPtrAllocatorImpl ( T && Allocator )

inline

Definition at line 90 of file Allocator.h.

◆ BumpPtrAllocatorImpl() [3/3]

template<typename AllocatorT = MallocAllocator, size_t SlabSize = 4096, size_t SizeThreshold = SlabSize, size_t GrowthDelay = 128, size_t MinAlign = 8>

llvm::BumpPtrAllocatorImpl< AllocatorT, SlabSize, SizeThreshold, GrowthDelay, MinAlign >::BumpPtrAllocatorImpl ( BumpPtrAllocatorImpl< AllocatorT, SlabSize, SizeThreshold, GrowthDelay, MinAlign > && Old )

inline

Definition at line 95 of file Allocator.h.

◆ ~BumpPtrAllocatorImpl()

template<typename AllocatorT = MallocAllocator, size_t SlabSize = 4096, size_t SizeThreshold = SlabSize, size_t GrowthDelay = 128, size_t MinAlign = 8>

llvm::BumpPtrAllocatorImpl< AllocatorT, SlabSize, SizeThreshold, GrowthDelay, MinAlign >::~BumpPtrAllocatorImpl ( )

inline

Definition at line 108 of file Allocator.h.

Member Function Documentation

◆ Allocate() [1/2]

template<typename AllocatorT = MallocAllocator, size_t SlabSize = 4096, size_t SizeThreshold = SlabSize, size_t GrowthDelay = 128, size_t MinAlign = 8>

LLVM_ATTRIBUTE_RETURNS_NONNULL void * llvm::BumpPtrAllocatorImpl< AllocatorT, SlabSize, SizeThreshold, GrowthDelay, MinAlign >::Allocate	(	size_t	Size,
		Align	Alignment )

inline

Allocate space at the specified alignment.

Definition at line 159 of file Allocator.h.

Referenced by llvm::BumpPtrAllocatorImpl< MallocAllocator, 65536 >::Allocate().

◆ Allocate() [2/2]

template<typename AllocatorT = MallocAllocator, size_t SlabSize = 4096, size_t SizeThreshold = SlabSize, size_t GrowthDelay = 128, size_t MinAlign = 8>

LLVM_ATTRIBUTE_RETURNS_NONNULL void * llvm::BumpPtrAllocatorImpl< AllocatorT, SlabSize, SizeThreshold, GrowthDelay, MinAlign >::Allocate	(	size_t	Size,
		size_t	Alignment )

inline

Definition at line 225 of file Allocator.h.

◆ AllocateSlow()

template<typename AllocatorT = MallocAllocator, size_t SlabSize = 4096, size_t SizeThreshold = SlabSize, size_t GrowthDelay = 128, size_t MinAlign = 8>

LLVM_ATTRIBUTE_RETURNS_NONNULL LLVM_ATTRIBUTE_NOINLINE void * llvm::BumpPtrAllocatorImpl< AllocatorT, SlabSize, SizeThreshold, GrowthDelay, MinAlign >::AllocateSlow	(	size_t	Size,
		size_t	SizeToAllocate,
		Align	Alignment )

inline

Definition at line 193 of file Allocator.h.

Referenced by llvm::BumpPtrAllocatorImpl< MallocAllocator, 65536 >::Allocate().

◆ Deallocate()

template<typename AllocatorT = MallocAllocator, size_t SlabSize = 4096, size_t SizeThreshold = SlabSize, size_t GrowthDelay = 128, size_t MinAlign = 8>

void llvm::BumpPtrAllocatorImpl< AllocatorT, SlabSize, SizeThreshold, GrowthDelay, MinAlign >::Deallocate	(	const void *	Ptr,
		size_t	Size,
		size_t	)

inline

Definition at line 236 of file Allocator.h.

◆ GetNumSlabs()

template<typename AllocatorT = MallocAllocator, size_t SlabSize = 4096, size_t SizeThreshold = SlabSize, size_t GrowthDelay = 128, size_t MinAlign = 8>

size_t llvm::BumpPtrAllocatorImpl< AllocatorT, SlabSize, SizeThreshold, GrowthDelay, MinAlign >::GetNumSlabs ( ) const

inline

Definition at line 243 of file Allocator.h.

◆ getTotalMemory()

template<typename AllocatorT = MallocAllocator, size_t SlabSize = 4096, size_t SizeThreshold = SlabSize, size_t GrowthDelay = 128, size_t MinAlign = 8>

size_t llvm::BumpPtrAllocatorImpl< AllocatorT, SlabSize, SizeThreshold, GrowthDelay, MinAlign >::getTotalMemory ( ) const

inline

Definition at line 299 of file Allocator.h.

◆ identifyKnownAlignedObject()

template<typename AllocatorT = MallocAllocator, size_t SlabSize = 4096, size_t SizeThreshold = SlabSize, size_t GrowthDelay = 128, size_t MinAlign = 8>

template<typename T>

int64_t llvm::BumpPtrAllocatorImpl< AllocatorT, SlabSize, SizeThreshold, GrowthDelay, MinAlign >::identifyKnownAlignedObject ( const void * Ptr )

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 Ptr in the given allocator. This identifier is different from the ones produced by identifyObject and identifyAlignedObject.

Definition at line 293 of file Allocator.h.

◆ identifyKnownObject()

template<typename AllocatorT = MallocAllocator, size_t SlabSize = 4096, size_t SizeThreshold = SlabSize, size_t GrowthDelay = 128, size_t MinAlign = 8>

int64_t llvm::BumpPtrAllocatorImpl< AllocatorT, SlabSize, SizeThreshold, GrowthDelay, MinAlign >::identifyKnownObject ( const void * Ptr )

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 Ptr in the given allocator.

Definition at line 276 of file Allocator.h.

Referenced by llvm::BumpPtrAllocatorImpl< MallocAllocator, 65536 >::identifyKnownAlignedObject().

◆ identifyObject()

template<typename AllocatorT = MallocAllocator, size_t SlabSize = 4096, size_t SizeThreshold = SlabSize, size_t GrowthDelay = 128, size_t MinAlign = 8>

std::optional< int64_t > llvm::BumpPtrAllocatorImpl< AllocatorT, SlabSize, SizeThreshold, GrowthDelay, MinAlign >::identifyObject ( const void * Ptr )

inline

Returns: An index uniquely and reproducibly identifying an input pointer Ptr in 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 250 of file Allocator.h.

Referenced by llvm::BumpPtrAllocatorImpl< MallocAllocator, 65536 >::identifyKnownObject().

◆ operator=()

template<typename AllocatorT = MallocAllocator, size_t SlabSize = 4096, size_t SizeThreshold = SlabSize, size_t GrowthDelay = 128, size_t MinAlign = 8>

BumpPtrAllocatorImpl & llvm::BumpPtrAllocatorImpl< AllocatorT, SlabSize, SizeThreshold, GrowthDelay, MinAlign >::operator= ( BumpPtrAllocatorImpl< AllocatorT, SlabSize, SizeThreshold, GrowthDelay, MinAlign > && RHS )

inline

Definition at line 113 of file Allocator.h.

◆ PrintStats()

template<typename AllocatorT = MallocAllocator, size_t SlabSize = 4096, size_t SizeThreshold = SlabSize, size_t GrowthDelay = 128, size_t MinAlign = 8>

void llvm::BumpPtrAllocatorImpl< AllocatorT, SlabSize, SizeThreshold, GrowthDelay, MinAlign >::PrintStats ( ) const

inline

Definition at line 314 of file Allocator.h.

◆ Reset()

template<typename AllocatorT = MallocAllocator, size_t SlabSize = 4096, size_t SizeThreshold = SlabSize, size_t GrowthDelay = 128, size_t MinAlign = 8>

void llvm::BumpPtrAllocatorImpl< AllocatorT, SlabSize, SizeThreshold, GrowthDelay, MinAlign >::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 135 of file Allocator.h.

◆ setRedZoneSize()

template<typename AllocatorT = MallocAllocator, size_t SlabSize = 4096, size_t SizeThreshold = SlabSize, size_t GrowthDelay = 128, size_t MinAlign = 8>

void llvm::BumpPtrAllocatorImpl< AllocatorT, SlabSize, SizeThreshold, GrowthDelay, MinAlign >::setRedZoneSize ( size_t NewSize )

inline

Definition at line 308 of file Allocator.h.

◆ SpecificBumpPtrAllocator

template<typename AllocatorT = MallocAllocator, size_t SlabSize = 4096, size_t SizeThreshold = SlabSize, size_t GrowthDelay = 128, size_t MinAlign = 8>

template<typename T>

friend class SpecificBumpPtrAllocator

friend

Definition at line 385 of file Allocator.h.

The documentation for this class was generated from the following file:

include/llvm/Support/Allocator.h

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ BumpPtrAllocatorImpl() [1/3]

◆ BumpPtrAllocatorImpl() [2/3]

◆ BumpPtrAllocatorImpl() [3/3]

◆ ~BumpPtrAllocatorImpl()

Member Function Documentation

◆ Allocate() [1/2]

◆ Allocate() [2/2]

◆ AllocateSlow()

◆ Deallocate()

◆ GetNumSlabs()

◆ getTotalMemory()

◆ identifyKnownAlignedObject()

◆ identifyKnownObject()

◆ identifyObject()

◆ operator=()

◆ PrintStats()

◆ Reset()

◆ setRedZoneSize()

Friends And Related Symbol Documentation

◆ SpecificBumpPtrAllocator