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

#include <mem_delay.hh>

Inheritance diagram for MemDelay::RequestPort:
QueuedRequestPort RequestPort Port AtomicRequestProtocol TimingRequestProtocol FunctionalRequestProtocol

Public Member Functions

 RequestPort (const std::string &_name, MemDelay &_parent)
 
- Public Member Functions inherited from QueuedRequestPort
 QueuedRequestPort (const std::string &name, SimObject *owner, ReqPacketQueue &req_queue, SnoopRespPacketQueue &snoop_resp_queue, PortID id=InvalidPortID)
 Create a QueuedPort with a given name, owner, and a supplied implementation of two packet queues. More...
 
virtual ~QueuedRequestPort ()
 
void schedTimingReq (PacketPtr pkt, Tick when)
 Schedule the sending of a timing request. More...
 
void schedTimingSnoopResp (PacketPtr pkt, Tick when)
 Schedule the sending of a timing snoop response. More...
 
bool trySatisfyFunctional (PacketPtr pkt)
 Check the list of buffered packets against the supplied functional request. More...
 
- 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 recvTimingResp (PacketPtr pkt) override
 Receive a timing response from the peer. More...
 
void recvFunctionalSnoop (PacketPtr pkt) override
 Receive a functional snoop request packet from the peer. More...
 
Tick recvAtomicSnoop (PacketPtr pkt) override
 Receive an atomic snoop request packet from our peer. More...
 
void recvTimingSnoopReq (PacketPtr pkt) override
 Receive a timing snoop request from the peer. More...
 
void recvRangeChange () override
 Called to receive an address range change from the peer response port. More...
 
bool isSnooping () const override
 Determine if this request port is snooping or not. More...
 
- Protected Member Functions inherited from QueuedRequestPort
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 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...
 
- 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

MemDelayparent
 

Additional Inherited Members

- Protected Attributes inherited from QueuedRequestPort
ReqPacketQueuereqQueue
 Packet queue used to store outgoing requests. More...
 
SnoopRespPacketQueuesnoopRespQueue
 Packet queue used to store outgoing snoop responses. More...
 
- 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

Definition at line 74 of file mem_delay.hh.

Constructor & Destructor Documentation

◆ RequestPort()

MemDelay::RequestPort::RequestPort ( const std::string &  _name,
MemDelay _parent 
)

Definition at line 80 of file mem_delay.cc.

Member Function Documentation

◆ isSnooping()

bool MemDelay::RequestPort::isSnooping ( ) const
inlineoverrideprotectedvirtual

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

Definition at line 92 of file mem_delay.hh.

References ResponsePort::isSnooping(), parent, and MemDelay::responsePort.

◆ recvAtomicSnoop()

Tick MemDelay::RequestPort::recvAtomicSnoop ( PacketPtr  pkt)
overrideprotectedvirtual

Receive an atomic snoop request packet from our peer.

Implements AtomicRequestProtocol.

Definition at line 113 of file mem_delay.cc.

◆ recvFunctionalSnoop()

void MemDelay::RequestPort::recvFunctionalSnoop ( PacketPtr  pkt)
overrideprotectedvirtual

Receive a functional snoop request packet from the peer.

Implements FunctionalRequestProtocol.

Definition at line 103 of file mem_delay.cc.

References Packet::makeResponse().

◆ recvRangeChange()

void MemDelay::RequestPort::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 88 of file mem_delay.hh.

References parent, MemDelay::responsePort, and ResponsePort::sendRangeChange().

◆ recvTimingResp()

bool MemDelay::RequestPort::recvTimingResp ( PacketPtr  pkt)
overrideprotectedvirtual

Receive a timing response from the peer.

Implements TimingRequestProtocol.

Definition at line 88 of file mem_delay.cc.

References curTick(), Packet::headerDelay, and Packet::payloadDelay.

◆ recvTimingSnoopReq()

void MemDelay::RequestPort::recvTimingSnoopReq ( PacketPtr  pkt)
overrideprotectedvirtual

Receive a timing snoop request from the peer.

Implements TimingRequestProtocol.

Definition at line 121 of file mem_delay.cc.

Member Data Documentation

◆ parent

MemDelay& MemDelay::RequestPort::parent
private

Definition at line 97 of file mem_delay.hh.

Referenced by isSnooping(), and recvRangeChange().


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

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