fz::BitshuffleStage Class Reference

#include <bitshuffle_stage.h>

Inheritance diagram for fz::BitshuffleStage:

Public Member Functions
void	setInverse (bool inv) override
size_t	getRequiredInputAlignment () const override
void	execute (cudaStream_t stream, MemoryPool *pool, const std::vector< void * > &inputs, const std::vector< void * > &outputs, const std::vector< size_t > &sizes) override
std::string	getName () const override
std::vector< size_t >	estimateOutputSizes (const std::vector< size_t > &input_sizes) const override
std::unordered_map< std::string, size_t >	getActualOutputSizesByName () const override
size_t	getActualOutputSize (int index) const override
uint16_t	getStageTypeId () const override
uint8_t	getOutputDataType (size_t) const override
size_t	serializeHeader (size_t output_index, uint8_t *buf, size_t max_size) const override
void	deserializeHeader (const uint8_t *buf, size_t size) override
size_t	getMaxHeaderSize (size_t) const override
void	saveState () override
Public Member Functions inherited from fz::Stage
virtual std::vector< std::string >	getOutputNames () const
int	getOutputIndex (const std::string &name) const
virtual uint8_t	getInputDataType (size_t) const
virtual void	setDims (const std::array< size_t, 3 > &dims)
virtual void	onFinalize (size_t, MemoryPool *)
virtual size_t	estimateDeviceFootprintBytes (size_t) const
virtual size_t	estimatePinnedFootprintBytes (size_t) const
virtual void	postStreamSync (cudaStream_t stream)
virtual bool	isGraphCompatible () const
virtual size_t	estimateScratchBytes (const std::vector< size_t > &input_sizes) const

Detailed Description

GPU bit-matrix transpose stage.

setBlockSize(bytes) — chunk size in bytes (default 16384; must be a multiple of 1024 × element_width). setElementWidth(bytes) — element width: 1, 2, 4, or 8 (default 4).

Note

Prior work: the 4- and 8-byte butterfly kernels are adapted from d_BIT_4 / d_BIT_8 in the LC framework (Burtscher et al., BSD-3-Clause). The 1- and 2-byte paths use a standard __ballot_sync approach. See THIRD_PARTY.md.

Member Function Documentation

setInverse()

void fz::BitshuffleStage::setInverse ( bool  inverse )

inlineoverridevirtual

Switch between forward (compression) and inverse (decompression) mode. Affects getNumInputs()/getNumOutputs() for stages with asymmetric port counts.

Reimplemented from fz::Stage.

getRequiredInputAlignment()

size_t fz::BitshuffleStage::getRequiredInputAlignment ( ) const

inlineoverridevirtual

Minimum input size alignment in bytes. Chunked stages return their chunk size; the pipeline uses the LCM of all stage alignments at finalize() to transparently zero-pad the input. Default: 1 (no alignment requirement).

Reimplemented from fz::Stage.

execute()

void fz::BitshuffleStage::execute ( cudaStream_t  stream, MemoryPool *  pool, const std::vector< void * > &  inputs, const std::vector< void * > &  outputs, const std::vector< size_t > &  sizes  )

overridevirtual

Execute the stage. Inputs, outputs, and sizes are device pointers/bytes.

Stages may call cudaStreamSynchronize(stream) or issue blocking D2H copies when the algorithm requires it (e.g. Huffman histogram readback for codebook construction, ANS renormalization tables). Such stages must return false from isGraphCompatible() and must document the sync points.

Note: the DAG dispatches sibling nodes (same topological level) via a sequential CPU loop, each enqueuing to its own stream. A sync inside execute() blocks the CPU from dispatching subsequent siblings until the synced stream is idle — this delays parallel branches in wide DAGs. In a linear pipeline there are no siblings and no extra cost.

Implements fz::Stage.

getName()

std::string fz::BitshuffleStage::getName ( ) const

inlineoverridevirtual

Human-readable name used in error messages and debug output.

Implements fz::Stage.

estimateOutputSizes()

std::vector< size_t > fz::BitshuffleStage::estimateOutputSizes ( const std::vector< size_t > &  input_sizes ) const

inlineoverridevirtual

Estimate output buffer sizes given input sizes. Used for buffer allocation planning in PREALLOCATE mode — must be a safe upper bound; under-estimation causes buffer overruns.

Implements fz::Stage.

getActualOutputSizesByName()

std::unordered_map< std::string, size_t > fz::BitshuffleStage::getActualOutputSizesByName ( ) const

inlineoverridevirtual

Actual output sizes after execute(), keyed by output port name.

Implements fz::Stage.

getActualOutputSize()

size_t fz::BitshuffleStage::getActualOutputSize ( int  index ) const

inlineoverridevirtual

Actual size of a single output by index after execute(). Avoids constructing the map for the common single-output case. Default delegates to getActualOutputSizesByName(); override to return directly from an internal field.

Reimplemented from fz::Stage.

getStageTypeId()

uint16_t fz::BitshuffleStage::getStageTypeId ( ) const

inlineoverridevirtual

Stage type identifier written into the FZM file header.

Implements fz::Stage.

getOutputDataType()

uint8_t fz::BitshuffleStage::getOutputDataType ( size_t  output_index ) const

inlineoverridevirtual

DataType enum of the given output port.

Implements fz::Stage.

serializeHeader()

size_t fz::BitshuffleStage::serializeHeader ( size_t  output_index, uint8_t *  header_buffer, size_t  max_size  ) const

inlineoverridevirtual

Serialize stage config into header_buffer (max 128 bytes) for the FZM file. Return the number of bytes written, or 0 if the stage has no config.

Reimplemented from fz::Stage.

deserializeHeader()

void fz::BitshuffleStage::deserializeHeader ( const uint8_t *  header_buffer, size_t  size  )

inlineoverridevirtual

Restore stage config from header_buffer during decompression.

Reimplemented from fz::Stage.

getMaxHeaderSize()

size_t fz::BitshuffleStage::getMaxHeaderSize ( size_t  output_index ) const

inlineoverridevirtual

Maximum bytes this stage writes into its per-output FZM header slot.

Reimplemented from fz::Stage.

saveState()

void fz::BitshuffleStage::saveState ( )

inlineoverridevirtual

Save/restore config state around a decompression pass. deserializeHeader() overwrites the stage's forward-pass config; saveState() is called before and restoreState() after so the stage returns to its original configuration.

Reimplemented from fz::Stage.