Common base of the Umpire-backed allocators, which forward to a named allocator in Umpire's ResourceManager. More...

Inheritance diagram for gko::UmpireAllocatorBase:

Public Member Functions
const std::string &	get_name () const
	Name of the underlying Umpire allocator.

size_type	get_current_size () const
	Bytes currently allocated from the Umpire allocator and not yet deallocated, by any of its users (not only through this object).

size_type	get_actual_size () const
	Bytes the Umpire allocator holds from its memory resource. More...

size_type	get_high_watermark () const
	Largest value get_current_size() has reached so far.

size_type	get_allocation_count () const
	Number of allocations from the Umpire allocator that are still live.

void	release ()
	Returns the pool's completely unused blocks to its memory resource.

Detailed Description

Common base of the Umpire-backed allocators, which forward to a named allocator in Umpire's ResourceManager.

Statistics cover everything allocated from the Umpire allocator.
Alignment is not checked (application-built pools: 16 bytes by default).
Not serialized by executors; share a pool across threads only if it is thread-safe (umpire_pool_config::thread_safe).
Each process, hence each MPI rank, has its own ResourceManager and pools.
The accessors are deliberately not noexcept: without Umpire they throw NotCompiled.

Warning: Pools are not stream-ordered: deallocate() frees immediately while Ginkgo's kernels may still use the memory. Call Executor::synchronize() before sharing a device pool across streams.

Member Function Documentation

size_type gko::UmpireAllocatorBase::get_actual_size ( ) const

Bytes the Umpire allocator holds from its memory resource.

For a pool, this includes reserved memory that is not currently allocated, so it is at least get_current_size().

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