gem5 v23.0.0.0
|
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>
Public Member Functions | |
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. | |
virtual bool | isSnooping () const |
Determine if this request port is snooping or not. | |
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. | |
![]() | |
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. | |
virtual void | bind (Port &peer) |
Attach to a peer port. | |
virtual void | unbind () |
Dettach from a peer port. | |
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 | 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. | |
![]() | |
void | reportUnbound () const |
Port (const std::string &_name, PortID _id) | |
Abstract base class for ports. | |
![]() | |
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. | |
virtual Tick | recvAtomicSnoop (PacketPtr pkt)=0 |
Receive an atomic snoop request packet from our peer. | |
![]() | |
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. | |
virtual bool | recvTimingResp (PacketPtr pkt)=0 |
Receive a timing response from the peer. | |
virtual void | recvTimingSnoopReq (PacketPtr pkt)=0 |
Receive a timing snoop request from the peer. | |
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. | |
virtual void | recvRetrySnoopResp ()=0 |
Called by the peer if sendTimingSnoopResp was called on this protocol (causing recvTimingSnoopResp to be called on the peer) and was unsuccessful. | |
![]() | |
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. | |
virtual void | recvFunctionalSnoop (PacketPtr pkt)=0 |
Receive a functional snoop request packet from the peer. | |
void | sendMemBackdoorReq (FunctionalResponseProtocol *peer, const MemBackdoorReq &req, MemBackdoorPtr &backdoor) |
Send a request for a back door to a range of memory. | |
Protected Attributes | |
SimObject & | owner |
![]() | |
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. | |
Private Attributes | |
ResponsePort * | _responsePort |
Friends | |
class | ResponsePort |
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.
gem5::RequestPort::RequestPort | ( | const std::string & | name, |
SimObject * | _owner, | ||
PortID | id = InvalidPortID |
||
) |
gem5::RequestPort::RequestPort | ( | const std::string & | name, |
PortID | id = InvalidPortID |
||
) |
|
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 148 of file port.cc.
References _responsePort, gem5::Port::bind(), fatal_if, gem5::Port::name(), and gem5::ResponsePort::responderBind().
Referenced by gem5::TokenRequestPort::bind().
AddrRangeList gem5::RequestPort::getAddrRanges | ( | ) | const |
Get the address ranges of the connected responder port.
Definition at line 171 of file port.cc.
References _responsePort, and gem5::ResponsePort::getAddrRanges().
Referenced by gem5::SimpleCache::getAddrRanges(), gem5::SimpleMemobj::getAddrRanges(), gem5::CommMonitor::getAddrRanges(), gem5::MemCheckerMonitor::getAddrRanges(), gem5::MemDelay::ResponsePort::getAddrRanges(), and gem5::SysBridge::SysBridgeSourcePort::getAddrRanges().
|
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.
Reimplemented in gem5::o3::LSQ::DcachePort, gem5::AtomicSimpleCPU::AtomicCPUDPort, gem5::TimingSimpleCPU::DcachePort, gem5::TraceCPU::DcachePort, gem5::BaseCache::CacheRequestPort, gem5::CommMonitor::MonitorRequestPort, gem5::MemCheckerMonitor::MonitorRequestPort, gem5::minor::LSQ::DcachePort, gem5::AddrMapper::MapperRequestPort, gem5::CoherentXBar::CoherentXBarRequestPort, and gem5::MemDelay::RequestPort.
Definition at line 118 of file port.hh.
Referenced by gem5::ResponsePort::isSnooping().
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 177 of file port.cc.
References gem5::ArmISA::a, gem5::Request::funcRequestorId, gem5::MemCmd::PrintReq, gem5::Packet::senderState, and sendFunctional().
Referenced by gem5::AtomicSimpleCPU::printAddr(), gem5::TimingSimpleCPU::printAddr(), and gem5::GarnetSyntheticTraffic::printAddr().
Default implementations.
Implements gem5::AtomicRequestProtocol.
Reimplemented in gem5::BaseTrafficGen::TrafficGenPort, and gem5::SysBridge::SysBridgeTargetPort.
Definition at line 246 of file port.hh.
References gem5::Port::name(), and panic.
|
inlineoverrideprotectedvirtual |
Receive a functional snoop request packet from the peer.
Implements gem5::FunctionalRequestProtocol.
Reimplemented in gem5::BaseTrafficGen::TrafficGenPort, and gem5::SysBridge::SysBridgeTargetPort.
Definition at line 253 of file port.hh.
References gem5::Port::name(), and panic.
|
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 gem5::X86ISA::GpuTLB::MemSidePort, gem5::TLBCoalescer::MemSidePort, gem5::VegaISA::GpuTLB::MemSidePort, gem5::VegaTLBCoalescer::MemSidePort, gem5::ComputeUnit::DataPort, gem5::ComputeUnit::SQCPort, gem5::ComputeUnit::DTLBPort, gem5::ComputeUnit::ITLBPort, gem5::ComputeUnit::LDSPort, gem5::CommMonitor::MonitorRequestPort, gem5::MemCheckerMonitor::MonitorRequestPort, gem5::ruby::RubyPort::MemRequestPort, gem5::ruby::RubyPort::PioRequestPort, gem5::SimpleCache::MemSidePort, gem5::SimpleMemobj::MemSidePort, gem5::AddrMapper::MapperRequestPort, gem5::CoherentXBar::CoherentXBarRequestPort, gem5::MemDelay::RequestPort, gem5::NoncoherentXBar::NoncoherentXBarRequestPort, gem5::PortTerminator::ReqPort, gem5::RequestPortWrapper, gem5::SysBridge::SysBridgeTargetPort, gem5::ThreadBridge::OutgoingPort, and sc_gem5::TlmToGem5Bridge< BITWIDTH >::BridgeRequestPort.
Definition at line 240 of file port.hh.
Referenced by gem5::RequestPortWrapper::recvRangeChange(), and gem5::ResponsePort::sendRangeChange().
|
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::SysBridge::SysBridgeTargetPort.
Definition at line 265 of file port.hh.
References gem5::Port::name(), and panic.
|
inlineoverrideprotectedvirtual |
Receive a timing snoop request from the peer.
Implements gem5::TimingRequestProtocol.
Reimplemented in gem5::BaseTrafficGen::TrafficGenPort, and gem5::SysBridge::SysBridgeTargetPort.
Definition at line 259 of file port.hh.
References gem5::Port::name(), and panic.
Send an atomic request packet, where the data is moved and the state is updated in zero time, without interleaving with other memory accesses.
pkt | Packet to send. |
Definition at line 487 of file port.hh.
References _responsePort, gem5::Port::reportUnbound(), and gem5::AtomicRequestProtocol::send().
Referenced by gem5::Cache::doWritebacksAtomic(), gem5::NoncoherentCache::doWritebacksAtomic(), gem5::Cache::handleAtomicReqMiss(), gem5::NoncoherentCache::handleAtomicReqMiss(), gem5::ArmISA::TableWalker::readDataUntimed(), gem5::AddrMapper::recvAtomic(), gem5::CommMonitor::recvAtomic(), gem5::ruby::AbstractController::recvAtomic(), gem5::SerialLink::SerialLinkResponsePort::recvAtomic(), gem5::Bridge::BridgeResponsePort::recvAtomic(), gem5::Cache::recvAtomic(), gem5::SysBridge::SysBridgeSourcePort::recvAtomic(), gem5::Gicv3Its::runProcessAtomic(), gem5::SMMUv3::runProcessAtomic(), gem5::DmaPort::sendAtomicReq(), gem5::X86ISA::IntRequestPort< Device >::sendMessage(), gem5::AtomicSimpleCPU::sendPacket(), and gem5::MemTest::sendPkt().
|
inline |
Send an atomic request packet like above, but also request a backdoor to the data being accessed.
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. |
Definition at line 497 of file port.hh.
References _responsePort, gem5::Port::reportUnbound(), and gem5::AtomicRequestProtocol::sendBackdoor().
Referenced by gem5::Bridge::BridgeResponsePort::recvAtomicBackdoor(), gem5::SysBridge::SysBridgeSourcePort::recvAtomicBackdoor(), gem5::DmaPort::sendAtomicBdReq(), and gem5::NonCachingSimpleCPU::sendPacket().
|
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.
pkt | Packet to send. |
Definition at line 508 of file port.hh.
References _responsePort, gem5::Port::reportUnbound(), and gem5::FunctionalRequestProtocol::send().
Referenced by gem5::FetchUnit::fetch(), gem5::BaseCache::functionalAccess(), gem5::ruby::AbstractController::functionalMemoryRead(), gem5::ruby::AbstractController::functionalMemoryWrite(), gem5::SimpleCache::handleFunctional(), gem5::SimpleMemobj::handleFunctional(), gem5::FetchUnit::initiateFetch(), printAddr(), gem5::ArmISA::TableWalker::readDataUntimed(), gem5::CheckerCPU::readMem(), gem5::AddrMapper::recvFunctional(), gem5::CommMonitor::recvFunctional(), gem5::MemCheckerMonitor::recvFunctional(), gem5::SerialLink::SerialLinkResponsePort::recvFunctional(), gem5::Bridge::BridgeResponsePort::recvFunctional(), gem5::SysBridge::SysBridgeSourcePort::recvFunctional(), gem5::ruby::AbstractController::serviceMemoryQueue(), gem5::MemTest::tick(), and gem5::BaseCache::writebackVisitor().
|
inline |
Send a request for a back door to a range of memory.
req | An object which describes what back door is being requested. |
backdoor | Can be set to a back door pointer by the target to let caller have direct access to the requested range. The original caller should initialize this pointer to nullptr. If a receiver does not want to provide a back door, they should leave this value. If an intermediary wants to support a back door across it, it should pass this pointer through, or if not, return without passing the request further downstream. |
Definition at line 518 of file port.hh.
References _responsePort, gem5::Port::reportUnbound(), and gem5::FunctionalRequestProtocol::sendMemBackdoorReq().
Referenced by gem5::Bridge::BridgeResponsePort::recvMemBackdoorReq(), and gem5::SysBridge::SysBridgeSourcePort::recvMemBackdoorReq().
|
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 560 of file port.hh.
References _responsePort, gem5::Port::reportUnbound(), and gem5::TimingRequestProtocol::sendRetryResp().
Referenced by gem5::AddrMapper::recvRespRetry(), gem5::CommMonitor::recvRespRetry(), gem5::MemCheckerMonitor::recvRespRetry(), gem5::SysBridge::SysBridgeSourcePort::recvRespRetry(), gem5::BaseXBar::RespLayer::sendRetry(), and gem5::TimingSimpleCPU::TimingCPUPort::TimingCPUPort().
|
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.
pkt | Packet to send. |
Definition at line 530 of file port.hh.
References _responsePort, gem5::Port::reportUnbound(), and gem5::TimingRequestProtocol::sendReq().
Referenced by gem5::o3::LSQ::checkStaleTranslations(), 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::AMDGPUMemoryManager::readRequest(), gem5::o3::Fetch::recvReqRetry(), gem5::TimingSimpleCPU::IcachePort::recvReqRetry(), gem5::TimingSimpleCPU::DcachePort::recvReqRetry(), gem5::Gicv3Its::recvReqRetry(), gem5::SMMUv3::recvReqRetry(), gem5::ComputeUnit::LDSPort::recvReqRetry(), gem5::MemTest::recvRetry(), gem5::AddrMapper::recvTimingReq(), gem5::CommMonitor::recvTimingReq(), gem5::MemCheckerMonitor::recvTimingReq(), gem5::Cache::recvTimingReq(), gem5::SysBridge::SysBridgeSourcePort::recvTimingReq(), gem5::TimingSimpleCPU::DcachePort::recvTimingSnoopReq(), gem5::BaseTrafficGen::retryReq(), gem5::Gicv3Its::runProcessTiming(), gem5::SMMUv3::runProcessTiming(), gem5::TraceCPU::FixedRetryGen::send(), gem5::TimingSimpleCPU::sendFetch(), gem5::BaseCache::sendMSHRQueuePacket(), gem5::GarnetSyntheticTraffic::sendPkt(), gem5::MemTest::sendPkt(), gem5::ComputeUnit::sendScalarRequest(), gem5::ReqPacketQueue::sendTiming(), gem5::VegaISA::Walker::sendTiming(), gem5::RiscvISA::Walker::sendTiming(), gem5::X86ISA::Walker::sendTiming(), gem5::GUPSGen::GenPort::sendTimingPacket(), 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(), gem5::BaseTrafficGen::update(), and gem5::AMDGPUMemoryManager::writeRequest().
|
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.
pkt | Packet to send. |
Definition at line 550 of file port.hh.
References _responsePort, gem5::Port::reportUnbound(), and gem5::TimingRequestProtocol::sendSnoopResp().
Referenced by gem5::AddrMapper::recvTimingSnoopResp(), gem5::CommMonitor::recvTimingSnoopResp(), gem5::MemCheckerMonitor::recvTimingSnoopResp(), gem5::SysBridge::SysBridgeSourcePort::recvTimingSnoopResp(), and gem5::SnoopRespPacketQueue::sendTiming().
|
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.
pkt | Packet to send. |
Definition at line 540 of file port.hh.
References _responsePort, gem5::Port::reportUnbound(), and gem5::TimingRequestProtocol::trySend().
Referenced by gem5::CommMonitor::tryTiming(), and gem5::SysBridge::SysBridgeSourcePort::tryTiming().
|
overridevirtual |
Unbind this request port and the associated response port.
Reimplemented from gem5::Port.
Reimplemented in gem5::TokenRequestPort.
Definition at line 161 of file port.cc.
References _responsePort, gem5::Port::isConnected(), gem5::Port::name(), panic_if, gem5::ResponsePort::responderUnbind(), and gem5::Port::unbind().
|
friend |
|
private |
Definition at line 83 of file port.hh.
Referenced by bind(), getAddrRanges(), sendAtomic(), sendAtomicBackdoor(), sendFunctional(), sendMemBackdoorReq(), sendRetryResp(), sendTimingReq(), sendTimingSnoopResp(), tryTiming(), and unbind().