#include <HTMSequencer.hh>

Inheritance diagram for HTMSequencer:

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 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	regStats () override
	Callback to set stat parameters. More...

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

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)

Stats::Histogram &	getOutstandReqHist ()

Stats::Histogram &	getLatencyHist ()

Stats::Histogram &	getTypeLatencyHist (uint32_t t)

Stats::Histogram &	getHitLatencyHist ()

Stats::Histogram &	getHitTypeLatencyHist (uint32_t t)

Stats::Histogram &	getHitMachLatencyHist (uint32_t t)

Stats::Histogram &	getHitTypeMachLatencyHist (uint32_t r, uint32_t t)

Stats::Histogram &	getMissLatencyHist ()

Stats::Histogram &	getMissTypeLatencyHist (uint32_t t)

Stats::Histogram &	getMissMachLatencyHist (uint32_t t) const

Stats::Histogram &	getMissTypeMachLatencyHist (uint32_t r, uint32_t t) const

Stats::Histogram &	getIssueToInitialDelayHist (uint32_t t) const

Stats::Histogram &	getInitialToForwardDelayHist (const MachineType t) const

Stats::Histogram &	getForwardRequestToFirstResponseHist (const MachineType t) const

Stats::Histogram &	getFirstResponseToCompletionDelayHist (const MachineType t) const

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

