Description:

template<size_t TCapacityInKB, typename TAllocator = lang::HeapAllocator>
class alib::monomem::TLocalAllocator< TCapacityInKB, TAllocator >

A mono allocator, that incorporates a member of templated size TCapacityInKB, which is used as the initial buffer for allocation. The class is intended to be instantiated by local variables, hence using stack memory.
When the initial buffer is exhausted, further buffers will be heap allocated.

Note that the usual type alias given in namespace alib, in this case misses the leading "T", and is given with LocalAllocator. Besides that, further aliases that denote specific stack sizes are provided with LocalAllocator1K, LocalAllocator2K, LocalAllocator4K, LocalAllocator8K, LocalAllocator16K, LocalAllocator32K, and LocalAllocator64K.

See also: Chapter 3.3 Class LocalAllocator of the Programmer's Manual of this ALib Camp.

Template Parameters

TCapacityInKB	The size of the internal buffer in kilobytes.
TAllocator	The allocator type that parent TMonoAllocator should be chained to. Defaults to HeapAllocator.

Definition at line 44 of file localallocator.hpp.

#include <localallocator.hpp>

Inheritance diagram for TLocalAllocator< TCapacityInKB, TAllocator >:

[legend]

Collaboration diagram for TLocalAllocator< TCapacityInKB, TAllocator >:

[legend]

Public Method Index:
	TLocalAllocator (TAllocator &pAllocator, unsigned int pBufferGrowthInPercent=200)

	TLocalAllocator (unsigned int pBufferGrowthInPercent=200)

	~TLocalAllocator ()
	Destructor. Calls MonoAllocator::destructWithExternalBuffer.

MonoAllocator &	AsMonoAllocator ()

Public Method Index: inherited from TMonoAllocator< lang::HeapAllocator >
	TMonoAllocator (const char dbgName, detail::Buffer pInitialBuffer, size_t pInitialBufferSizeInKB, unsigned int pBufferGrowthInPercent=200)

	TMonoAllocator (const char dbgName, lang::HeapAllocator &pAllocator, detail::Buffer pInitialBuffer, size_t pInitialBufferSizeInKB, unsigned int pBufferGrowthInPercent=200)

ALIB_API	TMonoAllocator (const char *dbgName, lang::HeapAllocator &pAllocator, size_t pInitialBufferSizeInKB, unsigned int pBufferGrowthInPercent=200)

	TMonoAllocator (const char *dbgName, size_t pInitialBufferSizeInKB, unsigned int pBufferGrowthInPercent=200)

	TMonoAllocator (const char *dbgName, std::nullptr_t) noexcept

	TMonoAllocator (const TMonoAllocator &)=delete
	Not copyable.

	TMonoAllocator (TMonoAllocator &&)=delete
	Not movable.

ALIB_API	~TMonoAllocator ()
	Destructor. Disposes all memory allocated with ChainedAllocator.

void *	allocate (size_t size, size_t alignment)

void *	reallocate (void *mem, size_t oldSize, size_t newSize, size_t alignment)

void	free (void *mem, size_t size) const

void	dbgAcknowledgeIncreasedAllocSize (void *, TSize) const

lang::AllocatorInterface< TMonoAllocator >	operator() ()

constexpr bool	allowsMemSplit () noexcept

Snapshot	TakeSnapshot ()

ALIB_API void	Reset (Snapshot snapshot=Snapshot())

void	Reset (size_t firstObjectSize, size_t firstObjectAlignment)

ALIB_API void	GetStatistics (Statistics &result)

ALIB_FORCE_INLINE void	DbgLock (bool onOff) noexcept

void	dbgCheckMemory (void *mem, TSize size)

const DbgStatistics &	DbgGetStatistics () const

ALIB_API NAString	DbgDumpStatistics ()

ALIB_API void	destructWithExternalBuffer ()

bool	IsInitialized () const noexcept

Public Method Index: inherited from AllocatorMember< lang::HeapAllocator >
	AllocatorMember ()=delete
	Deleted default constructor. (The allocator has to be given with construction)

	AllocatorMember (lang::HeapAllocator &pAllocator) noexcept

AllocatorInterface< lang::HeapAllocator >	AI () const noexcept

lang::HeapAllocator &	GetAllocator () const noexcept

Protected Type Index:
using	base = TMonoAllocator<TAllocator>
	Shortcut to our base type.

Protected Type Index: inherited from TMonoAllocator< lang::HeapAllocator >
using	allocMember
	The allocator type that TAllocator specifies.

Protected Field Index:
void *	localMemory [TCapacityInKB 1024/sizeof(void )]
	Internal memory passed as a first buffer to base class MonoAllocator.

