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

Declaration of the coherent crossbar memory-side port type, one will be instantiated for each of the CPU-side-port interfaces connecting to the crossbar. More...

#include <coherent_xbar.hh>

Inheritance diagram for CoherentXBar::CoherentXBarRequestPort:
RequestPort Port AtomicRequestProtocol TimingRequestProtocol FunctionalRequestProtocol

Public Member Functions

 CoherentXBarRequestPort (const std::string &_name, CoherentXBar &_xbar, PortID _id)
 
- Public Member Functions inherited from 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 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

bool isSnooping () const override
 Determine if this port should be considered a snooper. More...
 
bool recvTimingResp (PacketPtr pkt) override
 Receive a timing response from the peer. More...
 
void recvTimingSnoopReq (PacketPtr pkt) override
 Receive a timing snoop request from the peer. More...
 
Tick recvAtomicSnoop (PacketPtr pkt) override
 Receive an atomic snoop request packet from our peer. More...
 
void recvFunctionalSnoop (PacketPtr pkt) override
 Receive a functional snoop request packet from the peer. More...
 
void recvRangeChange () override
 Called to receive an address range change from the peer response port. More...
 
void recvReqRetry () override
 Called by the peer if sendTimingReq was called on this peer (causing recvTimingReq to be called on the peer) and was unsuccessful. More...
 
- Protected Member Functions inherited from 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 Port
void reportUnbound () const
 
 Port (const std::string &_name, PortID _id)
 Abstract base class for ports. More...
 
- Protected Member Functions inherited from 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 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 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

CoherentXBarxbar
 A reference to the crossbar to which this port belongs. More...
 

Additional Inherited Members

- Protected Attributes inherited from RequestPort
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

Declaration of the coherent crossbar memory-side port type, one will be instantiated for each of the CPU-side-port interfaces connecting to the crossbar.

Definition at line 149 of file coherent_xbar.hh.

Constructor & Destructor Documentation

◆ CoherentXBarRequestPort()

CoherentXBar::CoherentXBarRequestPort::CoherentXBarRequestPort ( const std::string &  _name,
CoherentXBar _xbar,
PortID  _id 
)
inline

Definition at line 157 of file coherent_xbar.hh.

Member Function Documentation

◆ isSnooping()

bool CoherentXBar::CoherentXBarRequestPort::isSnooping ( ) const
inlineoverrideprotectedvirtual

Determine if this port should be considered a snooper.

For a coherent crossbar memory-side port this is always true.

Returns
a boolean that is true if this port is snooping

Reimplemented from RequestPort.

Definition at line 170 of file coherent_xbar.hh.

◆ recvAtomicSnoop()

Tick CoherentXBar::CoherentXBarRequestPort::recvAtomicSnoop ( PacketPtr  pkt)
inlineoverrideprotectedvirtual

Receive an atomic snoop request packet from our peer.

Implements AtomicRequestProtocol.

Definition at line 185 of file coherent_xbar.hh.

References CoherentXBar::recvAtomicSnoop(), and xbar.

◆ recvFunctionalSnoop()

void CoherentXBar::CoherentXBarRequestPort::recvFunctionalSnoop ( PacketPtr  pkt)
inlineoverrideprotectedvirtual

Receive a functional snoop request packet from the peer.

Implements FunctionalRequestProtocol.

Definition at line 191 of file coherent_xbar.hh.

References CoherentXBar::recvFunctionalSnoop(), and xbar.

◆ recvRangeChange()

void CoherentXBar::CoherentXBarRequestPort::recvRangeChange ( )
inlineoverrideprotectedvirtual

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 RequestPort.

Definition at line 196 of file coherent_xbar.hh.

References BaseXBar::recvRangeChange(), and xbar.

◆ recvReqRetry()

void CoherentXBar::CoherentXBarRequestPort::recvReqRetry ( )
inlineoverrideprotectedvirtual

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

Implements TimingRequestProtocol.

Definition at line 197 of file coherent_xbar.hh.

References CoherentXBar::recvReqRetry(), and xbar.

◆ recvTimingResp()

bool CoherentXBar::CoherentXBarRequestPort::recvTimingResp ( PacketPtr  pkt)
inlineoverrideprotectedvirtual

Receive a timing response from the peer.

Implements TimingRequestProtocol.

Definition at line 173 of file coherent_xbar.hh.

References CoherentXBar::recvTimingResp(), and xbar.

◆ recvTimingSnoopReq()

void CoherentXBar::CoherentXBarRequestPort::recvTimingSnoopReq ( PacketPtr  pkt)
inlineoverrideprotectedvirtual

Receive a timing snoop request from the peer.

Implements TimingRequestProtocol.

Definition at line 179 of file coherent_xbar.hh.

References CoherentXBar::recvTimingSnoopReq(), and xbar.

Member Data Documentation

◆ xbar

CoherentXBar& CoherentXBar::CoherentXBarRequestPort::xbar
private

A reference to the crossbar to which this port belongs.

Definition at line 153 of file coherent_xbar.hh.

Referenced by recvAtomicSnoop(), recvFunctionalSnoop(), recvRangeChange(), recvReqRetry(), recvTimingResp(), and recvTimingSnoopReq().


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

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