A RequestPort is a specialisation of a Port, which implements the default protocol for the three different level of transport functions. More...

#include <port.hh>

Inheritance diagram for RequestPort:

Public Member Functions
	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...

virtual bool	isSnooping () const
	Determine if this request port is snooping or not. 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...

Port &	getPeer ()
	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	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...

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

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

virtual void	recvReqRetry ()=0
	Called by the peer if sendTimingReq was called on this peer (causing recvTimingReq to be called on the peer) and was unsuccessful. 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...

Protected Attributes
SimObject &	owner

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

Private Attributes
ResponsePort *	_responsePort

Friends
class	ResponsePort

Detailed Description

A RequestPort is a specialisation of a Port, which implements the default protocol for the three different level of transport functions.

In addition to the basic functionality of sending packets, it also has functions to receive range changes or determine if the port is snooping or not.

The three protocols are atomic, timing, and functional, each with its own header file.

Definition at line 74 of file port.hh.

Constructor & Destructor Documentation

◆ RequestPort()

RequestPort::RequestPort	(	const std::string &	name,
		SimObject *	_owner,
		PortID	id = `InvalidPortID`
	)

Request port.

Definition at line 114 of file port.cc.

◆ ~RequestPort()

RequestPort::~RequestPort ( )

virtual

Definition at line 120 of file port.cc.

Member Function Documentation

◆ bind()

void RequestPort::bind ( Port & peer )

overridevirtual

Bind this request port to a response port.

This also does the mirror action and binds the response port to the request port.

Reimplemented from Port.

Reimplemented in TokenRequestPort.

Definition at line 125 of file port.cc.

References _responsePort, Port::bind(), fatal_if, Port::name(), and ResponsePort::responderBind().

Referenced by TokenRequestPort::bind().

◆ getAddrRanges()

AddrRangeList RequestPort::getAddrRanges ( ) const

Get the address ranges of the connected responder port.

Definition at line 148 of file port.cc.

References _responsePort, and ResponsePort::getAddrRanges().

Referenced by MemDelay::ResponsePort::getAddrRanges(), SimpleMemobj::getAddrRanges(), MemCheckerMonitor::getAddrRanges(), SimpleCache::getAddrRanges(), and CommMonitor::getAddrRanges().

◆ isSnooping()

virtual bool RequestPort::isSnooping ( ) const

inlinevirtual

Determine if this request port is snooping or not.

The default implementation returns false and thus tells the neighbour we are not snooping. Any request port that wants to receive snoop requests (e.g. a cache connected to a bus) has to override this function.

Returns: true if the port should be considered a snooper

Reimplemented in CoherentXBar::CoherentXBarRequestPort, Minor::LSQ::DcachePort, MemDelay::RequestPort, TraceCPU::DcachePort, TimingSimpleCPU::DcachePort, LSQ< Impl >::DcachePort, CommMonitor::MonitorRequestPort, BaseCache::CacheRequestPort, AtomicSimpleCPU::AtomicCPUDPort, AddrMapper::MapperRequestPort, and MemCheckerMonitor::MonitorRequestPort.

Definition at line 110 of file port.hh.

Referenced by ResponsePort::isSnooping().

◆ printAddr()

void RequestPort::printAddr ( Addr a )

Inject a PrintReq for the given address to print the state of that address throughout the memory system.

For debugging.

Definition at line 154 of file port.cc.

References ArmISA::a, Request::funcRequestorId, MemCmd::PrintReq, Packet::senderState, and sendFunctional().

Referenced by GarnetSyntheticTraffic::printAddr(), AtomicSimpleCPU::printAddr(), and TimingSimpleCPU::printAddr().

◆ recvAtomicSnoop()

Tick RequestPort::recvAtomicSnoop ( PacketPtr pkt )

inlineoverrideprotectedvirtual

Default implementations.

Implements AtomicRequestProtocol.

