umpire::resource::MemoryResource Class Reference

Base class to represent the available hardware resources for memory allocation in the system. More...

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

Inheritance diagram for umpire::resource::MemoryResource:

Public Member Functions
	MemoryResource (const std::string &name, int id, MemoryResourceTraits traits)
	Construct a MemoryResource with the given name and id. More...
virtual	~MemoryResource ()=default
virtual void *	allocate (std::size_t bytes) override=0
	Allocate bytes of memory. More...
virtual void	deallocate (void *ptr, std::size_t size) override=0
	Free the memory at ptr. More...
virtual Platform	getPlatform () noexcept override=0
	Get the Platform assocatiated with this MemoryResource. More...
virtual bool	isAccessibleFrom (Platform p) noexcept=0
MemoryResourceTraits	getTraits () const noexcept override
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 void	release ()
	Release any and all unused memory held by this AllocationStrategy. More...
virtual std::size_t	getCurrentSize () const noexcept
	Get current (total) size of the allocated memory. More...
virtual std::size_t	getHighWatermark () const noexcept
	Get the high watermark of the total allocated size. More...
virtual std::size_t	getActualSize () const noexcept
	Get the current amount of memory allocated by this allocator. More...
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
MemoryResourceTraits	m_traits
std::string	m_name
std::string	m_strategy_name
int	m_id
bool	m_tracked {true}
AllocationStrategy *	m_parent

Detailed Description

Base class to represent the available hardware resources for memory allocation in the system.

Objects of this inherit from strategy::AllocationStrategy, allowing them to be used directly.

Constructor & Destructor Documentation

MemoryResource()

umpire::resource::MemoryResource::MemoryResource	(	const std::string &	name,
		int	id,
		MemoryResourceTraits	traits
	)

Construct a MemoryResource with the given name and id.

Parameters

name	Name of the MemoryResource.
id	ID of the MemoryResource (must be unique).

~MemoryResource()

virtual umpire::resource::MemoryResource::~MemoryResource ( )

virtualdefault

Member Function Documentation

allocate()

virtual void* umpire::resource::MemoryResource::allocate ( std::size_t  bytes )

overridepure virtual

Allocate bytes of memory.

This function is pure virtual and must be implemented by the inheriting class.

Parameters

bytes

Number of bytes to allocate.

Returns

Pointer to start of allocation.

Implements umpire::strategy::AllocationStrategy.

Implemented in umpire::resource::HostSharedMemoryResource, umpire::resource::HostMpi3SharedMemoryResource, umpire::resource::SyclDeviceMemoryResource< _allocator >, umpire::resource::NullMemoryResource, umpire::resource::NoOpMemoryResource, umpire::resource::HipUnifiedMemoryResource, umpire::resource::HipPinnedMemoryResource, umpire::resource::HipDeviceMemoryResource, umpire::resource::HipConstantMemoryResource, umpire::resource::FileMemoryResource, umpire::resource::DefaultMemoryResource< _allocator >, umpire::resource::CudaDeviceMemoryResource, and umpire::resource::CudaConstantMemoryResource.

deallocate()

virtual void umpire::resource::MemoryResource::deallocate ( void *  ptr, std::size_t  size  )

overridepure virtual

Free the memory at ptr.

This function is pure virtual and must be implemented by the inheriting class.

Parameters

ptr	Pointer to free.

Implements umpire::strategy::AllocationStrategy.

Implemented in umpire::resource::HostSharedMemoryResource, umpire::resource::HostMpi3SharedMemoryResource, umpire::resource::SyclDeviceMemoryResource< _allocator >, umpire::resource::NullMemoryResource, umpire::resource::NoOpMemoryResource, umpire::resource::HipUnifiedMemoryResource, umpire::resource::HipPinnedMemoryResource, umpire::resource::HipDeviceMemoryResource, umpire::resource::HipConstantMemoryResource, umpire::resource::FileMemoryResource, umpire::resource::DefaultMemoryResource< _allocator >, umpire::resource::CudaDeviceMemoryResource, and umpire::resource::CudaConstantMemoryResource.

