gem5  v21.1.0.2
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
gem5::prefetch::Base Class Referenceabstract

#include <base.hh>

Inheritance diagram for gem5::prefetch::Base:
gem5::ClockedObject gem5::SimObject gem5::Clocked gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named gem5::prefetch::Multi gem5::prefetch::Queued gem5::prefetch::AMPM gem5::prefetch::BOP gem5::prefetch::DCPT gem5::prefetch::IndirectMemory gem5::prefetch::IrregularStreamBuffer gem5::prefetch::PIF gem5::prefetch::SBOOE gem5::prefetch::SignaturePath gem5::prefetch::SlimAMPM gem5::prefetch::STeMS gem5::prefetch::Stride gem5::prefetch::Tagged

Classes

class  PrefetchInfo
 Class containing the information needed by the prefetch to train and generate new prefetch requests. More...
 
class  PrefetchListener
 
struct  StatGroup
 

Public Member Functions

 Base (const BasePrefetcherParams &p)
 
virtual ~Base ()=default
 
virtual void setCache (BaseCache *_cache)
 
virtual void notify (const PacketPtr &pkt, const PrefetchInfo &pfi)=0
 Notify prefetcher of cache access (may be any access or just misses, depending on cache parameters.) More...
 
virtual void notifyFill (const PacketPtr &pkt)
 Notify prefetcher of cache fill. More...
 
virtual PacketPtr getPacket ()=0
 
virtual Tick nextPrefetchReadyTime () const =0
 
void prefetchUnused ()
 
void incrDemandMhsrMisses ()
 
void pfHitInCache ()
 
void pfHitInMSHR ()
 
void pfHitInWB ()
 
void regProbeListeners () override
 Register probe points for this object. More...
 
void probeNotify (const PacketPtr &pkt, bool miss)
 Process a notification event from the ProbeListener. More...
 
void addEventProbe (SimObject *obj, const char *name)
 Add a SimObject and a probe name to listen events from. More...
 
void addTLB (BaseTLB *tlb)
 Add a BaseTLB object to be used whenever a translation is needed. More...
 
- Public Member Functions inherited from gem5::ClockedObject
 ClockedObject (const ClockedObjectParams &p)
 
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::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...
 
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
 
- Public Member Functions inherited from gem5::Clocked
void updateClockPeriod ()
 Update the tick to the current tick. More...
 
Tick clockEdge (Cycles cycles=Cycles(0)) const
 Determine the tick when a cycle begins, by default the current one, but the argument also enables the caller to determine a future cycle. More...
 
Cycles curCycle () const
 Determine the current cycle, corresponding to a tick aligned to a clock edge. More...
 
Tick nextCycle () const
 Based on the clock of the object, determine the start tick of the first cycle that is at least one cycle in the future. More...
 
uint64_t frequency () const
 
Tick clockPeriod () const
 
double voltage () const
 
Cycles ticksToCycles (Tick t) const
 
Tick cyclesToTicks (Cycles c) const
 

Protected Member Functions

bool observeAccess (const PacketPtr &pkt, bool miss) const
 Determine if this access should be observed. More...
 
bool inCache (Addr addr, bool is_secure) const
 Determine if address is in cache. More...
 
bool inMissQueue (Addr addr, bool is_secure) const
 Determine if address is in cache miss queue. More...
 
bool hasBeenPrefetched (Addr addr, bool is_secure) const
 
bool samePage (Addr a, Addr b) const
 Determine if addresses are on the same page. More...
 
Addr blockAddress (Addr a) const
 Determine the address of the block in which a lays. More...
 
Addr blockIndex (Addr a) const
 Determine the address of a at block granularity. More...
 
Addr pageAddress (Addr a) const
 Determine the address of the page in which a lays. More...
 
Addr pageOffset (Addr a) const
 Determine the page-offset of a
More...
 
