gem5  v22.1.0.0
Classes | Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
gem5::prefetch::PIF Class Reference

#include <pif.hh>

Inheritance diagram for gem5::prefetch::PIF:
gem5::prefetch::Queued gem5::prefetch::Base gem5::ClockedObject gem5::SimObject gem5::Clocked gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named

Classes

struct  CompactorEntry
 The compactor tracks retired instructions addresses, leveraging the spatial and temporal locality among instructions for compaction. More...
 
struct  IndexEntry
 
class  PrefetchListenerPC
 Probe Listener to handle probe events from the CPU. More...
 

Public Member Functions

 PIF (const PIFPrefetcherParams &p)
 
 ~PIF ()=default
 
void calculatePrefetch (const PrefetchInfo &pfi, std::vector< AddrPriority > &addresses)
 
void addEventProbeRetiredInsts (SimObject *obj, const char *name)
 Add a SimObject and a probe name to monitor the retired instructions. More...
 
- Public Member Functions inherited from gem5::prefetch::Queued
 Queued (const QueuedPrefetcherParams &p)
 
virtual ~Queued ()
 
void notify (const PacketPtr &pkt, const PrefetchInfo &pfi) override
 Notify prefetcher of cache access (may be any access or just misses, depending on cache parameters.) More...
 
void insert (const PacketPtr &pkt, PrefetchInfo &new_pfi, int32_t priority)
 
PacketPtr getPacket () override
 
Tick nextPrefetchReadyTime () const override
 
void printQueue (const std::list< DeferredPacket > &queue) const
 
- Public Member Functions inherited from gem5::prefetch::Base
 Base (const BasePrefetcherParams &p)
 
virtual ~Base ()=default
 
virtual void setCache (BaseCache *_cache)
 
virtual void notifyFill (const PacketPtr &pkt)
 Notify prefetcher of cache fill. More...
 
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
 

Private Types

using HistoryBuffer = CircularQueue< CompactorEntry >
 History buffer is a circular buffer that stores the sequence of retired instructions in FIFO order. More...
 

Private Member Functions

void notifyRetiredInst (const Addr pc)
 Updates the prefetcher structures upon an instruction retired. More...
 

Private Attributes

const unsigned int precSize
 Number of preceding and subsequent spatial addresses to compact. More...
 
const unsigned int succSize
 
const unsigned int maxCompactorEntries
 Number of entries used for the temporal compactor. More...
 
CompactorEntry spatialCompactor
 
std::deque< CompactorEntrytemporalCompactor
 
HistoryBuffer historyBuffer
 
AssociativeSet< IndexEntryindex
 The index table is a small cache-like structure that facilitates fast search of the history buffer. More...
 
CircularQueue< HistoryBuffer::iterator > streamAddressBuffer
 A Stream Address Buffer (SAB) tracks a window of consecutive spatial regions. More...
 
std::vector< PrefetchListenerPC * > listenersPC
 Array of probe listeners. More...
 

Additional Inherited Members

- Public Types inherited from gem5::prefetch::Queued
using AddrPriority = std::pair< Addr, int32_t >
 
- 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
 
- Protected Types inherited from gem5::prefetch::Queued
using const_iterator = std::list< DeferredPacket >::const_iterator
 
using iterator = std::list< DeferredPacket >::iterator
 
- Protected Member Functions inherited from gem5::prefetch::Base
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 inherited from gem5::prefetch::Queued
std::list< DeferredPacketpfq
 
std::list< DeferredPacketpfqMissingTranslation
 
const unsigned queueSize
 Maximum size of the prefetch queue. More...
 
const unsigned missingTranslationQueueSize
 Maximum size of the queue holding prefetch requests with missing address translations. More...
 
const Cycles latency
 Cycles after generation when a prefetch can first be issued. More...
 
const bool queueSquash
 Squash queued prefetch if demand access observed. More...
 
const bool queueFilter
 Filter prefetches if already queued. More...
 
const bool cacheSnoop
 Snoop the cache before generating prefetch (cheating basically) More...
 
const bool tagPrefetch
 Tag prefetch with PC of generating access? More...
 
const unsigned int throttleControlPct
 Percentage of requests that can be throttled. More...
 
gem5::prefetch::Queued::QueuedStats statsQueued
 
- Protected Attributes inherited from gem5::prefetch::Base
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...
 

Detailed Description

Definition at line 56 of file pif.hh.

Member Typedef Documentation

◆ HistoryBuffer

History buffer is a circular buffer that stores the sequence of retired instructions in FIFO order.

Definition at line 135 of file pif.hh.

Constructor & Destructor Documentation

◆ PIF()

gem5::prefetch::PIF::PIF ( const PIFPrefetcherParams &  p)

Definition at line 44 of file pif.cc.

◆ ~PIF()

gem5::prefetch::PIF::~PIF ( )
default

Member Function Documentation

◆ addEventProbeRetiredInsts()

void gem5::prefetch::PIF::addEventProbeRetiredInsts ( SimObject obj,
const char *  name 
)

Add a SimObject and a probe name to monitor the retired instructions.

Parameters
objThe SimObject pointer to listen from
nameThe probe name

Definition at line 245 of file pif.cc.

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

◆ calculatePrefetch()

void gem5::prefetch::PIF::calculatePrefetch ( const PrefetchInfo pfi,
std::vector< AddrPriority > &  addresses 
)
virtual

◆ notifyRetiredInst()

void gem5::prefetch::PIF::notifyRetiredInst ( const Addr  pc)
private

Member Data Documentation

◆ historyBuffer

HistoryBuffer gem5::prefetch::PIF::historyBuffer
private

Definition at line 136 of file pif.hh.

Referenced by notifyRetiredInst().

◆ index

AssociativeSet<IndexEntry> gem5::prefetch::PIF::index
private

The index table is a small cache-like structure that facilitates fast search of the history buffer.

Definition at line 146 of file pif.hh.

Referenced by calculatePrefetch(), and notifyRetiredInst().

◆ listenersPC

std::vector<PrefetchListenerPC *> gem5::prefetch::PIF::listenersPC
private

Array of probe listeners.

Definition at line 178 of file pif.hh.

Referenced by addEventProbeRetiredInsts().

◆ maxCompactorEntries

const unsigned int gem5::prefetch::PIF::maxCompactorEntries
private

Number of entries used for the temporal compactor.

Definition at line 63 of file pif.hh.

Referenced by notifyRetiredInst().

◆ precSize

const unsigned int gem5::prefetch::PIF::precSize
private

Number of preceding and subsequent spatial addresses to compact.

Definition at line 60 of file pif.hh.

Referenced by notifyRetiredInst().

◆ spatialCompactor

CompactorEntry gem5::prefetch::PIF::spatialCompactor
private

Definition at line 128 of file pif.hh.

Referenced by notifyRetiredInst().

◆ streamAddressBuffer

CircularQueue<HistoryBuffer::iterator> gem5::prefetch::PIF::streamAddressBuffer
private

A Stream Address Buffer (SAB) tracks a window of consecutive spatial regions.

The SAB mantains a pointer to the sequence in the history buffer, initiallly set to the pointer taken from the index table

Definition at line 154 of file pif.hh.

Referenced by calculatePrefetch().

◆ succSize

const unsigned int gem5::prefetch::PIF::succSize
private

Definition at line 61 of file pif.hh.

Referenced by notifyRetiredInst().

◆ temporalCompactor

std::deque<CompactorEntry> gem5::prefetch::PIF::temporalCompactor
private

Definition at line 129 of file pif.hh.

Referenced by notifyRetiredInst().


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

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