Implementation of a scalar stat. More...

#include <statistics.hh>

Inheritance diagram for Stats::ScalarBase< Derived, Stor >:

Public Types
typedef Stor	Storage

typedef Stor::Params	Params

Public Types inherited from Stats::DataWrap< Derived, ScalarInfoProxy >
typedef ScalarInfoProxy< Derived >	Info

Public Member Functions
	ScalarBase (Group parent=nullptr, const char name=nullptr, const Units::Base unit=UNIT_UNSPECIFIED, const char desc=nullptr)

void	operator++ ()
	Increment the stat by 1. More...

void	operator-- ()
	Decrement the stat by 1. More...

void	operator++ (int)
	Increment the stat by 1. More...

void	operator-- (int)
	Decrement the stat by 1. More...

template<typename U >
void	operator= (const U &v)
	Set the data value to the given value. More...

template<typename U >
void	operator+= (const U &v)
	Increment the stat by the given value. More...

template<typename U >
void	operator-= (const U &v)
	Decrement the stat by the given value. More...

size_type	size () const
	Return the number of elements, always 1 for a scalar. More...

Counter	value () const
	Return the current value of this stat as its base type. More...

Result	result () const

Result	total () const

bool	zero () const

void	reset ()

void	prepare ()

Public Member Functions inherited from Stats::DataWrap< Derived, ScalarInfoProxy >
const Info *	info () const

	DataWrap ()=delete

	DataWrap (const DataWrap &)=delete

	DataWrap (Group parent, const char name, const Units::Base unit, const char desc)

DataWrap &	operator= (const DataWrap &)=delete

Derived &	name (const std::string &name)
	Set the name and marks this stat to print at the end of simulation. More...

const std::string &	name () const

Derived &	setSeparator (const std::string &_sep)
	Set the character(s) used between the name and vector number on vectors, dist, etc. More...

const std::string &	setSeparator () const

Derived &	unit (const Units::Base *_unit)
	Set the unit of the stat. More...

Derived &	desc (const std::string &_desc)
	Set the description and marks this stat to print at the end of simulation. More...

Derived &	precision (int _precision)
	Set the precision and marks this stat to print at the end of simulation. More...

Derived &	flags (Flags _flags)
	Set the flags and marks this stat to print at the end of simulation. More...

Derived &	prereq (const Stat &prereq)
	Set the prerequisite stat and marks this stat to print at the end of simulation. More...

Public Member Functions inherited from Stats::InfoAccess
	InfoAccess ()

void	reset ()
	Reset the stat to the default state. More...

bool	zero () const

bool	check () const
	Check that this stat has been set up properly and is ready for use. More...

Protected Member Functions
	M5_ALIGNED (8) char storage[sizeof(Storage)]
	The storage of this stat. More...

Storage *	data ()
	Retrieve the storage. More...

const Storage *	data () const
	Retrieve a const pointer to the storage. More...

void	doInit ()

Protected Member Functions inherited from Stats::DataWrap< Derived, ScalarInfoProxy >
Derived &	self ()

Info *	info ()

Protected Member Functions inherited from Stats::InfoAccess
void	setInfo (Group parent, Info info)
	Set up an info class for this statistic. More...

void	setParams (const StorageParams *params)
	Save Storage class parameters if any. More...

void	setInit ()
	Save Storage class parameters if any. More...

Info *	info ()
	Grab the information class for this statistic. More...

const Info *	info () const
	Grab the information class for this statistic. More...

Detailed Description

template<class Derived, class Stor>
class Stats::ScalarBase< Derived, Stor >

Implementation of a scalar stat.

The type of stat is determined by the Storage template.

Definition at line 501 of file statistics.hh.

Member Typedef Documentation

◆ Params

template<class Derived , class Stor >

typedef Stor::Params Stats::ScalarBase< Derived, Stor >::Params

Definition at line 505 of file statistics.hh.

◆ Storage

template<class Derived , class Stor >

typedef Stor Stats::ScalarBase< Derived, Stor >::Storage

Definition at line 504 of file statistics.hh.

Constructor & Destructor Documentation

◆ ScalarBase()

template<class Derived , class Stor >

Stats::ScalarBase< Derived, Stor >::ScalarBase	(	Group *	parent = `nullptr`,
		const char *	name = `nullptr`,
		const Units::Base *	unit = `UNIT_UNSPECIFIED`,
		const char *	desc = `nullptr`
	)

inline

Definition at line 543 of file statistics.hh.

Member Function Documentation

◆ data() [1/2]

template<class Derived , class Stor >

Storage* Stats::ScalarBase< Derived, Stor >::data ( )

inlineprotected

Retrieve the storage.

Parameters

index The vector index to access.

Returns: The storage object at the given index.

Definition at line 518 of file statistics.hh.

Referenced by Stats::ScalarBase< Scalar, StatStor >::operator++(), Stats::ScalarBase< Scalar, StatStor >::operator+=(), Stats::ScalarBase< Scalar, StatStor >::operator--(), Stats::ScalarBase< Scalar, StatStor >::operator-=(), Stats::ScalarBase< Scalar, StatStor >::operator=(), Stats::ScalarBase< Scalar, StatStor >::prepare(), Stats::ScalarBase< Scalar, StatStor >::reset(), Stats::ScalarBase< Scalar, StatStor >::result(), and Stats::ScalarBase< Scalar, StatStor >::value().

◆ data() [2/2]

template<class Derived , class Stor >

