gem5  v21.1.0.2
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
gem5::QueuedRequestPort Class Reference

The QueuedRequestPort combines two queues, a request queue and a snoop response queue, that both share the same port. More...

#include <qport.hh>

Inheritance diagram for gem5::QueuedRequestPort:
gem5::RequestPort gem5::Port gem5::AtomicRequestProtocol gem5::TimingRequestProtocol gem5::FunctionalRequestProtocol gem5::ArmISA::TableWalker::Port gem5::BaseCache::CacheRequestPort gem5::MemDelay::RequestPort gem5::ruby::RubyPort::MemRequestPort gem5::ruby::RubyPort::PioRequestPort gem5::SMMUATSMemoryPort gem5::X86ISA::IntRequestPort< Device > gem5::X86ISA::IntRequestPort< gem5::X86ISA::I82094AA > gem5::X86ISA::IntRequestPort< gem5::X86ISA::Interrupts >

Public Member Functions

 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 gem5::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...
 
virtual bool isSnooping () const
 Determine if this request port is snooping or not. 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 gem5::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 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 gem5::RequestPort
virtual void recvRangeChange ()
 Called to receive an address range change from the peer response port. More...
 
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 gem5::Port
void reportUnbound () const
 
 Port (const std::string &_name, PortID _id)
 Abstract base class for ports. More...
 
- Protected Member Functions inherited from gem5::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 gem5::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...
 
virtual bool recvTimingResp (PacketPtr pkt)=0
 Receive a timing response from the peer. More...
 
- Protected Member Functions inherited from gem5::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...
 

Protected Attributes

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

The QueuedRequestPort combines two queues, a request queue and a snoop response queue, that both share the same port.

The flow control for requests and snoop responses are completely independent, and so each queue manages its own flow control (retries).

Definition at line 109 of file qport.hh.

Constructor & Destructor Documentation

◆ QueuedRequestPort()

gem5::QueuedRequestPort::QueuedRequestPort ( const std::string &  name,
SimObject owner,
ReqPacketQueue req_queue,
SnoopRespPacketQueue snoop_resp_queue,
PortID  id = InvalidPortID 
)
inline

Create a QueuedPort with a given name, owner, and a supplied implementation of two packet queues.

The external definition of the queues enables e.g. the cache to implement a specific queue behaviuor in a subclass, and provide the latter to the QueuePort constructor.

Definition at line 133 of file qport.hh.

◆ ~QueuedRequestPort()

virtual gem5::QueuedRequestPort::~QueuedRequestPort ( )
inlinevirtual

Definition at line 141 of file qport.hh.

Member Function Documentation

◆ recvReqRetry()

void gem5::QueuedRequestPort::recvReqRetry ( )
inlineprotectedvirtual

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

Implements gem5::TimingRequestProtocol.

Definition at line 120 of file qport.hh.

References reqQueue, and gem5::PacketQueue::retry().

◆ recvRetrySnoopResp()

void gem5::QueuedRequestPort::recvRetrySnoopResp ( )
inlineprotectedvirtual

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

Reimplemented from gem5::RequestPort.

Definition at line 122 of file qport.hh.

References gem5::PacketQueue::retry(), and snoopRespQueue.

◆ schedTimingReq()

void gem5::QueuedRequestPort::schedTimingReq ( PacketPtr  pkt,
Tick  when 
)
inline

Schedule the sending of a timing request.

Parameters
pktPacket to send
whenAbsolute time (in ticks) to send packet

Definition at line 149 of file qport.hh.

References reqQueue, and gem5::PacketQueue::schedSendTiming().

Referenced by gem5::ruby::RubyPort::MemResponsePort::recvTimingReq(), and gem5::X86ISA::IntRequestPort< gem5::X86ISA::I82094AA >::sendMessage().

◆ schedTimingSnoopResp()

void gem5::QueuedRequestPort::schedTimingSnoopResp ( PacketPtr  pkt,
Tick  when 
)
inline

Schedule the sending of a timing snoop response.

Parameters
pktPacket to send
whenAbsolute time (in ticks) to send packet

Definition at line 158 of file qport.hh.

References gem5::PacketQueue::schedSendTiming(), and snoopRespQueue.

Referenced by gem5::Cache::doTimingSupplyResponse(), and gem5::Cache::recvTimingSnoopResp().

◆ trySatisfyFunctional()

bool gem5::QueuedRequestPort::trySatisfyFunctional ( PacketPtr  pkt)
inline

Check the list of buffered packets against the supplied functional request.

Definition at line 163 of file qport.hh.

References reqQueue, snoopRespQueue, and gem5::PacketQueue::trySatisfyFunctional().

Referenced by gem5::BaseCache::functionalAccess(), and gem5::MemDelay::trySatisfyFunctional().

Member Data Documentation

◆ reqQueue

ReqPacketQueue& gem5::QueuedRequestPort::reqQueue
protected

Packet queue used to store outgoing requests.

Definition at line 115 of file qport.hh.

Referenced by recvReqRetry(), gem5::BaseCache::CacheRequestPort::schedSendEvent(), schedTimingReq(), and trySatisfyFunctional().

◆ snoopRespQueue

SnoopRespPacketQueue& gem5::QueuedRequestPort::snoopRespQueue
protected

Packet queue used to store outgoing snoop responses.

Definition at line 118 of file qport.hh.

Referenced by recvRetrySnoopResp(), schedTimingSnoopResp(), and trySatisfyFunctional().


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

Generated on Tue Sep 21 2021 12:27:59 for gem5 by doxygen 1.8.17