circt::arc::runtime::impl::TraceBuffer Struct Reference

A heap allocated buffer containing raw trace data and time step markers. More...

#include <TraceEncoder.h>

Collaboration diagram for circt::arc::runtime::impl::TraceBuffer:

Public Member Functions
	TraceBuffer ()=delete
	TraceBuffer (uint32_t capacity)
	TraceBuffer (const TraceBuffer &other)=delete
TraceBuffer	operator= (const TraceBuffer &other)=delete
	TraceBuffer (TraceBuffer &&other) noexcept=default
TraceBuffer &	operator= (TraceBuffer &&other) noexcept=default
uint64_t *	getData () const
	Get the pointer to the buffer's storage.
void	clear ()
	Reset the buffer.
void	assertSentinel () const
	Assert that the buffer's sentinel value has not been overwritten.

Public Attributes
uint32_t	capacity
	Available storage in number of elements.
uint32_t	size = 0
	Number of valid elements, set on dispatch.
int64_t	firstStep = -1
	Time step of the buffer's first entry.
std::vector< TraceBufferMarker >	stepMarkers
	Time step markers.

Private Attributes
std::unique_ptr< uint64_t[]>	storage

Static Private Attributes
static constexpr uint64_t	sentinelValue = UINT64_C(0xABCD1234EFBA8765)

Detailed Description

A heap allocated buffer containing raw trace data and time step markers.

Definition at line 45 of file TraceEncoder.h.

Constructor & Destructor Documentation

TraceBuffer() [1/4]

circt::arc::runtime::impl::TraceBuffer::TraceBuffer ( )

delete

TraceBuffer() [2/4]

circt::arc::runtime::impl::TraceBuffer::TraceBuffer ( uint32_t  capacity )

inlineexplicit

Definition at line 49 of file TraceEncoder.h.

References capacity, sentinelValue, and storage.

TraceBuffer() [3/4]

circt::arc::runtime::impl::TraceBuffer::TraceBuffer ( const TraceBuffer &  other )

delete

TraceBuffer() [4/4]

circt::arc::runtime::impl::TraceBuffer::TraceBuffer ( TraceBuffer &&  other )

defaultnoexcept

Member Function Documentation

assertSentinel()

void circt::arc::runtime::impl::TraceBuffer::assertSentinel ( ) const

inline

Assert that the buffer's sentinel value has not been overwritten.

Definition at line 82 of file TraceEncoder.h.

References capacity, circt::arc::runtime::impl::fatalError(), sentinelValue, and storage.

Referenced by circt::arc::runtime::impl::TraceEncoder::dispatch(), circt::arc::runtime::impl::TraceEncoder::finish(), and circt::arc::runtime::impl::TraceEncoder::step().

clear()

void circt::arc::runtime::impl::TraceBuffer::clear ( )

inline

Reset the buffer.

Definition at line 75 of file TraceEncoder.h.

References firstStep, size, and stepMarkers.

getData()

uint64_t * circt::arc::runtime::impl::TraceBuffer::getData ( ) const

inline

Get the pointer to the buffer's storage.

Definition at line 72 of file TraceEncoder.h.

References storage.

Referenced by circt::arc::runtime::impl::TraceEncoder::dispatch(), circt::arc::runtime::impl::VCDTraceEncoder::encode(), circt::arc::runtime::impl::TraceEncoder::step(), and circt::arc::runtime::impl::TraceEncoder::TraceEncoder().

operator=() [1/2]

TraceBuffer circt::arc::runtime::impl::TraceBuffer::operator= ( const TraceBuffer &  other )

delete

operator=() [2/2]

TraceBuffer & circt::arc::runtime::impl::TraceBuffer::operator= ( TraceBuffer &&  other )

defaultnoexcept

Member Data Documentation

capacity

uint32_t circt::arc::runtime::impl::TraceBuffer::capacity

Available storage in number of elements.

Note: Actual capacity is +1 for sentinel

Definition at line 63 of file TraceEncoder.h.

Referenced by assertSentinel(), and TraceBuffer().

firstStep

int64_t circt::arc::runtime::impl::TraceBuffer::firstStep = -1

Time step of the buffer's first entry.

Definition at line 67 of file TraceEncoder.h.

Referenced by clear(), circt::arc::runtime::impl::TraceEncoder::dispatch(), circt::arc::runtime::impl::VCDTraceEncoder::encode(), circt::arc::runtime::impl::TraceEncoder::run(), and circt::arc::runtime::impl::TraceEncoder::step().

sentinelValue

constexpr uint64_t circt::arc::runtime::impl::TraceBuffer::sentinelValue = UINT64_C(0xABCD1234EFBA8765)

staticconstexprprivate

Definition at line 88 of file TraceEncoder.h.

Referenced by assertSentinel(), and TraceBuffer().

size

uint32_t circt::arc::runtime::impl::TraceBuffer::size = 0

Number of valid elements, set on dispatch.

Definition at line 65 of file TraceEncoder.h.

Referenced by esiaccel.types.ArrayType::bit_width(), clear(), esiaccel.types.ArrayType::deserialize(), circt::arc::runtime::impl::TraceEncoder::dispatch(), circt::arc::runtime::impl::VCDTraceEncoder::encode(), and esiaccel.types.ArrayType::is_valid().

stepMarkers

std::vector<TraceBufferMarker> circt::arc::runtime::impl::TraceBuffer::stepMarkers

Time step markers.

Definition at line 69 of file TraceEncoder.h.

Referenced by clear(), circt::arc::runtime::impl::VCDTraceEncoder::encode(), circt::arc::runtime::impl::TraceEncoder::run(), and circt::arc::runtime::impl::TraceEncoder::step().

storage

std::unique_ptr<uint64_t[]> circt::arc::runtime::impl::TraceBuffer::storage

private

Definition at line 89 of file TraceEncoder.h.

Referenced by assertSentinel(), getData(), and TraceBuffer().

---

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

• /home/runner/work/circt-www/circt-www/circt_src/include/circt/Dialect/Arc/Runtime/TraceEncoder.h