scc  2022.4.0
SystemC components library
scc::tracer Class Reference

a component traversing the SystemC object hierarchy and tracing the objects More...

#include <tracer.h>

Inheritance diagram for scc::tracer:
Collaboration diagram for scc::tracer:

Public Types

enum  file_type {
  NONE , ENABLE , TEXT , COMPRESSED ,
  SQLITE , FTR , CFTR , LWFTR ,
  LWCFTR , CUSTOM , SC_VCD = TEXT , PULL_VCD = COMPRESSED ,
  PUSH_VCD = SQLITE , FST
}
 defines the transaction trace output type More...
 

Public Member Functions

 tracer (std::string const &&name, file_type tx_type, file_type sig_type, sc_core::sc_object *top=nullptr)
 
 tracer (std::string const &name, file_type tx_type=ENABLE, file_type sig_type=ENABLE, sc_core::sc_object *top=nullptr)
 
 tracer (std::string const &&name, file_type type, bool enable=true, sc_core::sc_object *top=nullptr)
 
 tracer (std::string const &name, file_type type, bool enable=true, sc_core::sc_object *top=nullptr)
 
 tracer (std::string const &&name, file_type type, sc_core::sc_trace_file *tf, sc_core::sc_object *top=nullptr)
 
 tracer (std::string const &name, file_type type, sc_core::sc_trace_file *tf, sc_core::sc_object *top=nullptr)
 
virtual ~tracer () override
 the destructor
 
- Public Member Functions inherited from scc::tracer_base
 tracer_base (const sc_core::sc_module_name &nm)
 named constructor More...
 
 tracer_base (const sc_core::sc_module_name &nm, sc_core::sc_trace_file *tf, bool owned=true)
 named constructor with trace file More...
 
 ~tracer_base ()
 destructor
 
void set_trace_types (trace_types t)
 set the types to trace More...
 
const sc_core::sc_trace_file * get_trace_file () const
 get the tracefile used by this tracer More...
 
sc_core::sc_trace_file * get_trace_file ()
 
void set_trace_file (sc_core::sc_trace_file *trf)
 set the trace file of this tracer More...
 

Public Attributes

cci::cci_param< unsigned > tx_trace_type
 
cci::cci_param< unsigned > sig_trace_type
 
cci::cci_param< bool > close_db_in_eos
 

Protected Member Functions

 tracer (std::string const &&name, file_type tx_type, file_type sig_type, sc_core::sc_object *top, sc_core::sc_module_name const &nm)
 
 tracer (std::string const &&name, file_type type, sc_core::sc_trace_file *tf, sc_core::sc_object *top, sc_core::sc_module_name const &nm)
 
void end_of_elaboration () override
 
void end_of_simulation () override
 
- Protected Member Functions inherited from scc::tracer_base
virtual void descend (const sc_core::sc_object *, bool trace_all)
 

Protected Attributes

scv_tr::scv_tr_db * txdb {nullptr}
 
lwtr::tx_db * lwtr_db {nullptr}
 
cci::cci_broker_handle cci_broker
 the cci broker
 
- Protected Attributes inherited from scc::tracer_base
bool default_trace_enable {true}
 the default for tracing if no attribute is configured
 
sc_core::sc_trace_file * trf {nullptr}
 
trace_types types_to_trace {trace_types::ALL}
 

Additional Inherited Members

- Static Protected Member Functions inherited from scc::tracer_base
static std::string get_name ()
 
static void try_trace (sc_core::sc_trace_file *trace_file, const sc_core::sc_object *object, trace_types t)
 

Detailed Description

a component traversing the SystemC object hierarchy and tracing the objects

Definition at line 51 of file tracer.h.

Member Enumeration Documentation

◆ file_type

defines the transaction trace output type

CUSTOM means the caller needs to initialize the database driver (scv_tr_text_init() or alike)

Definition at line 59 of file tracer.h.

Member Data Documentation

◆ close_db_in_eos

cci::cci_param<bool> scc::tracer::close_db_in_eos
Initial value:
{"close_db_in_eos", false,
"Close the waveform/transaction tracing databases during end_of_simulation"}

cci parameter to determine the file type being used to trace signals if not specified explicitly

Definition at line 88 of file tracer.h.

◆ sig_trace_type

cci::cci_param<unsigned> scc::tracer::sig_trace_type
Initial value:
{"sig_trace_type", FST,
"Type of signal trace file used for recording. See also scc::tracer::wave_type"}

cci parameter to determine the file type being used to trace signals if not specified explicitly

Definition at line 83 of file tracer.h.

◆ tx_trace_type

cci::cci_param<unsigned> scc::tracer::tx_trace_type
Initial value:
{"tx_trace_type", CFTR,
"Type of TX trace file used for recording. See also scc::tracer::file_type"}

cci parameter to determine the file type being used to trace transaction if not specified explicitly

Definition at line 78 of file tracer.h.


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