A queued port is a port that has an infinite queue for outgoing packets and thus decouples the module that wants to send request/responses from the flow control (retry mechanism) of the port. More...

#include <qport.hh>

Inheritance diagram for gem5::QueuedResponsePort:

Public Member Functions
	QueuedResponsePort (const std::string &name, RespPacketQueue &resp_queue, PortID id=InvalidPortID)
	Create a QueuedPort with a given name, owner, and a supplied implementation of a packet queue.

virtual	~QueuedResponsePort ()

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

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

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

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

virtual	~ResponsePort ()

bool	isSnooping () const
	Find out if the peer request port is snooping or not.

void	sendRangeChange () const
	Called by the owner to send a range change.

virtual AddrRangeList	getAddrRanges () const =0
	Get a list of the non-overlapping address ranges the owner is responsible for.

void	unbind () override
	We let the request port do the work, so these don't do anything.

void	bind (Port &peer) override
	Attach to a peer port.

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.

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.

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

void	sendTimingSnoopReq (PacketPtr pkt)
	Attempt to send a timing snoop request packet to the request port by calling its corresponding receive function.

void	sendRetryReq ()
	Send a retry to the request port that previously attempted a sendTimingReq to this response port and failed.

void	sendRetrySnoopResp ()
	Send a retry to the request port that previously attempted a sendTimingSnoopResp to this response 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
void	recvRespRetry ()
	Called by the peer if sendTimingResp was called on this protocol (causing recvTimingResp to be called on the peer) and was unsuccessful.

Protected Member Functions inherited from gem5::ResponsePort
void	responderUnbind ()
	Called by the request port to unbind.

void	responderBind (RequestPort &request_port)
	Called by the request port to bind.

Tick	recvAtomicBackdoor (PacketPtr pkt, MemBackdoorPtr &backdoor) override
	Default implementations.

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

bool	tryTiming (PacketPtr pkt) override
	Availability request from the peer.

bool	recvTimingSnoopResp (PacketPtr pkt) override
	Receive a timing snoop response from the peer.

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

virtual Tick	recvAtomic (PacketPtr pkt)=0
	Receive an atomic request packet from the peer.

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.

void	sendSnoopReq (TimingRequestProtocol *peer, PacketPtr pkt)
	Attempt to send a timing snoop request packet to the peer by calling its corresponding receive function.

void	sendRetryReq (TimingRequestProtocol *peer)
	Send a retry to the peer that previously attempted a sendTimingReq to this protocol and failed.

void	sendRetrySnoopResp (TimingRequestProtocol *peer)
	Send a retry to the peer that previously attempted a sendTimingSnoopResp to this peer and failed.

virtual bool	recvTimingReq (PacketPtr pkt)=0
	Receive a timing request from the peer.

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.

virtual void	recvFunctional (PacketPtr pkt)=0
	Receive a functional request packet from the peer.

Protected Attributes
RespPacketQueue &	respQueue
	Packet queue used to store outgoing responses.

Protected Attributes inherited from gem5::ResponsePort
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

A queued port is a port that has an infinite queue for outgoing packets and thus decouples the module that wants to send request/responses from the flow control (retry mechanism) of the port.

A queued port can be used by both a requestor and a responder. The queue is a parameter to allow tailoring of the queue implementation (used in the cache).

Definition at line 61 of file qport.hh.

Constructor & Destructor Documentation

◆ QueuedResponsePort()

gem5::QueuedResponsePort::QueuedResponsePort	(	const std::string &	name,
		RespPacketQueue &	resp_queue,
		PortID	id = InvalidPortID )

inline

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

The external definition of the queue 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 80 of file qport.hh.

References gem5::ArmISA::id, gem5::InvalidPortID, gem5::Port::name(), gem5::ResponsePort::ResponsePort(), and respQueue.

Referenced by gem5::BaseCache::CacheResponsePort::CacheResponsePort(), gem5::CoherentXBar::CoherentXBarResponsePort::CoherentXBarResponsePort(), gem5::memory::MemCtrl::MemoryPort::MemoryPort(), gem5::memory::qos::MemSinkCtrl::MemoryPort::MemoryPort(), gem5::ruby::RubyPort::MemResponsePort::MemResponsePort(), gem5::NoncoherentXBar::NoncoherentXBarResponsePort::NoncoherentXBarResponsePort(), gem5::ruby::RubyPort::PioResponsePort::PioResponsePort(), gem5::MemDelay::ResponsePort::ResponsePort(), gem5::SimpleTimingPort::SimpleTimingPort(), gem5::SMMUATSDevicePort::SMMUATSDevicePort(), and gem5::SMMUDevicePort::SMMUDevicePort().

◆ ~QueuedResponsePort()

virtual gem5::QueuedResponsePort::~QueuedResponsePort ( )

inlinevirtual

Definition at line 86 of file qport.hh.

Member Function Documentation

◆ recvRespRetry()

void gem5::QueuedResponsePort::recvRespRetry ( )

inlineprotectedvirtual

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

Implements gem5::TimingResponseProtocol.

Definition at line 69 of file qport.hh.

References respQueue.

◆ schedTimingResp()

void gem5::QueuedResponsePort::schedTimingResp	(	PacketPtr	pkt,
		Tick	when )

inline

Schedule the sending of a timing response.

Parameters

pkt	Packet to send
when	Absolute time (in ticks) to send packet

Definition at line 94 of file qport.hh.

References respQueue.

Referenced by gem5::ruby::RubyPort::MemResponsePort::hitCallback(), gem5::ruby::RubyPort::MemResponsePort::recvTimingReq(), gem5::SimpleTimingPort::recvTimingReq(), gem5::ruby::RubyPort::MemRequestPort::recvTimingResp(), and gem5::ruby::HTMSequencer::rubyHtmCallback().

◆ trySatisfyFunctional()

bool gem5::QueuedResponsePort::trySatisfyFunctional ( PacketPtr pkt )

inline

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

Definition at line 99 of file qport.hh.

References respQueue.

Member Data Documentation

◆ respQueue

RespPacketQueue& gem5::QueuedResponsePort::respQueue

protected

Packet queue used to store outgoing responses.

Definition at line 67 of file qport.hh.

Referenced by QueuedResponsePort(), gem5::SimpleTimingPort::recvFunctional(), recvRespRetry(), gem5::MemDelay::ResponsePort::ResponsePort(), schedTimingResp(), and trySatisfyFunctional().

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

mem/qport.hh

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ QueuedResponsePort()

◆ ~QueuedResponsePort()

Member Function Documentation

◆ recvRespRetry()

◆ schedTimingResp()

◆ trySatisfyFunctional()

Member Data Documentation

◆ respQueue