A common base class of Cache tagstore objects. More...

#include <base.hh>

Inheritance diagram for BaseTags:

Public Types
typedef BaseTagsParams	Params

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

Public Types inherited from SimObject
typedef SimObjectParams	Params

Public Member Functions
	BaseTags (const Params *p)

virtual	~BaseTags ()
	Destructor. More...

void	setCache (BaseCache *_cache)
	Set the parent cache back pointer. More...

void	regStats ()
	Register local statistics. More...

virtual void	cleanupRefs ()
	Average in the reference count for valid blocks when the simulation exits. More...

virtual void	computeStats ()
	Computes stats just prior to dump event. More...

virtual std::string	print () const =0
	Print all tags used. More...

virtual CacheBlk *	findBlock (Addr addr, bool is_secure) const =0
	Find a block using the memory address. More...

Addr	blkAlign (Addr addr) const
	Align an address to the block size. More...

int	extractBlkOffset (Addr addr) const
	Calculate the block offset of an address. More...

virtual CacheBlk *	findBlockBySetAndWay (int set, int way) const =0
	Find the cache block given set and way. More...

virtual void	setWayAllocationMax (int ways)
	Limit the allocation for the cache ways. More...

virtual int	getWayAllocationMax () const
	Get the way allocation mask limit. More...

virtual void	invalidate (CacheBlk *blk)=0

virtual CacheBlk *	accessBlock (Addr addr, bool is_secure, Cycles &lat)=0

virtual Addr	extractTag (Addr addr) const =0

virtual void	insertBlock (PacketPtr pkt, CacheBlk *blk)=0

virtual Addr	regenerateBlkAddr (Addr tag, unsigned set) const =0

virtual CacheBlk *	findVictim (Addr addr)=0

virtual int	extractSet (Addr addr) const =0

virtual void	forEachBlk (CacheBlkVisitor &visitor)=0

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

Enums::PwrState	pwrState () const

std::string	pwrStateName () const

std::vector< double >	pwrStateWeights () const
	Returns the percentage residency for each power state. More...

void	computeStats ()
	Record stats values like state residency by computing the time difference from previous update. More...

void	pwrState (Enums::PwrState)

void	regStats () override
	Register statistics for this 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	init ()
	init() is called after all C++ SimObjects have been created and all ports are connected. More...

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	resetStats ()
	Reset statistics associated with this object. 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
	EventManager (EventManager &em)

	EventManager (EventManager *em)

	EventManager (EventQueue *eq)

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)

void	setCurTick (Tick newVal)

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 Clocked
void	updateClockPeriod () const
	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

Protected Attributes
const unsigned	blkSize
	The block size of the cache. More...

const Addr	blkMask
	Mask out all bits that aren't part of the block offset. More...

const unsigned	size
	The size of the cache. More...

const Cycles	lookupLatency
	The tag lookup latency of the cache. More...

const Cycles	accessLatency
	The total access latency of the cache. More...

BaseCache *	cache
	Pointer to the parent cache. More...

int	warmupBound
	The number of tags that need to be touched to meet the warmup percentage. More...

bool	warmedUp
	Marked true when the cache is warmed up. More...

unsigned	numBlocks
	the number of blocks in the cache More...

Stats::Vector	replacements
	Number of replacements of valid blocks per thread. More...

Stats::Average	tagsInUse
	Per cycle average of the number of tags that hold valid data. More...

Stats::Scalar	totalRefs
	The total number of references to a block before it is replaced. More...

Stats::Scalar	sampledRefs
	The number of reference counts sampled. More...

Stats::Formula	avgRefs
	Average number of references to a block before is was replaced. More...

Stats::Scalar	warmupCycle
	The cycle that the warmup percentage was hit. More...

Stats::AverageVector	occupancies
	Average occupancy of each requestor using the cache. More...

Stats::Formula	avgOccs
	Average occ % of each requestor using the cache. More...

Stats::Vector	occupanciesTaskId
	Occupancy of each context/cpu using the cache. More...

Stats::Vector2d	ageTaskId
	Occupancy of each context/cpu using the cache. More...

Stats::Formula	percentOccsTaskId
	Occ % of each context/cpu using the cache. More...

Stats::Scalar	tagAccesses
	Number of tags consulted over all accesses. More...

Stats::Scalar	dataAccesses
	Number of data blocks consulted over all accesses. More...

Protected Attributes inherited from ClockedObject
Enums::PwrState	_currPwrState
	To keep track of the current power state. More...

Tick	prvEvalTick

Stats::Scalar	numPwrStateTransitions

