Detailed Description

Block combines a reference to a read-only ByteBlock and book-keeping information.

The book-keeping meta-information currently is the start of the first item, the ends of the item range, and the number of items in the range.

Multiple Block instances can share the same ByteBlock but have different book-keeping / meta- information!

    +–+------—+------—+----------—+------—+--—+
    |  |Item1    |Item2    |Item3        |Item4    |Item5|(partial)
    +–+------—+------—+----------—+------—+--—+
       ^         ^                                       ^
       begin     first_item    num_items=5               end

Definition at line 52 of file block.hpp.

Inheritance diagram for Block:

Collaboration diagram for Block:

#include <block.hpp>

Public Member Functions
	Block ()=default
	default-ctor: create invalid Block. More...

	Block (const Block &other)=default

	Block (Block &&other)=default

	Block (ByteBlockPtr &&byte_block, size_t begin, size_t end, size_t first_item, size_t num_items, bool typecode_verify)

const ByteBlockPtr &	byte_block () const
	access to byte_block_ More...

ByteBlockPtr &	byte_block ()
	mutable access to byte_block_ More...

size_t	first_item_absolute () const
	accessor to first_item_ (absolute in ByteBlock) More...

size_t	first_item_relative () const
	return the first_item_offset relative to data_begin(). More...

bool	IsValid () const
	Return whether the enclosed ByteBlock is valid. More...

size_t	num_items () const
	return number of items beginning in this block More...

Block &	operator= (const Block &other)=default

Block &	operator= (Block &&other)=default

PinRequestPtr	Pin (size_t local_worker_id) const

size_t	pin_count (size_t local_worker_id) const
	return number of pins in underlying ByteBlock More...

PinnedBlock	PinWait (size_t local_worker_id) const
	Convenience function to call Pin() and wait for the future. More...

void	set_begin (size_t i)
	accessor to begin_ More...

void	set_end (size_t i)
	accessor to end_ More...

size_t	size () const
	return length of valid data in bytes. More...

bool	typecode_verify () const
	Returns typecode_verify_. More...

Protected Attributes
size_t	begin_ = 0
	beginning offset of valid bytes to read More...

ByteBlockPtr	byte_block_
	referenced ByteBlock More...

size_t	end_ = 0

size_t	first_item_ = 0

size_t	num_items_ = 0

bool	typecode_verify_ = false

Static Protected Attributes
static constexpr bool	debug = false

Friends
std::ostream &	operator<< (std::ostream &os, const Block &b)

Constructor & Destructor Documentation

◆ Block() [1/4]

Block ( )

default

default-ctor: create invalid Block.

Referenced by PinnedBlock::MoveToBlock(), and PinnedBlock::ToBlock().

◆ Block() [2/4]

Block ( const Block & other )

default

◆ Block() [3/4]

Block ( Block && other )

default

◆ Block() [4/4]

Block	(	ByteBlockPtr &&	byte_block,
		size_t	begin,
		size_t	end,
		size_t	first_item,
		size_t	num_items,
		bool	typecode_verify
	)

inline

Creates a block that points to the given data::ByteBlock with the given offsets The block can be initialized as pinned or not.

Definition at line 65 of file block.hpp.

Member Function Documentation

◆ byte_block() [1/2]

const ByteBlockPtr& byte_block ( ) const

inline

access to byte_block_

Definition at line 79 of file block.hpp.

References Block::byte_block_.

Referenced by PinnedBlock::byte_block(), Block::Pin(), and BlockPool::PinBlock().

◆ byte_block() [2/2]

ByteBlockPtr& byte_block ( )

inline

mutable access to byte_block_

Definition at line 82 of file block.hpp.

References Block::byte_block_.

◆ first_item_absolute()

size_t first_item_absolute ( ) const

inline

accessor to first_item_ (absolute in ByteBlock)

Definition at line 103 of file block.hpp.

References Block::first_item_.

Referenced by PinnedBlock::first_item_absolute().

◆ first_item_relative()

size_t first_item_relative ( ) const

inline

return the first_item_offset relative to data_begin().

Definition at line 106 of file block.hpp.

References Block::begin_, and Block::first_item_.

Referenced by PinnedBlock::first_item_relative().

◆ IsValid()

bool IsValid ( ) const

inline

Return whether the enclosed ByteBlock is valid.

Definition at line 74 of file block.hpp.

References Block::byte_block_.

Referenced by BlockReader< CatBlockSource >::GetItemBatch(), PinnedBlock::IsValid(), thrill::data::operator<<(), Block::Pin(), BlockQueue::Pop(), MixBlockQueue::Pop(), MixBlockQueueReader::PullBlock(), and PinnedBlock::ToString().

◆ num_items()

size_t num_items ( ) const

inline

return number of items beginning in this block

Definition at line 85 of file block.hpp.

References Block::num_items_.

Referenced by StreamSink::AppendBlock(), File::AppendBlock(), BlockReader< CatBlockSource >::GetItemBatch(), PinnedBlock::num_items(), and MixBlockQueueReader::PullBlock().

◆ operator=() [1/2]

Block& operator= ( const Block & other )

default

Referenced by PinnedBlock::operator=().

◆ operator=() [2/2]

Block& operator= ( Block && other )

default

◆ Pin()

PinRequestPtr Pin ( size_t local_worker_id ) const

Creates a pinned copy of this Block. If the underlying data::ByteBlock is already pinned, the Future is directly filled with a copy if this block. Otherwise an async pin call will be issued.

Definition at line 39 of file block.cpp.

References Block::byte_block(), and Block::IsValid().

Referenced by PinnedBlock::CopyPinnedByteBlock(), KeepFileBlockSource::NextBlock(), ConsumeFileBlockSource::NextBlock(), Block::PinWait(), KeepFileBlockSource::Prefetch(), ConsumeFileBlockSource::Prefetch(), and Block::typecode_verify().