Detailed Description

template<typename BlockType>
class foxxll::read_write_pool< BlockType >

Implements dynamically resizable buffered writing and prefetched reading pool.

Definition at line 31 of file read_write_pool.hpp.

Collaboration diagram for read_write_pool< BlockType >:

#include <read_write_pool.hpp>

Public Types
using	bid_type = typename block_type::bid_type

using	block_type = BlockType

using	size_type = size_t

Public Member Functions
	read_write_pool (size_type init_size_prefetch=1, size_type init_size_write=1)

	read_write_pool (const read_write_pool &)=delete
	non-copyable: delete copy-constructor More...

	~read_write_pool ()
	Waits for completion of all ongoing requests and frees memory. More...

void	add (block_type *&block)
	Add block to write pool. More...

void	add_prefetch (block_type *&block)
	Add block to prefetch pool. More...

size_t	busy_size_prefetch () const
	Returns the number of busy prefetching blocks. More...

request_ptr	find_hint (bid_type bid)

size_t	free_size_prefetch () const
	Returns the number of free prefetching blocks. More...

bool	hint (bid_type bid)

bool	in_prefetching (bid_type bid)
	Checks if a block is in the hinted block set. More...

bool	invalidate (bid_type bid)
	Cancel a hint request in case the block is no longer desired. More...

read_write_pool &	operator= (const read_write_pool &)=delete
	non-copyable: delete assignment operator More...

bool	poll_hint (bid_type bid)
	Returns true if the blocks was hinted and the request is finished. More...

request_ptr	read (block_type *&block, bid_type bid)
	Reads block. More...

void	resize_prefetch (size_type new_size)

void	resize_write (size_type new_size)

size_type	size_prefetch () const
	Returns number of blocks owned by the prefetch_pool. More...

size_type	size_write () const
	Returns number of blocks owned by the write_pool. More...

block_type *	steal ()

block_type *	steal_prefetch ()

void	swap (read_write_pool &obj)

request_ptr	write (block_type *&block, bid_type bid)

Protected Types
using	prefetch_pool_type = prefetch_pool< block_type >

using	write_pool_type = write_pool< block_type >

Protected Attributes
bool	delete_pools

prefetch_pool_type *	p_pool

write_pool_type *	w_pool

Member Typedef Documentation

◆ bid_type

using bid_type = typename block_type::bid_type

Definition at line 35 of file read_write_pool.hpp.

◆ block_type

using block_type = BlockType

Definition at line 34 of file read_write_pool.hpp.

◆ prefetch_pool_type

using prefetch_pool_type = prefetch_pool<block_type>

protected

Definition at line 40 of file read_write_pool.hpp.

◆ size_type

using size_type = size_t

Definition at line 36 of file read_write_pool.hpp.

◆ write_pool_type

using write_pool_type = write_pool<block_type>

protected

Definition at line 39 of file read_write_pool.hpp.

Constructor & Destructor Documentation

◆ read_write_pool() [1/2]

read_write_pool	(	size_type	init_size_prefetch = `1`,
		size_type	init_size_write = `1`
	)

inlineexplicit

Constructs pool.

Parameters

init_size_prefetch	initial number of blocks in the prefetch pool
init_size_write	initial number of blocks in the write pool

Definition at line 50 of file read_write_pool.hpp.

References read_write_pool< BlockType >::operator=().

◆ read_write_pool() [2/2]

read_write_pool ( const read_write_pool< BlockType > & )

delete

non-copyable: delete copy-constructor

◆ ~read_write_pool()

~read_write_pool ( )

inline

Waits for completion of all ongoing requests and frees memory.

Definition at line 70 of file read_write_pool.hpp.

References read_write_pool< BlockType >::p_pool, and read_write_pool< BlockType >::w_pool.

Member Function Documentation

◆ add()

void add ( block_type *& block )

inline

Add block to write pool.

Definition at line 126 of file read_write_pool.hpp.

References write_pool< BlockType >::add().

◆ add_prefetch()

void add_prefetch ( block_type *& block )

inline

Add block to prefetch pool.

Definition at line 182 of file read_write_pool.hpp.

References prefetch_pool< BlockType >::add().

◆ busy_size_prefetch()

size_t busy_size_prefetch ( ) const

inline

Returns the number of busy prefetching blocks.

Definition at line 208 of file read_write_pool.hpp.

References prefetch_pool< BlockType >::busy_size().

◆ find_hint()

request_ptr find_hint ( bid_type bid )

inline

Returns the request pointer for a hinted block, or an invalid nullptr request in case it was not requested due to lack of prefetch buffers.

Definition at line 170 of file read_write_pool.hpp.

References prefetch_pool< BlockType >::find().

◆ free_size_prefetch()

size_t free_size_prefetch ( ) const

inline

Returns the number of free prefetching blocks.

Definition at line 202 of file read_write_pool.hpp.

References prefetch_pool< BlockType >::free_size().

◆ hint()

bool hint ( bid_type bid )

inline

Gives a hint for prefetching a block.

Parameters

bid	address of a block to be prefetched

Returns: true if there was a free block to do prefetch and prefetching was scheduled, false otherwise

Note: If there are no free blocks available (all blocks are already in reading or read but not retrieved by user calling read method) calling hint function has no effect

Definition at line 140 of file read_write_pool.hpp.

References prefetch_pool< BlockType >::hint().

◆ in_prefetching()

bool in_prefetching ( bid_type bid )