Stats::Distribution	pwrStateClkGateDist

Stats::Vector	pwrStateResidencyTicks

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

Additional Inherited Members
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 ()
	Get the fully-qualified name of the active section. More...

static void	serializeAll (const std::string &cpt_dir)

static void	unserializeGlobals (CheckpointIn &cp)

Static Public Attributes inherited from Serializable
static int	ckptCount = 0

static int	ckptMaxCount = 0

static int	ckptPrevCount = -1

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

Detailed Description

A common base class of Cache tagstore objects.

Definition at line 65 of file base.hh.

Member Typedef Documentation

typedef BaseTagsParams BaseTags::Params

Definition at line 151 of file base.hh.

Constructor & Destructor Documentation

BaseTags::BaseTags ( const Params * p )

Definition at line 57 of file base.cc.

virtual BaseTags::~BaseTags ( )

inlinevirtual

Destructor.

Definition at line 157 of file base.hh.

Member Function Documentation

virtual CacheBlk* BaseTags::accessBlock	(	Addr	addr,
		bool	is_secure,
		Cycles &	lat
	)

pure virtual

Implemented in FALRU, BaseSetAssoc, LRU, and RandomRepl.

Referenced by Cache::access().

Addr BaseTags::blkAlign ( Addr addr ) const

inline

Align an address to the block size.

Parameters

addr	the address to align.

Returns: The block address.

Definition at line 196 of file base.hh.

References blkMask.

Referenced by FALRU::accessBlock(), FALRU::extractTag(), FALRU::findBlock(), and FALRU::findVictim().

virtual void BaseTags::cleanupRefs ( )

inlinevirtual

Average in the reference count for valid blocks when the simulation exits.

Reimplemented in BaseSetAssoc.

Definition at line 174 of file base.hh.

Referenced by BaseTagsCallback::process().

virtual void BaseTags::computeStats ( )

inlinevirtual

Computes stats just prior to dump event.

Reimplemented in BaseSetAssoc.

Definition at line 179 of file base.hh.

Referenced by BaseTagsDumpCallback::process().

int BaseTags::extractBlkOffset ( Addr addr ) const

inline

Calculate the block offset of an address.

Parameters

addr	the address to get the offset of.

Returns: the block offset.

Definition at line 206 of file base.hh.

References blkMask.

Referenced by Cache::cmpAndSwap().

virtual int BaseTags::extractSet ( Addr addr ) const

pure virtual

Implemented in BaseSetAssoc, and FALRU.

Referenced by Cache::handleFill().

virtual Addr BaseTags::extractTag ( Addr addr ) const

pure virtual

Implemented in BaseSetAssoc, and FALRU.

Referenced by Cache::handleFill().

virtual CacheBlk* BaseTags::findBlock	(	Addr	addr,
		bool	is_secure
	)		const

pure virtual

Find a block using the memory address.

Implemented in BaseSetAssoc, and FALRU.

Referenced by Cache::access(), Cache::findBlock(), Cache::functionalAccess(), Cache::getNextQueueEntry(), Cache::inCache(), Cache::recvAtomicSnoop(), Cache::recvTimingResp(), Cache::recvTimingSnoopReq(), and Cache::sendMSHRQueuePacket().

virtual CacheBlk* BaseTags::findBlockBySetAndWay	(	int	set,
		int	way
	)		const

pure virtual

Find the cache block given set and way.

Parameters

set	The set of the block.
way	The way of the block.

Returns: The cache block.

Implemented in FALRU, and BaseSetAssoc.

virtual CacheBlk* BaseTags::findVictim ( Addr addr )

pure virtual

Implemented in BaseSetAssoc, FALRU, LRU, and RandomRepl.

Referenced by Cache::allocateBlock().

virtual void BaseTags::forEachBlk ( CacheBlkVisitor & visitor )

pure virtual

Implemented in BaseSetAssoc, and FALRU.

Referenced by Cache::isDirty(), Cache::memInvalidate(), and Cache::memWriteback().

virtual int BaseTags::getWayAllocationMax ( ) const

inlinevirtual

Get the way allocation mask limit.

Returns: The maximum number of ways available for replacement.

Reimplemented in BaseSetAssoc.

Definition at line 232 of file base.hh.

References panic.

virtual void BaseTags::insertBlock	(	PacketPtr	pkt,
		CacheBlk *	blk
	)

pure virtual

Implemented in BaseSetAssoc, FALRU, LRU, and RandomRepl.

Referenced by Cache::access(), and Cache::handleFill().

virtual void BaseTags::invalidate ( CacheBlk * blk )

pure virtual

