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 gem5::BaseCache::MemSidePort:

Public Member Functions
	MemSidePort (const std::string &_name, BaseCache *_cache, const std::string &_label)

Public Member Functions inherited from gem5::BaseCache::CacheRequestPort
void	schedSendEvent (Tick time)
	Schedule a send of a request packet (from the MSHR).

Public Member Functions inherited from gem5::QueuedRequestPort
	QueuedRequestPort (const std::string &name, ReqPacketQueue &req_queue, SnoopRespPacketQueue &snoop_resp_queue, PortID id=InvalidPortID)
	Create a QueuedPort with a given name, and a supplied implementation of two packet queues.

virtual	~QueuedRequestPort ()

void	schedTimingReq (PacketPtr pkt, Tick when)
	Schedule the sending of a timing request.

void	schedTimingSnoopResp (PacketPtr pkt, Tick when)
	Schedule the sending of a timing snoop response.

bool	trySatisfyFunctional (PacketPtr pkt)
	Check the list of buffered packets against the supplied functional request.

Public Member Functions inherited from gem5::RequestPort
	RequestPort (const std::string &name, SimObject *_owner, PortID id=InvalidPortID)
	Request port.

	RequestPort (const std::string &name, PortID id=InvalidPortID)

virtual	~RequestPort ()

void	bind (Port &peer) override
	Bind this request port to a response port.

void	unbind () override
	Unbind this request port and the associated response port.

AddrRangeList	getAddrRanges () const
	Get the address ranges of the connected responder port.

void	printAddr (Addr a)
	Inject a PrintReq for the given address to print the state of that address throughout the memory system.

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.

Tick	sendAtomicBackdoor (PacketPtr pkt, MemBackdoorPtr &backdoor)
	Send an atomic request packet like above, but also request a backdoor to the data being accessed.

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.

void	sendMemBackdoorReq (const MemBackdoorReq &req, MemBackdoorPtr &backdoor)
	Send a request for a back door to a range of memory.

bool	sendTimingReq (PacketPtr pkt)
	Attempt to send a timing request to the responder port by calling its corresponding receive function.

bool	tryTiming (PacketPtr pkt) const
	Check if the responder can handle a timing request.

bool	sendTimingSnoopResp (PacketPtr pkt)
	Attempt to send a timing snoop response packet to the response port by calling its corresponding receive function.

virtual void	sendRetryResp ()
	Send a retry to the response port that previously attempted a sendTimingResp to this request port and failed.

Public Member Functions inherited from gem5::Port
virtual	~Port ()
	Virtual destructor due to inheritance.

Port &	getPeer ()
	Return a reference to this port's peer.

const std::string	name () const
	Return port name (for DPRINTF).

PortID	getId () const
	Get the port id.

bool	isConnected () const
	Is this port currently connected to a peer?

void	takeOverFrom (Port *old)
	A utility function to make it easier to swap out ports.

Protected Member Functions
virtual void	recvTimingSnoopReq (PacketPtr pkt)
	Receive a timing snoop request from the peer.

virtual bool	recvTimingResp (PacketPtr pkt)
	Receive a timing response from the peer.

virtual Tick	recvAtomicSnoop (PacketPtr pkt)
	Receive an atomic snoop request packet from our peer.

virtual void	recvFunctionalSnoop (PacketPtr pkt)
	Receive a functional snoop request packet from the peer.

Protected Member Functions inherited from gem5::BaseCache::CacheRequestPort
	CacheRequestPort (const std::string &_name, ReqPacketQueue &_reqQueue, SnoopRespPacketQueue &_snoopRespQueue)

virtual bool	isSnooping () const
	Memory-side port always snoops.

Protected Member Functions inherited from gem5::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.

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

Protected Member Functions inherited from gem5::RequestPort
virtual void	recvRangeChange ()
	Called to receive an address range change from the peer response port.

Tick	recvAtomicSnoop (PacketPtr pkt) override
	Default implementations.

void	recvFunctionalSnoop (PacketPtr pkt) override
	Receive a functional snoop request packet from the peer.

void	recvTimingSnoopReq (PacketPtr pkt) override
	Receive a timing snoop request from the peer.

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

Protected Member Functions inherited from gem5::Port
void	reportUnbound () const

	Port (const std::string &_name, PortID _id)
	Abstract base class for ports.

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.

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.

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.

bool	trySend (TimingResponseProtocol *peer, PacketPtr pkt) const
	Check if the peer can handle a timing request.

bool	sendSnoopResp (TimingResponseProtocol *peer, PacketPtr pkt)
	Attempt to send a timing snoop response packet to it's peer by calling its corresponding receive function.

void	sendRetryResp (TimingResponseProtocol *peer)
	Send a retry to the peer that previously attempted a sendTimingResp to this protocol and failed.

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.

void	sendMemBackdoorReq (FunctionalResponseProtocol *peer, const MemBackdoorReq &req, MemBackdoorPtr &backdoor)
	Send a request for a back door to a range of memory.

Private Attributes
CacheReqPacketQueue	_reqQueue
	The cache-specific queue.

SnoopRespPacketQueue	_snoopRespQueue

BaseCache *	cache

Additional Inherited Members
Protected Attributes inherited from gem5::QueuedRequestPort
ReqPacketQueue &	reqQueue
	Packet queue used to store outgoing requests.

SnoopRespPacketQueue &	snoopRespQueue
	Packet queue used to store outgoing snoop responses.

Protected Attributes inherited from gem5::RequestPort
SimObject &	owner

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.

Port *	_peer
	A pointer to this port's peer.

bool	_connected
	Whether this port is currently connected to a peer port.

Detailed Description

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

Definition at line 220 of file base.hh.

Constructor & Destructor Documentation

◆ MemSidePort()

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

Definition at line 2707 of file base.cc.

Member Function Documentation

◆ recvAtomicSnoop()

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

protectedvirtual

Receive an atomic snoop request packet from our peer.

Implements gem5::AtomicRequestProtocol.

Definition at line 2651 of file base.cc.

◆ recvFunctionalSnoop()

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

protectedvirtual

Receive a functional snoop request packet from the peer.

Implements gem5::FunctionalRequestProtocol.

Definition at line 2660 of file base.cc.

◆ recvTimingResp()

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

protectedvirtual

Receive a timing response from the peer.

Implements gem5::TimingRequestProtocol.

Definition at line 2633 of file base.cc.

◆ recvTimingSnoopReq()

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

protectedvirtual

Receive a timing snoop request from the peer.

Implements gem5::TimingRequestProtocol.

Definition at line 2641 of file base.cc.

Member Data Documentation

◆ _reqQueue

CacheReqPacketQueue gem5::BaseCache::MemSidePort::_reqQueue

private

The cache-specific queue.

Definition at line 225 of file base.hh.

◆ _snoopRespQueue

SnoopRespPacketQueue gem5::BaseCache::MemSidePort::_snoopRespQueue

private

Definition at line 227 of file base.hh.

◆ cache

BaseCache* gem5::BaseCache::MemSidePort::cache

private

Definition at line 230 of file base.hh.

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

mem/cache/base.hh
mem/cache/base.cc

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MemSidePort()

Member Function Documentation

◆ recvAtomicSnoop()

◆ recvFunctionalSnoop()

◆ recvTimingResp()

◆ recvTimingSnoopReq()

Member Data Documentation

◆ _reqQueue

◆ _snoopRespQueue

◆ cache