gem5::StatTester Class Reference

This classes are used to test the stats system from setting through to output. More...

#include <stat_tester.hh>

Inheritance diagram for gem5::StatTester:

Public Member Functions
	StatTester (const StatTesterParams &p)
void	startup () override
	startup() is the final initialization call before simulation.
Public Member Functions inherited from gem5::SimObject
const Params &	params () const
	SimObject (const Params &p)
virtual	~SimObject ()
virtual void	init ()
	init() is called after all C++ SimObjects have been created and all ports are connected.
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 Port &	getPort (const std::string &if_name, PortID idx=InvalidPortID)
	Get a port with a given name and index.
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
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)
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	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 ()=delete
	Group (const Group &)=delete
Group &	operator= (const Group &)=delete
Public Member Functions inherited from gem5::Named
	Named (const std::string &name_)
virtual	~Named ()=default
virtual std::string	name () const

Protected Member Functions
virtual void	setStats ()
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.

Private Attributes
EventFunctionWrapper	event

Additional Inherited Members
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.
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 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.
Protected Attributes inherited from gem5::SimObject
const SimObjectParams &	_params
	Cached copy of the object parameters.
Protected Attributes inherited from gem5::EventManager
EventQueue *	eventq
	A pointer to this object's event queue.

Detailed Description

This classes are used to test the stats system from setting through to output.

The value of the stats are set via the parameters and when included in a simulation will create these stats and update them at Tick zero.

Example usage

import m5
from m5.objects import (
    Root,
    ScalarStatTester,
)

stat_tester = ScalarStatTester()

stat_tester.value = 42
stat_tester.name = "example"
root = Root(full_system=False)

root.stat_tester = stat_tester

m5.instantiate() m5.simulate()

When the above is run, the m5out/stats.txt file will contain the following:

---------- Begin Simulation Statistics ----------
simSeconds                               18446744.073710
simTicks                                 18446744073709551616
finalTick                                18446744073709551616
simFreq                                  1000000000000
hostSeconds                                      0.00
hostTickRate                             101355736668733798612992
hostMemory                                  403847696
stat_tester.example                                42
---------- End Simulation Statistics   ----------

Definition at line 82 of file stat_tester.hh.

Constructor & Destructor Documentation

StatTester()

gem5::StatTester::StatTester ( const StatTesterParams & p )

inline

Definition at line 88 of file stat_tester.hh.

References setStats().

Member Function Documentation

setStats()

virtual void gem5::StatTester::setStats ( )

inlineprotectedvirtual

Reimplemented in gem5::ScalarStatTester, gem5::SparseHistStatTester, gem5::Vector2dStatTester, and gem5::VectorStatTester.

Definition at line 95 of file stat_tester.hh.

Referenced by StatTester().

startup()

void gem5::StatTester::startup ( )

inlineoverridevirtual

startup() is the final initialization call before simulation.

All state is initialized (including unserialized state, if any, such as the curTick() value), so this is the appropriate place to schedule initial event(s) for objects that need them.

Reimplemented from gem5::SimObject.

Definition at line 92 of file stat_tester.hh.

References gem5::curTick(), event, and gem5::EventManager::schedule().

Member Data Documentation

event

EventFunctionWrapper gem5::StatTester::event

private

Definition at line 85 of file stat_tester.hh.

Referenced by startup().

---

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

• test_objects/stat_tester.hh