Implementation of a vector of stats. More...

#include <statistics.hh>

Inheritance diagram for gem5::statistics::VectorBase< Derived, Stor >:

Public Types
typedef Stor	Storage

typedef Stor::Params	Params

typedef ScalarProxy< Derived >	Proxy
	Proxy type.

Public Types inherited from gem5::statistics::DataWrapVec< Derived, VectorInfoProxy >
typedef VectorInfoProxy< Derived >	Info

Public Types inherited from gem5::statistics::DataWrap< Derived, VectorInfoProxy >
typedef VectorInfoProxy< Derived >	Info

Public Member Functions
void	value (VCounter &vec) const

void	result (VResult &vec) const
	Copy the values to a local vector and return a reference to it.

Result	total () const
	Return a total of all entries in this vector.

size_type	size () const

bool	zero () const

bool	check () const

	VectorBase (Group parent, const char name, const units::Base unit, const char desc)

	~VectorBase ()

Derived &	init (size_type size)
	Set this vector to have the given size.

Proxy	operator[] (off_type index)
	Return a reference (ScalarProxy) to the stat at the given index.

Public Member Functions inherited from gem5::statistics::DataWrapVec< Derived, VectorInfoProxy >
	DataWrapVec (Group parent=nullptr, const char name=nullptr, const units::Base unit=units::Unspecified::get(), const char desc=nullptr)

Derived &	subname (off_type index, const std::string &name)
	Set the subfield name for the given index, and marks this stat to print at the end of simulation.

Derived &	subdesc (off_type index, const std::string &desc)
	Set the subfield description for the given index and marks this stat to print at the end of simulation.

void	prepare ()

void	reset ()

Public Member Functions inherited from gem5::statistics::DataWrap< Derived, VectorInfoProxy >
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.

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.

const std::string &	setSeparator () const

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

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

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

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

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

Public Member Functions inherited from gem5::statistics::InfoAccess
	InfoAccess ()

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

bool	zero () const

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

Protected Member Functions
Storage *	data (off_type index)
	Retrieve the storage.

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

void	doInit (size_type s)

Protected Member Functions inherited from gem5::statistics::DataWrap< Derived, VectorInfoProxy >
Derived &	self ()

Info *	info ()

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

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

void	setInit ()
	Save Storage class parameters if any.

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

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

bool	newStyleStats () const
	Check if the info is new style stats.

Protected Attributes
std::vector< Storage * >	storage
	The storage of this stat.

Friends
class	ScalarProxy< Derived >

class	DataWrapVec< Derived, VectorInfoProxy >

Detailed Description

template<class Derived, class Stor>
class gem5::statistics::VectorBase< Derived, Stor >

Implementation of a vector of stats.

The type of stat is determined by the Storage class.

See also: ScalarBase

Definition at line 921 of file statistics.hh.

Member Typedef Documentation

◆ Params

template<class Derived, class Stor>

typedef Stor::Params gem5::statistics::VectorBase< Derived, Stor >::Params

Definition at line 925 of file statistics.hh.

◆ Proxy

template<class Derived, class Stor>

typedef ScalarProxy<Derived> gem5::statistics::VectorBase< Derived, Stor >::Proxy

Proxy type.

Definition at line 928 of file statistics.hh.

◆ Storage

template<class Derived, class Stor>

typedef Stor gem5::statistics::VectorBase< Derived, Stor >::Storage

Definition at line 924 of file statistics.hh.

Constructor & Destructor Documentation

◆ VectorBase()

template<class Derived, class Stor>

gem5::statistics::VectorBase< Derived, Stor >::VectorBase	(	Group *	parent,
		const char *	name,
		const units::Base *	unit,
		const char *	desc )

inline

Definition at line 1019 of file statistics.hh.

References gem5::statistics::DataWrapVec< Derived, VectorInfoProxy >::DataWrapVec(), gem5::statistics::DataWrap< Derived, VectorInfoProxy >::desc(), gem5::statistics::DataWrap< Derived, VectorInfoProxy >::name(), storage, and gem5::statistics::DataWrap< Derived, VectorInfoProxy >::unit().

◆ ~VectorBase()

template<class Derived, class Stor>

gem5::statistics::VectorBase< Derived, Stor >::~VectorBase ( )

inline

Definition at line 1026 of file statistics.hh.

References storage.

Member Function Documentation

◆ check()

template<class Derived, class Stor>

bool gem5::statistics::VectorBase< Derived, Stor >::check ( ) const

inline

Definition at line 1013 of file statistics.hh.

References size().

Referenced by doInit().

◆ data() [1/2]

template<class Derived, class Stor>

Storage * gem5::statistics::VectorBase< Derived, Stor >::data ( off_type index )

inlineprotected

Retrieve the storage.

Parameters