Addr pageIthBlockAddress (Addr page, uint32_t i) const
 Build the address of the i-th block inside the page. 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 Member Functions inherited from gem5::Clocked
 Clocked (ClockDomain &clk_domain)
 Create a clocked object and set the clock domain based on the parameters. More...
 
 Clocked (Clocked &)=delete
 
Clockedoperator= (Clocked &)=delete
 
virtual ~Clocked ()
 Virtual destructor due to inheritance. More...
 
void resetClock () const
 Reset the object's clock using the current global tick value. More...
 
virtual void clockPeriodUpdated ()
 A hook subclasses can implement so they can do any extra work that's needed when the clock rate is changed. More...
 

Protected Attributes

BaseCachecache
 Pointr to the parent cache. More...
 
unsigned blkSize
 The block size of the parent cache. More...
 
unsigned lBlkSize
 log_2(block size of the parent cache). More...
 
const bool onMiss
 Only consult prefetcher on cache misses? More...
 
const bool onRead
 Consult prefetcher on reads? More...
 
const bool onWrite
 Consult prefetcher on reads? More...
 
const bool onData
 Consult prefetcher on data accesses? More...
 
const bool onInst
 Consult prefetcher on instruction accesses? More...
 
const RequestorID requestorId
 Request id for prefetches. More...
 
const Addr pageBytes
 
const bool prefetchOnAccess
 Prefetch on every access, not just misses. More...
 
const bool prefetchOnPfHit
 Prefetch on hit on prefetched lines. More...
 
const bool useVirtualAddresses
 Use Virtual Addresses for prefetching. More...
 
gem5::prefetch::Base::StatGroup prefetchStats
 
uint64_t issuedPrefetches
 Total prefetches issued. More...
 
uint64_t usefulPrefetches
 Total prefetches that has been useful. More...
 
BaseTLBtlb
 Registered tlb for address translations. 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...
 

Private Attributes

std::vector< PrefetchListener * > listeners
 

Additional Inherited Members

- Public Types inherited from gem5::ClockedObject
using Params = ClockedObjectParams
 Parameters of ClockedObject. More...
 
- Public Types inherited from gem5::SimObject
typedef SimObjectParams Params
 
- 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...
 
- Public Attributes inherited from gem5::ClockedObject
PowerStatepowerState
 

Detailed Description

Definition at line 72 of file base.hh.

Constructor & Destructor Documentation

◆ Base()

Base::Base ( const BasePrefetcherParams &  p)

Definition at line 96 of file base.cc.

◆ ~Base()

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

Member Function Documentation

◆ addEventProbe()

void Base::addEventProbe ( SimObject obj,
const char *  name 
)

Add a SimObject and a probe name to listen events from.

Parameters
objThe SimObject pointer to listen from
nameThe probe name

Definition at line 295 of file base.cc.

References gem5::SimObject::getProbeManager(), listeners, and gem5::Named::name().

◆ addTLB()

void Base::addTLB ( BaseTLB tlb)

Add a BaseTLB object to be used whenever a translation is needed.

This is generally required when the prefetcher is allowed to generate page crossing references and/or uses virtual addresses for training.

Parameters
tlbpointer to the BaseTLB object to add

Definition at line 302 of file base.cc.

References fatal_if, gem5::ArmISA::t, and tlb.

◆ blockAddress()

Addr Base::blockAddress ( Addr  a) const
protected

Determine the address of the block in which a lays.

Definition at line 213 of file base.cc.

References gem5::ArmISA::a, and blkSize.

Referenced by gem5::prefetch::Tagged::calculatePrefetch(), and gem5::prefetch::Queued::notify().

◆ blockIndex()

Addr Base::blockIndex ( Addr  a) const
protected

Determine the address of a at block granularity.

Definition at line 219 of file base.cc.

References gem5::ArmISA::a, and lBlkSize.

Referenced by gem5::prefetch::IrregularStreamBuffer::calculatePrefetch(), and pageIthBlockAddress().

◆ getPacket()

virtual PacketPtr gem5::prefetch::Base::getPacket ( )
pure virtual

◆ hasBeenPrefetched()

