Implements an n bit saturating counter and provides methods to increment, decrement, and read it. More...

#include <sat_counter.hh>

Public Member Functions
	SatCounter ()=delete
	The default constructor should never be used. More...

	SatCounter (unsigned bits, uint8_t initial_val=0)
	Constructor for the counter. More...

	SatCounter (const SatCounter &other)
	Copy constructor. More...

SatCounter &	operator= (const SatCounter &other)
	Copy assignment. More...

	SatCounter (SatCounter &&other)
	Move constructor. More...

SatCounter &	operator= (SatCounter &&other)
	Move assignment. More...

void	swap (SatCounter &other)
	Swap the contents of every member of the class. More...

SatCounter &	operator++ ()
	Pre-increment operator. More...

SatCounter	operator++ (int)
	Post-increment operator. More...

SatCounter &	operator-- ()
	Pre-decrement operator. More...

SatCounter	operator-- (int)
	Post-decrement operator. More...

SatCounter &	operator>>= (const int &shift)
	Shift-right-assignment. More...

SatCounter &	operator<<= (const int &shift)
	Shift-left-assignment. More...

SatCounter &	operator+= (const int &value)
	Add-assignment. More...

SatCounter &	operator-= (const int &value)
	Subtract-assignment. More...

	operator uint8_t () const
	Read the counter's value. More...

void	reset ()
	Reset the counter to its initial value. More...

double	calcSaturation () const
	Calculate saturation percentile of the current counter's value with regard to its maximum possible value. More...

bool	isSaturated () const
	Whether the counter has achieved its maximum value or not. More...

uint8_t	saturate ()
	Saturate the counter. More...

Private Attributes
uint8_t	initialVal

uint8_t	maxVal

uint8_t	counter

Detailed Description

Implements an n bit saturating counter and provides methods to increment, decrement, and read it.

Definition at line 57 of file sat_counter.hh.

Constructor & Destructor Documentation

◆ SatCounter() [1/4]

SatCounter::SatCounter ( )

delete

The default constructor should never be used.

◆ SatCounter() [2/4]

SatCounter::SatCounter	(	unsigned	bits,
		uint8_t	initial_val = `0`
	)

inlineexplicit

Constructor for the counter.

The explicit keyword is used to make sure the user does not assign a number to the counter thinking it will be used as a counter value when it is in fact used as the number of bits.

Parameters

bits	How many bits the counter will have.
initial_val	Starting value for the counter.

Definition at line 72 of file sat_counter.hh.

References fatal_if, and maxVal.

◆ SatCounter() [3/4]

SatCounter::SatCounter ( const SatCounter & other )

inline

Copy constructor.

Definition at line 83 of file sat_counter.hh.

◆ SatCounter() [4/4]

SatCounter::SatCounter ( SatCounter && other )

inline

Move constructor.

Definition at line 99 of file sat_counter.hh.

References counter, initialVal, and maxVal.

Member Function Documentation

◆ calcSaturation()

double SatCounter::calcSaturation ( ) const

inline

Calculate saturation percentile of the current counter's value with regard to its maximum possible value.

Returns: A value between 0.0 and 1.0 to indicate which percentile of the maximum value the current value is.

Definition at line 240 of file sat_counter.hh.

References counter, and maxVal.

Referenced by SignaturePathPrefetcher::calculateLookaheadConfidence(), IndirectMemoryPrefetcher::calculatePrefetch(), SignaturePathPrefetcher::calculatePrefetchConfidence(), and TEST().

◆ isSaturated()

bool SatCounter::isSaturated ( ) const

inline

Whether the counter has achieved its maximum value or not.

Returns: True if the counter saturated.

Definition at line 247 of file sat_counter.hh.

References counter, and maxVal.

Referenced by SignaturePathPrefetcherV2::increasePatternEntryCounter(), and TEST().

◆ operator uint8_t()

SatCounter::operator uint8_t ( ) const

inline

Read the counter's value.

Definition at line 228 of file sat_counter.hh.

References counter.

◆ operator++() [1/2]

SatCounter& SatCounter::operator++ ( )

inline

Pre-increment operator.

Definition at line 136 of file sat_counter.hh.

References counter, and maxVal.

◆ operator++() [2/2]

SatCounter SatCounter::operator++ ( int )

inline

Post-increment operator.

Definition at line 146 of file sat_counter.hh.

◆ operator+=()

