gem5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
CommMonitor::MonitorMasterPort Class Reference

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

Inheritance diagram for CommMonitor::MonitorMasterPort:
MasterPort BaseMasterPort Port

Public Member Functions

 MonitorMasterPort (const std::string &_name, CommMonitor &_mon)
 
- Public Member Functions inherited from MasterPort
 MasterPort (const std::string &name, MemObject *owner, PortID id=InvalidPortID)
 Master port. More...
 
virtual ~MasterPort ()
 
void bind (BaseSlavePort &slave_port)
 Bind this master port to a slave port. More...
 
void unbind ()
 Unbind this master port and the associated slave port. 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...
 
void sendFunctional (PacketPtr pkt)
 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 slave port by calling its corresponding receive function. More...
 
bool sendTimingSnoopResp (PacketPtr pkt)
 Attempt to send a timing snoop response packet to the slave port by calling its corresponding receive function. More...
 
virtual void sendRetryResp ()
 Send a retry to the slave port that previously attempted a sendTimingResp to this master port and failed. More...
 
AddrRangeList getAddrRanges () const
 Get the address ranges of the connected slave 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...
 
- Public Member Functions inherited from BaseMasterPort
BaseSlavePortgetSlavePort () const
 
bool isConnected () const
 
- Public Member Functions inherited from Port
const std::string name () const
 Return port name (for DPRINTF). More...
 
PortID getId () const
 Get the port id. More...
 

Protected Member Functions

void recvFunctionalSnoop (PacketPtr pkt)
 Receive a functional snoop request packet from the slave port. More...
 
Tick recvAtomicSnoop (PacketPtr pkt)
 Receive an atomic snoop request packet from the slave port. More...
 
bool recvTimingResp (PacketPtr pkt)
 Receive a timing response from the slave port. More...
 
void recvTimingSnoopReq (PacketPtr pkt)
 Receive a timing snoop request from the slave port. More...
 
void recvRangeChange ()
 Called to receive an address range change from the peer slave port. More...
 
bool isSnooping () const
 Determine if this master port is snooping or not. More...
 
void recvReqRetry ()
 Called by the slave port if sendTimingReq was called on this master port (causing recvTimingReq to be called on the slave port) and was unsuccesful. More...
 
void recvRetrySnoopResp ()
 Called by the slave port if sendTimingSnoopResp was called on this master port (causing recvTimingSnoopResp to be called on the slave port) and was unsuccesful. More...
 
- Protected Member Functions inherited from BaseMasterPort
 BaseMasterPort (const std::string &name, MemObject *owner, PortID id=InvalidPortID)
 
virtual ~BaseMasterPort ()
 
- Protected Member Functions inherited from Port
 Port (const std::string &_name, MemObject &_owner, PortID _id)
 Abstract base class for ports. More...
 
virtual ~Port ()
 Virtual destructor due to inheritance. More...
 

Private Attributes

CommMonitormon
 

Additional Inherited Members

- Protected Attributes inherited from BaseMasterPort
BaseSlavePort_baseSlavePort
 
- 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...
 
MemObjectowner
 A reference to the MemObject that owns this port. More...
 

Detailed Description

This is the master port of the communication monitor.

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

Definition at line 128 of file comm_monitor.hh.

Constructor & Destructor Documentation

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

Definition at line 133 of file comm_monitor.hh.

Member Function Documentation

bool CommMonitor::MonitorMasterPort::isSnooping ( ) const
inlineprotectedvirtual

Determine if this master port is snooping or not.

The default implementation returns false and thus tells the neighbour we are not snooping. Any master 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 MasterPort.

Definition at line 164 of file comm_monitor.hh.

References CommMonitor::isSnooping(), and mon.

Tick CommMonitor::MonitorMasterPort::recvAtomicSnoop ( PacketPtr  pkt)
inlineprotectedvirtual

Receive an atomic snoop request packet from the slave port.

Reimplemented from MasterPort.

Definition at line 144 of file comm_monitor.hh.

References mon, and CommMonitor::recvAtomicSnoop().

void CommMonitor::MonitorMasterPort::recvFunctionalSnoop ( PacketPtr  pkt)
inlineprotectedvirtual

Receive a functional snoop request packet from the slave port.

Reimplemented from MasterPort.

Definition at line 139 of file comm_monitor.hh.

References mon, and CommMonitor::recvFunctionalSnoop().

void CommMonitor::MonitorMasterPort::recvRangeChange ( )
inlineprotectedvirtual

Called to receive an address range change from the peer slave 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 MasterPort.

Definition at line 159 of file comm_monitor.hh.

References mon, and CommMonitor::recvRangeChange().

void CommMonitor::MonitorMasterPort::recvReqRetry ( )
inlineprotectedvirtual

Called by the slave port if sendTimingReq was called on this master port (causing recvTimingReq to be called on the slave port) and was unsuccesful.

Implements MasterPort.

Definition at line 169 of file comm_monitor.hh.

References mon, and CommMonitor::recvReqRetry().

void CommMonitor::MonitorMasterPort::recvRetrySnoopResp ( )
inlineprotectedvirtual

Called by the slave port if sendTimingSnoopResp was called on this master port (causing recvTimingSnoopResp to be called on the slave port) and was unsuccesful.

Reimplemented from MasterPort.

Definition at line 174 of file comm_monitor.hh.

References mon, and CommMonitor::recvRetrySnoopResp().

bool CommMonitor::MonitorMasterPort::recvTimingResp ( PacketPtr  pkt)
inlineprotectedvirtual

Receive a timing response from the slave port.

Implements MasterPort.

Definition at line 149 of file comm_monitor.hh.

References mon, and CommMonitor::recvTimingResp().

void CommMonitor::MonitorMasterPort::recvTimingSnoopReq ( PacketPtr  pkt)
inlineprotectedvirtual

Receive a timing snoop request from the slave port.

Reimplemented from MasterPort.

Definition at line 154 of file comm_monitor.hh.

References mon, and CommMonitor::recvTimingSnoopReq().

Member Data Documentation

CommMonitor& CommMonitor::MonitorMasterPort::mon
private

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

Generated on Fri Jun 9 2017 13:04:06 for gem5 by doxygen 1.8.6