gem5::ruby::RubyPortProxy Class Reference

#include <RubyPortProxy.hh>

Inheritance diagram for gem5::ruby::RubyPortProxy:

Public Member Functions
	RubyPortProxy (const RubyPortProxyParams &p)
	Create a new RubyPortProxy.
virtual	~RubyPortProxy ()
	Destruct a RubyPortProxy.
void	init ()
	Initialise a RubyPortProxy by doing nothing and avoid involving the super class.
RequestStatus	makeRequest (PacketPtr pkt)
	Pure virtual member in the super class that we are forced to implement even if it is never used (since there are only functional accesses).
int	outstandingCount () const
	Pure virtual member in the super class that we are forced to implement even if it is never used (since there are only functional accesses).
bool	isDeadlockEventScheduled () const
	Pure virtual member in the super class that we are forced to implement even if it is never used (since there are only functional accesses).
void	descheduleDeadlockEvent ()
	Pure virtual member in the super class that we are forced to implement even if it is never used (since there are only functional accesses).
Public Member Functions inherited from gem5::ruby::RubyPort
	RubyPort (const Params &p)
virtual	~RubyPort ()
Port &	getPort (const std::string &if_name, PortID idx=InvalidPortID) override
	Get a port with a given name and index.
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

Additional Inherited Members
Public Types inherited from gem5::ruby::RubyPort
typedef RubyPortParams	Params
Public Types inherited from gem5::ClockedObject
using	Params = ClockedObjectParams
	Parameters of ClockedObject.
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.
Public Attributes inherited from gem5::ClockedObject
PowerState *	powerState
Protected Member Functions inherited from gem5::ruby::RubyPort
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 inherited from gem5::ruby::RubyPort
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.

Detailed Description

Definition at line 58 of file RubyPortProxy.hh.

Constructor & Destructor Documentation

RubyPortProxy()

gem5::ruby::RubyPortProxy::RubyPortProxy

(

const RubyPortProxyParams &

p

)

Create a new RubyPortProxy.

Parameters

p	Parameters inherited from the RubyPort

Definition at line 48 of file RubyPortProxy.cc.

~RubyPortProxy()

gem5::ruby::RubyPortProxy::~RubyPortProxy ( )

virtual

Destruct a RubyPortProxy.

Definition at line 53 of file RubyPortProxy.cc.

Member Function Documentation

descheduleDeadlockEvent()

void gem5::ruby::RubyPortProxy::descheduleDeadlockEvent ( )

inlinevirtual

Pure virtual member in the super class that we are forced to implement even if it is never used (since there are only functional accesses).

Implements gem5::ruby::RubyPort.

Definition at line 114 of file RubyPortProxy.hh.

init()

void gem5::ruby::RubyPortProxy::init ( )

virtual

Initialise a RubyPortProxy by doing nothing and avoid involving the super class.

Reimplemented from gem5::ruby::RubyPort.

Definition at line 58 of file RubyPortProxy.cc.

isDeadlockEventScheduled()

bool gem5::ruby::RubyPortProxy::isDeadlockEventScheduled ( ) const

inlinevirtual

Pure virtual member in the super class that we are forced to implement even if it is never used (since there are only functional accesses).

Returns

always false

Implements gem5::ruby::RubyPort.

Definition at line 107 of file RubyPortProxy.hh.

makeRequest()

RequestStatus gem5::ruby::RubyPortProxy::makeRequest ( PacketPtr pkt )

virtual

Pure virtual member in the super class that we are forced to implement even if it is never used (since there are only functional accesses).

Parameters

pkt	The packet to serve to Ruby

Returns

always a NULL status

Implements gem5::ruby::RubyPort.

Definition at line 64 of file RubyPortProxy.cc.

References panic.

outstandingCount()

int gem5::ruby::RubyPortProxy::outstandingCount ( ) const

inlinevirtual

Pure virtual member in the super class that we are forced to implement even if it is never used (since there are only functional accesses).

Returns

always 0

Implements gem5::ruby::RubyPort.

Definition at line 98 of file RubyPortProxy.hh.

---

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

• mem/ruby/system/RubyPortProxy.hh
• mem/ruby/system/RubyPortProxy.cc