gem5  v21.1.0.2
Public Member Functions | Private Member Functions | Private Attributes | List of all members
gem5::ruby::HTMSequencer Class Reference

#include <HTMSequencer.hh>

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

Public Member Functions

 HTMSequencer (const RubyHTMSequencerParams &p)
 
 ~HTMSequencer ()
 
void htmCallback (Addr, const HtmCallbackMode, const HtmFailedInCacheReason)
 
bool empty () const override
 
void print (std::ostream &out) const override
 
void regStats () override
 Callback to set stat parameters. More...
 
void wakeup () override
 
- 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. More...
 
void resetStats () override
 Callback to reset stats. More...
 
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))
 
RequestStatus makeRequest (PacketPtr pkt) override
 
int outstandingCount () const override
 
bool isDeadlockEventScheduled () const override
 
void descheduleDeadlockEvent () override
 
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. More...
 
void llscClearLocalMonitor ()
 Removes all addresses from the local monitor. More...
 
- 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. More...
 
PortgetPort (const std::string &if_name, PortID idx=InvalidPortID) override
 Get a port with a given name and index. More...
 
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. More...
 
bool isCPUSequencer ()
 
- Public Member Functions inherited from gem5::ClockedObject
 ClockedObject (const ClockedObjectParams &p)
 
void serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 
- 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. More...
 
virtual void initState ()
 initState() is called on each SimObject when not restoring from a checkpoint. More...
 
virtual void regProbePoints ()
 Register probe points for this object. More...
 
virtual void regProbeListeners ()
 Register probe listeners for this object. More...
 
ProbeManagergetProbeManager ()
 Get the probe manager for this object. More...
 
virtual void startup ()
 startup() is the final initialization call before simulation. More...
 
DrainState drain () override
 Provide a default implementation of the drain interface for objects that don't need draining. More...
 
virtual void memWriteback ()
 Write back dirty buffers to memory using functional writes. More...
 
virtual void memInvalidate ()
 Invalidate the contents of memory buffers. More...
 
void serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 
- 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. More...
 
void setCurTick (Tick newVal)
 
 EventManager (EventManager &em)
 Event manger manages events in the event queue. More...
 
 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. More...
 
void serializeSection (CheckpointOut &cp, const std::string &name) const
 
void unserializeSection (CheckpointIn &cp, const char *name)
 Unserialize an a child object. More...
 
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. More...
 
virtual void notifyFork ()
 Notify a child process of a fork. More...
 
- Public Member Functions inherited from gem5::statistics::Group
 Group (Group *parent, const char *name=nullptr)
 Construct a new statistics group. More...
 
virtual ~Group ()
 
virtual void preDumpStats ()
 Callback before stats are dumped. More...
 
void addStat (statistics::Info *info)
 Register a stat with this group. More...
 
const std::map< std::string, Group * > & getStatGroups () const
 Get all child groups associated with this object. More...
 
const std::vector< Info * > & getStats () const
 Get all stats associated with this object. More...
 
void addStatGroup (const char *name, Group *block)
 Add a stat block as a child of this block. More...
 
const InforesolveStat (std::string name) const
 Resolve a stat by its name within this group. More...
 
void mergeStatGroup (Group *block)
 Merge the contents (stats & children) of a block to this block. More...
 
 Group ()=delete
 
 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. More...
 
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. More...
 
Cycles curCycle () const
 Determine the current cycle, corresponding to a tick aligned to a clock edge. More...
 
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. More...
 
uint64_t frequency () const
 
Tick clockPeriod () const
 
double voltage () const
 
Cycles ticksToCycles (Tick t) const
 
Tick cyclesToTicks (Cycles c) const
 

Private Member Functions

HtmCacheFailure htmRetCodeConversion (const HtmFailedInCacheReason rc)
 Htm return code conversion. More...
 
void rubyHtmCallback (PacketPtr pkt, const HtmFailedInCacheReason fail_r)
 
RequestStatus insertRequest (PacketPtr pkt, RubyRequestType primary_type, RubyRequestType secondary_type) override
 
 HTMSequencer (const HTMSequencer &obj)
 
HTMSequenceroperator= (const HTMSequencer &obj)
 

Private Attributes

std::deque< SequencerRequest * > m_htmCmdRequestTable
 
Tick m_htmstart_tick
 
Counter m_htmstart_instruction
 
statistics::Histogram m_htm_transaction_cycles
 Histogram of cycle latencies of HTM transactions. More...
 
statistics::Histogram m_htm_transaction_instructions
 Histogram of instruction lengths of HTM transactions. More...
 
statistics::Vector m_htm_transaction_abort_cause
 Causes for HTM transaction aborts. More...
 

Additional Inherited Members

- 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. More...
 
- Public Types inherited from gem5::SimObject
typedef SimObjectParams Params
 
- 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. More...
 
static SimObjectfind (const char *name)
 Find the SimObject with the given name and return a pointer to it. More...
 
static void setSimObjectResolver (SimObjectResolver *resolver)
 There is a single object name resolver, and it is only set when simulation is restoring from checkpoints. More...
 
static SimObjectResolvergetSimObjectResolver ()
 There is a single object name resolver, and it is only set when simulation is restoring from checkpoints. More...
 
- Static Public Member Functions inherited from gem5::Serializable
static const std::string & currentSection ()
 Gets the fully-qualified name of the active section. More...
 
static void generateCheckpointOut (const std::string &cpt_dir, std::ofstream &outstream)
 Generate a checkpoint file so that the serialization can be routed to it. More...
 
- Public Attributes inherited from gem5::ClockedObject
PowerStatepowerState
 
- Protected Member Functions inherited from gem5::ruby::RubyPort
void trySendRetries ()
 
