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

The CPU-side port extends the base cache response port with access functions for functional, atomic and timing requests. More...

#include <base.hh>

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

Public Member Functions

 CpuSidePort (const std::string &_name, BaseCache *_cache, const std::string &_label)
 
- Public Member Functions inherited from gem5::BaseCache::CacheResponsePort
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...
 
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

virtual bool recvTimingSnoopResp (PacketPtr pkt) override
 Receive a timing snoop response from the peer. More...
 
virtual bool tryTiming (PacketPtr pkt) override
 Availability request from the peer. More...
 
virtual bool recvTimingReq (PacketPtr pkt) override
 Receive a timing request from the peer. More...
 
virtual Tick recvAtomic (PacketPtr pkt) override
 Receive an atomic request packet from the peer. More...
 
virtual void recvFunctional (PacketPtr pkt) override
 Receive a functional request packet from the peer. More...
 
virtual AddrRangeList getAddrRanges () const override
 Get a list of the non-overlapping address ranges the owner is responsible for. More...
 
- Protected Member Functions inherited from gem5::BaseCache::CacheResponsePort
 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...
 
- 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...
 
- 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...
 

Private Attributes

BaseCachecache
 

Additional Inherited Members

- Protected Attributes inherited from gem5::BaseCache::CacheResponsePort
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...
 

Detailed Description

The CPU-side port extends the base cache response port with access functions for functional, atomic and timing requests.

Definition at line 311 of file base.hh.

Constructor & Destructor Documentation

◆ CpuSidePort()

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

Definition at line 2499 of file base.cc.

Member Function Documentation

◆ getAddrRanges()

AddrRangeList gem5::BaseCache::CpuSidePort::getAddrRanges ( ) const
overrideprotectedvirtual

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 gem5::ResponsePort.

Definition at line 2492 of file base.cc.

◆ recvAtomic()

Tick gem5::BaseCache::CpuSidePort::recvAtomic ( PacketPtr  pkt)
overrideprotectedvirtual

Receive an atomic request packet from the peer.

Implements gem5::AtomicResponseProtocol.

Definition at line 2467 of file base.cc.

◆ recvFunctional()

void gem5::BaseCache::CpuSidePort::recvFunctional ( PacketPtr  pkt)
overrideprotectedvirtual

Receive a functional request packet from the peer.

Implements gem5::FunctionalResponseProtocol.

Definition at line 2478 of file base.cc.

◆ recvTimingReq()

bool gem5::BaseCache::CpuSidePort::recvTimingReq ( PacketPtr  pkt)
overrideprotectedvirtual

Receive a timing request from the peer.

Implements gem5::TimingResponseProtocol.

Definition at line 2449 of file base.cc.

References gem5::Packet::isRequest().

◆ recvTimingSnoopResp()

bool gem5::BaseCache::CpuSidePort::recvTimingSnoopResp ( PacketPtr  pkt)
overrideprotectedvirtual

Receive a timing snoop response from the peer.

Implements gem5::TimingResponseProtocol.

Definition at line 2420 of file base.cc.

References gem5::Packet::isResponse().

◆ tryTiming()

bool gem5::BaseCache::CpuSidePort::tryTiming ( PacketPtr  pkt)
overrideprotectedvirtual

Availability request from the peer.

Implements gem5::TimingResponseProtocol.

Definition at line 2434 of file base.cc.

References gem5::BaseCache::blocked, and gem5::Packet::isExpressSnoop().

Member Data Documentation

◆ cache

BaseCache* gem5::BaseCache::CpuSidePort::cache
private

Definition at line 316 of file base.hh.


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