gem5 v24.1.0.1
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Types | Public Member Functions | Private Member Functions | List of all members
gem5::ruby::VIPERSequencer Class Reference

#include <VIPERSequencer.hh>

Inheritance diagram for gem5::ruby::VIPERSequencer:
gem5::ruby::Sequencer gem5::ruby::RubyPort gem5::ClockedObject gem5::SimObject gem5::Clocked gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named

Public Types

typedef VIPERSequencerParams Params
 
- Public Types inherited from gem5::ruby::Sequencer
typedef RubySequencerParams Params
 
- Public Types inherited from gem5::ruby::RubyPort
typedef RubyPortParams Params
 
- Public Types inherited from gem5::ClockedObject
using Params = ClockedObjectParams
 Parameters of ClockedObject.
 
- Public Types inherited from gem5::SimObject
typedef SimObjectParams Params
 

Public Member Functions

 VIPERSequencer (const Params &p)
 
 ~VIPERSequencer ()
 
- Public Member Functions inherited from gem5::ruby::Sequencer
 Sequencer (const Params &)
 
 ~Sequencer ()
 
void writeCallbackScFail (Addr address, DataBlock &data)
 Proxy function to writeCallback that first invalidates the line address in the local monitor.
 
virtual void wakeup ()
 
void resetStats () override
 Callback to reset stats.
 
void collateStats ()
 
void writeCallback (Addr address, DataBlock &data, const bool externalHit=false, const MachineType mach=MachineType_NUM, const Cycles initialRequestTime=Cycles(0), const Cycles forwardRequestTime=Cycles(0), const Cycles firstResponseTime=Cycles(0), const bool noCoales=false)
 
void writeUniqueCallback (Addr address, DataBlock &data)
 
void readCallback (Addr address, DataBlock &data, const bool externalHit=false, const MachineType mach=MachineType_NUM, const Cycles initialRequestTime=Cycles(0), const Cycles forwardRequestTime=Cycles(0), const Cycles firstResponseTime=Cycles(0))
 
void atomicCallback (Addr address, DataBlock &data, const bool externalHit=false, const MachineType mach=MachineType_NUM, const Cycles initialRequestTime=Cycles(0), const Cycles forwardRequestTime=Cycles(0), const Cycles firstResponseTime=Cycles(0))
 
void unaddressedCallback (Addr unaddressedReqId, RubyRequestType requestType, const MachineType mach=MachineType_NUM, const Cycles initialRequestTime=Cycles(0), const Cycles forwardRequestTime=Cycles(0), const Cycles firstResponseTime=Cycles(0))
 
void completeHitCallback (std::vector< PacketPtr > &list)
 
void invL1Callback ()
 
void invL1 ()
 
RequestStatus makeRequest (PacketPtr pkt) override
 
virtual bool empty () const
 
int outstandingCount () const override
 
bool isDeadlockEventScheduled () const override
 
void descheduleDeadlockEvent () override
 
virtual void print (std::ostream &out) const
 
void markRemoved ()
 
void evictionCallback (Addr address)
 
int coreId () const
 
virtual int functionalWrite (Packet *func_pkt) override
 
void recordRequestType (SequencerRequestType requestType)
 
statistics::HistogramgetOutstandReqHist ()
 
statistics::HistogramgetLatencyHist ()
 
statistics::HistogramgetTypeLatencyHist (uint32_t t)
 
statistics::HistogramgetHitLatencyHist ()
 
statistics::HistogramgetHitTypeLatencyHist (uint32_t t)
 
statistics::HistogramgetHitMachLatencyHist (uint32_t t)
 
statistics::HistogramgetHitTypeMachLatencyHist (uint32_t r, uint32_t t)
 
statistics::HistogramgetMissLatencyHist ()
 
statistics::HistogramgetMissTypeLatencyHist (uint32_t t)
 
statistics::HistogramgetMissMachLatencyHist (uint32_t t) const
 
statistics::HistogramgetMissTypeMachLatencyHist (uint32_t r, uint32_t t) const
 
statistics::HistogramgetIssueToInitialDelayHist (uint32_t t) const
 
statistics::HistogramgetInitialToForwardDelayHist (const MachineType t) const
 
statistics::HistogramgetForwardRequestToFirstResponseHist (const MachineType t) const
 
statistics::HistogramgetFirstResponseToCompletionDelayHist (const MachineType t) const
 
statistics::Counter getIncompleteTimes (const MachineType t) const
 
bool llscCheckMonitor (const Addr)
 Searches for cache line address in the global monitor tagged with this Sequencer object's version id.
 
void llscClearLocalMonitor ()
 Removes all addresses from the local monitor.
 
- Public Member Functions inherited from gem5::ruby::RubyPort
 RubyPort (const Params &p)
 
virtual ~RubyPort ()
 
void init () override
 init() is called after all C++ SimObjects have been created and all ports are connected.
 
PortgetPort (const std::string &if_name, PortID idx=InvalidPortID) override
 Get a port with a given name and index.
 
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 ()
 
Addr getOffset (Addr addr) const
 
Addr makeLineAddress (Addr addr) const
 
std::string printAddress (Addr addr) const
 
- Public Member Functions inherited from gem5::ClockedObject
 ClockedObject (const ClockedObjectParams &p)
 
void serialize (CheckpointOut &cp) const override
 Serialize an object.
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object.
 
- Public Member Functions inherited from gem5::SimObject
const Paramsparams () 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.
 
