UMPIRE
Umpire: resource management and provision
Classes | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
DynamicSizePool< IA > Class Template Reference

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

Inheritance diagram for DynamicSizePool< IA >:
Inheritance graph
[legend]

Classes

struct  Block
 

Public Member Functions

 DynamicSizePool (umpire::strategy::AllocationStrategy *strat, const std::size_t first_minimum_pool_allocation_size=(16 *1024), const std::size_t next_minimum_pool_allocation_size=256, const std::size_t alignment=16)
 
 DynamicSizePool (const DynamicSizePool &)=delete
 
 ~DynamicSizePool ()
 
void * allocate (std::size_t bytes)
 
void deallocate (void *ptr)
 
void release ()
 
std::size_t getReleasableBlocks () const noexcept
 
std::size_t getTotalBlocks () const noexcept
 
std::size_t getActualSize () const
 
std::size_t getActualHighwaterMark () const noexcept
 
std::size_t getAlignedSize () const noexcept
 
std::size_t getAlignedHighwaterMark () const noexcept
 
std::size_t getBlocksInPool () const
 
std::size_t getLargestAvailableBlock () const
 
std::size_t getReleasableSize () const
 
std::size_t getFreeBlocks () const
 
std::size_t getInUseBlocks () const
 
void coalesce (std::size_t suggested_size)
 

Protected Types

typedef FixedSizePool< struct Block, IA, IA,(1<< 6)> BlockPool
 

Protected Member Functions

void findUsableBlock (struct Block *&best, struct Block *&prev, std::size_t size)
 
void allocateBlock (struct Block *&curr, struct Block *&prev, std::size_t size)
 
void splitBlock (struct Block *&curr, struct Block *&prev, const std::size_t size)
 
void releaseBlock (struct Block *curr, struct Block *prev)
 
std::size_t freeReleasedBlocks ()
 
void coalesceFreeBlocks (std::size_t size)
 

Protected Attributes

BlockPool blockPool {}
 
struct Block * usedBlocks {nullptr}
 
struct Block * freeBlocks {nullptr}
 
std::size_t m_aligned_bytes {0}
 
std::size_t m_aligned_highwatermark {0}
 
std::size_t m_actual_bytes {0}
 
std::size_t m_actual_highwatermark {0}
 
std::size_t m_first_minimum_pool_allocation_size
 
std::size_t m_next_minimum_pool_allocation_size
 
std::size_t m_releasable_blocks {0}
 
std::size_t m_total_blocks {0}
 
bool m_is_destructing {false}
 

Member Typedef Documentation

◆ BlockPool

template<class IA = StdAllocator>
typedef FixedSizePool<struct Block, IA, IA, (1 << 6)> DynamicSizePool< IA >::BlockPool
protected

Constructor & Destructor Documentation

◆ DynamicSizePool() [1/2]

template<class IA = StdAllocator>
DynamicSizePool< IA >::DynamicSizePool ( umpire::strategy::AllocationStrategy *  strat,
const std::size_t  first_minimum_pool_allocation_size = (16 * 1024),
const std::size_t  next_minimum_pool_allocation_size = 256,
const std::size_t  alignment = 16 
)
inline

References umpire::util::message::Debug, umpire::strategy::AllocationStrategy::getName(), DynamicSizePool< IA >::m_first_minimum_pool_allocation_size, DynamicSizePool< IA >::m_next_minimum_pool_allocation_size, and UMPIRE_LOG.

◆ DynamicSizePool() [2/2]

template<class IA = StdAllocator>
DynamicSizePool< IA >::DynamicSizePool ( const DynamicSizePool< IA > &  )
delete

◆ ~DynamicSizePool()

template<class IA = StdAllocator>
DynamicSizePool< IA >::~DynamicSizePool ( )
inline

References umpire::util::message::Debug, DynamicSizePool< IA >::freeReleasedBlocks(), DynamicSizePool< IA >::m_is_destructing, and UMPIRE_LOG.

