TlmGenerator: this class is basically a CHI-tlm traffic generator. More...

#include <generator.hh>

Inheritance diagram for gem5::tlm::chi::TlmGenerator:

Classes
class	Transaction
	Transaction object It stores ARM::CHI::Payload and ARM::CHI::Phase objects, and a list of action callables which will be executed in the order they have been registered once a transaction response arrives. More...

struct	TransactionEvent

Public Member Functions
	PARAMS (TlmGenerator)

	TlmGenerator (const Params &p)

void	scheduleTransaction (Tick when, Transaction *tr)

Public Member Functions inherited from gem5::SimObject
const Params &	params () const

	SimObject (const Params &p)

virtual	~SimObject ()

virtual void	init ()
	init() is called after all C++ SimObjects have been created and all ports are connected.

virtual void	loadState (CheckpointIn &cp)
	loadState() is called on each SimObject when restoring from a checkpoint.

virtual void	initState ()
	initState() is called on each SimObject when not restoring from a checkpoint.

virtual void	regProbePoints ()
	Register probe points for this object.

virtual void	regProbeListeners ()
	Register probe listeners for this object.

ProbeManager *	getProbeManager ()
	Get the probe manager for this object.

virtual Port &	getPort (const std::string &if_name, PortID idx=InvalidPortID)
	Get a port with a given name and index.

virtual void	startup ()
	startup() is the final initialization call before simulation.

DrainState	drain () override
	Provide a default implementation of the drain interface for objects that don't need draining.

virtual void	memWriteback ()
	Write back dirty buffers to memory using functional writes.

virtual void	memInvalidate ()
	Invalidate the contents of memory buffers.

void	serialize (CheckpointOut &cp) const override
	Serialize an object.

void	unserialize (CheckpointIn &cp) override
	Unserialize an object.

Public Member Functions inherited from gem5::EventManager
EventQueue *	eventQueue () const

void	schedule (Event &event, Tick when)

void	deschedule (Event &event)

void	reschedule (Event &event, Tick when, bool always=false)

void	schedule (Event *event, Tick when)

void	deschedule (Event *event)

void	reschedule (Event *event, Tick when, bool always=false)

void	wakeupEventQueue (Tick when=(Tick) -1)
	This function is not needed by the usual gem5 event loop but may be necessary in derived EventQueues which host gem5 on other schedulers.

void	setCurTick (Tick newVal)

	EventManager (EventManager &em)
	Event manger manages events in the event queue.

	EventManager (EventManager *em)

	EventManager (EventQueue *eq)

Public Member Functions inherited from gem5::Serializable
	Serializable ()

virtual	~Serializable ()

void	serializeSection (CheckpointOut &cp, const char *name) const
	Serialize an object into a new section.

void	serializeSection (CheckpointOut &cp, const std::string &name) const

void	unserializeSection (CheckpointIn &cp, const char *name)
	Unserialize an a child object.

void	unserializeSection (CheckpointIn &cp, const std::string &name)

Public Member Functions inherited from gem5::Drainable
DrainState	drainState () const
	Return the current drain state of an object.

virtual void	notifyFork ()
	Notify a child process of a fork.

Public Member Functions inherited from gem5::statistics::Group
	Group (Group parent, const char name=nullptr)
	Construct a new statistics group.

virtual	~Group ()

virtual void	regStats ()
	Callback to set stat parameters.

virtual void	resetStats ()
	Callback to reset stats.

virtual void	preDumpStats ()
	Callback before stats are dumped.

void	addStat (statistics::Info *info)
	Register a stat with this group.

const std::map< std::string, Group * > &	getStatGroups () const
	Get all child groups associated with this object.

const std::vector< Info * > &	getStats () const
	Get all stats associated with this object.

void	addStatGroup (const char name, Group block)
	Add a stat block as a child of this block.

const Info *	resolveStat (std::string name) const
	Resolve a stat by its name within this group.

void	mergeStatGroup (Group *block)
	Merge the contents (stats & children) of a block to this block.

	Group ()=delete

	Group (const Group &)=delete

Group &	operator= (const Group &)=delete

Public Member Functions inherited from gem5::Named
	Named (std::string_view name_)

virtual	~Named ()=default

virtual std::string	name () const

Protected Types
using	SchedulingQueue

Protected Member Functions
void	inject (Transaction *transaction)

void	recv (ARM::CHI::Payload payload, ARM::CHI::Phase phase)

void	passFailCheck ()

Protected Member Functions inherited from gem5::Drainable
	Drainable ()

virtual	~Drainable ()

virtual void	drainResume ()
	Resume execution after a successful drain.

void	signalDrainDone () const
	Signal that an object is drained.

Protected Attributes
uint8_t	cpuId
	cpuId to mimic the behaviour of a CPU

SchedulingQueue	scheduledTransactions
	PQ of transactions whose injection needs to be scheduled.

std::unordered_map< uint16_t, Transaction * >	pendingTransactions
	Map of pending (injected) transactions indexed by the txn_id.

CacheController *	controller
	Pointer to the CHI-tlm controller.

Protected Attributes inherited from gem5::SimObject
const SimObjectParams &	_params
	Cached copy of the object parameters.

Protected Attributes inherited from gem5::EventManager
EventQueue *	eventq
	A pointer to this object's event queue.

Additional Inherited Members
Public Types inherited from gem5::SimObject
typedef SimObjectParams	Params

Static Public Member Functions inherited from gem5::SimObject
static void	serializeAll (const std::string &cpt_dir)
	Create a checkpoint by serializing all SimObjects in the system.

static SimObject *	find (const char *name)
	Find the SimObject with the given name and return a pointer to it.