void ruby_hit_callback (PacketPtr pkt)
 
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. More...
 
- Protected Member Functions inherited from gem5::Drainable
 Drainable ()
 
virtual ~Drainable ()
 
virtual void drainResume ()
 Resume execution after a successful drain. More...
 
void signalDrainDone () const
 Signal that an object is drained. More...
 
- Protected Member Functions inherited from gem5::Clocked
 Clocked (ClockDomain &clk_domain)
 Create a clocked object and set the clock domain based on the parameters. More...
 
 Clocked (Clocked &)=delete
 
Clockedoperator= (Clocked &)=delete
 
virtual ~Clocked ()
 Virtual destructor due to inheritance. More...
 
void resetClock () const
 Reset the object's clock using the current global tick value. More...
 
virtual void clockPeriodUpdated ()
 A hook subclasses can implement so they can do any extra work that's needed when the clock rate is changed. More...
 
- Protected Attributes inherited from gem5::ruby::Sequencer
std::unordered_map< Addr, std::list< SequencerRequest > > m_RequestTable
 
Cycles m_deadlock_threshold
 
- 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. More...
 
- Protected Attributes inherited from gem5::EventManager
EventQueueeventq
 A pointer to this object's event queue. More...
 

Detailed Description

Definition at line 57 of file HTMSequencer.hh.

Constructor & Destructor Documentation

◆ HTMSequencer() [1/2]

gem5::ruby::HTMSequencer::HTMSequencer ( const RubyHTMSequencerParams &  p)

◆ ~HTMSequencer()

gem5::ruby::HTMSequencer::~HTMSequencer ( )

Definition at line 106 of file HTMSequencer.cc.

◆ HTMSequencer() [2/2]

gem5::ruby::HTMSequencer::HTMSequencer ( const HTMSequencer obj)
private

Member Function Documentation

◆ empty()

bool gem5::ruby::HTMSequencer::empty ( ) const
overridevirtual

Reimplemented from gem5::ruby::Sequencer.

Definition at line 313 of file HTMSequencer.cc.

References gem5::ruby::Sequencer::empty(), and m_htmCmdRequestTable.

◆ htmCallback()

void gem5::ruby::HTMSequencer::htmCallback ( Addr  address,
const HtmCallbackMode  mode,
const HtmFailedInCacheReason  htm_return_code 
)

◆ htmRetCodeConversion()

HtmCacheFailure gem5::ruby::HTMSequencer::htmRetCodeConversion ( const HtmFailedInCacheReason  rc)
private

Htm return code conversion.

This helper is a hack meant to convert the autogenerated ruby enum (HtmFailedInCacheReason) to the manually defined one (HtmCacheFailure). This is needed since the cpu code would otherwise have to include the ruby generated headers in order to handle the htm return code.

Definition at line 52 of file HTMSequencer.cc.

References gem5::FAIL_OTHER, gem5::FAIL_REMOTE, gem5::FAIL_SELF, gem5::NO_FAIL, and panic.

Referenced by rubyHtmCallback().

◆ insertRequest()

RequestStatus gem5::ruby::HTMSequencer::insertRequest ( PacketPtr  pkt,
RubyRequestType  primary_type,
RubyRequestType  secondary_type 
)
overrideprivatevirtual

◆ operator=()

HTMSequencer& gem5::ruby::HTMSequencer::operator= ( const HTMSequencer obj)
private

◆ print()

void gem5::ruby::HTMSequencer::print ( std::ostream &  out) const
overridevirtual

◆ regStats()

void gem5::ruby::HTMSequencer::regStats ( )
overridevirtual

◆ rubyHtmCallback()

void gem5::ruby::HTMSequencer::rubyHtmCallback ( PacketPtr  pkt,
const HtmFailedInCacheReason  fail_r 
)
private

◆ wakeup()

void gem5::ruby::HTMSequencer::wakeup ( )
overridevirtual

Member Data Documentation

◆ m_htm_transaction_abort_cause

statistics::Vector gem5::ruby::HTMSequencer::m_htm_transaction_abort_cause
private

Causes for HTM transaction aborts.

Definition at line 108 of file HTMSequencer.hh.

Referenced by htmCallback(), HTMSequencer(), and regStats().

◆ m_htm_transaction_cycles

statistics::Histogram gem5::ruby::HTMSequencer::m_htm_transaction_cycles
private

Histogram of cycle latencies of HTM transactions.

Definition at line 104 of file HTMSequencer.hh.

Referenced by htmCallback(), HTMSequencer(), and regStats().

◆ m_htm_transaction_instructions

statistics::Histogram gem5::ruby::HTMSequencer::m_htm_transaction_instructions
private

Histogram of instruction lengths of HTM transactions.

Definition at line 106 of file HTMSequencer.hh.

Referenced by htmCallback(), HTMSequencer(), and regStats().

◆ m_htmCmdRequestTable

std::deque<SequencerRequest*> gem5::ruby::HTMSequencer::m_htmCmdRequestTable
private

Definition at line 98 of file HTMSequencer.hh.

Referenced by empty(), htmCallback(), insertRequest(), print(), and wakeup().

◆ m_htmstart_instruction

Counter gem5::ruby::HTMSequencer::m_htmstart_instruction
private

Definition at line 101 of file HTMSequencer.hh.

Referenced by htmCallback(), and HTMSequencer().

◆ m_htmstart_tick

Tick gem5::ruby::HTMSequencer::m_htmstart_tick
private

Definition at line 100 of file HTMSequencer.hh.

Referenced by htmCallback(), and HTMSequencer().


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

Generated on Tue Sep 21 2021 12:32:05 for gem5 by doxygen 1.8.17