gem5  v20.1.0.0
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
MemCheckerMonitor::MonitorResponsePort Class Reference

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

Inheritance diagram for MemCheckerMonitor::MonitorResponsePort:
ResponsePort Port AtomicResponseProtocol TimingResponseProtocol FunctionalResponseProtocol

Public Member Functions

 MonitorResponsePort (const std::string &_name, MemCheckerMonitor &_mon)
 
- Public Member Functions inherited from ResponsePort
 ResponsePort (const std::string &name, SimObject *_owner, PortID id=InvalidPortID)
 Response port. More...
 
virtual ~ResponsePort ()
 
bool isSnooping () const
 Find out if the peer request port is snooping or not. More...
 
void sendRangeChange () const
 Called by the owner to send a range change. More...
 
void unbind () override
 We let the request port do the work, so these don't do anything. More...
 
void bind (Port &peer) override
 Attach to a peer port. More...
 
Tick sendAtomicSnoop (PacketPtr pkt)
 Send an atomic snoop request packet, where the data is moved and the state is updated in zero time, without interleaving with other memory accesses. More...
 
void sendFunctionalSnoop (PacketPtr pkt) const
 Send a functional snoop 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 sendTimingResp (PacketPtr pkt)
 Attempt to send a timing response to the request port by calling its corresponding receive function. More...
 
void sendTimingSnoopReq (PacketPtr pkt)
 Attempt to send a timing snoop request packet to the request port by calling its corresponding receive function. More...
 
void sendRetryReq ()
 Send a retry to the request port that previously attempted a sendTimingReq to this response port and failed. More...
 
void sendRetrySnoopResp ()
 Send a retry to the request port that previously attempted a sendTimingSnoopResp to this response port and failed. More...
 
- Public Member Functions inherited from 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 recvFunctional (PacketPtr pkt)
 Receive a functional request packet from the peer. More...
 
Tick recvAtomic (PacketPtr pkt)
 Receive an atomic request packet from the peer. More...
 
bool recvTimingReq (PacketPtr pkt)
 Receive a timing request from the peer. More...
 
bool recvTimingSnoopResp (PacketPtr pkt)
 Receive a timing snoop response from the peer. More...
 
AddrRangeList getAddrRanges () const
 Get a list of the non-overlapping address ranges the owner is responsible for. More...
 
void recvRespRetry ()
 Called by the peer if sendTimingResp was called on this protocol (causing recvTimingResp to be called on the peer) and was unsuccessful. More...
 
- Protected Member Functions inherited from ResponsePort
void responderUnbind ()
 Called by the request port to unbind. More...
 
void responderBind (RequestPort &request_port)
 Called by the request port to bind. More...
 
Tick recvAtomicBackdoor (PacketPtr pkt, MemBackdoorPtr &backdoor) override
 Default implementations. More...
 
bool tryTiming (PacketPtr pkt) override
 Availability request from the peer. More...
 
bool recvTimingSnoopResp (PacketPtr pkt) override
 Receive a timing snoop response from the peer. More...
 
- Protected Member Functions inherited from Port
void reportUnbound () const
 
 Port (const std::string &_name, PortID _id)
 Abstract base class for ports. More...
 
- Protected Member Functions inherited from AtomicResponseProtocol
Tick sendSnoop (AtomicRequestProtocol *peer, PacketPtr pkt)
 Send an atomic snoop request packet, where the data is moved and the state is updated in zero time, without interleaving with other memory accesses. More...
 
- Protected Member Functions inherited from TimingResponseProtocol
bool sendResp (TimingRequestProtocol *peer, PacketPtr pkt)
 Attempt to send a timing response to the peer by calling its corresponding receive function. More...
 
void sendSnoopReq (TimingRequestProtocol *peer, PacketPtr pkt)
 Attempt to send a timing snoop request packet to the peer by calling its corresponding receive function. More...
 
void sendRetryReq (TimingRequestProtocol *peer)
 Send a retry to the peer that previously attempted a sendTimingReq to this protocol and failed. More...
 
void sendRetrySnoopResp (TimingRequestProtocol *peer)
 Send a retry to the peer that previously attempted a sendTimingSnoopResp to this peer and failed. More...
 
- Protected Member Functions inherited from FunctionalResponseProtocol
void sendSnoop (FunctionalRequestProtocol *peer, PacketPtr pkt) const
 Send a functional snoop 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

MemCheckerMonitormon
 

Additional Inherited Members

- Protected Attributes inherited from ResponsePort
SimObjectowner
 
- Protected Attributes inherited from 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 response port of the communication monitor.

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

Definition at line 152 of file mem_checker_monitor.hh.

Constructor & Destructor Documentation

◆ MonitorResponsePort()

MemCheckerMonitor::MonitorResponsePort::MonitorResponsePort ( const std::string &  _name,
MemCheckerMonitor _mon 
)
inline

Definition at line 157 of file mem_checker_monitor.hh.

Member Function Documentation

◆ getAddrRanges()

AddrRangeList MemCheckerMonitor::MonitorResponsePort::getAddrRanges ( ) const
inlineprotectedvirtual

Get a list of the non-overlapping address ranges the owner is responsible for.

All response ports must override this function and return a populated list with at least one item.

Returns
a list of ranges responded to

Implements ResponsePort.

Definition at line 183 of file mem_checker_monitor.hh.

References MemCheckerMonitor::getAddrRanges(), and mon.

◆ recvAtomic()

Tick MemCheckerMonitor::MonitorResponsePort::recvAtomic ( PacketPtr  pkt)
inlineprotectedvirtual

Receive an atomic request packet from the peer.

Implements AtomicResponseProtocol.

Definition at line 168 of file mem_checker_monitor.hh.

References mon, and MemCheckerMonitor::recvAtomic().

◆ recvFunctional()

void MemCheckerMonitor::MonitorResponsePort::recvFunctional ( PacketPtr  pkt)
inlineprotectedvirtual

Receive a functional request packet from the peer.

Implements FunctionalResponseProtocol.

Definition at line 163 of file mem_checker_monitor.hh.

References mon, and MemCheckerMonitor::recvFunctional().

◆ recvRespRetry()

void MemCheckerMonitor::MonitorResponsePort::recvRespRetry ( )
inlineprotectedvirtual

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

Implements TimingResponseProtocol.

Definition at line 188 of file mem_checker_monitor.hh.

References mon, and MemCheckerMonitor::recvRespRetry().

◆ recvTimingReq()

bool MemCheckerMonitor::MonitorResponsePort::recvTimingReq ( PacketPtr  pkt)
inlineprotectedvirtual

Receive a timing request from the peer.

Implements TimingResponseProtocol.

Definition at line 173 of file mem_checker_monitor.hh.

References mon, and MemCheckerMonitor::recvTimingReq().

◆ recvTimingSnoopResp()

bool MemCheckerMonitor::MonitorResponsePort::recvTimingSnoopResp ( PacketPtr  pkt)
inlineprotectedvirtual

Receive a timing snoop response from the peer.

Implements TimingResponseProtocol.

Definition at line 178 of file mem_checker_monitor.hh.

References mon, and MemCheckerMonitor::recvTimingSnoopResp().

Member Data Documentation

◆ mon

MemCheckerMonitor& MemCheckerMonitor::MonitorResponsePort::mon
private

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

Generated on Wed Sep 30 2020 14:02:27 for gem5 by doxygen 1.8.17