gem5  v21.1.0.2
Public Types | Public Member Functions | Protected Attributes | List of all members
gem5::BaseIndexingPolicy Class Referenceabstract

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

#include <base.hh>

Inheritance diagram for gem5::BaseIndexingPolicy:
gem5::SimObject gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named gem5::SetAssociative gem5::SkewedAssociative gem5::prefetch::StridePrefetcherHashedSetAssociative

Public Types

typedef BaseIndexingPolicyParams Params
 Convenience typedef. More...
 
- Public Types inherited from gem5::SimObject
typedef SimObjectParams Params
 

Public Member Functions

 BaseIndexingPolicy (const Params &p)
 Construct and initialize this policy. More...
 
 ~BaseIndexingPolicy ()
 Destructor. More...
 
void setEntry (ReplaceableEntry *entry, const uint64_t index)
 Associate a pointer to an entry to its physical counterpart. More...
 
ReplaceableEntrygetEntry (const uint32_t set, const uint32_t way) const
 Get an entry based on its set and way. More...
 
virtual Addr extractTag (const Addr addr) const
 Generate the tag from the given address. More...
 
virtual std::vector< ReplaceableEntry * > getPossibleEntries (const Addr addr) const =0
 Find all possible entries for insertion and replacement of an address. More...
 
virtual Addr regenerateAddr (const Addr tag, const ReplaceableEntry *entry) const =0
 Regenerate an entry's address from its tag and assigned indexing bits. More...
 
- Public Member Functions inherited from gem5::SimObject
const Paramsparams () 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. 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...
 
ProbeManagergetProbeManager ()
 Get the probe manager for this object. More...
 
virtual PortgetPort (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 gem5::EventManager
EventQueueeventQueue () 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 gem5::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 gem5::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 gem5::statistics::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 (statistics::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 InforesolveStat (std::string name) const
 Resolve a stat by its name within this group. More...
 
void mergeStatGroup (Group *block)
 Merge the contents (stats & children) of a block to this block. More...
 
 Group ()=delete
 
 Group (const Group &)=delete
 
Groupoperator= (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. More...
 
const uint32_t numSets
 The number of sets in the cache. More...
 
const int setShift
 The amount to shift the address to get the set. More...
 
const unsigned setMask
 Mask out all bits that aren't part of the set index. More...
 
std::vector< std::vector< ReplaceableEntry * > > sets
 The cache sets. More...
 
const int tagShift
 The amount to shift the address to get the tag. More...
 
- Protected Attributes inherited from gem5::SimObject
const SimObjectParams & _params
 Cached copy of the object parameters. More...
 
- Protected Attributes inherited from gem5::EventManager
EventQueueeventq
 A pointer to this object's event queue. More...
 

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. More...
 
static SimObjectfind (const char *name)
 Find the SimObject with the given name and return a pointer to it. More...
 
static void setSimObjectResolver (SimObjectResolver *resolver)
 There is a single object name resolver, and it is only set when simulation is restoring from checkpoints. More...
 
static SimObjectResolvergetSimObjectResolver ()
 There is a single object name resolver, and it is only set when simulation is restoring from checkpoints. More...
 
- Static Public Member Functions inherited from gem5::Serializable
static const std::string & currentSection ()
 Gets the fully-qualified name of the active section. More...
 
static void generateCheckpointOut (const std::string &cpt_dir, std::ofstream &outstream)
 Generate a checkpoint file so that the serialization can be routed to it. More...
 
- Protected Member Functions inherited from gem5::Drainable
 Drainable ()
 
virtual ~Drainable ()
 
virtual void drainResume ()
 Resume execution after a successful drain. More...
 
void signalDrainDone () const
 Signal that an object is drained. More...
 

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
addrThe 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().

◆ 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
setThe set of the desired entry.
wayThe way of the desired entry.
Returns
entry The entry pointer.

Definition at line 75 of file base.cc.

References 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
addrThe addr to a find possible entries for.
Returns
The possible entries.

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

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

◆ 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
tagThe tag bits.
entryThe entry.
Returns
the entry's original address.

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

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

◆ setEntry()

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

Associate a pointer to an entry to its physical counterpart.

Parameters
entryThe entry pointer.
indexAn unique index for the entry.

Definition at line 81 of file base.cc.

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

Referenced by gem5::CompressedTags::tagsInit(), gem5::BaseSetAssoc::tagsInit(), and gem5::SectorTags::tagsInit().

Member Data Documentation

◆ assoc

const unsigned gem5::BaseIndexingPolicy::assoc
protected

◆ 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

◆ sets

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

◆ setShift

const int gem5::BaseIndexingPolicy::setShift
protected

◆ tagShift

const int gem5::BaseIndexingPolicy::tagShift
protected

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

Generated on Tue Sep 21 2021 12:27:19 for gem5 by doxygen 1.8.17