static void	setSimObjectResolver (SimObjectResolver *resolver)
	There is a single object name resolver, and it is only set when simulation is restoring from checkpoints.

static SimObjectResolver *	getSimObjectResolver ()
	There is a single object name resolver, and it is only set when simulation is restoring from checkpoints.

Static Public Member Functions inherited from gem5::Serializable
static const std::string &	currentSection ()
	Gets the fully-qualified name of the active section.

static void	generateCheckpointOut (const std::string &cpt_dir, std::ofstream &outstream)
	Generate a checkpoint file so that the serialization can be routed to it.

Detailed Description

TlmGenerator: this class is basically a CHI-tlm traffic generator.

Its interface is mainly allowing to inject transactions at a specific point in simulated time and to set expectations on what has to be returned to the generator. The intended use is as a testbench for the CHI implementation in ruby. As such it requires to be hooked with a TlmController as a bridge for converting the CHI-tlm transactions into ruby messages.

                                    +---------------+

+-----------—+ +------------—+ | | | | | | | | | TlmGenerator |-->| TlmController |--->| Ruby | | |<–| |<—| | +-----------—+ +------------—+ | | +------------—+

The APIs are entirely exposed to the python world for flexible definition of the unit tests.

To inject a CHI-tlm transaction at a specific tick in the simulation, the following TlmGenerator method should be used:

def injectAt(self, when, payload, phase):

This will return a Transaction object and from that point that will be the handle for managing the transaction: either adding transaction expectations upon response (e.g, what will be the cacheline state), or by adding action callbacks (execute some logic)

Definition at line 88 of file generator.hh.

Member Typedef Documentation

◆ SchedulingQueue

using gem5::tlm::chi::TlmGenerator::SchedulingQueue

protected

Initial value:

 std::priority_queue<TransactionEvent*,
        std::vector<TransactionEvent*>,
        TransactionEvent::Compare>

Definition at line 286 of file generator.hh.

Constructor & Destructor Documentation

◆ TlmGenerator()

gem5::tlm::chi::TlmGenerator::TlmGenerator ( const Params & p )

Definition at line 143 of file generator.cc.

References controller, cpuId, gem5::MipsISA::p, passFailCheck(), recv(), gem5::registerExitCallback(), and gem5::SimObject::SimObject().

Referenced by PARAMS(), gem5::tlm::chi::TlmGenerator::Transaction::setGenerator(), and gem5::tlm::chi::TlmGenerator::Transaction::Transaction().

Member Function Documentation

◆ inject()

void gem5::tlm::chi::TlmGenerator::inject ( Transaction * transaction )

protected

Definition at line 167 of file generator.cc.

References controller, cpuId, DPRINTF, gem5::tlm::chi::TlmGenerator::Transaction::hasCallbacks(), gem5::tlm::chi::TlmGenerator::Transaction::payload(), pendingTransactions, gem5::tlm::chi::TlmGenerator::Transaction::phase(), and gem5::tlm::chi::transactionToString().

◆ PARAMS()

gem5::tlm::chi::TlmGenerator::PARAMS ( TlmGenerator )

References gem5::MipsISA::p, and TlmGenerator().

◆ passFailCheck()

void gem5::tlm::chi::TlmGenerator::passFailCheck ( )

protected

Definition at line 199 of file generator.cc.

References inform, and pendingTransactions.

Referenced by TlmGenerator().

◆ recv()

void gem5::tlm::chi::TlmGenerator::recv	(	ARM::CHI::Payload *	payload,
		ARM::CHI::Phase *	phase )

protected

Definition at line 181 of file generator.cc.

References cpuId, DPRINTF, pendingTransactions, gem5::tlm::chi::transactionToString(), and warn.

Referenced by TlmGenerator().

◆ scheduleTransaction()

void gem5::tlm::chi::TlmGenerator::scheduleTransaction	(	Tick	when,
		Transaction *	tr )

Definition at line 155 of file generator.cc.

References gem5::MipsISA::event, gem5::EventManager::schedule(), scheduledTransactions, and gem5::tlm::chi::TlmGenerator::Transaction::setGenerator().

Member Data Documentation

◆ controller

CacheController* gem5::tlm::chi::TlmGenerator::controller

protected

Pointer to the CHI-tlm controller.

Definition at line 297 of file generator.hh.

Referenced by inject(), and TlmGenerator().

◆ cpuId

uint8_t gem5::tlm::chi::TlmGenerator::cpuId

protected

cpuId to mimic the behaviour of a CPU

Definition at line 284 of file generator.hh.

Referenced by inject(), recv(), and TlmGenerator().

◆ pendingTransactions

std::unordered_map<uint16_t, Transaction*> gem5::tlm::chi::TlmGenerator::pendingTransactions

protected

Map of pending (injected) transactions indexed by the txn_id.

Definition at line 294 of file generator.hh.

Referenced by inject(), passFailCheck(), and recv().

◆ scheduledTransactions

SchedulingQueue gem5::tlm::chi::TlmGenerator::scheduledTransactions

protected

PQ of transactions whose injection needs to be scheduled.

Definition at line 291 of file generator.hh.

Referenced by scheduleTransaction().

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

mem/ruby/protocol/chi/tlm/generator.hh
mem/ruby/protocol/chi/tlm/generator.cc

Classes

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ SchedulingQueue

Constructor & Destructor Documentation

◆ TlmGenerator()

Member Function Documentation

◆ inject()

◆ PARAMS()

◆ passFailCheck()

◆ recv()

◆ scheduleTransaction()

Member Data Documentation

◆ controller

◆ cpuId

◆ pendingTransactions

◆ scheduledTransactions