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

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 gem5::RequestPort:
gem5::Port gem5::AtomicRequestProtocol gem5::TimingRequestProtocol gem5::FunctionalRequestProtocol gem5::AddrMapper::MapperRequestPort gem5::AtomicSimpleCPU::AtomicCPUPort gem5::BaseKvmCPU::KVMCpuPort gem5::BaseTrafficGen::TrafficGenPort gem5::Bridge::BridgeRequestPort gem5::CoherentXBar::CoherentXBarRequestPort gem5::CoherentXBar::SnoopRespPort gem5::CommMonitor::MonitorRequestPort gem5::ComputeUnit::DataPort gem5::ComputeUnit::DTLBPort gem5::ComputeUnit::ITLBPort gem5::ComputeUnit::LDSPort gem5::ComputeUnit::ScalarDataPort gem5::ComputeUnit::ScalarDTLBPort gem5::ComputeUnit::SQCPort gem5::DmaPort gem5::ExternalMaster::ExternalPort gem5::GarnetSyntheticTraffic::CpuPort gem5::Gicv3Its::DataPort gem5::MasterPort gem5::MemCheckerMonitor::MonitorRequestPort gem5::MemTest::CpuPort gem5::MinorCPU::MinorCPUPort gem5::NoncoherentXBar::NoncoherentXBarRequestPort gem5::o3::Fetch::IcachePort gem5::o3::LSQ::DcachePort gem5::ProtocolTester::SeqPort gem5::QueuedRequestPort gem5::RiscvISA::Walker::WalkerPort gem5::ruby::AbstractController::MemoryPort gem5::RubyDirectedTester::CpuPort gem5::RubyTester::CpuPort gem5::SerialLink::SerialLinkRequestPort gem5::SimpleCache::MemSidePort gem5::SimpleMemobj::MemSidePort gem5::SMMURequestPort gem5::SMMUTableWalkPort gem5::System::SystemPort gem5::TimingSimpleCPU::TimingCPUPort gem5::TLBCoalescer::MemSidePort gem5::TokenRequestPort gem5::TraceCPU::DcachePort gem5::TraceCPU::IcachePort gem5::X86ISA::GpuTLB::MemSidePort gem5::X86ISA::Walker::WalkerPort sc_gem5::TlmToGem5Bridge< BITWIDTH >::BridgeRequestPort

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 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 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 gem5::Port
void reportUnbound () const
 
 Port (const std::string &_name, PortID _id)
 Abstract base class for ports. More...
 
- 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. 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 gem5::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 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. More...
 

Protected Attributes

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

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 77 of file port.hh.

Constructor & Destructor Documentation

◆ RequestPort()

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

Request port.

Definition at line 117 of file port.cc.

◆ ~RequestPort()

gem5::RequestPort::~RequestPort ( )
virtual

Definition at line 123 of file port.cc.

Member Function Documentation

◆ bind()

void gem5::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 gem5::Port.

Reimplemented in gem5::TokenRequestPort.

Definition at line 128 of file port.cc.

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

Referenced by gem5::TokenRequestPort::bind().

◆ getAddrRanges()

AddrRangeList gem5::RequestPort::getAddrRanges ( ) const

◆ isSnooping()

virtual bool gem5::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 gem5::CoherentXBar::CoherentXBarRequestPort, gem5::AddrMapper::MapperRequestPort, gem5::minor::LSQ::DcachePort, gem5::MemDelay::RequestPort, gem5::TraceCPU::DcachePort, gem5::TimingSimpleCPU::DcachePort, gem5::BaseCache::CacheRequestPort, gem5::o3::LSQ::DcachePort, gem5::CommMonitor::MonitorRequestPort, gem5::AtomicSimpleCPU::AtomicCPUDPort, and gem5::MemCheckerMonitor::MonitorRequestPort.

Definition at line 113 of file port.hh.

Referenced by gem5::ResponsePort::isSnooping().

◆ printAddr()

void gem5::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 157 of file port.cc.

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

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

◆ recvAtomicSnoop()

Tick gem5::RequestPort::recvAtomicSnoop ( PacketPtr  pkt)
inlineoverrideprotectedvirtual

Default implementations.

Implements gem5::AtomicRequestProtocol.

Definition at line 226 of file port.hh.

References gem5::Port::name(), and panic.

◆ recvFunctionalSnoop()

void gem5::RequestPort::recvFunctionalSnoop ( PacketPtr  pkt)
inlineoverrideprotectedvirtual

Receive a functional snoop request packet from the peer.

Implements gem5::FunctionalRequestProtocol.

Definition at line 233 of file port.hh.

References gem5::Port::name(), and panic.

◆ recvRangeChange()

virtual void gem5::RequestPort::recvRangeChange ( )
inlineprotectedvirtual

◆ recvRetrySnoopResp()

void gem5::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 gem5::TimingRequestProtocol.

Reimplemented in gem5::QueuedRequestPort.

Definition at line 245 of file port.hh.

References gem5::Port::name(), and panic.

◆ recvTimingSnoopReq()

