CIRCT 22.0.0git
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
circt::arc::runtime::impl::DummyTraceEncoder Class Referencefinal

Dummy encoder discarding all produced trace data. More...

#include <TraceEncoder.h>

Inheritance diagram for circt::arc::runtime::impl::DummyTraceEncoder:
Inheritance graph
[legend]
Collaboration diagram for circt::arc::runtime::impl::DummyTraceEncoder:
Collaboration graph
[legend]

Public Member Functions

 DummyTraceEncoder (const ArcRuntimeModelInfo *modelInfo, ArcState *state)
 
 ~DummyTraceEncoder () override=default
 
- Public Member Functions inherited from circt::arc::runtime::impl::TraceEncoder
 TraceEncoder ()=delete
 
 TraceEncoder (const ArcRuntimeModelInfo *modelInfo, ArcState *state, unsigned numBuffers, bool debug)
 Construct a trace encoder for the given model and the given number of buffers.
 
virtual ~TraceEncoder ()=default
 
void run (ArcState *state)
 Begin tracing.
 
uint64_t * dispatch (uint32_t oldBufferSize)
 Dispatch the currently active trace buffer containing oldBufferSize valid entries to the encoder thread and return the storage of the new active buffer.
 
void step (const ArcState *state)
 Signal the start of a new simulation time step.
 
void finish (const ArcState *state)
 Stop tracing.
 

Protected Member Functions

bool initialize (const ArcState *state) override
 Set-up the encoder before starting the worker thread.
 
- Protected Member Functions inherited from circt::arc::runtime::impl::TraceEncoder
virtual void startUpWorker ()
 Called by the worker thread before entering the encode loop.
 
virtual void encode (TraceBuffer &work)
 Encode the given trace buffer. Called by the worker thread.
 
virtual void windDownWorker ()
 Called by the worker thread after leaving the encode loop.
 
virtual void finalize (const ArcState *state)
 Finish trace encoding. Called by the simulation thread.
 

Additional Inherited Members

- Public Attributes inherited from circt::arc::runtime::impl::TraceEncoder
const unsigned numBuffers
 Number of trace buffers in rotation.
 
- Protected Attributes inherited from circt::arc::runtime::impl::TraceEncoder
const ArcRuntimeModelInfo *const modelInfo
 Metadata of the traced model.
 
const bool debug
 Debug mode flag.
 

Detailed Description

Dummy encoder discarding all produced trace data.

Definition at line 172 of file TraceEncoder.h.

Constructor & Destructor Documentation

◆ DummyTraceEncoder()

circt::arc::runtime::impl::DummyTraceEncoder::DummyTraceEncoder ( const ArcRuntimeModelInfo modelInfo,
ArcState state 
)
inline

Definition at line 174 of file TraceEncoder.h.

◆ ~DummyTraceEncoder()

circt::arc::runtime::impl::DummyTraceEncoder::~DummyTraceEncoder ( )
overridedefault

Member Function Documentation

◆ initialize()

bool circt::arc::runtime::impl::DummyTraceEncoder::initialize ( const ArcState state)
inlineoverrideprotectedvirtual

Set-up the encoder before starting the worker thread.

May return false to indicate failure. In this case, no worker thread will be created. Called by the simulation thread.

Implements circt::arc::runtime::impl::TraceEncoder.

Definition at line 180 of file TraceEncoder.h.


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