Stream frame FIFO. More...

#include <Fifo.h>

Inheritance diagram for rogue::interfaces::stream::Fifo:

Public Member Functions
	Fifo (uint32_t maxDepth, uint32_t trimSize, bool noCopy)
	Constructs a FIFO stream buffer.

	~Fifo ()
	Destroys the FIFO and stops internal worker thread.

std::size_t	size ()
	Returns current FIFO queue depth.

std::size_t	dropCnt () const
	Returns the total dropped-frame counter.

void	clearCnt ()
	Clears FIFO counters (including dropped-frame count).

void	acceptFrame (std::shared_ptr< rogue::interfaces::stream::Frame > frame)
	Receives a frame from upstream and enqueues or drops it.

Public Member Functions inherited from rogue::interfaces::stream::Master
	Master ()
	Constructs a stream master.

virtual	~Master ()
	Destroys the stream master.

uint32_t	slaveCount ()
	Returns the number of attached slaves.

void	addSlave (std::shared_ptr< rogue::interfaces::stream::Slave > slave)
	Attaches a downstream slave.

std::shared_ptr< rogue::interfaces::stream::Frame >	reqFrame (uint32_t size, bool zeroCopyEn)
	Requests allocation of a new frame from the primary slave.

void	sendFrame (std::shared_ptr< rogue::interfaces::stream::Frame > frame)
	Sends a frame to all attached slaves.

bool	ensureSingleBuffer (std::shared_ptr< rogue::interfaces::stream::Frame > &frame, bool reqEn)
	Ensures a frame is represented by a single buffer.

virtual void	stop ()
	Stops frame generation and shuts down associated threads.

void	equalsPy (boost::python::object p)
	Supports `==` operator usage from Python.

boost::python::object	rshiftPy (boost::python::object p)
	Supports `>>` operator usage from Python.

void	operator== (std::shared_ptr< rogue::interfaces::stream::Slave > &other)
	Supports `==` operator usage in C++.

std::shared_ptr< rogue::interfaces::stream::Slave > &	operator>> (std::shared_ptr< rogue::interfaces::stream::Slave > &other)
	Connects this master to a slave via stream chaining operator.

Public Member Functions inherited from rogue::EnableSharedFromThis< rogue::interfaces::stream::Master >
std::shared_ptr< rogue::interfaces::stream::Master >	shared_from_this ()
	Returns a `shared_ptr<T>` for this instance.

Public Member Functions inherited from rogue::EnableSharedFromThisBase
virtual	~EnableSharedFromThisBase ()
	Virtual destructor for polymorphic base usage.

Public Member Functions inherited from rogue::interfaces::stream::Slave
	Slave ()
	Constructs a stream slave.

virtual	~Slave ()
	Destroys the stream slave.

virtual void	stop ()
	Shuts down threads associated with this object.

void	setDebug (uint32_t debug, std::string name)
	Sets debug message verbosity and logger name.

uint64_t	getFrameCount ()
	Returns frame counter.

uint64_t	getByteCount ()
	Returns byte counter.

bool	ensureSingleBuffer (std::shared_ptr< rogue::interfaces::stream::Frame > &frame, bool reqEn)
	Ensures frame is backed by a single buffer.

std::shared_ptr< rogue::interfaces::stream::Frame >	reqLocalFrame (uint32_t size, bool zeroCopyEn)
	Services a local frame allocation request through this object's pool interface.

boost::python::object	lshiftPy (boost::python::object p)
	Supports `<<` operator usage from Python.

std::shared_ptr< rogue::interfaces::stream::Master > &	operator<< (std::shared_ptr< rogue::interfaces::stream::Master > &other)
	Connects this slave to a master via stream chaining operator.

Public Member Functions inherited from rogue::interfaces::stream::Pool
	Pool ()
	Constructs a pool with default allocation behavior enabled.

virtual	~Pool ()
	Destroys the pool and releases any cached buffer storage.

uint32_t	getAllocBytes ()
	Returns total currently allocated bytes.

uint32_t	getAllocCount ()
	Returns total currently allocated buffer count.

virtual std::shared_ptr< rogue::interfaces::stream::Frame >	acceptReq (uint32_t size, bool zeroCopyEn)
	Services a frame allocation request from a master.

virtual void	retBuffer (uint8_t *data, uint32_t meta, uint32_t size)
	Returns buffer data to the allocator.

void	setFixedSize (uint32_t size)
	Sets fixed-size mode.

uint32_t	getFixedSize ()
	Returns fixed-size allocation setting.

void	setPoolSize (uint32_t size)
	Sets buffer pool size.

uint32_t	getPoolSize ()
	Returns configured maximum number of cached pool entries.

Public Member Functions inherited from rogue::EnableSharedFromThis< rogue::interfaces::stream::Pool >
std::shared_ptr< rogue::interfaces::stream::Pool >	shared_from_this ()
	Returns a `shared_ptr<T>` for this instance.

Public Member Functions inherited from rogue::EnableSharedFromThis< rogue::interfaces::stream::Slave >
std::shared_ptr< rogue::interfaces::stream::Slave >	shared_from_this ()
	Returns a `shared_ptr<T>` for this instance.

Static Public Member Functions
static std::shared_ptr< rogue::interfaces::stream::Fifo >	create (uint32_t maxDepth, uint32_t trimSize, bool noCopy)
	Creates a FIFO stream buffer.

static void	setup_python ()
	Registers this type with Python bindings.

Static Public Member Functions inherited from rogue::interfaces::stream::Master
static std::shared_ptr< rogue::interfaces::stream::Master >	create ()
	Creates a stream master.

static void	setup_python ()
	Registers this type with Python bindings.

