bdlma::Multipool Class Reference

#include <bdlma_multipool.h>

Public Member Functions
	Multipool (bslma::Allocator *basicAllocator=0)
	Multipool (int numPools, bslma::Allocator *basicAllocator=0)
	Multipool (bsls::BlockGrowth::Strategy growthStrategy, bslma::Allocator *basicAllocator=0)
	Multipool (int numPools, bsls::BlockGrowth::Strategy growthStrategy, bslma::Allocator *basicAllocator=0)
	Multipool (int numPools, bsls::BlockGrowth::Strategy growthStrategy, int maxBlocksPerChunk, bslma::Allocator *basicAllocator=0)
	Multipool (int numPools, const bsls::BlockGrowth::Strategy *growthStrategyArray, bslma::Allocator *basicAllocator=0)
	Multipool (int numPools, const bsls::BlockGrowth::Strategy *growthStrategyArray, int maxBlocksPerChunk, bslma::Allocator *basicAllocator=0)
	Multipool (int numPools, bsls::BlockGrowth::Strategy growthStrategy, const int *maxBlocksPerChunkArray, bslma::Allocator *basicAllocator=0)
	Multipool (int numPools, const bsls::BlockGrowth::Strategy *growthStrategyArray, const int *maxBlocksPerChunkArray, bslma::Allocator *basicAllocator=0)
	~Multipool ()
void *	allocate (bsls::Types::size_type size)
void	deallocate (void *address)
template<class TYPE >
void	deleteObject (const TYPE *object)
template<class TYPE >
void	deleteObjectRaw (const TYPE *object)
void	release ()
	Relinquish all memory currently allocated via this multipool object.
void	reserveCapacity (bsls::Types::size_type size, int numBlocks)
int	numPools () const
	Return the number of pools managed by this multipool object.
bsls::Types::size_type	maxPooledBlockSize () const
bslma::Allocator *	allocator () const

Detailed Description

This class implements a memory manager that maintains a configurable number of bdlma::Pool objects, each dispensing memory blocks of a unique size. The bdlma::Pool objects are placed in an array, with each successive pool managing memory blocks of size twice that of the previous pool. Each multipool allocation (deallocation) request allocates memory from (returns memory to) the internal pool having the smallest block size not less than the requested size, or, if no pool manages memory blocks of sufficient size, from a separately managed list of memory blocks. Both the release method and the destructor of a bdlma::Multipool release all memory currently allocated via the object.

See bdlma_multipool

Constructor & Destructor Documentation

Multipool() [1/9]

bdlma::Multipool::Multipool ( bslma::Allocator *  basicAllocator = 0 )

explicit

Multipool() [2/9]

bdlma::Multipool::Multipool ( int  numPools, bslma::Allocator *  basicAllocator = 0  )

explicit

Multipool() [3/9]

bdlma::Multipool::Multipool ( bsls::BlockGrowth::Strategy  growthStrategy, bslma::Allocator *  basicAllocator = 0  )

explicit

Multipool() [4/9]

bdlma::Multipool::Multipool	(	int	numPools,
		bsls::BlockGrowth::Strategy	growthStrategy,
		bslma::Allocator *	basicAllocator = 0
	)

Multipool() [5/9]

bdlma::Multipool::Multipool	(	int	numPools,
		bsls::BlockGrowth::Strategy	growthStrategy,
		int	maxBlocksPerChunk,
		bslma::Allocator *	basicAllocator = 0
	)

Create a multipool memory manager. Optionally specify numPools, indicating the number of internally created bdlma::Pool objects; the block size of the first pool is 8 bytes, with the block size of each additional pool successively doubling. If numPools is not specified, an implementation-defined number of pools N – covering memory blocks ranging in size from 2^3 = 8 to 2^(N+2) – are created. Optionally specify a growthStrategy indicating whether the number of blocks allocated at once for every internally created bdlma::Pool should be either fixed or grow geometrically, starting with 1. If growthStrategy is not specified, the allocation strategy for each internally created bdlma::Pool object is geometric, starting from 1. If numPools and growthStrategy are specified, optionally specify a maxBlocksPerChunk, indicating the maximum number of blocks to be allocated at once when a pool must be replenished. If maxBlocksPerChunk is not specified, an implementation-defined value is used. Optionally specify a basicAllocator used to supply memory. If basicAllocator is 0, the currently installed default allocator is used. Memory allocation (and deallocation) requests will be satisfied using the internally maintained pool managing memory blocks of the smallest size not less than the requested size, or directly from the underlying allocator (supplied at construction), if no internal pool managing memory blocks of sufficient size exists. The behavior is undefined unless 1 <= numPools and 1 <= maxBlocksPerChunk. Note that, on platforms where 8 < bsls::AlignmentUtil::BSLS_MAX_ALIGNMENT, excess memory may be allocated for pools managing smaller blocks. Also note that maxBlocksPerChunk need not be an integral power of 2; if geometric growth would exceed the maximum value, the chunk size is capped at that value.

Multipool() [6/9]

bdlma::Multipool::Multipool	(	int	numPools,
		const bsls::BlockGrowth::Strategy *	growthStrategyArray,
		bslma::Allocator *	basicAllocator = 0
	)

Multipool() [7/9]