index The vector index to access.

Returns: The storage object at the given index.

Definition at line 942 of file statistics.hh.

References gem5::MipsISA::index, and storage.

◆ data() [2/2]

template<class Derived, class Stor>

const Storage * gem5::statistics::VectorBase< Derived, Stor >::data ( off_type index ) const

inlineprotected

Retrieve a const pointer to the storage.

Parameters

index The vector index to access.

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

Definition at line 949 of file statistics.hh.

References gem5::MipsISA::index, and storage.

◆ doInit()

template<class Derived, class Stor>

void gem5::statistics::VectorBase< Derived, Stor >::doInit ( size_type s )

inlineprotected

Definition at line 952 of file statistics.hh.

References check(), fatal_if, gem5::ArmISA::i, gem5::statistics::DataWrap< Derived, VectorInfoProxy >::info(), gem5::ArmISA::s, gem5::statistics::InfoAccess::setInit(), and storage.

◆ init()

template<class Derived, class Stor>

Derived & gem5::statistics::VectorBase< Derived, Stor >::init ( size_type size )

inline

Set this vector to have the given size.

Parameters

size	The new size.

Returns: A reference to this stat.

Definition at line 1039 of file statistics.hh.

References gem5::statistics::DataWrap< Derived, VectorInfoProxy >::self(), and size().

◆ operator[]()

template<class Derived, class Stor>

Proxy gem5::statistics::VectorBase< Derived, Stor >::operator[] ( off_type index )

inline

Return a reference (ScalarProxy) to the stat at the given index.

Parameters

index The vector index to access.

Returns: A reference of the stat.

Definition at line 1052 of file statistics.hh.

References gem5::MipsISA::index, gem5::statistics::DataWrap< Derived, VectorInfoProxy >::self(), and size().

◆ result()

template<class Derived, class Stor>

void gem5::statistics::VectorBase< Derived, Stor >::result ( VResult & vec ) const

inline

Copy the values to a local vector and return a reference to it.

Returns: A reference to a vector of the stat values.

Definition at line 978 of file statistics.hh.

References data, gem5::ArmISA::i, size(), and gem5::PowerISA::vec.

◆ size()

template<class Derived, class Stor>

size_type gem5::statistics::VectorBase< Derived, Stor >::size ( ) const

inline

Returns: the number of elements in this vector.

Definition at line 1001 of file statistics.hh.

References storage.

Referenced by check(), init(), operator[](), result(), total(), value(), and zero().

◆ total()

template<class Derived, class Stor>

Result gem5::statistics::VectorBase< Derived, Stor >::total ( ) const

inline

Return a total of all entries in this vector.

Returns: The total of all vector entries.

Definition at line 990 of file statistics.hh.

References data, gem5::ArmISA::i, size(), and total().

Referenced by total().

◆ value()

template<class Derived, class Stor>

void gem5::statistics::VectorBase< Derived, Stor >::value ( VCounter & vec ) const

inline

Definition at line 966 of file statistics.hh.

References data, gem5::ArmISA::i, size(), and gem5::PowerISA::vec.

◆ zero()

template<class Derived, class Stor>

bool gem5::statistics::VectorBase< Derived, Stor >::zero ( ) const

inline

Definition at line 1004 of file statistics.hh.

References data, gem5::ArmISA::i, size(), and zero().

Referenced by zero().

Friends And Related Symbol Documentation

◆ DataWrapVec< Derived, VectorInfoProxy >

template<class Derived, class Stor>

friend class DataWrapVec< Derived, VectorInfoProxy >

friend

Definition at line 928 of file statistics.hh.

References gem5::statistics::DataWrapVec< Derived, VectorInfoProxy >::DataWrapVec().

◆ ScalarProxy< Derived >

template<class Derived, class Stor>

friend class ScalarProxy< Derived >

friend

Definition at line 928 of file statistics.hh.

Member Data Documentation

◆ storage

template<class Derived, class Stor>

std::vector<Storage*> gem5::statistics::VectorBase< Derived, Stor >::storage

protected

The storage of this stat.

Definition at line 934 of file statistics.hh.

Referenced by data(), data(), doInit(), size(), VectorBase(), and ~VectorBase().

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

base/statistics.hh

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Params

◆ Proxy

◆ Storage

Constructor & Destructor Documentation

◆ VectorBase()

◆ ~VectorBase()

Member Function Documentation

◆ check()

◆ data() [1/2]

◆ data() [2/2]

◆ doInit()

◆ init()

◆ operator[]()

◆ result()

◆ size()

◆ total()

◆ value()

◆ zero()

Friends And Related Symbol Documentation

◆ DataWrapVec< Derived, VectorInfoProxy >

◆ ScalarProxy< Derived >

Member Data Documentation

◆ storage