#include <RubyPort.hh>

Inheritance diagram for gem5::ruby::RubyPort:

Classes
class	MemRequestPort

class	MemResponsePort

class	PioRequestPort

class	PioResponsePort

struct	SenderState

Public Types
typedef RubyPortParams	Params

Public Types inherited from gem5::ClockedObject
using	Params = ClockedObjectParams
	Parameters of ClockedObject.

Public Types inherited from gem5::SimObject
typedef SimObjectParams	Params

Public Member Functions
	RubyPort (const Params &p)

virtual	~RubyPort ()

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

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

virtual RequestStatus	makeRequest (PacketPtr pkt)=0

virtual int	outstandingCount () const =0

virtual bool	isDeadlockEventScheduled () const =0

virtual void	descheduleDeadlockEvent ()=0

void	setController (AbstractController *_cntrl)

uint32_t	getId ()

DrainState	drain () override
	Draining is the process of clearing out the states of SimObjects.These are the SimObjects that are partially executed or are partially in flight.

bool	isCPUSequencer ()

virtual int	functionalWrite (Packet *func_pkt)

Public Member Functions inherited from gem5::ClockedObject
	ClockedObject (const ClockedObjectParams &p)

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

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

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

	SimObject (const Params &p)

virtual	~SimObject ()

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 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 (const std::string &name_)

virtual	~Named ()=default

virtual std::string	name () const

Public Member Functions inherited from gem5::Clocked
void	updateClockPeriod ()
	Update the tick to the current tick.

Tick	clockEdge (Cycles cycles=Cycles(0)) const
	Determine the tick when a cycle begins, by default the current one, but the argument also enables the caller to determine a future cycle.

Cycles	curCycle () const
	Determine the current cycle, corresponding to a tick aligned to a clock edge.

Tick	nextCycle () const
	Based on the clock of the object, determine the start tick of the first cycle that is at least one cycle in the future.

uint64_t	frequency () const

Tick	clockPeriod () const

double	voltage () const

Cycles	ticksToCycles (Tick t) const

Tick	cyclesToTicks (Cycles c) const

Protected Member Functions
void	trySendRetries ()

void	ruby_hit_callback (PacketPtr pkt)

void	ruby_unaddressed_callback (PacketPtr pkt)

void	ruby_stale_translation_callback (Addr txnId)

void	testDrainComplete ()

void	ruby_eviction_callback (Addr address)

bool	recvTimingResp (PacketPtr pkt, PortID request_port_id)
	Called by the PIO port when receiving a timing response.

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 Member Functions inherited from gem5::Clocked
	Clocked (ClockDomain &clk_domain)
	Create a clocked object and set the clock domain based on the parameters.

	Clocked (Clocked &)=delete

Clocked &	operator= (Clocked &)=delete

virtual	~Clocked ()
	Virtual destructor due to inheritance.

void	resetClock () const
	Reset the object's clock using the current global tick value.

virtual void	clockPeriodUpdated ()
	A hook subclasses can implement so they can do any extra work that's needed when the clock rate is changed.

Protected Attributes
RubySystem *	m_ruby_system

uint32_t	m_version

AbstractController *	m_controller

MessageBuffer *	m_mandatory_q_ptr

bool	m_usingRubyTester

System *	system

std::vector< MemResponsePort * >	response_ports

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.

Private Types
typedef std::vector< MemResponsePort * >::iterator	CpuPortIter
	Vector of M5 Ports attached to this Ruby port.

Private Member Functions
bool	onRetryList (MemResponsePort *port)

void	addToRetryList (MemResponsePort *port)

Private Attributes
PioRequestPort	pioRequestPort

PioResponsePort	pioResponsePort

MemRequestPort	memRequestPort

MemResponsePort	memResponsePort

unsigned int	gotAddrRanges

std::vector< PioRequestPort * >	request_ports

std::vector< MemResponsePort * >	retryList

bool	m_isCPUSequencer

Additional Inherited Members
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.

Public Attributes inherited from gem5::ClockedObject
PowerState *	powerState