inline

Checks if a block is in the hinted block set.

Definition at line 196 of file read_write_pool.hpp.

References prefetch_pool< BlockType >::in_prefetching().

◆ invalidate()

bool invalidate ( bid_type bid )

inline

Cancel a hint request in case the block is no longer desired.

Definition at line 146 of file read_write_pool.hpp.

References prefetch_pool< BlockType >::invalidate().

◆ operator=()

read_write_pool& operator= ( const read_write_pool< BlockType > & )

delete

non-copyable: delete assignment operator

Referenced by read_write_pool< BlockType >::read_write_pool().

◆ poll_hint()

bool poll_hint ( bid_type bid )

inline

Returns true if the blocks was hinted and the request is finished.

Definition at line 176 of file read_write_pool.hpp.

References prefetch_pool< BlockType >::poll().

◆ read()

request_ptr read	(	block_type *&	block,
		bid_type	bid
	)

inline

Reads block.

If this block is cached block is not read but passed from the cache.

Parameters

block	block object, where data to be read to. If block was cached `block` 's ownership goes to the pool and block from cache is returned in `block` value.
bid	address of the block

Warning: block parameter must be allocated dynamically using new .

Returns: request pointer object of read operation

Definition at line 163 of file read_write_pool.hpp.

References prefetch_pool< BlockType >::read().

◆ resize_prefetch()

void resize_prefetch ( size_type new_size )

inline

Resizes size of the pool.

Parameters

new_size new size of the pool after the call

Definition at line 93 of file read_write_pool.hpp.

References prefetch_pool< BlockType >::resize().

◆ resize_write()

void resize_write ( size_type new_size )

inline

Resizes size of the pool.

Parameters

new_size new size of the pool after the call

Definition at line 86 of file read_write_pool.hpp.

References write_pool< BlockType >::resize().

◆ size_prefetch()

size_type size_prefetch ( ) const

inline

Returns number of blocks owned by the prefetch_pool.

Definition at line 82 of file read_write_pool.hpp.

References prefetch_pool< BlockType >::size().

◆ size_write()

size_type size_write ( ) const

inline

Returns number of blocks owned by the write_pool.

Definition at line 79 of file read_write_pool.hpp.

References write_pool< BlockType >::size().

◆ steal()

block_type* steal ( )

inline

Take out a block from the pool.

Returns: pointer to the block. Ownership of the block goes to the caller.

Definition at line 120 of file read_write_pool.hpp.

References write_pool< BlockType >::steal().

◆ steal_prefetch()

block_type* steal_prefetch ( )

inline

Take out a block from the prefetch pool, one unhinted free block must be available.

Returns: pointer to the block. Ownership of the block goes to the caller.

Definition at line 190 of file read_write_pool.hpp.

References prefetch_pool< BlockType >::steal().

◆ swap()

void swap ( read_write_pool< BlockType > & obj )

inline

Definition at line 62 of file read_write_pool.hpp.

References read_write_pool< BlockType >::delete_pools, read_write_pool< BlockType >::p_pool, and read_write_pool< BlockType >::w_pool.

Referenced by std::swap().

◆ write()

request_ptr write	(	block_type *&	block,
		bid_type	bid
	)

inline

Passes a block to the pool for writing.

Parameters

block	block to write. Ownership of the block goes to the pool. `block` must be allocated dynamically with using `new` .
bid	location, where to write

Warning: block must be allocated dynamically with using new .

Returns: request object of the write operation

Definition at line 106 of file read_write_pool.hpp.

References prefetch_pool< BlockType >::hint(), prefetch_pool< BlockType >::invalidate(), and write_pool< BlockType >::write().

Member Data Documentation

◆ delete_pools

bool delete_pools

protected

Definition at line 44 of file read_write_pool.hpp.

Referenced by read_write_pool< BlockType >::swap().

◆ p_pool

prefetch_pool_type* p_pool

protected

Definition at line 43 of file read_write_pool.hpp.

Referenced by read_write_pool< BlockType >::swap(), and read_write_pool< BlockType >::~read_write_pool().

◆ w_pool

write_pool_type* w_pool

protected

Definition at line 42 of file read_write_pool.hpp.

Referenced by read_write_pool< BlockType >::swap(), and read_write_pool< BlockType >::~read_write_pool().

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

extlib/foxxll/foxxll/mng/read_write_pool.hpp

Detailed Description

template<typename BlockType> class foxxll::read_write_pool< BlockType >

Public Types

Public Member Functions

Protected Types

Protected Attributes

Member Typedef Documentation

◆ bid_type

◆ block_type

◆ prefetch_pool_type

◆ size_type

◆ write_pool_type

Constructor & Destructor Documentation

◆ read_write_pool() [1/2]

◆ read_write_pool() [2/2]

◆ ~read_write_pool()

Member Function Documentation

◆ add()

◆ add_prefetch()

◆ busy_size_prefetch()

◆ find_hint()

◆ free_size_prefetch()

◆ hint()

◆ in_prefetching()

◆ invalidate()

◆ operator=()

◆ poll_hint()

◆ read()

◆ resize_prefetch()

◆ resize_write()

◆ size_prefetch()

◆ size_write()

◆ steal()

◆ steal_prefetch()

◆ swap()

◆ write()

Member Data Documentation

◆ delete_pools

◆ p_pool

◆ w_pool

template<typename BlockType>
class foxxll::read_write_pool< BlockType >