The TLM2 transaction recorder. More...

#include <tlm_recorder.h>

Inheritance diagram for tlm::scc::scv::tlm_recorder< TYPES >:

[legend]

Collaboration diagram for tlm::scc::scv::tlm_recorder< TYPES >:

[legend]

Public Types
using	recording_types = impl::tlm_recording_types<TYPES>
using	mm = tlm::scc::tlm_mm<recording_types>
using	tlm_recording_payload = impl::tlm_recording_payload<TYPES>

Public Member Functions
	tlm_recorder (sc_core::sc_port_b< tlm::tlm_fw_transport_if< TYPES > > &fw_port, sc_core::sc_port_b< tlm::tlm_bw_transport_if< TYPES > > &bw_port, bool recording_enabled=true, SCVNS scv_tr_db *tr_db=SCVNS scv_tr_db::get_default_db())
	tlm_recorder (const char name, sc_core::sc_port_b< tlm::tlm_fw_transport_if< TYPES > > &fw_port, sc_core::sc_port_b< tlm::tlm_bw_transport_if< TYPES > > &bw_port, bool recording_enabled=true, SCVNS scv_tr_db tr_db=SCVNS scv_tr_db::get_default_db())
tlm::tlm_sync_enum	nb_transport_fw (typename TYPES::tlm_payload_type &trans, typename TYPES::tlm_phase_type &phase, sc_core::sc_time &delay) override
	The non-blocking forward transport function.
tlm::tlm_sync_enum	nb_transport_bw (typename TYPES::tlm_payload_type &trans, typename TYPES::tlm_phase_type &phase, sc_core::sc_time &delay) override
	The non-blocking backward transport function.
void	b_transport (typename TYPES::tlm_payload_type &trans, sc_core::sc_time &delay) override
	The blocking transport function.
bool	get_direct_mem_ptr (typename TYPES::tlm_payload_type &trans, tlm::tlm_dmi &dmi_data) override
	The direct memory interface forward function.
void	invalidate_direct_mem_ptr (sc_dt::uint64 start_addr, sc_dt::uint64 end_addr) override
	The direct memory interface backward function.
unsigned int	transport_dbg (typename TYPES::tlm_payload_type &trans) override
	The debug transportfunction.
bool	isRecordingBlockingTxEnabled () const
	get the current state of transaction recording
bool	isRecordingNonBlockingTxEnabled () const
	get the current state of transaction recording
void	initialize_streams ()

Public Attributes
sc_core::sc_attribute< bool >	enableBlTracing
	the attribute to selectively enable/disable recording of blocking protocol tx
sc_core::sc_attribute< bool >	enableNbTracing
	the attribute to selectively enable/disable recording of non-blocking protocol tx
sc_core::sc_attribute< bool >	enableTimedTracing {"enableTimedTracing", true}
	the attribute to selectively enable/disable timed recording
sc_core::sc_attribute< bool >	enableDmiTracing {"enableDmiTracing", false}
	the attribute to selectively enable/disable DMI recording
sc_core::sc_port_b< tlm::tlm_fw_transport_if< TYPES > > &	fw_port
	the port where fw accesses are forwarded to
sc_core::sc_port_b< tlm::tlm_bw_transport_if< TYPES > > &	bw_port
	the port where bw accesses are forwarded to

Detailed Description

template<typename TYPES = tlm::tlm_base_protocol_types>
class tlm::scc::scv::tlm_recorder< TYPES >

The TLM2 transaction recorder.

This module records all TLM transaction to a SCV transaction stream for further viewing and analysis. The handle of the created transaction is storee in an tlm_extension so that another instance of the scv_tlm_recorder e.g. further down the opath can link to it.

Definition at line 89 of file tlm_recorder.h.

Member Typedef Documentation

◆ mm

template<typename TYPES = tlm::tlm_base_protocol_types>

using tlm::scc::scv::tlm_recorder< TYPES >::mm = tlm::scc::tlm_mm<recording_types>

Definition at line 98 of file tlm_recorder.h.

◆ recording_types

template<typename TYPES = tlm::tlm_base_protocol_types>

using tlm::scc::scv::tlm_recorder< TYPES >::recording_types = impl::tlm_recording_types<TYPES>

Definition at line 97 of file tlm_recorder.h.

◆ tlm_recording_payload

template<typename TYPES = tlm::tlm_base_protocol_types>

using tlm::scc::scv::tlm_recorder< TYPES >::tlm_recording_payload = impl::tlm_recording_payload<TYPES>

