gem5  v21.1.0.2
Classes | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Types | Private Member Functions | Private Attributes | List of all members
gem5::ruby::RubyPort Class Referenceabstract

#include <RubyPort.hh>

Inheritance diagram for gem5::ruby::RubyPort:
gem5::ClockedObject gem5::SimObject gem5::Clocked gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named gem5::ruby::DMASequencer gem5::ruby::GPUCoalescer gem5::ruby::RubyPortProxy gem5::ruby::Sequencer gem5::ruby::VIPERCoalescer gem5::ruby::HTMSequencer

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. More...
 
- 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. More...
 
PortgetPort (const std::string &if_name, PortID idx=InvalidPortID) override
 Get a port with a given name and index. More...
 
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. More...
 
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. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 
- Public Member Functions inherited from gem5::SimObject
const Paramsparams () const
 
 SimObject (const Params &p)
 
virtual ~SimObject ()
 
virtual void loadState (CheckpointIn &cp)
 loadState() is called on each SimObject when restoring from a checkpoint. More...
 
virtual void initState ()
 initState() is called on each SimObject when not restoring from a checkpoint. More...
 
virtual void regProbePoints ()
 Register probe points for this object. More...
 
virtual void regProbeListeners ()
 Register probe listeners for this object. More...
 
ProbeManagergetProbeManager ()
 Get the probe manager for this object. More...
 
virtual void startup ()
 startup() is the final initialization call before simulation. More...
 
DrainState drain () override
 Provide a default implementation of the drain interface for objects that don't need draining. More...
 
virtual void memWriteback ()
 Write back dirty buffers to memory using functional writes. More...
 
virtual void memInvalidate ()
 Invalidate the contents of memory buffers. More...
 
void serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 
- Public Member Functions inherited from gem5::EventManager
EventQueueeventQueue () 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. More...
 
void setCurTick (Tick newVal)
 
 EventManager (EventManager &em)
 Event manger manages events in the event queue. More...
 
 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. More...
 
void serializeSection (CheckpointOut &cp, const std::string &name) const
 
void unserializeSection (CheckpointIn &cp, const char *name)
 Unserialize an a child object. More...
 
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. More...
 
virtual void notifyFork ()
 Notify a child process of a fork. More...
 
- Public Member Functions inherited from gem5::statistics::Group
 Group (Group *parent, const char *name=nullptr)
 Construct a new statistics group. More...
 
virtual ~Group ()
 
virtual void regStats ()
 Callback to set stat parameters. More...
 
virtual void resetStats ()
 Callback to reset stats. More...
 
virtual void preDumpStats ()
 Callback before stats are dumped. More...
 
void addStat (statistics::Info *info)
 Register a stat with this group. More...
 
const std::map< std::string, Group * > & getStatGroups () const
 Get all child groups associated with this object. More...
 
const std::vector< Info * > & getStats () const
 Get all stats associated with this object. More...
 
void addStatGroup (const char *name, Group *block)
 Add a stat block as a child of this block. More...
 
const InforesolveStat (std::string name) const
 Resolve a stat by its name within this group. More...
 
void mergeStatGroup (Group *block)
 Merge the contents (stats & children) of a block to this block. More...
 
 Group ()=delete
 
 Group (const Group &)=delete
 
Groupoperator= (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. More...
 
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. More...
 
Cycles curCycle () const
 Determine the current cycle, corresponding to a tick aligned to a clock edge. More...
 
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. More...
 
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 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. More...
 
- Protected Member Functions inherited from gem5::Drainable
 Drainable ()
 
virtual ~Drainable ()
 
virtual void drainResume ()
 Resume execution after a successful drain. More...
 
void signalDrainDone () const
 Signal that an object is drained. More...
 
- Protected Member Functions inherited from gem5::Clocked
 Clocked (ClockDomain &clk_domain)
 Create a clocked object and set the clock domain based on the parameters. More...
 
 Clocked (Clocked &)=delete
 
Clockedoperator= (Clocked &)=delete
 
virtual ~Clocked ()
 Virtual destructor due to inheritance. More...
 
void resetClock () const
 Reset the object's clock using the current global tick value. More...
 
virtual void clockPeriodUpdated ()
 A hook subclasses can implement so they can do any extra work that's needed when the clock rate is changed. More...
 

Protected Attributes

RubySystemm_ruby_system
 
uint32_t m_version
 
AbstractControllerm_controller
 
MessageBufferm_mandatory_q_ptr
 
bool m_usingRubyTester
 
Systemsystem
 
std::vector< MemResponsePort * > response_ports
 
- Protected Attributes inherited from gem5::SimObject
const SimObjectParams & _params
 Cached copy of the object parameters. More...
 
- Protected Attributes inherited from gem5::EventManager
EventQueueeventq
 A pointer to this object's event queue. More...
 

Private Types

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

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. More...
 
static SimObjectfind (const char *name)
 Find the SimObject with the given name and return a pointer to it. More...
 
static void setSimObjectResolver (SimObjectResolver *resolver)
 There is a single object name resolver, and it is only set when simulation is restoring from checkpoints. More...
 
static SimObjectResolvergetSimObjectResolver ()
 There is a single object name resolver, and it is only set when simulation is restoring from checkpoints. More...
 
- Static Public Member Functions inherited from gem5::Serializable
static const std::string & currentSection ()
 Gets the fully-qualified name of the active section. More...
 
static void generateCheckpointOut (const std::string &cpt_dir, std::ofstream &outstream)
 Generate a checkpoint file so that the serialization can be routed to it. More...
 
- Public Attributes inherited from gem5::ClockedObject
PowerStatepowerState
 

Detailed Description

Definition at line 64 of file RubyPort.hh.

Member Typedef Documentation

◆ CpuPortIter

Vector of M5 Ports attached to this Ruby port.

Definition at line 223 of file RubyPort.hh.

◆ Params

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

Definition at line 153 of file RubyPort.hh.

Constructor & Destructor Documentation

◆ RubyPort()

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

◆ ~RubyPort()

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

Definition at line 155 of file RubyPort.hh.

Member Function Documentation

◆ addToRetryList()

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

◆ descheduleDeadlockEvent()

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

◆ 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 504 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 674 of file RubyPort.cc.

References response_ports.

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

◆ getId()

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

Definition at line 172 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
if_namePort name
idxIndex in the case of a VectorPort
Returns
A reference to the given port

Reimplemented from gem5::SimObject.

Definition at line 101 of file RubyPort.cc.

References gem5::SimObject::getPort(), memRequestPort, memResponsePort, panic, pioRequestPort, pioResponsePort, request_ports, and response_ports.

Referenced by gem5::ruby::GPUCoalescer::getPort().

◆ init()

void gem5::ruby::RubyPort::init ( )
overridevirtual

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

Initializations that are independent of unserialization but rely on a fully instantiated and connected SimObject graph should be done here.

Reimplemented from gem5::SimObject.

Reimplemented in gem5::ruby::RubyPortProxy.

Definition at line 92 of file RubyPort.cc.

References gem5::ruby::AbstractController::getMandatoryQueue(), m_controller, m_mandatory_q_ptr, and response_ports.

Referenced by gem5::ruby::DMASequencer::init().

◆ isCPUSequencer()

bool gem5::ruby::RubyPort::isCPUSequencer ( )
inline

Definition at line 175 of file RubyPort.hh.

References m_isCPUSequencer.

◆ isDeadlockEventScheduled()

virtual bool gem5::ruby::RubyPort::isDeadlockEventScheduled ( ) const
pure virtual

◆ makeRequest()

virtual RequestStatus gem5::ruby::RubyPort::makeRequest ( PacketPtr  pkt)
pure virtual

◆ onRetryList()

bool gem5::ruby::RubyPort::onRetryList ( MemResponsePort port)
inlineprivate

Definition at line 205 of file RubyPort.hh.

References retryList.

Referenced by gem5::ruby::RubyPort::MemResponsePort::addToRetryList(), and addToRetryList().

◆ outstandingCount()

virtual int gem5::ruby::RubyPort::outstandingCount ( ) const
pure virtual

◆ recvTimingResp()

bool gem5::ruby::RubyPort::recvTimingResp ( PacketPtr  pkt,
PortID  request_port_id 
)
protected

Called by the PIO port when receiving a timing response.

Parameters
pktResponse packet
request_port_idPort id of the PIO port
Returns
Whether successfully sent

◆ ruby_eviction_callback()

void gem5::ruby::RubyPort::ruby_eviction_callback ( Addr  address)
protected

◆ ruby_hit_callback()

void gem5::ruby::RubyPort::ruby_hit_callback ( PacketPtr  pkt)
protected

◆ setController()

void gem5::ruby::RubyPort::setController ( AbstractController _cntrl)
inline

Definition at line 171 of file RubyPort.hh.

References m_controller.

◆ testDrainComplete()

void gem5::ruby::RubyPort::testDrainComplete ( )
protected

◆ trySendRetries()

void gem5::ruby::RubyPort::trySendRetries ( )
protected

Member Data Documentation

◆ gotAddrRanges

unsigned int gem5::ruby::RubyPort::gotAddrRanges
private

Definition at line 220 of file RubyPort.hh.

◆ m_controller

AbstractController* gem5::ruby::RubyPort::m_controller
protected

◆ m_isCPUSequencer

bool gem5::ruby::RubyPort::m_isCPUSequencer
private

Definition at line 232 of file RubyPort.hh.

Referenced by isCPUSequencer().

◆ m_mandatory_q_ptr

MessageBuffer* gem5::ruby::RubyPort::m_mandatory_q_ptr
protected

◆ m_ruby_system

RubySystem* gem5::ruby::RubyPort::m_ruby_system
protected

◆ m_usingRubyTester

bool gem5::ruby::RubyPort::m_usingRubyTester
protected

◆ m_version

uint32_t gem5::ruby::RubyPort::m_version
protected

◆ memRequestPort

MemRequestPort gem5::ruby::RubyPort::memRequestPort
private

◆ memResponsePort

MemResponsePort gem5::ruby::RubyPort::memResponsePort
private

Definition at line 219 of file RubyPort.hh.

Referenced by getPort().

◆ pioRequestPort

PioRequestPort gem5::ruby::RubyPort::pioRequestPort
private

Definition at line 216 of file RubyPort.hh.

Referenced by getPort().

◆ pioResponsePort

PioResponsePort gem5::ruby::RubyPort::pioResponsePort
private

Definition at line 217 of file RubyPort.hh.

Referenced by getPort(), and gem5::ruby::RubyPort::PioRequestPort::recvTimingResp().

◆ request_ports

std::vector<PioRequestPort *> gem5::ruby::RubyPort::request_ports
private

◆ response_ports

std::vector<MemResponsePort *> gem5::ruby::RubyPort::response_ports
protected

Definition at line 202 of file RubyPort.hh.

Referenced by functionalWrite(), getPort(), init(), ruby_eviction_callback(), and RubyPort().

◆ retryList

std::vector<MemResponsePort *> gem5::ruby::RubyPort::retryList
private

Definition at line 230 of file RubyPort.hh.

Referenced by addToRetryList(), onRetryList(), and trySendRetries().

◆ system

System* gem5::ruby::RubyPort::system
protected

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

Generated on Tue Sep 21 2021 12:32:09 for gem5 by doxygen 1.8.17