Provides a unified interface to allocate and free data. More...

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

Inheritance diagram for umpire::Allocator:

Public Member Functions
void *	allocate (std::size_t bytes)
	Allocate bytes of memory. More...

void *	allocate (std::size_t bytes, camp::resources::Resource const &r)

void *	allocate (const std::string &name, std::size_t bytes)

void	deallocate (void *ptr)
	Free the memory at ptr. More...

void	deallocate (void *ptr, camp::resources::Resource const &r)

void	release ()
	Release any and all unused memory held by this Allocator. More...

std::size_t	getSize (void *ptr) const
	Return number of bytes allocated for allocation. More...

std::size_t	getHighWatermark () const noexcept
	Return the memory high watermark for this Allocator. More...

std::size_t	getCurrentSize () const noexcept
	Return the current size of this Allocator. More...

std::size_t	getActualSize () const noexcept
	Return the actual size of this Allocator. More...

std::size_t	getAllocationCount () const noexcept
	Return the number of active allocations. More...

const std::string &	getName () const noexcept
	Get the name of this Allocator. More...

int	getId () const noexcept
	Get the integer ID of this Allocator. More...

strategy::AllocationStrategy *	getParent () const noexcept

strategy::AllocationStrategy *	getAllocationStrategy () noexcept
	Get the AllocationStrategy object used by this Allocator. More...

Platform	getPlatform () noexcept
	Get the Platform object appropriate for this Allocator. More...

bool	isTracked () const noexcept

const std::string &	getStrategyName () const noexcept

	Allocator ()=default

Friends
class	ResourceManager

class	::AllocatorTest

class	umpire::op::HostReallocateOperation

class	umpire::op::GenericReallocateOperation

std::ostream &	operator<< (std::ostream &, const Allocator &)

Detailed Description

Provides a unified interface to allocate and free data.

An Allocator encapsulates all the details of how and where allocations will be made, and can also be used to introspect the memory resource. Allocator objects do not return typed allocations, so the pointer returned from the allocate method must be cast to the relevant type.

See also: TypedAllocator

Constructor & Destructor Documentation

◆ Allocator()

umpire::Allocator::Allocator ( )

default

Member Function Documentation

◆ allocate() [1/3]

void * umpire::Allocator::allocate ( std::size_t bytes )

inline

Allocate bytes of memory.

The memory will be allocated as determined by the AllocationStrategy used by this Allocator. Note that this method does not guarantee new memory pages being requested from the underlying memory system, as the associated AllocationStrategy could have already allocated sufficient memory, or re-use existing allocations that were not returned to the system.

Parameters

bytes Number of bytes to allocate (>= 0)

Returns: Pointer to start of the allocation.

Referenced by umpire::malloc(), umpire::ResourceManager::move(), and umpire_allocator_allocate().

◆ allocate() [2/3]

void * umpire::Allocator::allocate	(	std::size_t	bytes,
		camp::resources::Resource const &	r
	)

inline

◆ allocate() [3/3]

void * umpire::Allocator::allocate	(	const std::string &	name,
		std::size_t	bytes
	)

inline

◆ deallocate() [1/2]

void umpire::Allocator::deallocate ( void * ptr )

inline

Free the memory at ptr.

This method will throw an umpire::runtime_error if ptr was not allocated using this Allocator. If the value of the pointer is set to nullptr, this behavior is allowed, but it will be ignored. If you need to deallocate memory allocated by an unknown object, use the ResourceManager::deallocate method.

Parameters