A common base class for indexing table locations. More...

#include <base.hh>

Inheritance diagram for gem5::BaseIndexingPolicy:

Public Types
typedef BaseIndexingPolicyParams	Params
	Convenience typedef.

Public Types inherited from gem5::SimObject
typedef SimObjectParams	Params

Public Member Functions
	BaseIndexingPolicy (const Params &p)
	Construct and initialize this policy.

	~BaseIndexingPolicy ()
	Destructor.

void	setEntry (ReplaceableEntry *entry, const uint64_t index)
	Associate a pointer to an entry to its physical counterpart.

ReplaceableEntry *	getEntry (const uint32_t set, const uint32_t way) const
	Get an entry based on its set and way.

virtual Addr	extractTag (const Addr addr) const
	Generate the tag from the given address.

virtual std::vector< ReplaceableEntry * >	getPossibleEntries (const Addr addr) const =0
	Find all possible entries for insertion and replacement of an address.

virtual Addr	regenerateAddr (const Addr tag, const ReplaceableEntry *entry) const =0
	Regenerate an entry's address from its tag and assigned indexing bits.

Public Member Functions inherited from gem5::SimObject
const Params &	params () const

	SimObject (const Params &p)

virtual	~SimObject ()

virtual void	init ()
	init() is called after all C++ SimObjects have been created and all ports are connected.

virtual void	loadState (CheckpointIn &cp)
	loadState() is called on each SimObject when restoring from a checkpoint.

virtual void	initState ()
	initState() is called on each SimObject when not restoring from a checkpoint.

virtual void	regProbePoints ()
	Register probe points for this object.

virtual void	regProbeListeners ()
	Register probe listeners for this object.

ProbeManager *	getProbeManager ()
	Get the probe manager for this object.

virtual Port &	getPort (const std::string &if_name, PortID idx=InvalidPortID)
	Get a port with a given name and index.

virtual void	startup ()
	startup() is the final initialization call before simulation.

DrainState	drain () override
	Provide a default implementation of the drain interface for objects that don't need draining.

virtual void	memWriteback ()
	Write back dirty buffers to memory using functional writes.

virtual void	memInvalidate ()
	Invalidate the contents of memory buffers.

void	serialize (CheckpointOut &cp) const override
	Serialize an object.

void	unserialize (CheckpointIn &cp) override
	Unserialize an object.

Public Member Functions inherited from gem5::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.

void	setCurTick (Tick newVal)

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

	EventManager (EventManager *em)

	EventManager (EventQueue *eq)

Public Member Functions inherited from gem5::Serializable
	Serializable ()

virtual	~Serializable ()

void	serializeSection (CheckpointOut &cp, const char *name) const
	Serialize an object into a new section.

void	serializeSection (CheckpointOut &cp, const std::string &name) const

void	unserializeSection (CheckpointIn &cp, const char *name)
	Unserialize an a child object.

void	unserializeSection (CheckpointIn &cp, const std::string &name)

Public Member Functions inherited from gem5::Drainable
DrainState	drainState () const
	Return the current drain state of an object.

virtual void	notifyFork ()
	Notify a child process of a fork.

Public Member Functions inherited from gem5::statistics::Group
	Group (Group parent, const char name=nullptr)
	Construct a new statistics group.

virtual	~Group ()

virtual void	regStats ()
	Callback to set stat parameters.

virtual void	resetStats ()
	Callback to reset stats.

virtual void	preDumpStats ()
	Callback before stats are dumped.

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

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

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

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

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

void	mergeStatGroup (Group *block)
	Merge the contents (stats & children) of a block to this block.

	Group ()=delete

	Group (const Group &)=delete

Group &	operator= (const Group &)=delete

Public Member Functions inherited from gem5::Named
	Named (const std::string &name_)

virtual	~Named ()=default

virtual std::string	name () const

Protected Attributes
const unsigned	assoc
	The associativity.

const uint32_t	numSets
	The number of sets in the cache.

const int	setShift
	The amount to shift the address to get the set.

const unsigned	setMask
	Mask out all bits that aren't part of the set index.

std::vector< std::vector< ReplaceableEntry * > >	sets
	The cache sets.