Member Function Documentation

◆ findUsableBlock()

template<class IA = StdAllocator>
void DynamicSizePool< IA >::findUsableBlock ( struct Block *&  best,
struct Block *&  prev,
std::size_t  size 
)
inlineprotected

References DynamicSizePool< IA >::freeBlocks, DynamicSizePool< IA >::Block::next, and DynamicSizePool< IA >::Block::size.

Referenced by DynamicSizePool< IA >::allocate().

◆ allocateBlock()

template<class IA = StdAllocator>
void DynamicSizePool< IA >::allocateBlock ( struct Block *&  curr,
struct Block *&  prev,
std::size_t  size 
)
inlineprotected

References umpire::strategy::mixins::AlignedAllocation::aligned_allocate(), FixedSizePool< T, MA, IA, NP >::allocate(), DynamicSizePool< IA >::blockPool, DynamicSizePool< IA >::Block::blockSize, DynamicSizePool< IA >::Block::data, umpire::util::message::Debug, umpire::util::message::Error, DynamicSizePool< IA >::freeBlocks, DynamicSizePool< IA >::freeReleasedBlocks(), umpire_mod::get_backtrace(), umpire::util::message::Info, DynamicSizePool< IA >::m_actual_bytes, DynamicSizePool< IA >::m_actual_highwatermark, DynamicSizePool< IA >::m_first_minimum_pool_allocation_size, DynamicSizePool< IA >::m_next_minimum_pool_allocation_size, DynamicSizePool< IA >::m_releasable_blocks, DynamicSizePool< IA >::m_total_blocks, DynamicSizePool< IA >::Block::next, DynamicSizePool< IA >::Block::size, UMPIRE_LOG, and DynamicSizePool< IA >::usedBlocks.

Referenced by DynamicSizePool< IA >::allocate().

◆ splitBlock()

template<class IA = StdAllocator>
void DynamicSizePool< IA >::splitBlock ( struct Block *&  curr,
struct Block *&  prev,
const std::size_t  size 
)
inlineprotected

References FixedSizePool< T, MA, IA, NP >::allocate(), DynamicSizePool< IA >::blockPool, DynamicSizePool< IA >::Block::blockSize, DynamicSizePool< IA >::Block::data, DynamicSizePool< IA >::freeBlocks, DynamicSizePool< IA >::m_releasable_blocks, DynamicSizePool< IA >::Block::next, and DynamicSizePool< IA >::Block::size.

Referenced by DynamicSizePool< IA >::allocate().

◆ releaseBlock()

template<class IA = StdAllocator>
void DynamicSizePool< IA >::releaseBlock ( struct Block *  curr,
struct Block *  prev 
)
inlineprotected

References DynamicSizePool< IA >::blockPool, DynamicSizePool< IA >::Block::blockSize, DynamicSizePool< IA >::Block::data, FixedSizePool< T, MA, IA, NP >::deallocate(), DynamicSizePool< IA >::freeBlocks, DynamicSizePool< IA >::m_releasable_blocks, DynamicSizePool< IA >::Block::next, DynamicSizePool< IA >::Block::size, and DynamicSizePool< IA >::usedBlocks.

Referenced by DynamicSizePool< IA >::deallocate().

◆ freeReleasedBlocks()

template<class IA = StdAllocator>
std::size_t DynamicSizePool< IA >::freeReleasedBlocks ( )
inlineprotected

References umpire::strategy::mixins::AlignedAllocation::aligned_deallocate(), DynamicSizePool< IA >::blockPool, DynamicSizePool< IA >::Block::blockSize, DynamicSizePool< IA >::Block::data, FixedSizePool< T, MA, IA, NP >::deallocate(), umpire::util::message::Debug, umpire::util::message::Error, DynamicSizePool< IA >::freeBlocks, umpire_mod::get_backtrace(), umpire::util::message::Info, DynamicSizePool< IA >::m_actual_bytes, DynamicSizePool< IA >::m_is_destructing, DynamicSizePool< IA >::m_releasable_blocks, DynamicSizePool< IA >::m_total_blocks, DynamicSizePool< IA >::Block::next, DynamicSizePool< IA >::Block::size, and UMPIRE_LOG.

