gem5 v24.0.0.0
Loading...
Searching...
No Matches
gem5::replacement_policy::Base Class Referenceabstract

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

#include <base.hh>

Inheritance diagram for gem5::replacement_policy::Base:
gem5::SimObject gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named gem5::replacement_policy::BRRIP gem5::replacement_policy::Dueling gem5::replacement_policy::FIFO gem5::replacement_policy::LFU gem5::replacement_policy::LRU gem5::replacement_policy::MRU gem5::replacement_policy::Random gem5::replacement_policy::TreePLRU

Public Types

typedef BaseReplacementPolicyParams Params
 
- Public Types inherited from gem5::SimObject
typedef SimObjectParams Params
 

Public Member Functions

 Base (const Params &p)
 
virtual ~Base ()=default
 
virtual void invalidate (const std::shared_ptr< ReplacementData > &replacement_data)=0
 Invalidate replacement data to set it as the next probable victim.
 
virtual void touch (const std::shared_ptr< ReplacementData > &replacement_data, const PacketPtr pkt)
 Update replacement data.
 
virtual void touch (const std::shared_ptr< ReplacementData > &replacement_data) const =0
 
virtual void reset (const std::shared_ptr< ReplacementData > &replacement_data, const PacketPtr pkt)
 Reset replacement data.
 
virtual void reset (const std::shared_ptr< ReplacementData > &replacement_data) const =0
 
virtual ReplaceableEntrygetVictim (const ReplacementCandidates &candidates) const =0
 Find replacement victim among candidates.
 
virtual std::shared_ptr< ReplacementDatainstantiateEntry ()=0
 Instantiate a replacement data entry.
 
- 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.
 
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.
 
ProbeManagergetProbeManager ()
 Get the probe manager for this object.
 
virtual PortgetPort (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
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.
 
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 InforesolveStat (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
 
Groupoperator= (const Group &)=delete
 
- Public Member Functions inherited from gem5::Named
 Named (const std::string &name_)
 
virtual ~Named ()=default
 
virtual std::string name () const
 

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 SimObjectfind (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 SimObjectResolvergetSimObjectResolver ()
 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.
 
- Protected Attributes inherited from gem5::SimObject
const SimObjectParams & _params
 Cached copy of the object parameters.
 
- Protected Attributes inherited from gem5::EventManager
EventQueueeventq
 A pointer to this object's event queue.
 

Detailed Description

A common base class of cache replacement policy objects.

Definition at line 54 of file base.hh.

Member Typedef Documentation

◆ Params

typedef BaseReplacementPolicyParams gem5::replacement_policy::Base::Params

Definition at line 57 of file base.hh.

Constructor & Destructor Documentation

◆ Base()

gem5::replacement_policy::Base::Base ( const Params & p)
inline

Definition at line 58 of file base.hh.

◆ ~Base()

virtual gem5::replacement_policy::Base::~Base ( )
virtualdefault

Member Function Documentation

◆ getVictim()

◆ instantiateEntry()

◆ invalidate()

◆ reset() [1/2]

◆ reset() [2/2]

virtual void gem5::replacement_policy::Base::reset ( const std::shared_ptr< ReplacementData > & replacement_data,
const PacketPtr pkt )
inlinevirtual

◆ touch() [1/2]

◆ touch() [2/2]


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

Generated on Tue Jun 18 2024 16:24:21 for gem5 by doxygen 1.11.0