bdlma::Multipool::Multipool	(	int	numPools,
		const bsls::BlockGrowth::Strategy *	growthStrategyArray,
		int	maxBlocksPerChunk,
		bslma::Allocator *	basicAllocator = 0
	)

Multipool() [8/9]

bdlma::Multipool::Multipool	(	int	numPools,
		bsls::BlockGrowth::Strategy	growthStrategy,
		const int *	maxBlocksPerChunkArray,
		bslma::Allocator *	basicAllocator = 0
	)

Multipool() [9/9]

bdlma::Multipool::Multipool	(	int	numPools,
		const bsls::BlockGrowth::Strategy *	growthStrategyArray,
		const int *	maxBlocksPerChunkArray,
		bslma::Allocator *	basicAllocator = 0
	)

Create a multipool memory manager having the specified numPools, indicating the number of internally created bdlma::Pool objects; the block size of the first pool is 8 bytes, with the block size of each additional pool successively doubling. Optionally specify a growthStrategy indicating whether the number of blocks allocated at once for every internally created bdlma::Pool should be either fixed or grow geometrically, starting with 1. If growthStrategy is not specified, optionally specify a growthStrategyArray, indicating the strategies for each individual bdlma::Pool created by this object. If neither growthStrategy nor growthStrategyArray is specified, the allocation strategy for each internally created bdlma::Pool object will grow geometrically, starting from 1. Optionally specify a maxBlocksPerChunk, indicating the maximum number of blocks to be allocated at once when a pool must be replenished. If maxBlocksPerChunk is not specified, optionally specify a maxBlocksPerChunkArray, indicating the maximum number of blocks to allocate at once for each individually created bdlma::Pool object. If neither maxBlocksPerChunk nor maxBlocksPerChunkArray is specified, an implementation-defined value is used. Optionally specify a basicAllocator used to supply memory. If basicAllocator is 0, the currently installed default allocator is used. Memory allocation (and deallocation) requests will be satisfied using the internally maintained pool managing memory blocks of the smallest size not less than the requested size, or directly from the underlying allocator (supplied at construction), if no internal pool managing memory blocks of sufficient size exists. The behavior is undefined unless 1 <= numPools, growthStrategyArray has at least numPools strategies, 1 <= maxBlocksPerChunk, and maxBlocksPerChunkArray has at least numPools positive values. Note that, on platforms where 8 < bsls::AlignmentUtil::BSLS_MAX_ALIGNMENT, excess memory may be allocated for pools managing smaller blocks. Also note that the maximum need not be an integral power of 2; if geometric growth would exceed a maximum value, the chunk size is capped at that value.

~Multipool()

bdlma::Multipool::~Multipool

(

)

Destroy this multipool. All memory allocated from this memory pool is released.

Member Function Documentation

allocate()

void * bdlma::Multipool::allocate

(

bsls::Types::size_type

size

)

Return the address of a contiguous block of maximally-aligned memory of (at least) the specified size (in bytes). If size is 0, no memory is allocated and 0 is returned. If size > maxPooledBlockSize(), the memory allocation is managed directly by the underlying allocator, and will not be pooled, but will be deallocated when the release method is called, or when this object is destroyed.

allocator()

bslma::Allocator * bdlma::Multipool::allocator ( ) const

inline

Return the allocator used by this object to allocate memory. Note that this allocator can not be used to deallocate memory allocated through this pool.

deallocate()

void bdlma::Multipool::deallocate

(

void *

address

)

Relinquish the memory block at the specified address back to this multipool object for reuse. The behavior is undefined unless address is non-zero, was allocated by this multipool object, and has not already been deallocated.

deleteObject()

template<class TYPE >

void bdlma::Multipool::deleteObject ( const TYPE *  object )

inline

Destroy the specified object based on its dynamic type and then use this multipool object to deallocate its memory footprint. This method has no effect if object is 0. The behavior is undefined unless object, when cast appropriately to void *, was allocated using this multipool object and has not already been deallocated. Note that dynamic_cast<void *>(object) is applied if TYPE is polymorphic, and static_cast<void *>(object) is applied otherwise.

deleteObjectRaw()

template<class TYPE >

void bdlma::Multipool::deleteObjectRaw ( const TYPE *  object )

inline

Destroy the specified object and then use this multipool to deallocate its memory footprint. This method has no effect if object is 0. The behavior is undefined unless object is not a secondary base class pointer (i.e., the address is (numerically) the same as when it was originally dispensed by this multipool), was allocated using this multipool, and has not already been deallocated.

maxPooledBlockSize()

bsls::Types::size_type bdlma::Multipool::maxPooledBlockSize ( ) const

inline

Return the maximum size of memory blocks that are pooled by this multipool object. Note that the maximum value is defined as:

2 ^ (numPools + 2)

where numPools is either specified at construction, or an implementation-defined value.

numPools()

int bdlma::Multipool::numPools ( ) const

inline

release()

void bdlma::Multipool::release

(

)

reserveCapacity()

void bdlma::Multipool::reserveCapacity	(	bsls::Types::size_type	size,
		int	numBlocks
	)

Reserve memory from this multipool to satisfy memory requests for at least the specified numBlocks having the specified size (in bytes) before the pool replenishes. If size is 0, this method has no effect. The behavior is undefined unless size <= maxPooledBlockSize() and 0 <= numBlocks.

---

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

• bdlma_multipool.h