ProbeManagergetProbeManager ()
 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.
 
- Public Member Functions inherited from gem5::EventManager
EventQueueeventQueue () 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)
 
- Public Member Functions inherited from gem5::Serializable
 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)
 
- Public Member Functions inherited from gem5::Drainable
DrainState drainState () const
 Return the current drain state of an object.
 
virtual void notifyFork ()
 Notify a child process of a fork.
 
- Public Member Functions inherited from gem5::statistics::Group
 Group (Group *parent, const char *name=nullptr)
 Construct a new statistics group.
 
virtual ~Group ()
 
virtual void regStats ()
 Callback to set stat parameters.
 
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 InforesolveStat (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
 
Groupoperator= (const Group &)=delete
 
- Public Member Functions inherited from gem5::Named
 Named (const std::string &name_)
 
virtual ~Named ()=default
 
virtual std::string name () const
 
- Public Member Functions inherited from gem5::Clocked
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
 

Private Member Functions

void hitCallback (SequencerRequest *srequest, DataBlock &data, bool llscSuccess, const MachineType mach, const bool externalHit, const Cycles initialRequestTime, const Cycles forwardRequestTime, const Cycles firstResponseTime, const bool was_coalesced)
 
bool processReadCallback (SequencerRequest &seq_req, DataBlock &data, const bool rubyRequest, bool externalHit, const MachineType mach, Cycles initialRequestTime, Cycles forwardRequestTime, Cycles firstResponseTime)
 

Additional Inherited Members

- Static Public Member Functions inherited from gem5::SimObject
static void serializeAll (const std::string &cpt_dir)
 Create a checkpoint by serializing all SimObjects in the system.
 
static SimObjectfind (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 SimObjectResolvergetSimObjectResolver ()
 There is a single object name resolver, and it is only set when simulation is restoring from checkpoints.
 
- Static Public Member Functions inherited from gem5::Serializable
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.
 
- Public Attributes inherited from gem5::ClockedObject
PowerStatepowerState
 
- Protected Member Functions inherited from gem5::ruby::Sequencer
void issueRequest (PacketPtr pkt, RubyRequestType type)
 
void recordMissLatency (SequencerRequest *srequest, bool llscSuccess, const MachineType respondingMach, bool isExternalHit, Cycles initialRequestTime, Cycles forwardRequestTime, Cycles firstResponseTime)
 
virtual RequestStatus insertRequest (PacketPtr pkt, RubyRequestType primary_type, RubyRequestType secondary_type)
 
- Protected Member Functions inherited from gem5::ruby::RubyPort
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.
 
- Protected Member Functions inherited from gem5::Drainable
 Drainable ()
 
virtual ~Drainable ()
 
virtual void drainResume ()
 Resume execution after a successful drain.
 
void signalDrainDone () const
 Signal that an object is drained.
 
- Protected Member Functions inherited from gem5::Clocked
 Clocked (ClockDomain &clk_domain)
 Create a clocked object and set the clock domain based on the parameters.
 
 Clocked (Clocked &)=delete
 
Clockedoperator= (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 inherited from gem5::ruby::Sequencer
std::unordered_map< Addr, std::list< SequencerRequest > > m_RequestTable
 
std::unordered_map< uint64_t, SequencerRequestm_UnaddressedRequestTable
 
Cycles m_deadlock_threshold
 
RubySystemm_ruby_system
 
- Protected Attributes inherited from gem5::ruby::RubyPort
RubySystemm_ruby_system
 
uint32_t m_version
 
AbstractControllerm_controller
 
MessageBufferm_mandatory_q_ptr
 
bool m_usingRubyTester
 
Systemsystem
 
std::vector< MemResponsePort * > response_ports
 
- Protected Attributes inherited from gem5::SimObject
const SimObjectParams & _params
 Cached copy of the object parameters.
 
- Protected Attributes inherited from gem5::EventManager
EventQueueeventq
 A pointer to this object's event queue.
 

Detailed Description

Definition at line 46 of file VIPERSequencer.hh.

Member Typedef Documentation

◆ Params

typedef VIPERSequencerParams gem5::ruby::VIPERSequencer::Params

Definition at line 49 of file VIPERSequencer.hh.

Constructor & Destructor Documentation

◆ VIPERSequencer()

gem5::ruby::VIPERSequencer::VIPERSequencer ( const Params p)

Definition at line 45 of file VIPERSequencer.cc.

◆ ~VIPERSequencer()

gem5::ruby::VIPERSequencer::~VIPERSequencer ( )

Definition at line 51 of file VIPERSequencer.cc.

Member Function Documentation

◆ hitCallback()

void gem5::ruby::VIPERSequencer::hitCallback ( SequencerRequest srequest,
DataBlock data,
bool  llscSuccess,
const MachineType  mach,
const bool  externalHit,
const Cycles  initialRequestTime,
const Cycles  forwardRequestTime,
const Cycles  firstResponseTime,
const bool  was_coalesced 
)
privatevirtual

◆ processReadCallback()

bool gem5::ruby::VIPERSequencer::processReadCallback ( SequencerRequest seq_req,
DataBlock data,
const bool  rubyRequest,
bool  externalHit,
const MachineType  mach,
Cycles  initialRequestTime,
Cycles  forwardRequestTime,
Cycles  firstResponseTime 
)
privatevirtual

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

Generated on Mon Jan 13 2025 04:29:13 for gem5 by doxygen 1.9.8