Definition at line 223 of file port.hh.

References Port::name(), and panic.

◆ recvFunctionalSnoop()

void RequestPort::recvFunctionalSnoop ( PacketPtr pkt )

inlineoverrideprotectedvirtual

Receive a functional snoop request packet from the peer.

Implements FunctionalRequestProtocol.

Definition at line 230 of file port.hh.

References Port::name(), and panic.

◆ recvRangeChange()

virtual void RequestPort::recvRangeChange ( )

inlineprotectedvirtual

Called to receive an address range change from the peer response port.

The default implementation ignores the change and does nothing. Override this function in a derived class if the owner needs to be aware of the address ranges, e.g. in an interconnect component like a bus.

Reimplemented in CoherentXBar::CoherentXBarRequestPort, SimpleCache::MemSidePort, SimpleMemobj::MemSidePort, NoncoherentXBar::NoncoherentXBarRequestPort, sc_gem5::TlmToGem5Bridge< BITWIDTH >::BridgeRequestPort, MemDelay::RequestPort, ComputeUnit::LDSPort, ComputeUnit::ITLBPort, ComputeUnit::DTLBPort, ComputeUnit::SQCPort, ComputeUnit::DataPort, X86ISA::GpuTLB::MemSidePort, TLBCoalescer::MemSidePort, CommMonitor::MonitorRequestPort, AddrMapper::MapperRequestPort, MemCheckerMonitor::MonitorRequestPort, RubyPort::PioRequestPort, and RubyPort::MemRequestPort.

Definition at line 217 of file port.hh.

Referenced by ResponsePort::sendRangeChange().

◆ recvRetrySnoopResp()

void RequestPort::recvRetrySnoopResp ( )

inlineoverrideprotectedvirtual

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

Implements TimingRequestProtocol.

Reimplemented in QueuedRequestPort.

Definition at line 242 of file port.hh.

References Port::name(), and panic.

◆ recvTimingSnoopReq()

void RequestPort::recvTimingSnoopReq ( PacketPtr pkt )

inlineoverrideprotectedvirtual

Receive a timing snoop request from the peer.

Implements TimingRequestProtocol.

Definition at line 236 of file port.hh.

References Port::name(), and panic.

◆ sendAtomic()

Tick RequestPort::sendAtomic ( PacketPtr pkt )

inline

Send an atomic request packet, where the data is moved and the state is updated in zero time, without interleaving with other memory accesses.

Parameters

pkt	Packet to send.

Returns: Estimated latency of access.

Definition at line 461 of file port.hh.

References _responsePort, Port::reportUnbound(), and AtomicRequestProtocol::send().

Referenced by NoncoherentCache::doWritebacksAtomic(), Cache::doWritebacksAtomic(), NoncoherentCache::handleAtomicReqMiss(), Cache::handleAtomicReqMiss(), ArmISA::Stage2MMU::readDataUntimed(), RubyPort::MemResponsePort::recvAtomic(), Cache::recvAtomic(), AbstractController::recvAtomic(), SerialLink::SerialLinkResponsePort::recvAtomic(), Bridge::BridgeResponsePort::recvAtomic(), AddrMapper::recvAtomic(), CommMonitor::recvAtomic(), SMMUv3::runProcessAtomic(), Gicv3Its::runProcessAtomic(), DmaPort::sendDma(), X86ISA::IntRequestPort< X86ISA::I82094AA >::sendMessage(), NonCachingSimpleCPU::sendPacket(), and AtomicSimpleCPU::sendPacket().

◆ sendAtomicBackdoor()

Tick RequestPort::sendAtomicBackdoor	(	PacketPtr	pkt,
		MemBackdoorPtr &	backdoor
	)

inline

Send an atomic request packet like above, but also request a backdoor to the data being accessed.

Parameters

pkt	Packet to send.
backdoor	Can be set to a back door pointer by the target to let caller have direct access to the requested data.

