umpire::strategy::FixedPool Class Reference

Pool for fixed size allocations. More...

#include </home/docs/checkouts/readthedocs.org/user_builds/umpire/checkouts/develop/src/umpire/strategy/FixedPool.hpp>

Inheritance diagram for umpire::strategy::FixedPool:

Public Member Functions
	FixedPool (const std::string &name, int id, Allocator allocator, const std::size_t object_bytes, const std::size_t objects_per_pool=64 *sizeof(int) *8) noexcept
	Constructs a FixedPool. More...
	~FixedPool ()
	FixedPool (const FixedPool &)=delete
void *	allocate (std::size_t bytes=0) override final
	Allocate bytes of memory. More...
void	deallocate (void *ptr, std::size_t size) override final
	Free the memory at ptr. More...
void	release () override final
	Release any and all unused memory held by this AllocationStrategy. More...
std::size_t	getCurrentSize () const noexcept override final
	Get current (total) size of the allocated memory. More...
std::size_t	getHighWatermark () const noexcept override final
	Get the high watermark of the total allocated size. More...
std::size_t	getActualSize () const noexcept override final
	Get the current amount of memory allocated by this allocator. More...
Platform	getPlatform () noexcept override final
	Get the platform associated with this AllocationStrategy. More...
MemoryResourceTraits	getTraits () const noexcept override final
bool	pointerIsFromPool (void *ptr) const noexcept
std::size_t	numPools () const noexcept
void *	allocate_internal (std::size_t bytes)
void *	allocate_named_internal (const std::string &name, std::size_t bytes)
void	deallocate_internal (void *ptr, std::size_t size=0)
virtual std::size_t	getAllocationCount () const noexcept
	Get the total number of active allocations by this allocator. More...
const std::string &	getName () noexcept
	Get the name of this AllocationStrategy. More...
const std::string &	getStrategyName () const noexcept
int	getId () noexcept
	Get the id of this AllocationStrategy. More...
virtual AllocationStrategy *	getParent () const noexcept
	Traces where the allocator came from. More...
virtual bool	tracksMemoryUse () const noexcept
bool	isTracked () const noexcept

Public Attributes
std::size_t	m_current_size {0}
std::size_t	m_high_watermark {0}
std::size_t	m_allocation_count {0}

Protected Member Functions
void	setTracking (bool) noexcept

Protected Attributes
std::string	m_name
std::string	m_strategy_name
int	m_id
bool	m_tracked {true}
AllocationStrategy *	m_parent

Detailed Description

Pool for fixed size allocations.

This AllocationStrategy provides an efficient pool for fixed size allocations, and used to quickly allocate and deallocate objects.

Constructor & Destructor Documentation

FixedPool() [1/2]

umpire::strategy::FixedPool::FixedPool ( const std::string &  name, int  id, Allocator  allocator, const std::size_t  object_bytes, const std::size_t  objects_per_pool = 64 * sizeof(int) * 8  )

noexcept

Constructs a FixedPool.

Parameters

name	The allocator name for reference later in ResourceManager
id	The allocator id for reference later in ResourceManager
allocator	Used for data allocation. It uses std::malloc for internal tracking of these allocations.
object_bytes	The fixed size (in bytes) for each allocation
objects_per_pool	Number of objects in each sub-pool internally. Performance likely improves if this is large, at the cost of memory usage. This does not have to be a multiple of sizeof(int)*8, but it will also likely improve performance if so.

~FixedPool()

umpire::strategy::FixedPool::~FixedPool

(

)

References umpire::strategy::bits_per_int, umpire::free(), UMPIRE_LOG, and umpire::util::message::Warning.

FixedPool() [2/2]

umpire::strategy::FixedPool::FixedPool ( const FixedPool &  )

delete

Member Function Documentation

allocate()

void * umpire::strategy::FixedPool::allocate ( std::size_t  bytes = 0 )

finaloverridevirtual

Allocate bytes of memory.

Parameters

bytes

Number of bytes to allocate.

Returns

Pointer to start of allocated bytes.

Implements umpire::strategy::AllocationStrategy.

References UMPIRE_ASSERT, and UMPIRE_ERROR.

Referenced by umpire::strategy::mixins::AllocateNull::allocateNull().

deallocate()

void umpire::strategy::FixedPool::deallocate ( void *  ptr, std::size_t  size  )

finaloverridevirtual

Free the memory at ptr.

Parameters

ptr	Pointer to free.

Implements umpire::strategy::AllocationStrategy.

References umpire::strategy::bits_per_int, UMPIRE_ASSERT, and UMPIRE_ERROR.

Referenced by umpire::strategy::mixins::AllocateNull::deallocateNull().

release()

void umpire::strategy::FixedPool::release ( )

finaloverridevirtual

Release any and all unused memory held by this AllocationStrategy.

Reimplemented from umpire::strategy::AllocationStrategy.