Referenced by DynamicSizePool< IA >::allocateBlock(), DynamicSizePool< IA >::coalesce(), DynamicSizePool< IA >::coalesceFreeBlocks(), DynamicSizePool< IA >::release(), and DynamicSizePool< IA >::~DynamicSizePool().

◆ coalesceFreeBlocks()

template<class IA = StdAllocator>
void DynamicSizePool< IA >::coalesceFreeBlocks ( std::size_t  size)
inlineprotected

References DynamicSizePool< IA >::allocate(), DynamicSizePool< IA >::deallocate(), umpire::util::message::Debug, DynamicSizePool< IA >::freeReleasedBlocks(), DynamicSizePool< IA >::getFreeBlocks(), and UMPIRE_LOG.

Referenced by DynamicSizePool< IA >::coalesce().

◆ allocate()

template<class IA = StdAllocator>
void* DynamicSizePool< IA >::allocate ( std::size_t  bytes)
inline

References umpire::strategy::mixins::AlignedAllocation::aligned_round_up(), DynamicSizePool< IA >::allocateBlock(), DynamicSizePool< IA >::Block::data, umpire::util::message::Debug, DynamicSizePool< IA >::findUsableBlock(), DynamicSizePool< IA >::m_aligned_bytes, DynamicSizePool< IA >::m_aligned_highwatermark, umpire::strategy::mixins::AlignedAllocation::m_allocator, DynamicSizePool< IA >::splitBlock(), UMPIRE_LOG, UMPIRE_UNPOISON_MEMORY_REGION, and DynamicSizePool< IA >::usedBlocks.

Referenced by umpire::strategy::DynamicPoolList::allocate(), and DynamicSizePool< IA >::coalesceFreeBlocks().

◆ deallocate()

template<class IA = StdAllocator>
void DynamicSizePool< IA >::deallocate ( void *  ptr)
inline

References DynamicSizePool< IA >::Block::data, umpire::util::message::Debug, DynamicSizePool< IA >::m_aligned_bytes, umpire::strategy::mixins::AlignedAllocation::m_allocator, DynamicSizePool< IA >::Block::next, DynamicSizePool< IA >::releaseBlock(), DynamicSizePool< IA >::Block::size, UMPIRE_LOG, UMPIRE_POISON_MEMORY_REGION, and DynamicSizePool< IA >::usedBlocks.

Referenced by DynamicSizePool< IA >::coalesceFreeBlocks(), and umpire::strategy::DynamicPoolList::deallocate().

◆ release()

template<class IA = StdAllocator>
void DynamicSizePool< IA >::release ( )
inline

References umpire::util::message::Debug, DynamicSizePool< IA >::freeReleasedBlocks(), and UMPIRE_LOG.

Referenced by umpire::strategy::DynamicPoolList::release().

◆ getReleasableBlocks()

template<class IA = StdAllocator>
std::size_t DynamicSizePool< IA >::getReleasableBlocks ( ) const
inlinenoexcept

References DynamicSizePool< IA >::m_releasable_blocks.

Referenced by umpire::strategy::DynamicPoolList::getReleasableBlocks().

◆ getTotalBlocks()

template<class IA = StdAllocator>
std::size_t DynamicSizePool< IA >::getTotalBlocks ( ) const
inlinenoexcept

References DynamicSizePool< IA >::m_total_blocks.

Referenced by umpire::strategy::DynamicPoolList::getTotalBlocks().

◆ getActualSize()

template<class IA = StdAllocator>
std::size_t DynamicSizePool< IA >::getActualSize ( ) const
inline

References DynamicSizePool< IA >::m_actual_bytes.

