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

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

#include <coherent_xbar.hh>

Inheritance diagram for CoherentXBar::CoherentXBarResponsePort:
QueuedResponsePort ResponsePort Port AtomicResponseProtocol TimingResponseProtocol FunctionalResponseProtocol

Public Member Functions

 CoherentXBarResponsePort (const std::string &_name, CoherentXBar &_xbar, PortID _id)
 
- Public Member Functions inherited from QueuedResponsePort
 QueuedResponsePort (const std::string &name, SimObject *owner, RespPacketQueue &resp_queue, PortID id=InvalidPortID)
 Create a QueuedPort with a given name, owner, and a supplied implementation of a packet queue. More...
 
virtual ~QueuedResponsePort ()
 
void schedTimingResp (PacketPtr pkt, Tick when)
 Schedule the sending of a timing response. More...
 
bool trySatisfyFunctional (PacketPtr pkt)
 Check the list of buffered packets against the supplied functional request. More...
 
- 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

bool recvTimingReq (PacketPtr pkt) override
 Receive a timing request from the peer. More...
 
bool recvTimingSnoopResp (PacketPtr pkt) override
 Receive a timing snoop response from the peer. More...
 
Tick recvAtomic (PacketPtr pkt) override
 Receive an atomic request packet from the peer. More...
 
Tick recvAtomicBackdoor (PacketPtr pkt, MemBackdoorPtr &backdoor) override
 Receive an atomic request packet from the peer, and optionally provide a backdoor to the data being accessed. More...
 
void recvFunctional (PacketPtr pkt) override
 Receive a functional request packet from the peer. More...
 
AddrRangeList getAddrRanges () const override
 Get a list of the non-overlapping address ranges the owner is responsible for. More...
 
- Protected Member Functions inherited from QueuedResponsePort
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

CoherentXBarxbar
 A reference to the crossbar to which this port belongs. More...
 
RespPacketQueue queue
 A normal packet queue used to store responses. More...
 

Additional Inherited Members

- Protected Attributes inherited from QueuedResponsePort
RespPacketQueuerespQueue
 Packet queue used to store outgoing responses. More...
 
- 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

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

Definition at line 85 of file coherent_xbar.hh.

Constructor & Destructor Documentation

◆ CoherentXBarResponsePort()

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

Definition at line 98 of file coherent_xbar.hh.

Member Function Documentation

◆ getAddrRanges()

AddrRangeList CoherentXBar::CoherentXBarResponsePort::getAddrRanges ( ) const
inlineoverrideprotectedvirtual

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 137 of file coherent_xbar.hh.

References BaseXBar::getAddrRanges(), and xbar.

◆ recvAtomic()

Tick CoherentXBar::CoherentXBarResponsePort::recvAtomic ( PacketPtr  pkt)
inlineoverrideprotectedvirtual

Receive an atomic request packet from the peer.

Implements AtomicResponseProtocol.

Definition at line 119 of file coherent_xbar.hh.

References CoherentXBar::recvAtomicBackdoor(), and xbar.

◆ recvAtomicBackdoor()

Tick CoherentXBar::CoherentXBarResponsePort::recvAtomicBackdoor ( PacketPtr  pkt,
MemBackdoorPtr backdoor 
)
inlineoverrideprotectedvirtual

Receive an atomic request packet from the peer, and optionally provide a backdoor to the data being accessed.

Implements AtomicResponseProtocol.

Definition at line 125 of file coherent_xbar.hh.

References CoherentXBar::recvAtomicBackdoor(), and xbar.

◆ recvFunctional()

void CoherentXBar::CoherentXBarResponsePort::recvFunctional ( PacketPtr  pkt)
inlineoverrideprotectedvirtual

Receive a functional request packet from the peer.

Implements FunctionalResponseProtocol.

Definition at line 131 of file coherent_xbar.hh.

References CoherentXBar::recvFunctional(), and xbar.

◆ recvTimingReq()

bool CoherentXBar::CoherentXBarResponsePort::recvTimingReq ( PacketPtr  pkt)
inlineoverrideprotectedvirtual

Receive a timing request from the peer.

Implements TimingResponseProtocol.

Definition at line 107 of file coherent_xbar.hh.

References CoherentXBar::recvTimingReq(), and xbar.

◆ recvTimingSnoopResp()

bool CoherentXBar::CoherentXBarResponsePort::recvTimingSnoopResp ( PacketPtr  pkt)
inlineoverrideprotectedvirtual

Receive a timing snoop response from the peer.

Implements TimingResponseProtocol.

Definition at line 113 of file coherent_xbar.hh.

References CoherentXBar::recvTimingSnoopResp(), and xbar.

Member Data Documentation

◆ queue

RespPacketQueue CoherentXBar::CoherentXBarResponsePort::queue
private

A normal packet queue used to store responses.

Definition at line 94 of file coherent_xbar.hh.

◆ xbar

CoherentXBar& CoherentXBar::CoherentXBarResponsePort::xbar
private

A reference to the crossbar to which this port belongs.

Definition at line 91 of file coherent_xbar.hh.

Referenced by getAddrRanges(), recvAtomic(), recvAtomicBackdoor(), recvFunctional(), recvTimingReq(), and recvTimingSnoopResp().


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