bool Base::hasBeenPrefetched ( Addr  addr,
bool  is_secure 
) const
protected

Definition at line 201 of file base.cc.

References gem5::X86ISA::addr, cache, and gem5::BaseCache::hasBeenPrefetched().

Referenced by observeAccess(), and probeNotify().

◆ inCache()

bool Base::inCache ( Addr  addr,
bool  is_secure 
) const
protected

◆ incrDemandMhsrMisses()

void gem5::prefetch::Base::incrDemandMhsrMisses ( )
inline

◆ inMissQueue()

bool Base::inMissQueue ( Addr  addr,
bool  is_secure 
) const
protected

◆ nextPrefetchReadyTime()

virtual Tick gem5::prefetch::Base::nextPrefetchReadyTime ( ) const
pure virtual

◆ notify()

virtual void gem5::prefetch::Base::notify ( const PacketPtr pkt,
const PrefetchInfo pfi 
)
pure virtual

Notify prefetcher of cache access (may be any access or just misses, depending on cache parameters.)

Implemented in gem5::prefetch::Queued, and gem5::prefetch::Multi.

Referenced by probeNotify().

◆ notifyFill()

virtual void gem5::prefetch::Base::notifyFill ( const PacketPtr pkt)
inlinevirtual

Notify prefetcher of cache fill.

Reimplemented in gem5::prefetch::SBOOE, gem5::prefetch::BOP, and gem5::prefetch::Multi.

Definition at line 383 of file base.hh.

◆ observeAccess()

bool Base::observeAccess ( const PacketPtr pkt,
bool  miss 
) const
protected

Determine if this access should be observed.

Parameters
pktThe memory request causing the event
misswhether this event comes from a cache miss

Definition at line 161 of file base.cc.

References gem5::MemCmd::CleanEvict, gem5::Packet::cmd, gem5::Packet::getAddr(), hasBeenPrefetched(), gem5::X86ISA::inv, gem5::Packet::isInvalidate(), gem5::Packet::isRead(), gem5::Packet::isSecure(), onData, onInst, onMiss, onRead, onWrite, prefetchOnAccess, prefetchOnPfHit, and gem5::Packet::req.

Referenced by probeNotify().

◆ pageAddress()

Addr Base::pageAddress ( Addr  a) const
protected

Determine the address of the page in which a lays.

Definition at line 225 of file base.cc.

References gem5::ArmISA::a, pageBytes, and gem5::roundDown().

◆ pageIthBlockAddress()

Addr Base::pageIthBlockAddress ( Addr  page,
uint32_t  i 
) const
protected

Build the address of the i-th block inside the page.

Definition at line 237 of file base.cc.

References blockIndex(), and lBlkSize.

◆ pageOffset()

Addr Base::pageOffset ( Addr  a) const
protected

Determine the page-offset of a

Definition at line 231 of file base.cc.

References gem5::ArmISA::a, and pageBytes.

◆ pfHitInCache()

void gem5::prefetch::Base::pfHitInCache ( )
inline

◆ pfHitInMSHR()

void gem5::prefetch::Base::pfHitInMSHR ( )
inline

◆ pfHitInWB()

void gem5::prefetch::Base::pfHitInWB ( )
inline

◆ prefetchUnused()

void gem5::prefetch::Base::prefetchUnused ( )
inline

Definition at line 391 of file base.hh.

References gem5::prefetch::Base::StatGroup::pfUnused, and prefetchStats.

Referenced by gem5::BaseCache::invalidateBlock().

◆ probeNotify()

void Base::probeNotify ( const PacketPtr pkt,
bool  miss 
)

◆ regProbeListeners()

void Base::regProbeListeners ( )
overridevirtual

Register probe points for this object.

If no probes were added by the configuration scripts, connect to the parent cache using the probe "Miss". Also connect to "Hit", if the cache is configured to prefetch on accesses.

Reimplemented from gem5::SimObject.

Definition at line 276 of file base.cc.