Referenced by DynamicSizePool< IA >::coalesce(), and umpire::strategy::DynamicPoolList::getActualSize().

◆ getActualHighwaterMark()

template<class IA = StdAllocator>
std::size_t DynamicSizePool< IA >::getActualHighwaterMark ( ) const
inlinenoexcept

References DynamicSizePool< IA >::m_actual_highwatermark.

Referenced by umpire::strategy::DynamicPoolList::getActualHighwaterMark().

◆ getAlignedSize()

template<class IA = StdAllocator>
std::size_t DynamicSizePool< IA >::getAlignedSize ( ) const
inlinenoexcept

References DynamicSizePool< IA >::m_aligned_bytes.

Referenced by umpire::strategy::DynamicPoolList::getAlignedSize().

◆ getAlignedHighwaterMark()

template<class IA = StdAllocator>
std::size_t DynamicSizePool< IA >::getAlignedHighwaterMark ( ) const
inlinenoexcept

References DynamicSizePool< IA >::m_aligned_highwatermark.

Referenced by umpire::strategy::DynamicPoolList::getAlignedHighwaterMark().

◆ getBlocksInPool()

template<class IA = StdAllocator>
std::size_t DynamicSizePool< IA >::getBlocksInPool ( ) const
inline

References DynamicSizePool< IA >::freeBlocks, DynamicSizePool< IA >::Block::next, and DynamicSizePool< IA >::usedBlocks.

Referenced by umpire::strategy::DynamicPoolList::getBlocksInPool().

◆ getLargestAvailableBlock()

template<class IA = StdAllocator>
std::size_t DynamicSizePool< IA >::getLargestAvailableBlock ( ) const
inline

References DynamicSizePool< IA >::freeBlocks, and DynamicSizePool< IA >::Block::next.

Referenced by umpire::strategy::DynamicPoolList::getLargestAvailableBlock().

◆ getReleasableSize()

template<class IA = StdAllocator>
std::size_t DynamicSizePool< IA >::getReleasableSize ( ) const
inline

References DynamicSizePool< IA >::freeBlocks, and DynamicSizePool< IA >::Block::next.

Referenced by umpire::strategy::DynamicPoolList::getReleasableSize().

◆ getFreeBlocks()

template<class IA = StdAllocator>
std::size_t DynamicSizePool< IA >::getFreeBlocks ( ) const
inline

References DynamicSizePool< IA >::freeBlocks, and DynamicSizePool< IA >::Block::next.

Referenced by DynamicSizePool< IA >::coalesce(), and DynamicSizePool< IA >::coalesceFreeBlocks().

◆ getInUseBlocks()

template<class IA = StdAllocator>
std::size_t DynamicSizePool< IA >::getInUseBlocks ( ) const
inline

References DynamicSizePool< IA >::Block::next, and DynamicSizePool< IA >::usedBlocks.

◆ coalesce()

template<class IA = StdAllocator>
void DynamicSizePool< IA >::coalesce ( std::size_t  suggested_size)
inline

References DynamicSizePool< IA >::coalesceFreeBlocks(), umpire::util::message::Debug, DynamicSizePool< IA >::freeReleasedBlocks(), DynamicSizePool< IA >::getActualSize(), DynamicSizePool< IA >::getFreeBlocks(), and UMPIRE_LOG.

Referenced by umpire::strategy::DynamicPoolList::coalesce(), and umpire::strategy::DynamicPoolList::deallocate().

Member Data Documentation

◆ blockPool

template<class IA = StdAllocator>
BlockPool DynamicSizePool< IA >::blockPool {}
protected

Referenced by DynamicSizePool< IA >::allocateBlock(), DynamicSizePool< IA >::freeReleasedBlocks(), DynamicSizePool< IA >::releaseBlock(), and DynamicSizePool< IA >::splitBlock().

◆ usedBlocks

template<class IA = StdAllocator>
struct Block* DynamicSizePool< IA >::usedBlocks {nullptr}
protected