Detailed Description

Definition at line 64 of file RubyPort.hh.

Member Typedef Documentation

◆ CpuPortIter

typedef std::vector<MemResponsePort*>::iterator gem5::ruby::RubyPort::CpuPortIter

private

Vector of M5 Ports attached to this Ruby port.

Definition at line 230 of file RubyPort.hh.

◆ Params

typedef RubyPortParams gem5::ruby::RubyPort::Params

Definition at line 158 of file RubyPort.hh.

Constructor & Destructor Documentation

◆ RubyPort()

gem5::ruby::RubyPort::RubyPort ( const Params & p )

Definition at line 61 of file RubyPort.cc.

References gem5::csprintf(), gem5::ArmISA::i, m_version, gem5::Named::name(), gem5::MipsISA::p, request_ports, and response_ports.

◆ ~RubyPort()

virtual gem5::ruby::RubyPort::~RubyPort ( )

inlinevirtual

Definition at line 160 of file RubyPort.hh.

Member Function Documentation

◆ addToRetryList()

void gem5::ruby::RubyPort::addToRetryList ( MemResponsePort * port )

inlineprivate

Definition at line 217 of file RubyPort.hh.

References onRetryList(), and retryList.

Referenced by gem5::ruby::RubyPort::MemResponsePort::recvTimingReq().

◆ descheduleDeadlockEvent()

virtual void gem5::ruby::RubyPort::descheduleDeadlockEvent ( )

pure virtual

Implemented in gem5::ruby::DMASequencer, gem5::ruby::GPUCoalescer, gem5::ruby::RubyPortProxy, and gem5::ruby::Sequencer.

Referenced by drain().

◆ drain()

DrainState gem5::ruby::RubyPort::drain ( )

overridevirtual

Draining is the process of clearing out the states of SimObjects.These are the SimObjects that are partially executed or are partially in flight.

Draining is mostly used before forking and creating a check point.

This function notifies an object that it needs to drain its state.

If the object does not need further simulation to drain internal buffers, it returns DrainState::Drained and automatically switches to the Drained state. If the object needs more simulation, it returns DrainState::Draining and automatically enters the Draining state. Other return values are invalid.

Note: An object that has entered the Drained state can be disturbed by other objects in the system and consequently stop being drained. These perturbations are not visible in the drain state. The simulator therefore repeats the draining process until all objects return DrainState::Drained on the first call to drain().

Returns: DrainState::Drained if the object is drained at this point in time, DrainState::Draining if it needs further simulation.

Implements gem5::Drainable.

Definition at line 563 of file RubyPort.cc.

References descheduleDeadlockEvent(), DPRINTF, gem5::Drained, gem5::Draining, isDeadlockEventScheduled(), and outstandingCount().

◆ functionalWrite()

int gem5::ruby::RubyPort::functionalWrite ( Packet * func_pkt )

virtual

Reimplemented in gem5::ruby::Sequencer.

Definition at line 729 of file RubyPort.cc.

References response_ports.

Referenced by gem5::ruby::Sequencer::functionalWrite().

◆ getId()

uint32_t gem5::ruby::RubyPort::getId ( )

inline

Definition at line 177 of file RubyPort.hh.

References m_version.

Referenced by gem5::ruby::UncoalescedTable::checkDeadlock().

◆ getPort()

Port & gem5::ruby::RubyPort::getPort	(	const std::string &	if_name,
		PortID	idx = InvalidPortID )

overridevirtual

Get a port with a given name and index.

This is used at binding time and returns a reference to a protocol-agnostic port.

gem5 has a request and response port interface. All memory objects are connected together via ports. These ports provide a rigid interface between these memory objects. These ports implement three different memory system modes: timing, atomic, and functional. The most important mode is the timing mode and here timing mode is used for conducting cycle-level timing experiments. The other modes are only used in special circumstances and should not be used to conduct cycle-level timing experiments. The other modes are only used in special circumstances. These ports allow SimObjects to communicate with each other.

Parameters