Definition at line 99 of file tlm_recorder.h.

Constructor & Destructor Documentation

◆ tlm_recorder() [1/2]

template<typename TYPES = tlm::tlm_base_protocol_types>

tlm::scc::scv::tlm_recorder< TYPES >::tlm_recorder	(	sc_core::sc_port_b< tlm::tlm_fw_transport_if< TYPES > > &	fw_port,
		sc_core::sc_port_b< tlm::tlm_bw_transport_if< TYPES > > &	bw_port,
		bool	recording_enabled = true,
		SCVNS scv_tr_db *	tr_db = SCVNS scv_tr_db::get_default_db() )

inline

Definition at line 132 of file tlm_recorder.h.

◆ tlm_recorder() [2/2]

template<typename TYPES = tlm::tlm_base_protocol_types>

tlm::scc::scv::tlm_recorder< TYPES >::tlm_recorder	(	const char *	name,
		sc_core::sc_port_b< tlm::tlm_fw_transport_if< TYPES > > &	fw_port,
		sc_core::sc_port_b< tlm::tlm_bw_transport_if< TYPES > > &	bw_port,
		bool	recording_enabled = true,
		SCVNS scv_tr_db *	tr_db = SCVNS scv_tr_db::get_default_db() )

inline

Definition at line 149 of file tlm_recorder.h.

◆ ~tlm_recorder()

template<typename TYPES = tlm::tlm_base_protocol_types>

virtual tlm::scc::scv::tlm_recorder< TYPES >::~tlm_recorder ( )

inlineoverridevirtual

Definition at line 161 of file tlm_recorder.h.

Member Function Documentation

◆ b_transport()

template<typename TYPES>

void tlm::scc::scv::tlm_recorder< TYPES >::b_transport	(	typename TYPES::tlm_payload_type &	trans,
		sc_core::sc_time &	delay )

override

The blocking transport function.

This type of transaction is forwarded and recorded to a transaction stream named "b_tx" with current timestamps. Additionally a "b_tx_timed" is been created recording the transactions at their annotated delay

Parameters

trans	is the generic payload of the transaction
delay	is the annotated delay

Definition at line 350 of file tlm_recorder.h.

◆ get_direct_mem_ptr()

template<typename TYPES>

bool tlm::scc::scv::tlm_recorder< TYPES >::get_direct_mem_ptr	(	typename TYPES::tlm_payload_type &	trans,
		tlm::tlm_dmi &	dmi_data )

override

The direct memory interface forward function.

This type of transaction is just forwarded and not recorded.

Parameters

trans	is the generic payload of the transaction
dmi_data	is the structure holding the dmi information

Returns: if the dmi structure is valid

Definition at line 648 of file tlm_recorder.h.

◆ initialize_streams()

template<typename TYPES = tlm::tlm_base_protocol_types>

void tlm::scc::scv::tlm_recorder< TYPES >::initialize_streams ( )

inline

Definition at line 299 of file tlm_recorder.h.

◆ invalidate_direct_mem_ptr()

template<typename TYPES>

void tlm::scc::scv::tlm_recorder< TYPES >::invalidate_direct_mem_ptr	(	sc_dt::uint64	start_addr,
		sc_dt::uint64	end_addr )

override

The direct memory interface backward function.

This type of transaction is just forwarded and not recorded.

Parameters

start_addr	is the start address of the memory area being invalid
end_addr	is the end address of the memory area being invalid

Definition at line 666 of file tlm_recorder.h.

◆ isRecordingBlockingTxEnabled()

template<typename TYPES = tlm::tlm_base_protocol_types>

bool tlm::scc::scv::tlm_recorder< TYPES >::isRecordingBlockingTxEnabled ( ) const

inline

get the current state of transaction recording

Returns: if true transaction recording is enabled otherwise transaction recording is bypassed

Definition at line 244 of file tlm_recorder.h.

◆ isRecordingNonBlockingTxEnabled()

template<typename TYPES = tlm::tlm_base_protocol_types>

bool tlm::scc::scv::tlm_recorder< TYPES >::isRecordingNonBlockingTxEnabled ( ) const

inline

get the current state of transaction recording

Returns: if true transaction recording is enabled otherwise transaction recording is bypassed

Definition at line 250 of file tlm_recorder.h.

◆ nb_transport_bw()

template<typename TYPES>

tlm::tlm_sync_enum tlm::scc::scv::tlm_recorder< TYPES >::nb_transport_bw	(	typename TYPES::tlm_payload_type &	trans,
		typename TYPES::tlm_phase_type &	phase,
		sc_core::sc_time &	delay )