void gem5::RequestPort::recvTimingSnoopReq ( PacketPtr  pkt)
inlineoverrideprotectedvirtual

Receive a timing snoop request from the peer.

Implements gem5::TimingRequestProtocol.

Definition at line 239 of file port.hh.

References gem5::Port::name(), and panic.

◆ sendAtomic()

Tick gem5::RequestPort::sendAtomic ( PacketPtr  pkt)
inline

◆ sendAtomicBackdoor()

Tick gem5::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
pktPacket to send.
backdoorCan 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 474 of file port.hh.

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

Referenced by gem5::DmaPort::sendAtomicBdReq(), and gem5::NonCachingSimpleCPU::sendPacket().

◆ sendFunctional()

void gem5::RequestPort::sendFunctional ( PacketPtr  pkt) const
inline

◆ sendRetryResp()

void gem5::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 gem5::CoherentXBar::SnoopRespPort.

Definition at line 525 of file port.hh.

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

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

◆ sendTimingReq()

bool gem5::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
pktPacket to send.
Returns
If the send was succesful or not.

Definition at line 495 of file port.hh.

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

Referenced by gem5::GarnetSyntheticTraffic::doRetry(), gem5::TraceCPU::ElasticDataGen::execute(), gem5::TraceCPU::ElasticDataGen::executeMemReq(), gem5::FetchUnit::fetch(), gem5::o3::Fetch::finishTranslation(), gem5::TimingSimpleCPU::handleReadPacket(), gem5::TimingSimpleCPU::handleWritePacket(), gem5::o3::CPU::htmSendAbortSignal(), gem5::InvalidateGenerator::initiate(), gem5::SeriesRequestGenerator::initiate(), gem5::Check::initiateAction(), gem5::Check::initiateCheck(), gem5::FetchUnit::initiateFetch(), gem5::Check::initiateFlush(), gem5::Check::initiatePrefetch(), gem5::GpuWavefront::issueAcquireOp(), gem5::GpuWavefront::issueAtomicOps(), gem5::DmaThread::issueLoadOps(), gem5::GpuWavefront::issueLoadOps(), gem5::DmaThread::issueStoreOps(), gem5::GpuWavefront::issueStoreOps(), gem5::ComputeUnit::ScalarDataPort::MemReqEvent::process(), gem5::Gicv3Its::recvReqRetry(), gem5::SMMUv3::recvReqRetry(), gem5::TimingSimpleCPU::IcachePort::recvReqRetry(), gem5::o3::Fetch::recvReqRetry(), gem5::TimingSimpleCPU::DcachePort::recvReqRetry(), gem5::ComputeUnit::LDSPort::recvReqRetry(), gem5::MemTest::recvRetry(), gem5::Cache::recvTimingReq(), gem5::MemCheckerMonitor::recvTimingReq(), gem5::AddrMapper::recvTimingReq(), gem5::CommMonitor::recvTimingReq(), gem5::BaseTrafficGen::retryReq(), gem5::SMMUv3::runProcessTiming(), gem5::Gicv3Its::runProcessTiming(), gem5::TraceCPU::FixedRetryGen::send(), gem5::TimingSimpleCPU::sendFetch(), gem5::BaseCache::sendMSHRQueuePacket(), gem5::GarnetSyntheticTraffic::sendPkt(), gem5::MemTest::sendPkt(), gem5::ComputeUnit::sendScalarRequest(), gem5::X86ISA::Walker::sendTiming(), gem5::RiscvISA::Walker::sendTiming(), gem5::ReqPacketQueue::sendTiming(), gem5::ComputeUnit::LDSPort::sendTimingReq(), gem5::BaseCache::sendWriteQueuePacket(), gem5::ruby::AbstractController::serviceMemoryQueue(), gem5::SMMUv3::tableWalkRecvReqRetry(), gem5::TraceCPU::FixedRetryGen::tryNext(), gem5::o3::LSQUnit::trySendPacket(), gem5::DmaPort::trySendTimingReq(), gem5::minor::Fetch1::tryToSend(), gem5::minor::LSQ::tryToSend(), and gem5::BaseTrafficGen::update().

◆ sendTimingSnoopResp()

bool gem5::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
pktPacket to send.

Definition at line 515 of file port.hh.

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

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

◆ tryTiming()

bool gem5::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
pktPacket to send.
Returns
If the send was successful or not.

Definition at line 505 of file port.hh.

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

Referenced by gem5::CommMonitor::tryTiming().

◆ unbind()

void gem5::RequestPort::unbind ( )
overridevirtual

Unbind this request port and the associated response port.

Reimplemented from gem5::Port.

Reimplemented in gem5::TokenRequestPort.

Definition at line 141 of file port.cc.

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

Friends And Related Function Documentation

◆ ResponsePort

friend class ResponsePort
friend

Definition at line 80 of file port.hh.

Member Data Documentation

◆ _responsePort

ResponsePort* gem5::RequestPort::_responsePort
private

◆ owner

SimObject& gem5::RequestPort::owner
protected

Definition at line 86 of file port.hh.

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


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

Generated on Tue Sep 21 2021 12:28:04 for gem5 by doxygen 1.8.17