Protected Field Index: inherited from TMonoAllocator< lang::HeapAllocator >
detail::Buffer *	buffer
	The actual buffer. Contains a link to previously allocated buffers.

unsigned int	bufferGrowthInPercent

bool	dbgLock

DbgStatistics	dbgStats

size_t	nextBuffersUsableSize

detail::Buffer *	recyclables
	The list of buffers that are to be recycled.

Protected Field Index: inherited from AllocatorMember< lang::HeapAllocator >
lang::HeapAllocator &	allocator
	A reference to the allocator.

Additional Inherited Members
Public Type Index: inherited from TMonoAllocator< lang::HeapAllocator >
using	ChainedAllocator

Public Type Index: inherited from AllocatorMember< lang::HeapAllocator >
using	AllocatorType
	Exposes the allocator type.

Public Static Field Index: inherited from TMonoAllocator< lang::HeapAllocator >
static constexpr size_t	MAX_ALIGNMENT

static constexpr size_t	MIN_ALIGNMENT

Public Static Method Index: inherited from TMonoAllocator< lang::HeapAllocator >
static ALIB_API TMonoAllocator *	Create (const char *dbgName, lang::HeapAllocator &pAllocator, size_t initialBufferSizeInKB, unsigned int bufferGrowthInPercent=200)

static TMonoAllocator *	Create (const char *dbgName, size_t initialBufferSizeInKB, unsigned int bufferGrowthInPercent=200)

Public Field Index: inherited from TMonoAllocator< lang::HeapAllocator >
lang::Placeholder< lang::DbgCriticalSections >	DbgCriticalSectionsPH

const char *	DbgName

Protected Method Index: inherited from TMonoAllocator< lang::HeapAllocator >
ALIB_API char *	nextBuffer (size_t size, size_t alignment)

Type Definition Details:

◆ base

template<size_t TCapacityInKB, typename TAllocator = lang::HeapAllocator>

using base = TMonoAllocator<TAllocator>

protected

Shortcut to our base type.

Definition at line 48 of file localallocator.hpp.

Field Details:

◆ localMemory

template<size_t TCapacityInKB, typename TAllocator = lang::HeapAllocator>

void* localMemory[TCapacityInKB *1024/sizeof(void *)]

protected

Internal memory passed as a first buffer to base class MonoAllocator.

Definition at line 51 of file localallocator.hpp.

Constructor(s) / Destructor Details:

◆ TLocalAllocator() [1/2]

template<size_t TCapacityInKB, typename TAllocator = lang::HeapAllocator>

TLocalAllocator ( unsigned int pBufferGrowthInPercent = 200 )

inline

Default constructor.

Parameters

pBufferGrowthInPercent Optional growth factor in percent, applied to each allocation of a next buffer size in respect to its previous size. Defaults to 200, which doubles buffer size with each next internal buffer allocation.

Definition at line 59 of file localallocator.hpp.

◆ TLocalAllocator() [2/2]

template<size_t TCapacityInKB, typename TAllocator = lang::HeapAllocator>

TLocalAllocator	(	TAllocator &	pAllocator,
		unsigned int	pBufferGrowthInPercent = 200 )

inline

Constructor that accepts a different underlying allocator

Parameters

pAllocator	The allocator to use for allocation of additional buffers.
pBufferGrowthInPercent	Optional growth factor in percent, applied to each allocation of a next buffer size in respect to its previous size. Defaults to `200`, which doubles buffer size with each next internal buffer allocation.

Definition at line 71 of file localallocator.hpp.

◆ ~TLocalAllocator()

template<size_t TCapacityInKB, typename TAllocator = lang::HeapAllocator>

~TLocalAllocator ( )

inline

Destructor. Calls MonoAllocator::destructWithExternalBuffer.

Definition at line 79 of file localallocator.hpp.

Here is the call graph for this function:

Method Details:

◆ AsMonoAllocator()

template<size_t TCapacityInKB, typename TAllocator = lang::HeapAllocator>

MonoAllocator & AsMonoAllocator ( )

inline

Convenience method that returns *this statically cast to base type MonoAllocator. This is primarily needed in situations where overload resolution of methods fails, if not exactly this base type is given. A prominent sample for this is the constructor of type AStringMA.

Returns: A reference to *this as its base type.

Definition at line 90 of file localallocator.hpp.

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

localallocator.hpp

Description:

Public Method Index:

Protected Type Index:

Protected Field Index:

Additional Inherited Members

Type Definition Details:

◆ base

Field Details:

◆ localMemory

Constructor(s) / Destructor Details:

◆ TLocalAllocator() [1/2]

◆ TLocalAllocator() [2/2]

◆ ~TLocalAllocator()

Method Details:

◆ AsMonoAllocator()