const Storage* Stats::ScalarBase< Derived, Stor >::data ( ) const

inlineprotected

Retrieve a const pointer to the storage.

for the given index.

Parameters

index The vector index to access.

Returns: A const pointer to the storage object at the given index.

Definition at line 530 of file statistics.hh.

◆ doInit()

template<class Derived , class Stor >

void Stats::ScalarBase< Derived, Stor >::doInit ( )

inlineprotected

Definition at line 536 of file statistics.hh.

Referenced by Stats::ScalarBase< Scalar, StatStor >::ScalarBase().

◆ M5_ALIGNED()

template<class Derived , class Stor >

Stats::ScalarBase< Derived, Stor >::M5_ALIGNED ( 8 )

protected

The storage of this stat.

◆ operator++() [1/2]

template<class Derived , class Stor >

void Stats::ScalarBase< Derived, Stor >::operator++ ( )

inline

Increment the stat by 1.

This calls the associated storage object inc function.

Definition at line 557 of file statistics.hh.

◆ operator++() [2/2]

template<class Derived , class Stor >

void Stats::ScalarBase< Derived, Stor >::operator++ ( int )

inline

Increment the stat by 1.

Definition at line 565 of file statistics.hh.

◆ operator+=()

template<class Derived , class Stor >

template<typename U >

void Stats::ScalarBase< Derived, Stor >::operator+= ( const U & v )

inline

Increment the stat by the given value.

This calls the associated storage object inc function.

Parameters

v	The value to add.

Definition at line 583 of file statistics.hh.

◆ operator--() [1/2]

template<class Derived , class Stor >

void Stats::ScalarBase< Derived, Stor >::operator-- ( )

inline

Decrement the stat by 1.

This calls the associated storage object dec function.

Definition at line 562 of file statistics.hh.

◆ operator--() [2/2]

template<class Derived , class Stor >

void Stats::ScalarBase< Derived, Stor >::operator-- ( int )

inline

Decrement the stat by 1.

Definition at line 567 of file statistics.hh.

◆ operator-=()

template<class Derived , class Stor >

template<typename U >

void Stats::ScalarBase< Derived, Stor >::operator-= ( const U & v )

inline

Decrement the stat by the given value.

This calls the associated storage object dec function.

Parameters

v	The value to substract.

Definition at line 591 of file statistics.hh.

◆ operator=()

template<class Derived , class Stor >

template<typename U >

void Stats::ScalarBase< Derived, Stor >::operator= ( const U & v )

inline

Set the data value to the given value.

This calls the associated storage object set function.

Parameters

v	The new value.

Definition at line 575 of file statistics.hh.

◆ prepare()

template<class Derived , class Stor >

void Stats::ScalarBase< Derived, Stor >::prepare ( )

inline

Definition at line 612 of file statistics.hh.

◆ reset()

template<class Derived , class Stor >

void Stats::ScalarBase< Derived, Stor >::reset ( )

inline

Definition at line 611 of file statistics.hh.

◆ result()

template<class Derived , class Stor >

Result Stats::ScalarBase< Derived, Stor >::result ( ) const

inline

Definition at line 605 of file statistics.hh.

Referenced by Stats::ScalarBase< Scalar, StatStor >::total(), and Stats::ScalarBase< Scalar, StatStor >::zero().

◆ size()

template<class Derived , class Stor >

size_type Stats::ScalarBase< Derived, Stor >::size ( ) const

inline

Return the number of elements, always 1 for a scalar.

Returns: 1.

Definition at line 597 of file statistics.hh.

◆ total()

template<class Derived , class Stor >

Result Stats::ScalarBase< Derived, Stor >::total ( ) const

inline

Definition at line 607 of file statistics.hh.

◆ value()

template<class Derived , class Stor >

Counter Stats::ScalarBase< Derived, Stor >::value ( ) const

inline

Return the current value of this stat as its base type.

Returns: The current value.

Definition at line 603 of file statistics.hh.

Referenced by TraceCPU::ElasticDataGen::addDepsOnParent(), TraceCPU::ElasticDataGen::addToSortedReadyList(), ElasticTrace::assignRobDep(), Wavefront::exec(), SectorTags::insertBlock(), BaseTags::insertBlock(), SectorTags::invalidate(), SectorTags::moveBlock(), ElasticTrace::recordExecTick(), TraceCPU::totalOps(), BaseTrafficGen::update(), TraceCPU::updateNumOps(), X86ISA::GpuTLB::updatePageFootprint(), and ElasticTrace::updateRegDep().

◆ zero()

template<class Derived , class Stor >

bool Stats::ScalarBase< Derived, Stor >::zero ( ) const

inline

Definition at line 609 of file statistics.hh.

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

base/statistics.hh

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

template<class Derived, class Stor> class Stats::ScalarBase< Derived, Stor >

Member Typedef Documentation

◆ Params

◆ Storage

Constructor & Destructor Documentation

◆ ScalarBase()

Member Function Documentation

◆ data() [1/2]

◆ data() [2/2]

◆ doInit()

◆ M5_ALIGNED()

◆ operator++() [1/2]

◆ operator++() [2/2]

◆ operator+=()

◆ operator--() [1/2]

◆ operator--() [2/2]

◆ operator-=()

◆ operator=()

◆ prepare()

◆ reset()

◆ result()

◆ size()

◆ total()

◆ value()

◆ zero()

template<class Derived, class Stor>
class Stats::ScalarBase< Derived, Stor >