Returns: Estimated latency of access.

Definition at line 471 of file port.hh.

References _responsePort, Port::reportUnbound(), and AtomicRequestProtocol::sendBackdoor().

◆ sendFunctional()

void RequestPort::sendFunctional ( PacketPtr pkt ) const

inline

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.

Parameters

pkt	Packet to send.

Definition at line 482 of file port.hh.

References _responsePort, Port::reportUnbound(), and FunctionalRequestProtocol::send().

Referenced by FetchUnit::fetch(), ArmISA::TableWalker::fetchDescriptor(), BaseCache::functionalAccess(), AbstractController::functionalMemoryRead(), AbstractController::functionalMemoryWrite(), SimpleMemobj::handleFunctional(), SimpleCache::handleFunctional(), FetchUnit::initiateFetch(), PortProxy::PortProxy(), printAddr(), ArmISA::Stage2MMU::readDataUntimed(), CheckerCPU::readMem(), SerialLink::SerialLinkResponsePort::recvFunctional(), MemCheckerMonitor::recvFunctional(), AddrMapper::recvFunctional(), Bridge::BridgeResponsePort::recvFunctional(), CommMonitor::recvFunctional(), AbstractController::serviceMemoryQueue(), MemTest::tick(), and BaseCache::writebackVisitor().

◆ sendRetryResp()

void RequestPort::sendRetryResp ( )

inlinevirtual

Send a retry to the response port that previously attempted a sendTimingResp to this request port and failed.

Note that this is virtual so that the "fake" snoop response port in the coherent crossbar can override the behaviour.

Reimplemented in CoherentXBar::SnoopRespPort.

Definition at line 522 of file port.hh.

References _responsePort, Port::reportUnbound(), and TimingRequestProtocol::sendRetryResp().

Referenced by MemCheckerMonitor::recvRespRetry(), AddrMapper::recvRespRetry(), CommMonitor::recvRespRetry(), BaseXBar::RespLayer::sendRetry(), and TimingSimpleCPU::TimingCPUPort::TimingCPUPort().

◆ sendTimingReq()

bool RequestPort::sendTimingReq ( PacketPtr pkt )

inline

Attempt to send a timing request to the responder port by calling its corresponding receive function.

If the send does not succeed, as indicated by the return value, then the sender must wait for a recvReqRetry at which point it can re-issue a sendTimingReq.

Parameters

pkt	Packet to send.

Returns: If the send was succesful or not.

Definition at line 492 of file port.hh.

References _responsePort, Port::reportUnbound(), and TimingRequestProtocol::sendReq().

Referenced by GarnetSyntheticTraffic::doRetry(), TraceCPU::ElasticDataGen::execute(), TraceCPU::ElasticDataGen::executeMemReq(), FetchUnit::fetch(), DefaultFetch< Impl >::finishTranslation(), TimingSimpleCPU::handleReadPacket(), TimingSimpleCPU::handleWritePacket(), InvalidateGenerator::initiate(), SeriesRequestGenerator::initiate(), Check::initiateAction(), Check::initiateCheck(), FetchUnit::initiateFetch(), Check::initiateFlush(), Check::initiatePrefetch(), ComputeUnit::ScalarDataPort::MemReqEvent::process(), Gicv3Its::recvReqRetry(), SMMUv3::recvReqRetry(), TimingSimpleCPU::IcachePort::recvReqRetry(), TimingSimpleCPU::DcachePort::recvReqRetry(), DefaultFetch< Impl >::recvReqRetry(), ComputeUnit::LDSPort::recvReqRetry(), MemTest::recvRetry(), Cache::recvTimingReq(), MemCheckerMonitor::recvTimingReq(), AddrMapper::recvTimingReq(), CommMonitor::recvTimingReq(), BaseTrafficGen::retryReq(), SMMUv3::runProcessTiming(), Gicv3Its::runProcessTiming(), TraceCPU::FixedRetryGen::send(), TimingSimpleCPU::sendFetch(), BaseCache::sendMSHRQueuePacket(), ComputeUnit::sendScalarRequest(), RiscvISA::Walker::sendTiming(), X86ISA::Walker::sendTiming(), ReqPacketQueue::sendTiming(), ComputeUnit::LDSPort::sendTimingReq(), BaseCache::sendWriteQueuePacket(), AbstractController::serviceMemoryQueue(), SMMUv3::tableWalkRecvReqRetry(), TraceCPU::FixedRetryGen::tryNext(), LSQUnit< Impl >::trySendPacket(), DmaPort::trySendTimingReq(), Minor::Fetch1::tryToSend(), Minor::LSQ::tryToSend(), and BaseTrafficGen::update().