const int	tagShift
	The amount to shift the address to get the tag.

Protected Attributes inherited from gem5::SimObject
const SimObjectParams &	_params
	Cached copy of the object parameters.

Protected Attributes inherited from gem5::EventManager
EventQueue *	eventq
	A pointer to this object's event queue.

Additional Inherited Members
Static Public Member Functions inherited from gem5::SimObject
static void	serializeAll (const std::string &cpt_dir)
	Create a checkpoint by serializing all SimObjects in the system.

static SimObject *	find (const char *name)
	Find the SimObject with the given name and return a pointer to it.

static void	setSimObjectResolver (SimObjectResolver *resolver)
	There is a single object name resolver, and it is only set when simulation is restoring from checkpoints.

static SimObjectResolver *	getSimObjectResolver ()
	There is a single object name resolver, and it is only set when simulation is restoring from checkpoints.

Static Public Member Functions inherited from gem5::Serializable
static const std::string &	currentSection ()
	Gets the fully-qualified name of the active section.

static void	generateCheckpointOut (const std::string &cpt_dir, std::ofstream &outstream)
	Generate a checkpoint file so that the serialization can be routed to it.

Protected Member Functions inherited from gem5::Drainable
	Drainable ()

virtual	~Drainable ()

virtual void	drainResume ()
	Resume execution after a successful drain.

void	signalDrainDone () const
	Signal that an object is drained.

Detailed Description

A common base class for indexing table locations.

Classes that inherit from it determine hash functions that should be applied based on the set and way. These functions are then applied to re-map the original values.

See also: gem5 Memory System

Definition at line 66 of file base.hh.

Member Typedef Documentation

◆ Params

typedef BaseIndexingPolicyParams gem5::BaseIndexingPolicy::Params

Convenience typedef.

Definition at line 103 of file base.hh.

Constructor & Destructor Documentation

◆ BaseIndexingPolicy()

gem5::BaseIndexingPolicy::BaseIndexingPolicy ( const Params & p )

Construct and initialize this policy.

Definition at line 58 of file base.cc.

References assoc, fatal_if, gem5::ArmISA::i, gem5::isPowerOf2(), numSets, and sets.

◆ ~BaseIndexingPolicy()

gem5::BaseIndexingPolicy::~BaseIndexingPolicy ( )

inline

Destructor.

Definition at line 113 of file base.hh.

Member Function Documentation

◆ extractTag()

Addr gem5::BaseIndexingPolicy::extractTag ( const Addr addr ) const

virtual

Generate the tag from the given address.

Parameters

addr	The address to get the tag from.

Returns: The tag of the address.

Reimplemented in gem5::prefetch::StridePrefetcherHashedSetAssociative.

Definition at line 99 of file base.cc.

References gem5::X86ISA::addr, and tagShift.

Referenced by gem5::BaseTags::extractTag(), gem5::AssociativeCache< Entry >::getTag(), and gem5::AssociativeCache< Entry >::insertEntry().

◆ getEntry()

ReplaceableEntry * gem5::BaseIndexingPolicy::getEntry	(	const uint32_t	set,
		const uint32_t	way ) const

Get an entry based on its set and way.

All entries must have been set already before calling this function.

Parameters

set	The set of the desired entry.
way	The way of the desired entry.

Returns: entry The entry pointer.

Definition at line 75 of file base.cc.

References gem5::ArmISA::set, and sets.

Referenced by gem5::BaseTags::findBlockBySetAndWay().

◆ getPossibleEntries()

virtual std::vector< ReplaceableEntry * > gem5::BaseIndexingPolicy::getPossibleEntries ( const Addr addr ) const

pure virtual

Find all possible entries for insertion and replacement of an address.

Should be called immediately before ReplacementPolicy's findVictim() not to break cache resizing.

Parameters

addr	The addr to a find possible entries for.

Returns: The possible entries.

Implemented in gem5::SetAssociative, and gem5::SkewedAssociative.

