gem5  v22.1.0.0
Classes | Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
gem5::replacement_policy::SHiP Class Referenceabstract

#include <ship_rp.hh>

Inheritance diagram for gem5::replacement_policy::SHiP:
gem5::replacement_policy::BRRIP gem5::replacement_policy::Base gem5::SimObject gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named gem5::replacement_policy::SHiPMem gem5::replacement_policy::SHiPPC

Classes

class  SHiPReplData
 SHiP-specific implementation of replacement data. More...
 

Public Types

typedef SHiPRPParams Params
 
- Public Types inherited from gem5::replacement_policy::BRRIP
typedef BRRIPRPParams Params
 
- Public Types inherited from gem5::replacement_policy::Base
typedef BaseReplacementPolicyParams Params
 
- Public Types inherited from gem5::SimObject
typedef SimObjectParams Params
 

Public Member Functions

 SHiP (const Params &p)
 
 ~SHiP ()=default
 
void invalidate (const std::shared_ptr< ReplacementData > &replacement_data) override
 Invalidate replacement data to set it as the next probable victim. More...
 
void touch (const std::shared_ptr< ReplacementData > &replacement_data, const PacketPtr pkt) override
 Touch an entry to update its replacement data. More...
 
void touch (const std::shared_ptr< ReplacementData > &replacement_data) const override
 Touch an entry to update its replacement data. More...
 
void reset (const std::shared_ptr< ReplacementData > &replacement_data, const PacketPtr pkt) override
 Reset replacement data. More...
 
void reset (const std::shared_ptr< ReplacementData > &replacement_data) const override
 Reset replacement data. More...
 
std::shared_ptr< ReplacementDatainstantiateEntry () override
 Instantiate a replacement data entry. More...
 
- Public Member Functions inherited from gem5::replacement_policy::BRRIP
 BRRIP (const Params &p)
 
 ~BRRIP ()=default
 
ReplaceableEntrygetVictim (const ReplacementCandidates &candidates) const override
 Find replacement victim using rrpv. More...
 
- Public Member Functions inherited from gem5::replacement_policy::Base
 Base (const Params &p)
 
virtual ~Base ()=default
 
- 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 Types

typedef std::size_t SignatureType
 

Protected Member Functions

virtual SignatureType getSignature (const PacketPtr pkt) const =0
 Extract signature from packet. 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...
 

Protected Attributes

const double insertionThreshold
 Saturation percentage at which an entry starts being inserted as intermediate re-reference. More...
 
std::vector< SatCounter8SHCT
 Signature History Counter Table; learns the re-reference behavior of a signature. More...
 
- Protected Attributes inherited from gem5::replacement_policy::BRRIP
const unsigned numRRPVBits
 Number of RRPV bits. More...
 
const bool hitPriority
 The hit priority (HP) policy replaces entries that do not receive cache hits over any cache entry that receives a hit, while the frequency priority (FP) policy replaces infrequently re-referenced entries. More...
 
const unsigned btp
 Bimodal throtle parameter. 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...
 

Detailed Description

Definition at line 58 of file ship_rp.hh.

Member Typedef Documentation

◆ Params

Definition at line 119 of file ship_rp.hh.

◆ SignatureType

typedef std::size_t gem5::replacement_policy::SHiP::SignatureType
protected

Definition at line 61 of file ship_rp.hh.

Constructor & Destructor Documentation

◆ SHiP()

gem5::replacement_policy::SHiP::SHiP ( const Params p)

Definition at line 72 of file ship_rp.cc.

◆ ~SHiP()

gem5::replacement_policy::SHiP::~SHiP ( )
default

Member Function Documentation

◆ getSignature()

virtual SignatureType gem5::replacement_policy::SHiP::getSignature ( const PacketPtr  pkt) const
protectedpure virtual

Extract signature from packet.

Parameters
pktThe packet to extract a signature from.
Returns
The signature extracted.