getPlatform()

virtual Platform umpire::resource::MemoryResource::getPlatform ( )

overridepure virtualnoexcept

Get the Platform assocatiated with this MemoryResource.

This function is pure virtual and must be implemented by the inheriting class.

Returns

Platform associated with this MemoryResource.

Implements umpire::strategy::AllocationStrategy.

Implemented in umpire::resource::HostSharedMemoryResource, umpire::resource::HostMpi3SharedMemoryResource, umpire::resource::SyclDeviceMemoryResource< _allocator >, umpire::resource::NullMemoryResource, umpire::resource::NoOpMemoryResource, umpire::resource::HipUnifiedMemoryResource, umpire::resource::HipPinnedMemoryResource, umpire::resource::HipDeviceMemoryResource, umpire::resource::HipConstantMemoryResource, umpire::resource::FileMemoryResource, umpire::resource::DefaultMemoryResource< _allocator >, umpire::resource::CudaDeviceMemoryResource, and umpire::resource::CudaConstantMemoryResource.

isAccessibleFrom()

virtual bool umpire::resource::MemoryResource::isAccessibleFrom ( Platform  p )

pure virtualnoexcept

Implemented in umpire::resource::HostSharedMemoryResource, umpire::resource::HostMpi3SharedMemoryResource, umpire::resource::SyclDeviceMemoryResource< _allocator >, umpire::resource::NullMemoryResource, umpire::resource::NoOpMemoryResource, umpire::resource::HipUnifiedMemoryResource, umpire::resource::HipPinnedMemoryResource, umpire::resource::HipDeviceMemoryResource, umpire::resource::HipConstantMemoryResource, umpire::resource::FileMemoryResource, umpire::resource::DefaultMemoryResource< _allocator >, umpire::resource::CudaDeviceMemoryResource, and umpire::resource::CudaConstantMemoryResource.

Referenced by umpire::is_accessible().

getTraits()

MemoryResourceTraits umpire::resource::MemoryResource::getTraits ( ) const

overridevirtualnoexcept

Reimplemented from umpire::strategy::AllocationStrategy.

References m_traits.

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().

release()

void umpire::strategy::AllocationStrategy::release ( )

virtualinherited

Release any and all unused memory held by this AllocationStrategy.

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

References umpire::util::message::Info, and UMPIRE_LOG.

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

getCurrentSize()

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

virtualnoexceptinherited

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 in umpire::strategy::FixedPool, umpire::strategy::MonotonicAllocationStrategy, umpire::resource::SyclDeviceMemoryResource< _allocator >, umpire::resource::NullMemoryResource, umpire::resource::NoOpMemoryResource, and umpire::resource::FileMemoryResource.

References umpire::strategy::AllocationStrategy::m_current_size.

Referenced by umpire::strategy::AllocationStrategy::getActualSize(), and umpire::Allocator::getCurrentSize().

getHighWatermark()

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

virtualnoexceptinherited

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 in umpire::strategy::FixedPool, umpire::strategy::MonotonicAllocationStrategy, umpire::resource::SyclDeviceMemoryResource< _allocator >, umpire::resource::NullMemoryResource, umpire::resource::NoOpMemoryResource, and umpire::resource::FileMemoryResource.

References umpire::strategy::AllocationStrategy::m_high_watermark.

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

getActualSize()

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

virtualnoexceptinherited

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 in umpire::strategy::FixedPool, umpire::strategy::ResourceAwarePool, umpire::strategy::QuickPool, umpire::strategy::MixedPool, umpire::strategy::DynamicPoolList, and umpire::resource::HostSharedMemoryResource.

References umpire::strategy::AllocationStrategy::getCurrentSize().

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

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_traits

MemoryResourceTraits umpire::resource::MemoryResource::m_traits

protected

Referenced by umpire::resource::CudaDeviceMemoryResource::allocate(), umpire::resource::HipDeviceMemoryResource::allocate(), umpire::resource::CudaDeviceMemoryResource::deallocate(), umpire::resource::HipDeviceMemoryResource::deallocate(), and getTraits().

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().