Static Public Member Functions inherited from rogue::interfaces::stream::Slave
static std::shared_ptr< rogue::interfaces::stream::Slave >	create ()
	Creates a new stream slave.

static void	setup_python ()
	Registers this type with Python bindings.

Static Public Member Functions inherited from rogue::interfaces::stream::Pool
static void	setup_python ()
	Registers this type with Python bindings.

Additional Inherited Members
Protected Member Functions inherited from rogue::interfaces::stream::Pool
std::shared_ptr< rogue::interfaces::stream::Buffer >	allocBuffer (uint32_t size, uint32_t *total)
	Allocate a buffer passed size.

std::shared_ptr< rogue::interfaces::stream::Buffer >	createBuffer (void *data, uint32_t meta, uint32_t size, uint32_t alloc)
	Creates a Buffer with a pre-allocated data block.

void	decCounter (uint32_t alloc)
	Decrements allocation counter.

Detailed Description

Stream frame FIFO.

Buffers incoming frames and forwards them to downstream slaves from a worker thread. For each accepted frame:

If noCopy is true, the original frame object is queued (no payload copy, no trim).
If noCopy is false, a new frame is allocated and payload bytes are copied.
In copy mode, trimSize can cap copied payload length.

Queue backpressure/drop behavior is controlled by maxDepth:

maxDepth > 0: once queue depth reaches maxDepth, new incoming frames are dropped.
maxDepth == 0: no busy/drop threshold is applied by this FIFO (queue can continue growing).

Trim behavior:

trimSize > 0 and noCopy == false: copied payload is limited to min(payload, trimSize).
trimSize == 0: copied payload is not trimmed.
noCopy == true: trimSize is ignored.

Definition at line 53 of file Fifo.h.

Constructor & Destructor Documentation

◆ Fifo()

rogue::interfaces::stream::Fifo::Fifo	(	uint32_t	maxDepth,
		uint32_t	trimSize,
		bool	noCopy
	)

Constructs a FIFO stream buffer.

Creator with version constant.

This constructor is a low-level C++ allocation path. Prefer create() when shared ownership or Python exposure is required.

Parameters

maxDepth	Queue busy/drop threshold in frames. `0` disables threshold-based drops.
trimSize	Payload trim limit in copy mode. `0` disables trimming.
noCopy	Set to `true` to queue original frames; when `true`, `trimSize` is ignored.

Definition at line 61 of file Fifo.cpp.

◆ ~Fifo()

rogue::interfaces::stream::Fifo::~Fifo ( )

Destroys the FIFO and stops internal worker thread.

Deconstructor.

Definition at line 80 of file Fifo.cpp.

Member Function Documentation

◆ acceptFrame()

void rogue::interfaces::stream::Fifo::acceptFrame ( std::shared_ptr< rogue::interfaces::stream::Frame > frame )

virtual

Receives a frame from upstream and enqueues or drops it.

Accept a frame from master.

Parameters

frame Incoming frame.

Reimplemented from rogue::interfaces::stream::Slave.

Definition at line 104 of file Fifo.cpp.

◆ clearCnt()

void rogue::interfaces::stream::Fifo::clearCnt ( )

Clears FIFO counters (including dropped-frame count).

Clear counters.

Definition at line 99 of file Fifo.cpp.

◆ create()

rogue::interfaces::stream::FifoPtr rogue::interfaces::stream::Fifo::create	(	uint32_t	maxDepth,
		uint32_t	trimSize,
		bool	noCopy
	)

static

Creates a FIFO stream buffer.

Class creation.

Parameter semantics are identical to the constructor; see Fifo() for queue-depth and trim behavior details.

Exposed as rogue.interfaces.stream.Fifo() in Python.

This static factory is the preferred construction path when the object is shared across Rogue graph connections or exposed to Python. It returns std::shared_ptr ownership compatible with Rogue pointer typedefs.

Parameters

maxDepth	Queue busy/drop threshold in frames. `0` disables threshold-based drops.
trimSize	Payload trim limit in copy mode. `0` disables trimming.
noCopy	Set to `true` to queue original frames; when `true`, `trimSize` is ignored.

Returns: Shared pointer to the created FIFO.

Company : SLAC National Accelerator Laboratory

Description :

AXI Stream FIFO

This file is part of the rogue software platform. It is subject to the license terms in the LICENSE.txt file found in the top-level directory of this distribution and at: https://confluence.slac.stanford.edu/display/ppareg/LICENSE.html. No part of the rogue software platform, including this file, may be copied, modified, propagated, or distributed except according to the terms

contained in the LICENSE.txt file.

Definition at line 43 of file Fifo.cpp.

◆ dropCnt()

std::size_t rogue::interfaces::stream::Fifo::dropCnt ( ) const

Returns the total dropped-frame counter.

Return the number of dropped frames.

Definition at line 94 of file Fifo.cpp.

◆ setup_python()

void rogue::interfaces::stream::Fifo::setup_python ( )

static

Registers this type with Python bindings.

Setup class in python.

Definition at line 49 of file Fifo.cpp.

◆ size()

std::size_t rogue::interfaces::stream::Fifo::size ( )

Returns current FIFO queue depth.

Return the number of elements in the Fifo.

Definition at line 89 of file Fifo.cpp.

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

/home/runner/work/rogue/rogue/include/rogue/interfaces/stream/Fifo.h
/home/runner/work/rogue/rogue/src/rogue/interfaces/stream/Fifo.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Fifo()

◆ ~Fifo()

Member Function Documentation

◆ acceptFrame()

◆ clearCnt()

◆ create()

Company : SLAC National Accelerator Laboratory

AXI Stream FIFO

contained in the LICENSE.txt file.

◆ dropCnt()

◆ setup_python()

◆ size()