◆ sendTimingSnoopResp()

bool RequestPort::sendTimingSnoopResp ( PacketPtr pkt )

inline

Attempt to send a timing snoop response packet to the response port by calling its corresponding receive function.

If the send does not succeed, as indicated by the return value, then the sender must wait for a recvRetrySnoop at which point it can re-issue a sendTimingSnoopResp.

Parameters

pkt	Packet to send.

Definition at line 512 of file port.hh.

References _responsePort, Port::reportUnbound(), and TimingRequestProtocol::sendSnoopResp().

Referenced by MemCheckerMonitor::recvTimingSnoopResp(), AddrMapper::recvTimingSnoopResp(), CommMonitor::recvTimingSnoopResp(), and SnoopRespPacketQueue::sendTiming().

◆ tryTiming()

bool RequestPort::tryTiming ( PacketPtr pkt ) const

inline

Check if the responder can handle a timing request.

If the send cannot be handled at the moment, as indicated by the return value, then the sender will receive a recvReqRetry at which point it can re-issue a sendTimingReq.

Parameters

pkt	Packet to send.

Returns: If the send was successful or not.

Definition at line 502 of file port.hh.

References _responsePort, Port::reportUnbound(), and TimingRequestProtocol::trySend().

Referenced by CommMonitor::tryTiming().

◆ unbind()

void RequestPort::unbind ( )

overridevirtual

Unbind this request port and the associated response port.

Reimplemented from Port.

Reimplemented in TokenRequestPort.

Definition at line 138 of file port.cc.

References _responsePort, Port::isConnected(), Port::name(), panic_if, ResponsePort::responderUnbind(), and Port::unbind().

Friends And Related Function Documentation

◆ ResponsePort

friend class ResponsePort

friend

Definition at line 77 of file port.hh.

Member Data Documentation

◆ _responsePort

ResponsePort* RequestPort::_responsePort

private

Definition at line 80 of file port.hh.

Referenced by bind(), getAddrRanges(), sendAtomic(), sendAtomicBackdoor(), sendFunctional(), sendRetryResp(), sendTimingReq(), sendTimingSnoopResp(), tryTiming(), and unbind().

◆ owner

SimObject& RequestPort::owner

protected

Definition at line 83 of file port.hh.

Referenced by AtomicSimpleCPU::AtomicCPUDPort::recvAtomicSnoop().

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

mem/port.hh
mem/port.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ RequestPort()

◆ ~RequestPort()

Member Function Documentation

◆ bind()

◆ getAddrRanges()

◆ isSnooping()

◆ printAddr()

◆ recvAtomicSnoop()

◆ recvFunctionalSnoop()

◆ recvRangeChange()

◆ recvRetrySnoopResp()

◆ recvTimingSnoopReq()

◆ sendAtomic()

◆ sendAtomicBackdoor()

◆ sendFunctional()

◆ sendRetryResp()

◆ sendTimingReq()

◆ sendTimingSnoopResp()

◆ tryTiming()

◆ unbind()

Friends And Related Function Documentation

◆ ResponsePort

Member Data Documentation

◆ _responsePort

◆ owner