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

The memory-side port extends the base cache request port with access functions for functional, atomic and timing snoops. More...

#include <base.hh>

Inheritance diagram for BaseCache::MemSidePort:
BaseCache::CacheRequestPort QueuedRequestPort RequestPort Port AtomicRequestProtocol TimingRequestProtocol FunctionalRequestProtocol

Public Member Functions

 MemSidePort (const std::string &_name, BaseCache *_cache, const std::string &_label)
 
- Public Member Functions inherited from BaseCache::CacheRequestPort
void schedSendEvent (Tick time)
 Schedule a send of a request packet (from the MSHR). More...
 
- 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

virtual void recvTimingSnoopReq (PacketPtr pkt)
 Receive a timing snoop request from the peer. More...
 
virtual bool recvTimingResp (PacketPtr pkt)
 Receive a timing response from the peer. More...
 
virtual Tick recvAtomicSnoop (PacketPtr pkt)
 Receive an atomic snoop request packet from our peer. More...
 
virtual void recvFunctionalSnoop (PacketPtr pkt)
 Receive a functional snoop request packet from the peer. More...
 
- Protected Member Functions inherited from BaseCache::CacheRequestPort
 CacheRequestPort (const std::string &_name, BaseCache *_cache, ReqPacketQueue &_reqQueue, SnoopRespPacketQueue &_snoopRespQueue)
 
virtual bool isSnooping () const
 Memory-side port always snoops. 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
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 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

CacheReqPacketQueue _reqQueue
 The cache-specific queue. More...
 
SnoopRespPacketQueue _snoopRespQueue
 
BaseCachecache
 

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

The memory-side port extends the base cache request port with access functions for functional, atomic and timing snoops.

Definition at line 208 of file base.hh.

Constructor & Destructor Documentation

◆ MemSidePort()

BaseCache::MemSidePort::MemSidePort ( const std::string &  _name,
BaseCache _cache,
const std::string &  _label 
)

Definition at line 2452 of file base.cc.

Member Function Documentation

◆ recvAtomicSnoop()

Tick BaseCache::MemSidePort::recvAtomicSnoop ( PacketPtr  pkt)
protectedvirtual

Receive an atomic snoop request packet from our peer.

Implements AtomicRequestProtocol.

Definition at line 2396 of file base.cc.

◆ recvFunctionalSnoop()

void BaseCache::MemSidePort::recvFunctionalSnoop ( PacketPtr  pkt)
protectedvirtual

Receive a functional snoop request packet from the peer.

Implements FunctionalRequestProtocol.

Definition at line 2405 of file base.cc.

◆ recvTimingResp()

bool BaseCache::MemSidePort::recvTimingResp ( PacketPtr  pkt)
protectedvirtual

Receive a timing response from the peer.

Implements TimingRequestProtocol.

Definition at line 2378 of file base.cc.

◆ recvTimingSnoopReq()

void BaseCache::MemSidePort::recvTimingSnoopReq ( PacketPtr  pkt)
protectedvirtual

Receive a timing snoop request from the peer.

Implements TimingRequestProtocol.

Definition at line 2386 of file base.cc.

Member Data Documentation

◆ _reqQueue

CacheReqPacketQueue BaseCache::MemSidePort::_reqQueue
private

The cache-specific queue.

Definition at line 213 of file base.hh.

◆ _snoopRespQueue

SnoopRespPacketQueue BaseCache::MemSidePort::_snoopRespQueue
private

Definition at line 215 of file base.hh.

◆ cache

BaseCache* BaseCache::MemSidePort::cache
private

Definition at line 218 of file base.hh.


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

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