Port &	getPort (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 ClockedObject
	ClockedObject (const ClockedObjectParams *p)

const Params *	params () const

void	serialize (CheckpointOut &cp) const override
	Serialize an object. More...

void	unserialize (CheckpointIn &cp) override
	Unserialize an object. More...

Public Member Functions inherited from SimObject
const Params *	params () const

	SimObject (const Params *_params)

virtual	~SimObject ()

virtual const std::string	name () const

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

ProbeManager *	getProbeManager ()
	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 EventManager
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. 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 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 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 Stats::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 (Stats::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 Info *	resolveStat (std::string name) const
	Resolve a stat by its name within this group. More...

	Group ()=delete

	Group (const Group &)=delete

Group &	operator= (const Group &)=delete

Public Member Functions inherited from 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)

HTMSequencer &	operator= (const HTMSequencer &obj)

Private Attributes
std::deque< SequencerRequest * >	m_htmCmdRequestTable

Tick	m_htmstart_tick

Counter	m_htmstart_instruction

Stats::Histogram	m_htm_transaction_cycles
	Histogram of cycle latencies of HTM transactions. More...

Stats::Histogram	m_htm_transaction_instructions
	Histogram of instruction lengths of HTM transactions. More...

Stats::Vector	m_htm_transaction_abort_cause
	Causes for HTM transaction aborts. More...

Additional Inherited Members
Public Types inherited from Sequencer
typedef RubySequencerParams	Params

Public Types inherited from RubyPort
typedef RubyPortParams	Params

Public Types inherited from ClockedObject
typedef ClockedObjectParams	Params
	Parameters of ClockedObject. More...

Public Types inherited from SimObject
typedef SimObjectParams	Params

Static Public Member Functions inherited from SimObject
static void	serializeAll (CheckpointOut &cp)
	Serialize all SimObjects in the system. More...

static SimObject *	find (const char *name)
	Find the SimObject with the given name and return a pointer to it. More...

Static Public Member Functions inherited from Serializable
static const std::string &	currentSection ()
	Gets the fully-qualified name of the active section. More...

static void	serializeAll (const std::string &cpt_dir)
	Serializes all the SimObjects. More...

static void	unserializeGlobals (CheckpointIn &cp)

Public Attributes inherited from ClockedObject
PowerState *	powerState

Protected Member Functions inherited from 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 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 Clocked
	Clocked (ClockDomain &clk_domain)
	Create a clocked object and set the clock domain based on the parameters. More...

	Clocked (Clocked &)=delete

Clocked &	operator= (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 Sequencer
std::unordered_map< Addr, std::list< SequencerRequest > >	m_RequestTable

Cycles	m_deadlock_threshold

Protected Attributes inherited from RubyPort
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

Protected Attributes inherited from SimObject
const SimObjectParams *	_params
	Cached copy of the object parameters. More...

Protected Attributes inherited from EventManager
EventQueue *	eventq
	A pointer to this object's event queue. More...

Detailed Description

Definition at line 51 of file HTMSequencer.hh.

Constructor & Destructor Documentation

◆ HTMSequencer() [1/2]

HTMSequencer::HTMSequencer ( const RubyHTMSequencerParams * p )

Definition at line 71 of file HTMSequencer.cc.

References m_htmstart_instruction, and m_htmstart_tick.

◆ ~HTMSequencer()

HTMSequencer::~HTMSequencer ( )

Definition at line 78 of file HTMSequencer.cc.

◆ HTMSequencer() [2/2]

HTMSequencer::HTMSequencer ( const HTMSequencer & obj )

private

Member Function Documentation

◆ empty()

bool HTMSequencer::empty ( ) const

overridevirtual

Reimplemented from Sequencer.

Definition at line 284 of file HTMSequencer.cc.

References Sequencer::empty(), and m_htmCmdRequestTable.

◆ htmCallback()

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

◆ htmRetCodeConversion()

HtmCacheFailure 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 48 of file HTMSequencer.cc.

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

Referenced by rubyHtmCallback().

◆ insertRequest()

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

overrideprivatevirtual

Reimplemented from Sequencer.

Definition at line 317 of file HTMSequencer.cc.

References Clocked::curCycle(), Sequencer::insertRequest(), isHtmCmdRequest(), m_htmCmdRequestTable, and Packet::req.

◆ operator=()

HTMSequencer& HTMSequencer::operator= ( const HTMSequencer & obj )

private

◆ print()

void HTMSequencer::print ( std::ostream & out ) const

overridevirtual

Reimplemented from Sequencer.

Definition at line 305 of file HTMSequencer.cc.

References m_htmCmdRequestTable, RubyPort::m_version, and Sequencer::print().

Referenced by operator<<().

◆ regStats()

void HTMSequencer::regStats ( )

overridevirtual

Callback to set stat parameters.

This callback is typically used for complex stats (e.g., distributions) that need parameters in addition to a name and a description. Stat names and descriptions should typically be set from the constructor usingo from the constructor using the ADD_STAT macro.

Reimplemented from Stats::Group.

Definition at line 185 of file HTMSequencer.cc.

References Stats::DataWrap< Derived, InfoProxyType >::desc(), Stats::dist, Stats::DataWrap< Derived, InfoProxyType >::flags(), htmFailureToStr(), Stats::VectorBase< Derived, Stor >::init(), Stats::Histogram::init(), m_htm_transaction_abort_cause, m_htm_transaction_cycles, m_htm_transaction_instructions, SimObject::name(), Stats::DataWrap< Derived, InfoProxyType >::name(), Stats::nonan, Stats::nozero, NUM_CAUSES, Stats::pdf, Sequencer::regStats(), Stats::DataWrapVec< Derived, InfoProxyType >::subname(), and Stats::total.

◆ rubyHtmCallback()

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

private

Definition at line 218 of file HTMSequencer.cc.

References curTick(), DPRINTF, Packet::getAddr(), htmRetCodeConversion(), System::isDeviceMemAddr(), System::isMemAddr(), Packet::isRequest(), Packet::makeHtmTransactionalReqResponse(), Packet::needsResponse(), Packet::popSenderState(), RubyPort::SenderState::port, Packet::req, QueuedResponsePort::schedTimingResp(), RubyPort::system, and RubyPort::trySendRetries().

Referenced by htmCallback().

◆ wakeup()

void HTMSequencer::wakeup ( )

overridevirtual

Reimplemented from Sequencer.

Definition at line 254 of file HTMSequencer.cc.

References Clocked::clockPeriod(), Clocked::curCycle(), SequencerRequest::issue_time, Sequencer::m_deadlock_threshold, m_htmCmdRequestTable, RubyPort::m_version, panic, and Sequencer::wakeup().

Member Data Documentation

◆ m_htm_transaction_abort_cause

Stats::Vector HTMSequencer::m_htm_transaction_abort_cause

private

Causes for HTM transaction aborts.

Definition at line 102 of file HTMSequencer.hh.

Referenced by htmCallback(), and regStats().

◆ m_htm_transaction_cycles

Stats::Histogram HTMSequencer::m_htm_transaction_cycles

private

Histogram of cycle latencies of HTM transactions.

Definition at line 98 of file HTMSequencer.hh.

Referenced by htmCallback(), and regStats().

◆ m_htm_transaction_instructions

Stats::Histogram HTMSequencer::m_htm_transaction_instructions

private

Histogram of instruction lengths of HTM transactions.

Definition at line 100 of file HTMSequencer.hh.

Referenced by htmCallback(), and regStats().

◆ m_htmCmdRequestTable

std::deque<SequencerRequest*> HTMSequencer::m_htmCmdRequestTable

private

Definition at line 92 of file HTMSequencer.hh.

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

◆ m_htmstart_instruction

Counter HTMSequencer::m_htmstart_instruction

private

Definition at line 95 of file HTMSequencer.hh.

Referenced by htmCallback(), and HTMSequencer().

◆ m_htmstart_tick

Tick HTMSequencer::m_htmstart_tick

private

Definition at line 94 of file HTMSequencer.hh.

Referenced by htmCallback(), and HTMSequencer().

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

mem/ruby/system/HTMSequencer.hh
mem/ruby/system/HTMSequencer.cc

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ HTMSequencer() [1/2]

◆ ~HTMSequencer()

◆ HTMSequencer() [2/2]

Member Function Documentation

◆ empty()

◆ htmCallback()

◆ htmRetCodeConversion()

◆ insertRequest()

◆ operator=()

◆ print()

◆ regStats()

◆ rubyHtmCallback()

◆ wakeup()

Member Data Documentation

◆ m_htm_transaction_abort_cause

◆ m_htm_transaction_cycles

◆ m_htm_transaction_instructions

◆ m_htmCmdRequestTable

◆ m_htmstart_instruction

◆ m_htmstart_tick