Referenced by gem5::BaseTags::findBlock(), gem5::SectorTags::findBlock(), gem5::AssociativeCache< Entry >::findEntry(), gem5::AssociativeCache< Entry >::findVictim(), gem5::BaseSetAssoc::findVictim(), gem5::CompressedTags::findVictim(), gem5::SectorTags::findVictim(), and gem5::AssociativeCache< Entry >::getPossibleEntries().

◆ regenerateAddr()

virtual Addr gem5::BaseIndexingPolicy::regenerateAddr	(	const Addr	tag,
		const ReplaceableEntry *	entry ) const

pure virtual

Regenerate an entry's address from its tag and assigned indexing bits.

Parameters

tag	The tag bits.
entry	The entry.

Returns: the entry's original address.

Implemented in gem5::SetAssociative, and gem5::SkewedAssociative.

Referenced by gem5::BaseSetAssoc::regenerateBlkAddr(), and gem5::SectorTags::regenerateBlkAddr().

◆ setEntry()

void gem5::BaseIndexingPolicy::setEntry	(	ReplaceableEntry *	entry,
		const uint64_t	index )

Associate a pointer to an entry to its physical counterpart.

Parameters

entry	The entry pointer.
index	An unique index for the entry.

Definition at line 81 of file base.cc.

References assoc, gem5::MipsISA::index, numSets, gem5::ArmISA::set, gem5::ReplaceableEntry::setPosition(), and sets.

Referenced by gem5::AssociativeCache< Entry >::initParams(), gem5::BaseSetAssoc::tagsInit(), gem5::CompressedTags::tagsInit(), and gem5::SectorTags::tagsInit().

Member Data Documentation

◆ assoc

const unsigned gem5::BaseIndexingPolicy::assoc

protected

The associativity.

Definition at line 72 of file base.hh.

Referenced by BaseIndexingPolicy(), gem5::SkewedAssociative::getPossibleEntries(), setEntry(), and gem5::SkewedAssociative::SkewedAssociative().

◆ numSets

const uint32_t gem5::BaseIndexingPolicy::numSets

protected

The number of sets in the cache.

Definition at line 77 of file base.hh.

Referenced by BaseIndexingPolicy(), setEntry(), and gem5::SkewedAssociative::SkewedAssociative().

◆ setMask

const unsigned gem5::BaseIndexingPolicy::setMask

protected

Mask out all bits that aren't part of the set index.

Definition at line 87 of file base.hh.

Referenced by gem5::prefetch::StridePrefetcherHashedSetAssociative::extractSet(), gem5::SetAssociative::extractSet(), gem5::SkewedAssociative::extractSet(), and gem5::SkewedAssociative::regenerateAddr().

◆ sets

std::vector<std::vector<ReplaceableEntry*> > gem5::BaseIndexingPolicy::sets

protected

The cache sets.

Definition at line 92 of file base.hh.

Referenced by BaseIndexingPolicy(), getEntry(), gem5::SetAssociative::getPossibleEntries(), gem5::SkewedAssociative::getPossibleEntries(), and setEntry().

◆ setShift

const int gem5::BaseIndexingPolicy::setShift

protected

The amount to shift the address to get the set.

Definition at line 82 of file base.hh.

Referenced by gem5::SetAssociative::extractSet(), gem5::SkewedAssociative::extractSet(), gem5::SetAssociative::regenerateAddr(), gem5::SkewedAssociative::regenerateAddr(), and gem5::SkewedAssociative::SkewedAssociative().

◆ tagShift

const int gem5::BaseIndexingPolicy::tagShift

protected

The amount to shift the address to get the tag.

Definition at line 97 of file base.hh.

Referenced by gem5::prefetch::StridePrefetcherHashedSetAssociative::extractSet(), extractTag(), gem5::SetAssociative::regenerateAddr(), and gem5::SkewedAssociative::regenerateAddr().

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

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

Public Types

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Params

Constructor & Destructor Documentation

◆ BaseIndexingPolicy()

◆ ~BaseIndexingPolicy()

Member Function Documentation

◆ extractTag()

◆ getEntry()

◆ getPossibleEntries()

◆ regenerateAddr()

◆ setEntry()

Member Data Documentation

◆ assoc

◆ numSets

◆ setMask

◆ sets

◆ setShift

◆ tagShift