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

A cache response port is used for the CPU-side port of the cache, and it is basically a simple timing port that uses a transmit list for responses to the CPU (or connected requestor). More...

#include <base.hh>

Inheritance diagram for gem5::BaseCache::CacheResponsePort:
gem5::QueuedResponsePort gem5::ResponsePort gem5::Port gem5::AtomicResponseProtocol gem5::TimingResponseProtocol gem5::FunctionalResponseProtocol gem5::BaseCache::CpuSidePort

Public Member Functions

void setBlocked ()
 Do not accept any new requests. More...
 
void clearBlocked ()
 Return to normal operation and accept new requests. More...
 
bool isBlocked () const
 
- Public Member Functions inherited from gem5::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 gem5::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...
 
virtual AddrRangeList getAddrRanges () const =0
 Get a list of the non-overlapping address ranges the owner is responsible for. 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 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

 CacheResponsePort (const std::string &_name, BaseCache *_cache, const std::string &_label)
 
- Protected Member Functions inherited from gem5::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 gem5::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 gem5::Port
void reportUnbound () const
 
 Port (const std::string &_name, PortID _id)
 Abstract base class for ports. More...
 
- Protected Member Functions inherited from gem5::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...
 
virtual Tick recvAtomic (PacketPtr pkt)=0
 Receive an atomic request packet from the peer. More...
 
- Protected Member Functions inherited from gem5::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...
 
virtual bool recvTimingReq (PacketPtr pkt)=0
 Receive a timing request from the peer. More...
 
- Protected Member Functions inherited from gem5::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...
 
virtual void recvFunctional (PacketPtr pkt)=0
 Receive a functional request packet from the peer. More...
 

Protected Attributes

RespPacketQueue queue
 A normal packet queue used to store responses. More...
 
bool blocked
 
bool mustSendRetry
 
- Protected Attributes inherited from gem5::QueuedResponsePort
RespPacketQueuerespQueue
 Packet queue used to store outgoing responses. More...
 
- Protected Attributes inherited from gem5::ResponsePort
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...
 

Private Member Functions

void processSendRetry ()
 

Private Attributes

EventFunctionWrapper sendRetryEvent
 

Detailed Description

A cache response port is used for the CPU-side port of the cache, and it is basically a simple timing port that uses a transmit list for responses to the CPU (or connected requestor).

In addition, it has the functionality to block the port for incoming requests. If blocked, the port will issue a retry once unblocked.

Definition at line 274 of file base.hh.

Constructor & Destructor Documentation

◆ CacheResponsePort()

gem5::BaseCache::CacheResponsePort::CacheResponsePort ( const std::string &  _name,
BaseCache _cache,
const std::string &  _label 
)
protected

Definition at line 69 of file base.cc.

References processSendRetry().

Member Function Documentation

◆ clearBlocked()

void gem5::BaseCache::CacheResponsePort::clearBlocked ( )

Return to normal operation and accept new requests.

Definition at line 160 of file base.cc.

References gem5::BaseCache::blocked, gem5::curTick(), and DPRINTF.

Referenced by gem5::BaseCache::clearBlocked().

◆ isBlocked()

bool gem5::BaseCache::CacheResponsePort::isBlocked ( ) const
inline

Definition at line 285 of file base.hh.

References blocked.

◆ processSendRetry()

void gem5::BaseCache::CacheResponsePort::processSendRetry ( )
private

Definition at line 172 of file base.cc.

References DPRINTF.

Referenced by CacheResponsePort().

◆ setBlocked()

void gem5::BaseCache::CacheResponsePort::setBlocked ( )

Do not accept any new requests.

Definition at line 145 of file base.cc.

References blocked, gem5::EventManager::deschedule(), DPRINTF, mustSendRetry, gem5::ResponsePort::owner, gem5::Event::scheduled(), and sendRetryEvent.

Referenced by gem5::BaseCache::setBlocked().

Member Data Documentation

◆ blocked

bool gem5::BaseCache::CacheResponsePort::blocked
protected

Definition at line 295 of file base.hh.

Referenced by isBlocked(), and setBlocked().

◆ mustSendRetry

bool gem5::BaseCache::CacheResponsePort::mustSendRetry
protected

Definition at line 297 of file base.hh.

Referenced by setBlocked().

◆ queue

RespPacketQueue gem5::BaseCache::CacheResponsePort::queue
protected

A normal packet queue used to store responses.

Definition at line 293 of file base.hh.

◆ sendRetryEvent

EventFunctionWrapper gem5::BaseCache::CacheResponsePort::sendRetryEvent
private

Definition at line 303 of file base.hh.

Referenced by setBlocked().


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

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