SatCounter& SatCounter::operator+= ( const int & value )

inline

Add-assignment.

Definition at line 195 of file sat_counter.hh.

References counter, and maxVal.

◆ operator--() [1/2]

SatCounter& SatCounter::operator-- ( )

inline

Pre-decrement operator.

Definition at line 155 of file sat_counter.hh.

References counter.

◆ operator--() [2/2]

SatCounter SatCounter::operator-- ( int )

inline

Post-decrement operator.

Definition at line 165 of file sat_counter.hh.

◆ operator-=()

SatCounter& SatCounter::operator-= ( const int & value )

inline

Subtract-assignment.

Definition at line 211 of file sat_counter.hh.

References counter.

◆ operator<<=()

SatCounter& SatCounter::operator<<= ( const int & shift )

inline

Shift-left-assignment.

Definition at line 183 of file sat_counter.hh.

References counter, maxVal, and ArmISA::shift.

◆ operator=() [1/2]

SatCounter& SatCounter::operator= ( const SatCounter & other )

inline

Copy assignment.

Definition at line 90 of file sat_counter.hh.

References swap().

◆ operator=() [2/2]

SatCounter& SatCounter::operator= ( SatCounter && other )

inline

Move assignment.

Definition at line 109 of file sat_counter.hh.

References counter, initialVal, and maxVal.

◆ operator>>=()

SatCounter& SatCounter::operator>>= ( const int & shift )

inline

Shift-right-assignment.

Definition at line 174 of file sat_counter.hh.

References counter, and ArmISA::shift.

◆ reset()

void SatCounter::reset ( )

inline

Reset the counter to its initial value.

Definition at line 231 of file sat_counter.hh.

References counter, and initialVal.

Referenced by IrregularStreamBufferPrefetcher::addStructuralToPhysicalEntry(), IrregularStreamBufferPrefetcher::calculatePrefetch(), SignaturePathPrefetcher::PatternEntry::getStrideEntry(), IndirectMemoryPrefetcher::PrefetchTableEntry::invalidate(), SignaturePathPrefetcher::PatternEntry::invalidate(), TEST(), BRRIPRP::touch(), and IndirectMemoryPrefetcher::trackMissIndex2().

◆ saturate()

uint8_t SatCounter::saturate ( )

inline

Saturate the counter.

Returns: The value added to the counter to reach saturation.

Definition at line 254 of file sat_counter.hh.

References counter, and maxVal.

Referenced by BRRIPRP::reset(), and TEST().

◆ swap()

void SatCounter::swap ( SatCounter & other )

inline

Swap the contents of every member of the class.

Used for the default copy-assignment created by the compiler.

Parameters

other The other object to swap contents with.

Definition at line 127 of file sat_counter.hh.

References counter, initialVal, and maxVal.

Referenced by operator=().

Member Data Documentation

◆ counter

uint8_t SatCounter::counter

private

Definition at line 264 of file sat_counter.hh.

Referenced by calcSaturation(), SignaturePathPrefetcher::PatternEntry::getStrideEntry(), SignaturePathPrefetcherV2::increasePatternEntryCounter(), isSaturated(), operator uint8_t(), operator++(), operator+=(), operator--(), operator-=(), operator<<=(), operator=(), operator>>=(), reset(), SatCounter(), saturate(), and swap().

◆ initialVal

uint8_t SatCounter::initialVal

private

Definition at line 262 of file sat_counter.hh.

Referenced by operator=(), reset(), SatCounter(), and swap().

◆ maxVal

uint8_t SatCounter::maxVal

private

Definition at line 263 of file sat_counter.hh.

Referenced by calcSaturation(), isSaturated(), operator++(), operator+=(), operator<<=(), operator=(), SatCounter(), saturate(), and swap().

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

base/sat_counter.hh

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SatCounter() [1/4]

◆ SatCounter() [2/4]

◆ SatCounter() [3/4]

◆ SatCounter() [4/4]

Member Function Documentation

◆ calcSaturation()

◆ isSaturated()

◆ operator uint8_t()

◆ operator++() [1/2]

◆ operator++() [2/2]

◆ operator+=()

◆ operator--() [1/2]

◆ operator--() [2/2]

◆ operator-=()

◆ operator<<=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator>>=()

◆ reset()

◆ saturate()

◆ swap()

Member Data Documentation

◆ counter

◆ initialVal

◆ maxVal