gem5 v24.1.0.1
|
#include <RubyPort.hh>
Classes | |
class | MemRequestPort |
class | MemResponsePort |
class | PioRequestPort |
class | PioResponsePort |
struct | SenderState |
Public Types | |
typedef RubyPortParams | Params |
![]() | |
using | Params = ClockedObjectParams |
Parameters of ClockedObject. | |
![]() | |
typedef SimObjectParams | Params |
Public Member Functions | |
RubyPort (const Params &p) | |
virtual | ~RubyPort () |
void | init () override |
init() is called after all C++ SimObjects have been created and all ports are connected. | |
Port & | getPort (const std::string &if_name, PortID idx=InvalidPortID) override |
Get a port with a given name and index. | |
virtual RequestStatus | makeRequest (PacketPtr pkt)=0 |
virtual int | outstandingCount () const =0 |
virtual bool | isDeadlockEventScheduled () const =0 |
virtual void | descheduleDeadlockEvent ()=0 |
void | setController (AbstractController *_cntrl) |
uint32_t | getId () |
DrainState | drain () override |
Draining is the process of clearing out the states of SimObjects.These are the SimObjects that are partially executed or are partially in flight. | |
bool | isCPUSequencer () |
virtual int | functionalWrite (Packet *func_pkt) |
Addr | getOffset (Addr addr) const |
Addr | makeLineAddress (Addr addr) const |
std::string | printAddress (Addr addr) const |
![]() | |
ClockedObject (const ClockedObjectParams &p) | |
void | serialize (CheckpointOut &cp) const override |
Serialize an object. | |
void | unserialize (CheckpointIn &cp) override |
Unserialize an object. | |
![]() | |
const Params & | params () const |
SimObject (const Params &p) | |
virtual | ~SimObject () |
virtual void | loadState (CheckpointIn &cp) |
loadState() is called on each SimObject when restoring from a checkpoint. | |
virtual void | initState () |
initState() is called on each SimObject when not restoring from a checkpoint. | |
virtual void | regProbePoints () |
Register probe points for this object. | |
virtual void | regProbeListeners () |
Register probe listeners for this object. | |
ProbeManager * | getProbeManager () |
Get the probe manager for this object. | |
virtual void | startup () |
startup() is the final initialization call before simulation. | |
DrainState | drain () override |
Provide a default implementation of the drain interface for objects that don't need draining. | |
virtual void | memWriteback () |
Write back dirty buffers to memory using functional writes. | |
virtual void | memInvalidate () |
Invalidate the contents of memory buffers. | |
void | serialize (CheckpointOut &cp) const override |
Serialize an object. | |
void | unserialize (CheckpointIn &cp) override |
Unserialize an object. | |
![]() | |
EventQueue * | eventQueue () const |
void | schedule (Event &event, Tick when) |
void | deschedule (Event &event) |
void | reschedule (Event &event, Tick when, bool always=false) |
void | schedule (Event *event, Tick when) |
void | deschedule (Event *event) |
void | reschedule (Event *event, Tick when, bool always=false) |
void | wakeupEventQueue (Tick when=(Tick) -1) |
This function is not needed by the usual gem5 event loop but may be necessary in derived EventQueues which host gem5 on other schedulers. | |
void | setCurTick (Tick newVal) |
EventManager (EventManager &em) | |
Event manger manages events in the event queue. | |
EventManager (EventManager *em) | |
EventManager (EventQueue *eq) | |
![]() | |
Serializable () | |
virtual | ~Serializable () |
void | serializeSection (CheckpointOut &cp, const char *name) const |
Serialize an object into a new section. | |
void | serializeSection (CheckpointOut &cp, const std::string &name) const |
void | unserializeSection (CheckpointIn &cp, const char *name) |
Unserialize an a child object. | |
void | unserializeSection (CheckpointIn &cp, const std::string &name) |
![]() | |
DrainState | drainState () const |
Return the current drain state of an object. | |
virtual void | notifyFork () |
Notify a child process of a fork. | |
![]() | |
Group (Group *parent, const char *name=nullptr) | |
Construct a new statistics group. | |
virtual | ~Group () |
virtual void | regStats () |
Callback to set stat parameters. | |
virtual void | resetStats () |
Callback to reset stats. | |
virtual void | preDumpStats () |
Callback before stats are dumped. | |
void | addStat (statistics::Info *info) |
Register a stat with this group. | |
const std::map< std::string, Group * > & | getStatGroups () const |
Get all child groups associated with this object. | |
const std::vector< Info * > & | getStats () const |
Get all stats associated with this object. | |
void | addStatGroup (const char *name, Group *block) |
Add a stat block as a child of this block. | |
const Info * | resolveStat (std::string name) const |
Resolve a stat by its name within this group. | |
void | mergeStatGroup (Group *block) |
Merge the contents (stats & children) of a block to this block. | |
Group (const Group &)=delete | |
Group & | operator= (const Group &)=delete |
![]() | |
Named (const std::string &name_) | |
virtual | ~Named ()=default |
virtual std::string | name () const |
![]() | |
void | updateClockPeriod () |
Update the tick to the current tick. | |
Tick | clockEdge (Cycles cycles=Cycles(0)) const |
Determine the tick when a cycle begins, by default the current one, but the argument also enables the caller to determine a future cycle. | |
Cycles | curCycle () const |
Determine the current cycle, corresponding to a tick aligned to a clock edge. | |
Tick | nextCycle () const |
Based on the clock of the object, determine the start tick of the first cycle that is at least one cycle in the future. | |
uint64_t | frequency () const |
Tick | clockPeriod () const |
double | voltage () const |
Cycles | ticksToCycles (Tick t) const |
Tick | cyclesToTicks (Cycles c) const |
Protected Member Functions | |
void | trySendRetries () |
void | ruby_hit_callback (PacketPtr pkt) |
void | ruby_unaddressed_callback (PacketPtr pkt) |
void | ruby_stale_translation_callback (Addr txnId) |
void | testDrainComplete () |
void | ruby_eviction_callback (Addr address) |
bool | recvTimingResp (PacketPtr pkt, PortID request_port_id) |
Called by the PIO port when receiving a timing response. | |
![]() | |
Drainable () | |
virtual | ~Drainable () |
virtual void | drainResume () |
Resume execution after a successful drain. | |
void | signalDrainDone () const |
Signal that an object is drained. | |
![]() | |
Clocked (ClockDomain &clk_domain) | |
Create a clocked object and set the clock domain based on the parameters. | |
Clocked (Clocked &)=delete | |
Clocked & | operator= (Clocked &)=delete |
virtual | ~Clocked () |
Virtual destructor due to inheritance. | |
void | resetClock () const |
Reset the object's clock using the current global tick value. | |
virtual void | clockPeriodUpdated () |
A hook subclasses can implement so they can do any extra work that's needed when the clock rate is changed. | |
Protected Attributes | |
RubySystem * | m_ruby_system |
uint32_t | m_version |
AbstractController * | m_controller |
MessageBuffer * | m_mandatory_q_ptr |
bool | m_usingRubyTester |
System * | system |
std::vector< MemResponsePort * > | response_ports |
![]() | |
const SimObjectParams & | _params |
Cached copy of the object parameters. | |
![]() | |
EventQueue * | eventq |
A pointer to this object's event queue. | |
Private Types | |
typedef std::vector< MemResponsePort * >::iterator | CpuPortIter |
Vector of M5 Ports attached to this Ruby port. | |
Private Member Functions | |
bool | onRetryList (MemResponsePort *port) |
void | addToRetryList (MemResponsePort *port) |
Private Attributes | |
PioRequestPort | pioRequestPort |
PioResponsePort | pioResponsePort |
MemRequestPort | memRequestPort |
MemResponsePort | memResponsePort |
unsigned int | gotAddrRanges |
std::vector< PioRequestPort * > | request_ports |
std::vector< MemResponsePort * > | retryList |
bool | m_isCPUSequencer |
Additional Inherited Members | |
![]() | |
static void | serializeAll (const std::string &cpt_dir) |
Create a checkpoint by serializing all SimObjects in the system. | |
static SimObject * | find (const char *name) |
Find the SimObject with the given name and return a pointer to it. | |
static void | setSimObjectResolver (SimObjectResolver *resolver) |
There is a single object name resolver, and it is only set when simulation is restoring from checkpoints. | |
static SimObjectResolver * | getSimObjectResolver () |
There is a single object name resolver, and it is only set when simulation is restoring from checkpoints. | |
![]() | |
static const std::string & | currentSection () |
Gets the fully-qualified name of the active section. | |
static void | generateCheckpointOut (const std::string &cpt_dir, std::ofstream &outstream) |
Generate a checkpoint file so that the serialization can be routed to it. | |
![]() | |
PowerState * | powerState |
Definition at line 64 of file RubyPort.hh.
|
private |
Vector of M5 Ports attached to this Ruby port.
Definition at line 235 of file RubyPort.hh.
typedef RubyPortParams gem5::ruby::RubyPort::Params |
Definition at line 158 of file RubyPort.hh.
gem5::ruby::RubyPort::RubyPort | ( | const Params & | p | ) |
Definition at line 61 of file RubyPort.cc.
References gem5::csprintf(), gem5::ArmISA::i, m_version, gem5::Named::name(), gem5::MipsISA::p, request_ports, and response_ports.
|
inlinevirtual |
Definition at line 160 of file RubyPort.hh.
|
inlineprivate |
Definition at line 222 of file RubyPort.hh.
References onRetryList(), and retryList.
Referenced by gem5::ruby::RubyPort::MemResponsePort::recvTimingReq().
|
pure virtual |
Implemented in gem5::ruby::RubyPortProxy, gem5::ruby::DMASequencer, gem5::ruby::GPUCoalescer, and gem5::ruby::Sequencer.
Referenced by drain().
|
overridevirtual |
Draining is the process of clearing out the states of SimObjects.These are the SimObjects that are partially executed or are partially in flight.
Draining is mostly used before forking and creating a check point.
This function notifies an object that it needs to drain its state.
If the object does not need further simulation to drain internal buffers, it returns DrainState::Drained and automatically switches to the Drained state. If the object needs more simulation, it returns DrainState::Draining and automatically enters the Draining state. Other return values are invalid.
Implements gem5::Drainable.
Definition at line 575 of file RubyPort.cc.
References descheduleDeadlockEvent(), DPRINTF, gem5::Drained, gem5::Draining, isDeadlockEventScheduled(), and outstandingCount().
|
virtual |
Reimplemented in gem5::ruby::Sequencer.
Definition at line 741 of file RubyPort.cc.
References response_ports.
Referenced by gem5::ruby::Sequencer::functionalWrite().
|
inline |
Definition at line 177 of file RubyPort.hh.
References m_version.
Referenced by gem5::ruby::UncoalescedTable::checkDeadlock().
Definition at line 753 of file RubyPort.cc.
References gem5::X86ISA::addr, gem5::ruby::RubySystem::getBlockSizeBits(), gem5::ruby::getOffset(), and m_ruby_system.
Referenced by gem5::ruby::GPUCoalescer::hitCallback(), gem5::ruby::Sequencer::hitCallback(), and gem5::ruby::Sequencer::issueRequest().
|
overridevirtual |
Get a port with a given name and index.
This is used at binding time and returns a reference to a protocol-agnostic port.
gem5 has a request and response port interface. All memory objects are connected together via ports. These ports provide a rigid interface between these memory objects. These ports implement three different memory system modes: timing, atomic, and functional. The most important mode is the timing mode and here timing mode is used for conducting cycle-level timing experiments. The other modes are only used in special circumstances and should not be used to conduct cycle-level timing experiments. The other modes are only used in special circumstances. These ports allow SimObjects to communicate with each other.
if_name | Port name |
idx | Index in the case of a VectorPort |
Reimplemented from gem5::SimObject.
Definition at line 104 of file RubyPort.cc.
References gem5::SimObject::getPort(), memRequestPort, memResponsePort, panic, pioRequestPort, pioResponsePort, request_ports, and response_ports.
Referenced by gem5::ruby::GPUCoalescer::getPort().
|
overridevirtual |
init() is called after all C++ SimObjects have been created and all ports are connected.
Initializations that are independent of unserialization but rely on a fully instantiated and connected SimObject graph should be done here.
Reimplemented from gem5::SimObject.
Reimplemented in gem5::ruby::RubyPortProxy.
Definition at line 92 of file RubyPort.cc.
References gem5::FullSystem, gem5::ruby::AbstractController::getMandatoryQueue(), gotAddrRanges, m_controller, m_mandatory_q_ptr, pioResponsePort, response_ports, and gem5::ResponsePort::sendRangeChange().
Referenced by gem5::ruby::DMASequencer::init().
|
inline |
Definition at line 180 of file RubyPort.hh.
References m_isCPUSequencer.
|
pure virtual |
Implemented in gem5::ruby::RubyPortProxy, gem5::ruby::DMASequencer, gem5::ruby::GPUCoalescer, and gem5::ruby::Sequencer.
Referenced by drain().
Definition at line 759 of file RubyPort.cc.
References gem5::X86ISA::addr, gem5::ruby::RubySystem::getBlockSizeBits(), m_ruby_system, and gem5::ruby::makeLineAddress().
Referenced by gem5::ruby::Sequencer::atomicCallback(), gem5::ruby::GPUCoalescer::atomicCallback(), gem5::ruby::GPUCoalescer::coalescePacket(), gem5::ruby::Sequencer::functionalWrite(), gem5::ruby::GPUCoalescer::hitCallback(), gem5::ruby::Sequencer::hitCallback(), gem5::ruby::Sequencer::insertRequest(), gem5::ruby::DMASequencer::issueNext(), gem5::ruby::Sequencer::llscCheckMonitor(), gem5::ruby::DMASequencer::makeRequest(), gem5::ruby::Sequencer::makeRequest(), gem5::ruby::Sequencer::readCallback(), gem5::ruby::GPUCoalescer::readCallback(), gem5::ruby::Sequencer::writeCallback(), and gem5::ruby::GPUCoalescer::writeCallback().
|
pure virtual |
|
inlineprivate |
|
pure virtual |
Implemented in gem5::ruby::RubyPortProxy, gem5::ruby::DMASequencer, gem5::ruby::GPUCoalescer, and gem5::ruby::Sequencer.
Referenced by drain(), and testDrainComplete().
std::string gem5::ruby::RubyPort::printAddress | ( | Addr | addr | ) | const |
Definition at line 765 of file RubyPort.cc.
References gem5::X86ISA::addr, gem5::ruby::RubySystem::getBlockSizeBits(), m_ruby_system, and gem5::ruby::printAddress().
Referenced by gem5::ruby::GPUCoalescer::hitCallback(), gem5::ruby::Sequencer::hitCallback(), gem5::ruby::Sequencer::issueRequest(), gem5::ruby::UncoalescedTable::printRequestTable(), gem5::ruby::GPUCoalescer::printRequestTable(), and gem5::ruby::Sequencer::recordMissLatency().
Called by the PIO port when receiving a timing response.
pkt | Response packet |
request_port_id | Port id of the PIO port |
|
protected |
Definition at line 707 of file RubyPort.cc.
References DPRINTF, gem5::Request::funcRequestorId, gem5::ruby::RubySystem::getBlockSizeBytes(), gem5::MemCmd::InvalidateReq, m_ruby_system, gem5::MipsISA::p, and response_ports.
Referenced by gem5::ruby::GPUCoalescer::evictionCallback(), and gem5::ruby::Sequencer::evictionCallback().
|
protected |
Definition at line 462 of file RubyPort.cc.
References gem5::Packet::cmdString(), DPRINTF, gem5::Packet::getAddr(), gem5::ruby::RubyPort::MemResponsePort::hitCallback(), gem5::System::isDeviceMemAddr(), gem5::System::isMemAddr(), gem5::Packet::isRequest(), gem5::Packet::popSenderState(), gem5::ruby::RubyPort::SenderState::port, gem5::Packet::req, system, and trySendRetries().
Referenced by gem5::ruby::DMASequencer::atomicCallback(), gem5::ruby::Sequencer::hitCallback(), gem5::ruby::VIPERSequencer::hitCallback(), gem5::ruby::DMASequencer::issueNext(), and gem5::ruby::GPUCoalescer::kernelCallback().
|
protected |
Definition at line 506 of file RubyPort.cc.
References DPRINTF, gem5::Request::funcRequestorId, gem5::ruby::RubySystem::getBlockSizeBytes(), m_ruby_system, response_ports, gem5::Request::TLBI_EXT_SYNC, and gem5::MemCmd::TlbiExtSync.
Referenced by gem5::ruby::Sequencer::unaddressedCallback().
|
protected |
Definition at line 487 of file RubyPort.cc.
References gem5::Packet::cmdString(), DPRINTF, gem5::ruby::RubyPort::MemResponsePort::hitCallback(), gem5::Packet::isRequest(), gem5::Packet::popSenderState(), gem5::ruby::RubyPort::SenderState::port, and trySendRetries().
Referenced by gem5::ruby::Sequencer::unaddressedCallback().
|
inline |
Definition at line 176 of file RubyPort.hh.
References m_controller.
|
protected |
Definition at line 561 of file RubyPort.cc.
References DPRINTF, gem5::Draining, gem5::Drainable::drainState(), outstandingCount(), and gem5::Drainable::signalDrainDone().
Referenced by gem5::ruby::Sequencer::completeHitCallback(), gem5::ruby::GPUCoalescer::completeHitCallback(), gem5::ruby::Sequencer::hitCallback(), gem5::ruby::VIPERSequencer::hitCallback(), gem5::ruby::HTMSequencer::htmCallback(), and gem5::ruby::Sequencer::unaddressedCallback().
|
protected |
Definition at line 535 of file RubyPort.cc.
References DPRINTF, gem5::ArmISA::i, gem5::Named::name(), and retryList.
Referenced by gem5::ruby::Sequencer::completeHitCallback(), gem5::ruby::GPUCoalescer::completeHitCallback(), ruby_hit_callback(), ruby_unaddressed_callback(), gem5::ruby::HTMSequencer::rubyHtmCallback(), and gem5::ruby::VIPERCoalescer::writeCompleteCallback().
|
private |
Definition at line 232 of file RubyPort.hh.
Referenced by init(), and gem5::ruby::RubyPort::PioRequestPort::recvRangeChange().
|
protected |
Definition at line 209 of file RubyPort.hh.
Referenced by gem5::ruby::Sequencer::hitCallback(), init(), gem5::ruby::Sequencer::invL1(), gem5::ruby::VIPERCoalescer::invTCC(), gem5::ruby::VIPERCoalescer::invTCP(), gem5::ruby::VIPERCoalescer::issueRequest(), gem5::ruby::Sequencer::issueRequest(), gem5::ruby::Sequencer::makeRequest(), setController(), and gem5::ruby::Sequencer::writeCallback().
|
private |
Definition at line 244 of file RubyPort.hh.
Referenced by isCPUSequencer().
|
protected |
Definition at line 210 of file RubyPort.hh.
Referenced by init(), gem5::ruby::Sequencer::invL1(), gem5::ruby::VIPERCoalescer::invTCC(), gem5::ruby::VIPERCoalescer::invTCP(), gem5::ruby::DMASequencer::issueNext(), gem5::ruby::VIPERCoalescer::issueRequest(), gem5::ruby::Sequencer::issueRequest(), gem5::ruby::DMASequencer::makeRequest(), and gem5::ruby::Sequencer::writeCallback().
|
protected |
Definition at line 207 of file RubyPort.hh.
Referenced by gem5::ruby::GPUCoalescer::completeHitCallback(), getOffset(), gem5::ruby::GPUCoalescer::getRubySystem(), gem5::ruby::GPUCoalescer::hitCallback(), gem5::ruby::DMASequencer::init(), gem5::ruby::VIPERCoalescer::invTCC(), gem5::ruby::VIPERCoalescer::invTCP(), gem5::ruby::DMASequencer::issueNext(), gem5::ruby::VIPERCoalescer::issueRequest(), makeLineAddress(), gem5::ruby::DMASequencer::makeRequest(), gem5::ruby::GPUCoalescer::makeRequest(), printAddress(), ruby_eviction_callback(), and ruby_stale_translation_callback().
|
protected |
Definition at line 211 of file RubyPort.hh.
Referenced by gem5::ruby::GPUCoalescer::coalescePacket(), gem5::ruby::Sequencer::hitCallback(), gem5::ruby::VIPERSequencer::hitCallback(), gem5::ruby::GPUCoalescer::makeRequest(), and gem5::ruby::GPUCoalescer::writeCompleteCallback().
|
protected |
Definition at line 208 of file RubyPort.hh.
Referenced by gem5::ruby::Sequencer::getCurrentUnaddressedTransactionID(), getId(), gem5::ruby::VIPERCoalescer::issueRequest(), gem5::ruby::Sequencer::issueRequest(), gem5::ruby::Sequencer::llscCheckMonitor(), gem5::ruby::Sequencer::llscClearLocalMonitor(), gem5::ruby::Sequencer::llscClearMonitor(), gem5::ruby::Sequencer::llscLoadLinked(), gem5::ruby::Sequencer::llscStoreConditional(), gem5::ruby::GPUCoalescer::print(), gem5::ruby::Sequencer::print(), gem5::ruby::HTMSequencer::print(), gem5::ruby::Sequencer::recordMissLatency(), RubyPort(), gem5::ruby::GPUCoalescer::wakeup(), gem5::ruby::Sequencer::wakeup(), and gem5::ruby::HTMSequencer::wakeup().
|
private |
Definition at line 230 of file RubyPort.hh.
Referenced by getPort().
|
private |
Definition at line 231 of file RubyPort.hh.
Referenced by getPort().
|
private |
Definition at line 228 of file RubyPort.hh.
Referenced by getPort().
|
private |
Definition at line 229 of file RubyPort.hh.
|
private |
Definition at line 236 of file RubyPort.hh.
Referenced by getPort(), and RubyPort().
|
protected |
Definition at line 214 of file RubyPort.hh.
Referenced by functionalWrite(), getPort(), init(), ruby_eviction_callback(), ruby_stale_translation_callback(), and RubyPort().
|
private |
Definition at line 242 of file RubyPort.hh.
Referenced by addToRetryList(), onRetryList(), and trySendRetries().
|
protected |
Definition at line 212 of file RubyPort.hh.
Referenced by ruby_hit_callback(), and gem5::ruby::HTMSequencer::rubyHtmCallback().