Implemented in gem5::replacement_policy::SHiPPC, and gem5::replacement_policy::SHiPMem.

Referenced by reset(), and touch().

◆ instantiateEntry()

std::shared_ptr< ReplacementData > gem5::replacement_policy::SHiP::instantiateEntry ( )
overridevirtual

Instantiate a replacement data entry.

Returns
A shared pointer to the new replacement data.

Reimplemented from gem5::replacement_policy::BRRIP.

Definition at line 145 of file ship_rp.cc.

References gem5::replacement_policy::BRRIP::numRRPVBits.

◆ invalidate()

void gem5::replacement_policy::SHiP::invalidate ( const std::shared_ptr< ReplacementData > &  replacement_data)
overridevirtual

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

Updates predictor and invalidate data.

Parameters
replacement_dataReplacement data to be invalidated.

Reimplemented from gem5::replacement_policy::BRRIP.

Definition at line 79 of file ship_rp.cc.

References gem5::replacement_policy::BRRIP::invalidate(), and SHCT.

◆ reset() [1/2]

void gem5::replacement_policy::SHiP::reset ( const std::shared_ptr< ReplacementData > &  replacement_data) const
overridevirtual

Reset replacement data.

Used when an entry is inserted. Set RRPV according to the insertion policy used.

Parameters
replacement_dataReplacement data to be reset.

Reimplemented from gem5::replacement_policy::BRRIP.

Definition at line 138 of file ship_rp.cc.

References panic.

◆ reset() [2/2]

void gem5::replacement_policy::SHiP::reset ( const std::shared_ptr< ReplacementData > &  replacement_data,
const PacketPtr  pkt 
)
overridevirtual

Reset replacement data.

Used when an entry is inserted. Updates predictor and assigns RRPV values of Table 3.

Parameters
replacement_dataReplacement data to be reset.
pktPacket that generated this miss.

Reimplemented from gem5::replacement_policy::Base.

Definition at line 117 of file ship_rp.cc.

References getSignature(), insertionThreshold, gem5::replacement_policy::BRRIP::reset(), and SHCT.

◆ touch() [1/2]

void gem5::replacement_policy::SHiP::touch ( const std::shared_ptr< ReplacementData > &  replacement_data) const
overridevirtual

Touch an entry to update its replacement data.

Parameters
replacement_dataReplacement data to be touched.

Reimplemented from gem5::replacement_policy::BRRIP.

Definition at line 110 of file ship_rp.cc.

References panic.

◆ touch() [2/2]

void gem5::replacement_policy::SHiP::touch ( const std::shared_ptr< ReplacementData > &  replacement_data,
const PacketPtr  pkt 
)
overridevirtual

Touch an entry to update its replacement data.

Updates predictor and assigns RRPV values of Table 3.

Parameters
replacement_dataReplacement data to be touched.
pktPacket that generated this hit.

Reimplemented from gem5::replacement_policy::Base.

Definition at line 94 of file ship_rp.cc.

References getSignature(), SHCT, and gem5::replacement_policy::BRRIP::touch().

Member Data Documentation

◆ insertionThreshold

const double gem5::replacement_policy::SHiP::insertionThreshold
protected

Saturation percentage at which an entry starts being inserted as intermediate re-reference.

Definition at line 101 of file ship_rp.hh.

Referenced by reset().

◆ SHCT

std::vector<SatCounter8> gem5::replacement_policy::SHiP::SHCT
protected

Signature History Counter Table; learns the re-reference behavior of a signature.

A zero entry provides a strong indication that future lines brought by that signature will not receive any hits.

Definition at line 108 of file ship_rp.hh.

Referenced by gem5::replacement_policy::SHiPMem::getSignature(), gem5::replacement_policy::SHiPPC::getSignature(), invalidate(), reset(), and touch().


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

Generated on Wed Dec 21 2022 10:24:21 for gem5 by doxygen 1.9.1