A common base class of cache replacement policy objects. More...

#include <base.hh>

Inheritance diagram for BaseReplacementPolicy:

Public Types
typedef BaseReplacementPolicyParams	Params
	Convenience typedef. More...

Public Types inherited from SimObject
typedef SimObjectParams	Params

Public Member Functions
	BaseReplacementPolicy (const Params *p)
	Construct and initiliaze this replacement policy. More...

virtual	~BaseReplacementPolicy ()
	Destructor. More...

virtual void	invalidate (const std::shared_ptr< ReplacementData > &replacement_data) const =0
	Invalidate replacement data to set it as the next probable victim. More...

virtual void	touch (const std::shared_ptr< ReplacementData > &replacement_data) const =0
	Update replacement data. More...

virtual void	reset (const std::shared_ptr< ReplacementData > &replacement_data) const =0
	Reset replacement data. More...

virtual ReplaceableEntry *	getVictim (const ReplacementCandidates &candidates) const =0
	Find replacement victim among candidates. More...

virtual std::shared_ptr< ReplacementData >	instantiateEntry ()=0
	Instantiate a replacement data entry. 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	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 Port &	getPort (const std::string &if_name, PortID idx=InvalidPortID)
	Get a port with a given name and index. 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
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. More...

void	setCurTick (Tick newVal)

	EventManager (EventManager &em)
	Event manger manages events in the event queue. More...

	EventManager (EventManager *em)

	EventManager (EventQueue *eq)

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 Stats::Group
	Group (Group parent, const char name=nullptr)
	Construct a new statistics group. More...

virtual	~Group ()

virtual void	regStats ()
	Callback to set stat parameters. More...

virtual void	resetStats ()
	Callback to reset stats. More...

virtual void	preDumpStats ()
	Callback before stats are dumped. More...

void	addStat (Stats::Info *info)
	Register a stat with this group. More...

const std::map< std::string, Group * > &	getStatGroups () const
	Get all child groups associated with this object. More...

const std::vector< Info * > &	getStats () const
	Get all stats associated with this object. More...

void	addStatGroup (const char name, Group block)
	Add a stat block as a child of this block. More...

const Info *	resolveStat (std::string name) const
	Resolve a stat by its name within this group. More...

	Group ()=delete

	Group (const Group &)=delete

Group &	operator= (const Group &)=delete

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 ()
	Gets the fully-qualified name of the active section. More...

static void	serializeAll (const std::string &cpt_dir)
	Serializes all the SimObjects. More...

static void	unserializeGlobals (CheckpointIn &cp)

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

Detailed Description

A common base class of cache replacement policy objects.

Definition at line 46 of file base.hh.

Member Typedef Documentation

◆ Params

typedef BaseReplacementPolicyParams BaseReplacementPolicy::Params

Convenience typedef.

Definition at line 52 of file base.hh.

Constructor & Destructor Documentation

◆ BaseReplacementPolicy()

BaseReplacementPolicy::BaseReplacementPolicy ( const Params * p )

inline

Construct and initiliaze this replacement policy.

Definition at line 57 of file base.hh.

◆ ~BaseReplacementPolicy()

virtual BaseReplacementPolicy::~BaseReplacementPolicy ( )

inlinevirtual

Destructor.

Definition at line 62 of file base.hh.

Member Function Documentation

◆ getVictim()

virtual ReplaceableEntry* BaseReplacementPolicy::getVictim ( const ReplacementCandidates & candidates ) const

pure virtual

Find replacement victim among candidates.

Parameters

candidates Replacement candidates, selected by indexing policy.

Returns: Replacement entry to be replaced.

Implemented in TreePLRURP, BRRIPRP, SecondChanceRP, WeightedLRUPolicy, RandomRP, FIFORP, LFURP, MRURP, and LRURP.

Referenced by CompressedTags::findVictim(), BaseSetAssoc::findVictim(), and SectorTags::findVictim().

◆ instantiateEntry()

virtual std::shared_ptr<ReplacementData> BaseReplacementPolicy::instantiateEntry ( )

pure virtual

Instantiate a replacement data entry.

Returns: A shared pointer to the new replacement data.

Implemented in TreePLRURP, BRRIPRP, SecondChanceRP, RandomRP, FIFORP, LFURP, MRURP, LRURP, and WeightedLRUPolicy.

Referenced by AssociativeSet< Prefetcher::IrregularStreamBuffer::AddressMappingEntry >::AssociativeSet(), CacheMemory::init(), CompressedTags::tagsInit(), BaseSetAssoc::tagsInit(), and SectorTags::tagsInit().

◆ invalidate()

virtual void BaseReplacementPolicy::invalidate ( const std::shared_ptr< ReplacementData > & replacement_data ) const

pure virtual

Invalidate replacement data to set it as the next probable victim.

Parameters

replacement_data Replacement data to be invalidated.

Implemented in TreePLRURP, BRRIPRP, SecondChanceRP, RandomRP, FIFORP, LFURP, MRURP, LRURP, and WeightedLRUPolicy.

Referenced by CacheMemory::deallocate(), BaseSetAssoc::invalidate(), and SectorTags::invalidate().

◆ reset()

virtual void BaseReplacementPolicy::reset ( const std::shared_ptr< ReplacementData > & replacement_data ) const

pure virtual

Reset replacement data.

Used when it's holder is inserted/validated.

Parameters

replacement_data Replacement data to be reset.

Implemented in TreePLRURP, BRRIPRP, SecondChanceRP, RandomRP, FIFORP, LFURP, MRURP, LRURP, WeightedLRUPolicy, and BIPRP.

Referenced by CacheMemory::allocate(), SectorTags::insertBlock(), and BaseSetAssoc::insertBlock().

◆ touch()

virtual void BaseReplacementPolicy::touch ( const std::shared_ptr< ReplacementData > & replacement_data ) const

pure virtual

Update replacement data.

Parameters

replacement_data Replacement data to be touched.

Implemented in TreePLRURP, BRRIPRP, SecondChanceRP, RandomRP, FIFORP, LFURP, MRURP, LRURP, and WeightedLRUPolicy.

Referenced by BaseSetAssoc::accessBlock(), SectorTags::accessBlock(), SectorTags::insertBlock(), CacheMemory::setMRU(), CacheMemory::testCacheAccess(), and CacheMemory::tryCacheAccess().

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

mem/cache/replacement_policies/base.hh

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Params

Constructor & Destructor Documentation

◆ BaseReplacementPolicy()

◆ ~BaseReplacementPolicy()

Member Function Documentation

◆ getVictim()

◆ instantiateEntry()

◆ invalidate()

◆ reset()

◆ touch()