References umpire::free().

getCurrentSize()

std::size_t umpire::strategy::FixedPool::getCurrentSize ( ) const

finaloverridevirtualnoexcept

Get current (total) size of the allocated memory.

This is the total size of all allocation currently 'live' that have been made by this AllocationStrategy object.

Returns

Current total size of allocations.

Reimplemented from umpire::strategy::AllocationStrategy.

getHighWatermark()

std::size_t umpire::strategy::FixedPool::getHighWatermark ( ) const

finaloverridevirtualnoexcept

Get the high watermark of the total allocated size.

This is equivalent to the highest observed value of getCurrentSize.

Returns

High watermark allocation size.

Reimplemented from umpire::strategy::AllocationStrategy.

getActualSize()

std::size_t umpire::strategy::FixedPool::getActualSize ( ) const

finaloverridevirtualnoexcept

Get the current amount of memory allocated by this allocator.

Note that this can be larger than getCurrentSize(), particularly if the AllocationStrategy implements some kind of pooling.

Returns

The total size of all the memory this object has allocated.

Reimplemented from umpire::strategy::AllocationStrategy.

getPlatform()

Platform umpire::strategy::FixedPool::getPlatform ( )

finaloverridevirtualnoexcept

Get the platform associated with this AllocationStrategy.

The Platform distinguishes the appropriate place to execute operations on memory allocated by this AllocationStrategy.

Returns

The platform associated with this AllocationStrategy.

Implements umpire::strategy::AllocationStrategy.

getTraits()

MemoryResourceTraits umpire::strategy::FixedPool::getTraits ( ) const

finaloverridevirtualnoexcept

Reimplemented from umpire::strategy::AllocationStrategy.

pointerIsFromPool()

bool umpire::strategy::FixedPool::pointerIsFromPool ( void *  ptr ) const

noexcept

Referenced by umpire::strategy::mixins::AllocateNull::deallocateNull().

numPools()

std::size_t umpire::strategy::FixedPool::numPools ( ) const

noexcept

References umpire::MemoryResourceTraits::size.

allocate_internal()

void * umpire::strategy::AllocationStrategy::allocate_internal ( std::size_t  bytes )

inherited

References umpire::strategy::AllocationStrategy::m_allocation_count, umpire::strategy::AllocationStrategy::m_current_size, and umpire::strategy::AllocationStrategy::m_high_watermark.

Referenced by umpire::strategy::mixins::AlignedAllocation::aligned_allocate(), umpire::strategy::AlignedAllocator::allocate(), umpire::strategy::AllocationAdvisor::allocate(), umpire::strategy::AllocationPrefetcher::allocate(), umpire::strategy::MixedPool::allocate(), umpire::strategy::NamedAllocationStrategy::allocate(), umpire::strategy::NumaPolicy::allocate(), umpire::strategy::SizeLimiter::allocate(), umpire::strategy::SlotPool::allocate(), umpire::strategy::ThreadSafeAllocator::allocate(), and umpire::strategy::MonotonicAllocationStrategy::MonotonicAllocationStrategy().

allocate_named_internal()

void * umpire::strategy::AllocationStrategy::allocate_named_internal ( const std::string &  name, std::size_t  bytes  )

inherited

References umpire::strategy::AllocationStrategy::m_allocation_count, umpire::strategy::AllocationStrategy::m_current_size, and umpire::strategy::AllocationStrategy::m_high_watermark.

Referenced by umpire::strategy::NamingShim::allocate(), and umpire::strategy::NamedAllocationStrategy::allocate_named().

deallocate_internal()

void umpire::strategy::AllocationStrategy::deallocate_internal ( void *  ptr, std::size_t  size = 0  )

inherited

References umpire::strategy::AllocationStrategy::m_allocation_count, and umpire::strategy::AllocationStrategy::m_current_size.

Referenced by umpire::strategy::mixins::AlignedAllocation::aligned_deallocate(), umpire::strategy::AlignedAllocator::deallocate(), umpire::strategy::AllocationAdvisor::deallocate(), umpire::strategy::AllocationPrefetcher::deallocate(), umpire::strategy::MixedPool::deallocate(), umpire::strategy::NamedAllocationStrategy::deallocate(), umpire::strategy::NamingShim::deallocate(), umpire::strategy::NumaPolicy::deallocate(), umpire::strategy::SizeLimiter::deallocate(), umpire::strategy::ThreadSafeAllocator::deallocate(), umpire::strategy::DeviceIpcAllocator::deallocate(), umpire::strategy::DeviceIpcAllocator::~DeviceIpcAllocator(), umpire::strategy::MonotonicAllocationStrategy::~MonotonicAllocationStrategy(), and umpire::strategy::SlotPool::~SlotPool().

getAllocationCount()

std::size_t umpire::strategy::AllocationStrategy::getAllocationCount ( ) const

virtualnoexceptinherited

Get the total number of active allocations by this allocator.

Returns

The total number of active allocations this object has allocated.

References umpire::strategy::AllocationStrategy::m_allocation_count.

Referenced by umpire::Allocator::getAllocationCount().

getName()

const std::string & umpire::strategy::AllocationStrategy::getName ( )

noexceptinherited

Get the name of this AllocationStrategy.

Returns

The name of this AllocationStrategy.

References umpire::strategy::AllocationStrategy::m_name.

Referenced by umpire::strategy::DynamicPoolList::coalesce(), umpire::strategy::QuickPool::coalesce(), umpire::strategy::ResourceAwarePool::coalesce(), umpire::strategy::mixins::Inspector::deregisterAllocation(), umpire::ResourceManager::destroyAllocator(), DynamicSizePool< IA >::DynamicSizePool(), umpire::Allocator::getName(), and umpire::util::unwrap_allocation_strategy().

getStrategyName()

const std::string & umpire::strategy::AllocationStrategy::getStrategyName ( ) const

noexceptinherited

References umpire::strategy::AllocationStrategy::m_strategy_name.

Referenced by umpire::Allocator::getStrategyName().

getId()

int umpire::strategy::AllocationStrategy::getId ( )

noexceptinherited

Get the id of this AllocationStrategy.

Returns

The id of this AllocationStrategy.

References umpire::strategy::AllocationStrategy::m_id.

Referenced by umpire::ResourceManager::destroyAllocator(), and umpire::Allocator::getId().

getParent()

AllocationStrategy * umpire::strategy::AllocationStrategy::getParent ( ) const

virtualnoexceptinherited

Traces where the allocator came from.

Returns

Pointer to the parent AllocationStrategy.

References umpire::strategy::AllocationStrategy::m_parent.

Referenced by umpire::ResourceManager::destroyAllocator(), umpire::Allocator::getParent(), and umpire::is_accessible().

tracksMemoryUse()

bool umpire::strategy::AllocationStrategy::tracksMemoryUse ( ) const

virtualnoexceptinherited

Reimplemented in umpire::strategy::ResourceAwarePool, umpire::strategy::QuickPool, and umpire::strategy::DynamicPoolList.

isTracked()

bool umpire::strategy::AllocationStrategy::isTracked ( ) const

noexceptinherited

References umpire::strategy::AllocationStrategy::m_tracked.

Referenced by umpire::Allocator::isTracked().

setTracking()

void umpire::strategy::AllocationStrategy::setTracking ( bool  tracking )

protectednoexceptinherited

Member Data Documentation

m_current_size

std::size_t umpire::strategy::AllocationStrategy::m_current_size {0}

inherited

Referenced by umpire::strategy::AllocationStrategy::allocate_internal(), umpire::strategy::AllocationStrategy::allocate_named_internal(), umpire::strategy::AllocationStrategy::deallocate_internal(), umpire::strategy::mixins::Inspector::deregisterAllocation(), umpire::strategy::AllocationStrategy::getCurrentSize(), and umpire::strategy::mixins::Inspector::registerAllocation().

m_high_watermark

std::size_t umpire::strategy::AllocationStrategy::m_high_watermark {0}

inherited

Referenced by umpire::strategy::AllocationStrategy::allocate_internal(), umpire::strategy::AllocationStrategy::allocate_named_internal(), umpire::strategy::AllocationStrategy::getHighWatermark(), and umpire::strategy::mixins::Inspector::registerAllocation().

m_allocation_count

std::size_t umpire::strategy::AllocationStrategy::m_allocation_count {0}

inherited

Referenced by umpire::strategy::AllocationStrategy::allocate_internal(), umpire::strategy::AllocationStrategy::allocate_named_internal(), umpire::strategy::AllocationStrategy::deallocate_internal(), umpire::strategy::mixins::Inspector::deregisterAllocation(), umpire::strategy::AllocationStrategy::getAllocationCount(), and umpire::strategy::mixins::Inspector::registerAllocation().

m_name

std::string umpire::strategy::AllocationStrategy::m_name

protectedinherited

Referenced by umpire::strategy::NamingShim::allocate(), and umpire::strategy::AllocationStrategy::getName().

m_strategy_name

std::string umpire::strategy::AllocationStrategy::m_strategy_name

protectedinherited

Referenced by umpire::strategy::AllocationStrategy::getStrategyName().

m_id

int umpire::strategy::AllocationStrategy::m_id

protectedinherited

Referenced by umpire::strategy::AllocationStrategy::getId().

m_tracked

bool umpire::strategy::AllocationStrategy::m_tracked {true}

protectedinherited

Referenced by umpire::strategy::AllocationStrategy::isTracked().

m_parent

AllocationStrategy* umpire::strategy::AllocationStrategy::m_parent

protectedinherited

Referenced by umpire::strategy::AllocationStrategy::getParent().