override

The non-blocking backward transport function.

This type of transaction is forwarded and recorded to a transaction stream named "nb_bw" with current timestamps.

Parameters

trans	is the generic payload of the transaction
phase	is the current phase of the transaction
delay	is the annotated delay

Returns: the sync state of the transaction

Definition at line 525 of file tlm_recorder.h.

◆ nb_transport_fw()

template<typename TYPES>

tlm::tlm_sync_enum tlm::scc::scv::tlm_recorder< TYPES >::nb_transport_fw	(	typename TYPES::tlm_payload_type &	trans,
		typename TYPES::tlm_phase_type &	phase,
		sc_core::sc_time &	delay )

override

The non-blocking forward transport function.

This type of transaction is forwarded and recorded to a transaction stream named "nb_fw" with current timestamps.

Parameters

trans	is the generic payload of the transaction
phase	is the current phase of the transaction
delay	is the annotated delay

Returns: the sync state of the transaction

Definition at line 439 of file tlm_recorder.h.

◆ transport_dbg()

template<typename TYPES>

unsigned int tlm::scc::scv::tlm_recorder< TYPES >::transport_dbg ( typename TYPES::tlm_payload_type & trans )

override

The debug transportfunction.

This type of transaction is just forwarded and not recorded.

Parameters

trans is the generic payload of the transaction

Returns: the sync state of the transaction

Definition at line 683 of file tlm_recorder.h.

Member Data Documentation

◆ bw_port

template<typename TYPES = tlm::tlm_base_protocol_types>

sc_core::sc_port_b<tlm::tlm_bw_transport_if<TYPES> >& tlm::scc::scv::tlm_recorder< TYPES >::bw_port

the port where bw accesses are forwarded to

Definition at line 117 of file tlm_recorder.h.

◆ enableBlTracing

template<typename TYPES = tlm::tlm_base_protocol_types>

sc_core::sc_attribute<bool> tlm::scc::scv::tlm_recorder< TYPES >::enableBlTracing

the attribute to selectively enable/disable recording of blocking protocol tx

Definition at line 102 of file tlm_recorder.h.

◆ enableDmiTracing

template<typename TYPES = tlm::tlm_base_protocol_types>

sc_core::sc_attribute<bool> tlm::scc::scv::tlm_recorder< TYPES >::enableDmiTracing {"enableDmiTracing", false}

the attribute to selectively enable/disable DMI recording

Definition at line 111 of file tlm_recorder.h.

◆ enableNbTracing

template<typename TYPES = tlm::tlm_base_protocol_types>

sc_core::sc_attribute<bool> tlm::scc::scv::tlm_recorder< TYPES >::enableNbTracing

the attribute to selectively enable/disable recording of non-blocking protocol tx

Definition at line 105 of file tlm_recorder.h.

◆ enableTimedTracing

template<typename TYPES = tlm::tlm_base_protocol_types>

sc_core::sc_attribute<bool> tlm::scc::scv::tlm_recorder< TYPES >::enableTimedTracing {"enableTimedTracing", true}

the attribute to selectively enable/disable timed recording

Definition at line 108 of file tlm_recorder.h.

◆ fw_port

template<typename TYPES = tlm::tlm_base_protocol_types>

sc_core::sc_port_b<tlm::tlm_fw_transport_if<TYPES> >& tlm::scc::scv::tlm_recorder< TYPES >::fw_port

the port where fw accesses are forwarded to

Definition at line 114 of file tlm_recorder.h.

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

/home/eyck/Projects/MINRES/SystemC-Components/src/sysc/tlm/scc/scv/tlm_recorder.h

Public Types

Public Member Functions

Public Attributes

Detailed Description

Member Typedef Documentation

◆ mm

◆ recording_types

◆ tlm_recording_payload

Constructor & Destructor Documentation

◆ tlm_recorder() [1/2]

◆ tlm_recorder() [2/2]

◆ ~tlm_recorder()

Member Function Documentation

◆ b_transport()

◆ get_direct_mem_ptr()

◆ initialize_streams()

◆ invalidate_direct_mem_ptr()

◆ isRecordingBlockingTxEnabled()

◆ isRecordingNonBlockingTxEnabled()

◆ nb_transport_bw()

◆ nb_transport_fw()

◆ transport_dbg()

Member Data Documentation

◆ bw_port

◆ enableBlTracing

◆ enableDmiTracing

◆ enableNbTracing

◆ enableTimedTracing

◆ fw_port