Implemented in FALRU, BaseSetAssoc, LRU, and RandomRepl.

Referenced by Cache::invalidateBlock().

virtual std::string BaseTags::print ( ) const

pure virtual

Print all tags used.

Implemented in BaseSetAssoc, and FALRU.

Referenced by Cache::recvTimingReq().

virtual Addr BaseTags::regenerateBlkAddr	(	Addr	tag,
		unsigned	set
	)		const

pure virtual

Implemented in BaseSetAssoc, and FALRU.

Referenced by Cache::allocateBlock(), Cache::cleanEvictBlk(), Cache::writebackBlk(), and Cache::writebackVisitor().

void BaseTags::regStats ( )

virtual

Register local statistics.

Reimplemented from SimObject.

Reimplemented in FALRU.

Definition at line 77 of file base.cc.

References ageTaskId, avgOccs, avgRefs, cache, Stats::constant(), dataAccesses, Stats::DataWrap< Derived, InfoProxyType >::desc(), Stats::DataWrap< Derived, InfoProxyType >::flags(), System::getMasterName(), ArmISA::i, Stats::VectorBase< Derived, Stor >::init(), Stats::Vector2dBase< Derived, Stor >::init(), System::maxMasters(), maxThreadsPerCPU, SimObject::name(), Stats::DataWrap< Derived, InfoProxyType >::name(), Stats::nonan, Stats::nozero, numBlocks, ContextSwitchTaskId::NumTaskId, occupancies, occupanciesTaskId, percentOccsTaskId, Stats::registerDumpCallback(), registerExitCallback(), ClockedObject::regStats(), replacements, sampledRefs, Stats::DataWrapVec< Derived, InfoProxyType >::subname(), BaseCache::system, tagAccesses, tagsInUse, Stats::total, totalRefs, and warmupCycle.

Referenced by FALRU::regStats().

void BaseTags::setCache ( BaseCache * _cache )

Set the parent cache back pointer.

Parameters

_cache Pointer to parent cache.

Definition at line 70 of file base.cc.

References cache.

Referenced by Cache::Cache().

virtual void BaseTags::setWayAllocationMax ( int ways )

inlinevirtual

Limit the allocation for the cache ways.

Parameters

ways	The maximum number of ways available for replacement.

Reimplemented in BaseSetAssoc.

Definition at line 223 of file base.hh.

References panic.

Member Data Documentation

const Cycles BaseTags::accessLatency

protected

The total access latency of the cache.

This latency is different depending on the cache access mode (parallel or sequential)

Definition at line 81 of file base.hh.

Referenced by BaseSetAssoc::accessBlock(), and FALRU::accessBlock().

const Addr BaseTags::blkMask

protected

Mask out all bits that aren't part of the block offset.

Definition at line 71 of file base.hh.

Referenced by blkAlign(), and extractBlkOffset().

const unsigned BaseTags::blkSize

protected

The block size of the cache.

Definition at line 69 of file base.hh.

Referenced by BaseSetAssoc::BaseSetAssoc(), FALRU::check(), and FALRU::FALRU().

BaseCache* BaseTags::cache

protected

Pointer to the parent cache.

Definition at line 83 of file base.hh.

Referenced by BaseSetAssoc::accessBlock(), FALRU::accessBlock(), BaseSetAssoc::insertBlock(), BaseSetAssoc::invalidate(), regStats(), and setCache().

const Cycles BaseTags::lookupLatency

protected

The tag lookup latency of the cache.

Definition at line 75 of file base.hh.

Referenced by BaseSetAssoc::accessBlock(), and FALRU::accessBlock().

unsigned BaseTags::numBlocks

protected

the number of blocks in the cache

Definition at line 94 of file base.hh.

Referenced by BaseSetAssoc::BaseSetAssoc(), FALRU::FALRU(), FALRU::forEachBlk(), and regStats().

const unsigned BaseTags::size

protected

The size of the cache.

Definition at line 73 of file base.hh.

Referenced by FALRU::FALRU().

bool BaseTags::warmedUp

protected

Marked true when the cache is warmed up.

Definition at line 91 of file base.hh.

Referenced by FALRU::findVictim(), and BaseSetAssoc::insertBlock().

int BaseTags::warmupBound

protected

The number of tags that need to be touched to meet the warmup percentage.

Definition at line 89 of file base.hh.

Referenced by BaseSetAssoc::BaseSetAssoc(), FALRU::FALRU(), FALRU::findVictim(), and BaseSetAssoc::insertBlock().

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

mem/cache/tags/base.hh
mem/cache/tags/base.cc

Public Types

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation