gem5  v21.1.0.2
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
gem5::CommMonitor::MonitorRequestPort Class Reference

This is the request port of the communication monitor. More...

Inheritance diagram for gem5::CommMonitor::MonitorRequestPort:
gem5::RequestPort gem5::Port gem5::AtomicRequestProtocol gem5::TimingRequestProtocol gem5::FunctionalRequestProtocol

Public Member Functions

 MonitorRequestPort (const std::string &_name, CommMonitor &_mon)
 
- Public Member Functions inherited from gem5::RequestPort
 RequestPort (const std::string &name, SimObject *_owner, PortID id=InvalidPortID)
 Request port. More...
 
virtual ~RequestPort ()
 
void bind (Port &peer) override
 Bind this request port to a response port. More...
 
void unbind () override
 Unbind this request port and the associated response port. More...
 
AddrRangeList getAddrRanges () const
 Get the address ranges of the connected responder port. More...
 
void printAddr (Addr a)
 Inject a PrintReq for the given address to print the state of that address throughout the memory system. More...
 
Tick sendAtomic (PacketPtr pkt)
 Send an atomic request packet, where the data is moved and the state is updated in zero time, without interleaving with other memory accesses. More...
 
Tick sendAtomicBackdoor (PacketPtr pkt, MemBackdoorPtr &backdoor)
 Send an atomic request packet like above, but also request a backdoor to the data being accessed. More...
 
void sendFunctional (PacketPtr pkt) const
 Send a functional request packet, where the data is instantly updated everywhere in the memory system, without affecting the current state of any block or moving the block. More...
 
bool sendTimingReq (PacketPtr pkt)
 Attempt to send a timing request to the responder port by calling its corresponding receive function. More...
 
bool tryTiming (PacketPtr pkt) const
 Check if the responder can handle a timing request. More...
 
bool sendTimingSnoopResp (PacketPtr pkt)
 Attempt to send a timing snoop response packet to the response port by calling its corresponding receive function. More...
 
virtual void sendRetryResp ()
 Send a retry to the response port that previously attempted a sendTimingResp to this request port and failed. More...
 
- Public Member Functions inherited from gem5::Port
virtual ~Port ()
 Virtual destructor due to inheritance. More...
 
PortgetPeer ()
 Return a reference to this port's peer. More...
 
const std::string name () const
 Return port name (for DPRINTF). More...
 
PortID getId () const
 Get the port id. More...
 
bool isConnected () const
 Is this port currently connected to a peer? More...
 
void takeOverFrom (Port *old)
 A utility function to make it easier to swap out ports. More...
 

Protected Member Functions

void recvFunctionalSnoop (PacketPtr pkt)
 Receive a functional snoop request packet from the peer. More...
 
Tick recvAtomicSnoop (PacketPtr pkt)
 Receive an atomic snoop request packet from our peer. More...
 
bool recvTimingResp (PacketPtr pkt)
 Receive a timing response from the peer. More...
 
void recvTimingSnoopReq (PacketPtr pkt)
 Receive a timing snoop request from the peer. More...
 
void recvRangeChange ()
 Called to receive an address range change from the peer response port. More...
 
bool isSnooping () const
 Determine if this request port is snooping or not. More...
 
void recvReqRetry ()
 Called by the peer if sendTimingReq was called on this peer (causing recvTimingReq to be called on the peer) and was unsuccessful. More...
 
void recvRetrySnoopResp ()
 Called by the peer if sendTimingSnoopResp was called on this protocol (causing recvTimingSnoopResp to be called on the peer) and was unsuccessful. More...
 
- Protected Member Functions inherited from gem5::RequestPort
Tick recvAtomicSnoop (PacketPtr pkt) override
 Default implementations. More...
 
void recvFunctionalSnoop (PacketPtr pkt) override
 Receive a functional snoop request packet from the peer. More...
 
void recvTimingSnoopReq (PacketPtr pkt) override
 Receive a timing snoop request from the peer. More...
 
void recvRetrySnoopResp () override
 Called by the peer if sendTimingSnoopResp was called on this protocol (causing recvTimingSnoopResp to be called on the peer) and was unsuccessful. More...
 
- Protected Member Functions inherited from gem5::Port
void reportUnbound () const
 
 Port (const std::string &_name, PortID _id)
 Abstract base class for ports. More...
 
- Protected Member Functions inherited from gem5::AtomicRequestProtocol
Tick send (AtomicResponseProtocol *peer, PacketPtr pkt)
 Send an atomic request packet, where the data is moved and the state is updated in zero time, without interleaving with other memory accesses. More...
 
Tick sendBackdoor (AtomicResponseProtocol *peer, PacketPtr pkt, MemBackdoorPtr &backdoor)
 Send an atomic request packet like above, but also request a backdoor to the data being accessed. More...
 
- Protected Member Functions inherited from gem5::TimingRequestProtocol
bool sendReq (TimingResponseProtocol *peer, PacketPtr pkt)
 Attempt to send a timing request to the peer by calling its corresponding receive function. More...
 
bool trySend (TimingResponseProtocol *peer, PacketPtr pkt) const
 Check if the peer can handle a timing request. More...
 
bool sendSnoopResp (TimingResponseProtocol *peer, PacketPtr pkt)
 Attempt to send a timing snoop response packet to it's peer by calling its corresponding receive function. More...
 
void sendRetryResp (TimingResponseProtocol *peer)
 Send a retry to the peer that previously attempted a sendTimingResp to this protocol and failed. More...
 
- Protected Member Functions inherited from gem5::FunctionalRequestProtocol
void send (FunctionalResponseProtocol *peer, PacketPtr pkt) const
 Send a functional request packet, where the data is instantly updated everywhere in the memory system, without affecting the current state of any block or moving the block. More...
 

Private Attributes

CommMonitormon
 

Additional Inherited Members

- Protected Attributes inherited from gem5::RequestPort
SimObjectowner
 
- Protected Attributes inherited from gem5::Port
const PortID id
 A numeric identifier to distinguish ports in a vector, and set to InvalidPortID in case this port is not part of a vector. More...
 
Port_peer
 A pointer to this port's peer. More...
 
bool _connected
 Whether this port is currently connected to a peer port. More...
 

Detailed Description

This is the request port of the communication monitor.

All recv functions call a function in CommMonitor, where the send function of the CPU-side port is called. Besides this, these functions can also perform actions for capturing statistics.

Definition at line 121 of file comm_monitor.hh.

Constructor & Destructor Documentation

◆ MonitorRequestPort()

gem5::CommMonitor::MonitorRequestPort::MonitorRequestPort ( const std::string &  _name,
CommMonitor _mon 
)
inline

Definition at line 126 of file comm_monitor.hh.

Member Function Documentation

◆ isSnooping()

bool gem5::CommMonitor::MonitorRequestPort::isSnooping ( ) const
inlineprotectedvirtual

Determine if this request port is snooping or not.

The default implementation returns false and thus tells the neighbour we are not snooping. Any request port that wants to receive snoop requests (e.g. a cache connected to a bus) has to override this function.

Returns
true if the port should be considered a snooper

Reimplemented from gem5::RequestPort.

Definition at line 157 of file comm_monitor.hh.

References gem5::CommMonitor::isSnooping(), and mon.

◆ recvAtomicSnoop()

Tick gem5::CommMonitor::MonitorRequestPort::recvAtomicSnoop ( PacketPtr  pkt)
inlineprotectedvirtual

Receive an atomic snoop request packet from our peer.

Implements gem5::AtomicRequestProtocol.

Definition at line 137 of file comm_monitor.hh.

References mon, and gem5::CommMonitor::recvAtomicSnoop().

◆ recvFunctionalSnoop()

void gem5::CommMonitor::MonitorRequestPort::recvFunctionalSnoop ( PacketPtr  pkt)
inlineprotectedvirtual

Receive a functional snoop request packet from the peer.

Implements gem5::FunctionalRequestProtocol.

Definition at line 132 of file comm_monitor.hh.

References mon, and gem5::CommMonitor::recvFunctionalSnoop().

◆ recvRangeChange()

void gem5::CommMonitor::MonitorRequestPort::recvRangeChange ( )
inlineprotectedvirtual

Called to receive an address range change from the peer response port.

The default implementation ignores the change and does nothing. Override this function in a derived class if the owner needs to be aware of the address ranges, e.g. in an interconnect component like a bus.

Reimplemented from gem5::RequestPort.

Definition at line 152 of file comm_monitor.hh.

References mon, and gem5::CommMonitor::recvRangeChange().

◆ recvReqRetry()

void gem5::CommMonitor::MonitorRequestPort::recvReqRetry ( )
inlineprotectedvirtual

Called by the peer if sendTimingReq was called on this peer (causing recvTimingReq to be called on the peer) and was unsuccessful.

Implements gem5::TimingRequestProtocol.

Definition at line 162 of file comm_monitor.hh.

References mon, and gem5::CommMonitor::recvReqRetry().

◆ recvRetrySnoopResp()

void gem5::CommMonitor::MonitorRequestPort::recvRetrySnoopResp ( )
inlineprotectedvirtual

Called by the peer if sendTimingSnoopResp was called on this protocol (causing recvTimingSnoopResp to be called on the peer) and was unsuccessful.

Implements gem5::TimingRequestProtocol.

Definition at line 167 of file comm_monitor.hh.

References mon, and gem5::CommMonitor::recvRetrySnoopResp().

◆ recvTimingResp()

bool gem5::CommMonitor::MonitorRequestPort::recvTimingResp ( PacketPtr  pkt)
inlineprotectedvirtual

Receive a timing response from the peer.

Implements gem5::TimingRequestProtocol.

Definition at line 142 of file comm_monitor.hh.

References mon, and gem5::CommMonitor::recvTimingResp().

◆ recvTimingSnoopReq()

void gem5::CommMonitor::MonitorRequestPort::recvTimingSnoopReq ( PacketPtr  pkt)
inlineprotectedvirtual

Receive a timing snoop request from the peer.

Implements gem5::TimingRequestProtocol.

Definition at line 147 of file comm_monitor.hh.

References mon, and gem5::CommMonitor::recvTimingSnoopReq().

Member Data Documentation

◆ mon

CommMonitor& gem5::CommMonitor::MonitorRequestPort::mon
private

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

Generated on Tue Sep 21 2021 12:27:24 for gem5 by doxygen 1.8.17