Referenced by DynamicSizePool< IA >::allocate(), DynamicSizePool< IA >::allocateBlock(), DynamicSizePool< IA >::deallocate(), DynamicSizePool< IA >::getBlocksInPool(), DynamicSizePool< IA >::getInUseBlocks(), and DynamicSizePool< IA >::releaseBlock().

◆ freeBlocks

template<class IA = StdAllocator>
struct Block* DynamicSizePool< IA >::freeBlocks {nullptr}
protected

Referenced by DynamicSizePool< IA >::allocateBlock(), DynamicSizePool< IA >::findUsableBlock(), DynamicSizePool< IA >::freeReleasedBlocks(), DynamicSizePool< IA >::getBlocksInPool(), DynamicSizePool< IA >::getFreeBlocks(), DynamicSizePool< IA >::getLargestAvailableBlock(), DynamicSizePool< IA >::getReleasableSize(), DynamicSizePool< IA >::releaseBlock(), and DynamicSizePool< IA >::splitBlock().

◆ m_aligned_bytes

template<class IA = StdAllocator>
std::size_t DynamicSizePool< IA >::m_aligned_bytes {0}
protected

Referenced by DynamicSizePool< IA >::allocate(), DynamicSizePool< IA >::deallocate(), and DynamicSizePool< IA >::getAlignedSize().

◆ m_aligned_highwatermark

template<class IA = StdAllocator>
std::size_t DynamicSizePool< IA >::m_aligned_highwatermark {0}
protected

Referenced by DynamicSizePool< IA >::allocate(), and DynamicSizePool< IA >::getAlignedHighwaterMark().

◆ m_actual_bytes

template<class IA = StdAllocator>
std::size_t DynamicSizePool< IA >::m_actual_bytes {0}
protected

Referenced by DynamicSizePool< IA >::allocateBlock(), DynamicSizePool< IA >::freeReleasedBlocks(), and DynamicSizePool< IA >::getActualSize().

◆ m_actual_highwatermark

template<class IA = StdAllocator>
std::size_t DynamicSizePool< IA >::m_actual_highwatermark {0}
protected

Referenced by DynamicSizePool< IA >::allocateBlock(), and DynamicSizePool< IA >::getActualHighwaterMark().

◆ m_first_minimum_pool_allocation_size

template<class IA = StdAllocator>
std::size_t DynamicSizePool< IA >::m_first_minimum_pool_allocation_size
protected

Referenced by DynamicSizePool< IA >::allocateBlock(), and DynamicSizePool< IA >::DynamicSizePool().

◆ m_next_minimum_pool_allocation_size

template<class IA = StdAllocator>
std::size_t DynamicSizePool< IA >::m_next_minimum_pool_allocation_size
protected

Referenced by DynamicSizePool< IA >::allocateBlock(), and DynamicSizePool< IA >::DynamicSizePool().

◆ m_releasable_blocks

template<class IA = StdAllocator>
std::size_t DynamicSizePool< IA >::m_releasable_blocks {0}
protected

Referenced by DynamicSizePool< IA >::allocateBlock(), DynamicSizePool< IA >::freeReleasedBlocks(), DynamicSizePool< IA >::getReleasableBlocks(), DynamicSizePool< IA >::releaseBlock(), and DynamicSizePool< IA >::splitBlock().

◆ m_total_blocks

template<class IA = StdAllocator>
std::size_t DynamicSizePool< IA >::m_total_blocks {0}
protected

Referenced by DynamicSizePool< IA >::allocateBlock(), DynamicSizePool< IA >::freeReleasedBlocks(), and DynamicSizePool< IA >::getTotalBlocks().

◆ m_is_destructing

template<class IA = StdAllocator>
bool DynamicSizePool< IA >::m_is_destructing {false}
protected

Referenced by DynamicSizePool< IA >::freeReleasedBlocks(), and DynamicSizePool< IA >::~DynamicSizePool().