Class DynamicPoolList

Inheritance Relationships

Base Type

Class Documentation

class DynamicPoolList : public umpire::strategy::AllocationStrategy

Simple dynamic pool for allocations.

This AllocationStrategy uses Simpool to provide pooling for allocations of any size. The behavior of the pool can be controlled by two parameters: the initial allocation size, and the minimum allocation size.

The initial size controls how large the first piece of memory allocated is, and the minimum size controls the lower bound on all future chunk allocations.

Public Types

using CoalesceHeuristic = std::function<bool(const strategy::DynamicPoolList&)>

Callback Heuristic to trigger coalesce of free blocks in pool.

The registered heuristic callback function will be called immediately after a deallocation() has completed from the pool.

Public Functions

DynamicPoolList(const std::string &name, int id, Allocator allocator, const std::size_t min_initial_alloc_size = (512 * 1024 * 1024), const std::size_t min_alloc_size = (1 * 1024 * 1024), CoalesceHeuristic coalesce_heuristic = heuristic_percent_releasable_list(100))

Construct a new DynamicPoolList.

Parameters
  • name: Name of this instance of the DynamicPoolList.

  • id: Id of this instance of the DynamicPoolList.

  • min_initial_alloc_size: The minimum size of the first allocation the pool will make.

  • min_alloc_size: The minimum size of all future allocations.

  • coalesce_heuristic: Heuristic callback function.

void *allocate(size_t bytes)
void deallocate(void *ptr)

Free the memory at ptr.

Parameters
  • ptr: Pointer to free.

void release()

Release any and all unused memory held by this AllocationStrategy.

std::size_t getCurrentSize() const

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.

Return

Current total size of allocations.

std::size_t getActualSize() const

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.

Return

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

std::size_t getHighWatermark() const

Get the high watermark of the total allocated size.

This is equivalent to the highest observed value of getCurrentSize.

Return

High watermark allocation size.

Platform getPlatform()

Get the platform associated with this AllocationStrategy.

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

Return

The platform associated with this AllocationStrategy.

std::size_t getReleasableSize() const

Get the number of bytes that may be released back to resource.

A memory pool has a set of blocks that have no allocations against them. If the size of the set is greater than one, then the pool will have a number of bytes that may be released back to the resource or coalesced into a larger block.

Return

The total number of bytes that are releasable

std::size_t getBlocksInPool() const

Get the number of memory blocks that the pool has.

Return

The total number of blocks that are allocated by the pool

std::size_t getLargestAvailableBlock() const

Get the largest allocatable number of bytes from pool before the pool will grow.

return The largest number of bytes that may be allocated without causing pool growth

void coalesce()
virtual void *allocate(std::size_t bytes) = 0

Allocate bytes of memory.

Return

Pointer to start of allocated bytes.

Parameters
  • bytes: Number of bytes to allocate.

const std::string &getName()

Get the name of this AllocationStrategy.

Return

The name of this AllocationStrategy.

int getId()

Get the id of this AllocationStrategy.

Return

The id of this AllocationStrategy.

Protected Attributes

std::string m_name
int m_id