References cache, gem5::SimObject::getProbeManager(), and listeners.

◆ samePage()

bool Base::samePage ( Addr  a,
Addr  b 
) const
protected

Determine if addresses are on the same page.

Definition at line 207 of file base.cc.

References gem5::ArmISA::a, gem5::ArmISA::b, pageBytes, and gem5::roundDown().

Referenced by gem5::prefetch::Queued::insert(), and gem5::prefetch::Queued::notify().

◆ setCache()

void Base::setCache ( BaseCache _cache)
virtual

Reimplemented in gem5::prefetch::Multi.

Definition at line 111 of file base.cc.

References blkSize, cache, gem5::floorLog2(), gem5::BaseCache::getBlockSize(), and lBlkSize.

Member Data Documentation

◆ blkSize

unsigned gem5::prefetch::Base::blkSize
protected

◆ cache

BaseCache* gem5::prefetch::Base::cache
protected

Pointr to the parent cache.

Definition at line 267 of file base.hh.

Referenced by hasBeenPrefetched(), inCache(), inMissQueue(), gem5::prefetch::Queued::insert(), probeNotify(), regProbeListeners(), and setCache().

◆ issuedPrefetches

uint64_t gem5::prefetch::Base::issuedPrefetches
protected

◆ lBlkSize

unsigned gem5::prefetch::Base::lBlkSize
protected

◆ listeners

std::vector<PrefetchListener *> gem5::prefetch::Base::listeners
private

Definition at line 89 of file base.hh.

Referenced by addEventProbe(), and regProbeListeners().

◆ onData

const bool gem5::prefetch::Base::onData
protected

Consult prefetcher on data accesses?

Definition at line 285 of file base.hh.

Referenced by observeAccess().

◆ onInst

const bool gem5::prefetch::Base::onInst
protected

Consult prefetcher on instruction accesses?

Definition at line 288 of file base.hh.

Referenced by observeAccess().

◆ onMiss

const bool gem5::prefetch::Base::onMiss
protected

Only consult prefetcher on cache misses?

Definition at line 276 of file base.hh.

Referenced by observeAccess().

◆ onRead

const bool gem5::prefetch::Base::onRead
protected

Consult prefetcher on reads?

Definition at line 279 of file base.hh.

Referenced by observeAccess().

◆ onWrite

const bool gem5::prefetch::Base::onWrite
protected

Consult prefetcher on reads?

Definition at line 282 of file base.hh.

Referenced by observeAccess().

◆ pageBytes

const Addr gem5::prefetch::Base::pageBytes
protected

◆ prefetchOnAccess

const bool gem5::prefetch::Base::prefetchOnAccess
protected

Prefetch on every access, not just misses.

Definition at line 296 of file base.hh.

Referenced by observeAccess().

◆ prefetchOnPfHit

const bool gem5::prefetch::Base::prefetchOnPfHit
protected

Prefetch on hit on prefetched lines.

Definition at line 299 of file base.hh.

Referenced by observeAccess().

◆ prefetchStats

gem5::prefetch::Base::StatGroup gem5::prefetch::Base::prefetchStats
protected

◆ requestorId

const RequestorID gem5::prefetch::Base::requestorId
protected

◆ tlb

BaseTLB* gem5::prefetch::Base::tlb
protected

◆ usefulPrefetches

uint64_t gem5::prefetch::Base::usefulPrefetches
protected

Total prefetches that has been useful.

Definition at line 365 of file base.hh.

Referenced by gem5::prefetch::SignaturePathV2::calculateLookaheadConfidence(), gem5::prefetch::Queued::getMaxPermittedPrefetches(), and probeNotify().

◆ useVirtualAddresses

const bool gem5::prefetch::Base::useVirtualAddresses
protected

Use Virtual Addresses for prefetching.

Definition at line 302 of file base.hh.

Referenced by gem5::prefetch::Queued::insert(), and probeNotify().


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

Generated on Tue Sep 21 2021 12:31:50 for gem5 by doxygen 1.8.17