gem5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
BasePrefetcher Class Referenceabstract

#include <base.hh>

Inheritance diagram for BasePrefetcher:
ClockedObject SimObject Clocked EventManager Serializable Drainable QueuedPrefetcher StridePrefetcher TaggedPrefetcher

Public Member Functions

 BasePrefetcher (const BasePrefetcherParams *p)
 
virtual ~BasePrefetcher ()
 
void setCache (BaseCache *_cache)
 
virtual Tick notify (const PacketPtr &pkt)=0
 Notify prefetcher of cache access (may be any access or just misses, depending on cache parameters.) More...
 
virtual PacketPtr getPacket ()=0
 
virtual Tick nextPrefetchReadyTime () const =0
 
virtual void regStats ()
 Register statistics for this object. More...
 
- Public Member Functions inherited from ClockedObject
 ClockedObject (const ClockedObjectParams *p)
 
const Paramsparams () const
 
void serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 
Enums::PwrState pwrState () const
 
std::string pwrStateName () const
 
std::vector< double > pwrStateWeights () const
 Returns the percentage residency for each power state. More...
 
void computeStats ()
 Record stats values like state residency by computing the time difference from previous update. More...
 
void pwrState (Enums::PwrState)
 
void regStats () override
 Register statistics for this object. More...
 
- Public Member Functions inherited from SimObject
const Paramsparams () const
 
 SimObject (const Params *_params)
 
virtual ~SimObject ()
 
virtual const std::string name () const
 
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 resetStats ()
 Reset statistics associated with this object. 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 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 EventManager
 EventManager (EventManager &em)
 
 EventManager (EventManager *em)
 
 EventManager (EventQueue *eq)
 
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)
 
void setCurTick (Tick newVal)
 
- Public Member Functions inherited from 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 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 Clocked
void updateClockPeriod () const
 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) 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 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 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 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...
 

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...
 
Systemsystem
 System we belong to. More...
 
bool onMiss
 Only consult prefetcher on cache misses? More...
 
bool onRead
 Consult prefetcher on reads? More...
 
bool onWrite
 Consult prefetcher on reads? More...
 
bool onData
 Consult prefetcher on data accesses? More...
 
bool onInst
 Consult prefetcher on instruction accesses? More...
 
MasterID masterId
 Request id for prefetches. More...
 
const Addr pageBytes
 
Stats::Scalar pfIssued
 
- Protected Attributes inherited from ClockedObject
Enums::PwrState _currPwrState
 To keep track of the current power state. More...
 
Tick prvEvalTick
 
Stats::Scalar numPwrStateTransitions
 
Stats::Distribution pwrStateClkGateDist
 
Stats::Vector pwrStateResidencyTicks
 
- Protected Attributes inherited from SimObject
const SimObjectParams * _params
 Cached copy of the object parameters. More...
 
- Protected Attributes inherited from EventManager
EventQueueeventq
 A pointer to this object's event queue. More...
 

Additional Inherited Members

- Public Types inherited from ClockedObject
typedef ClockedObjectParams Params
 Parameters of ClockedObject. More...
 
- Public Types inherited from SimObject
typedef SimObjectParams Params
 
- Static Public Member Functions inherited from SimObject
static void serializeAll (CheckpointOut &cp)
 Serialize 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 Public Member Functions inherited from Serializable
static const std::string & currentSection ()
 Get the fully-qualified name of the active section. More...
 
static void serializeAll (const std::string &cpt_dir)
 
static void unserializeGlobals (CheckpointIn &cp)
 
- Static Public Attributes inherited from Serializable
static int ckptCount = 0
 
static int ckptMaxCount = 0
 
static int ckptPrevCount = -1
 

Detailed Description

Definition at line 59 of file base.hh.

Constructor & Destructor Documentation

BasePrefetcher::BasePrefetcher ( const BasePrefetcherParams *  p)

Definition at line 57 of file base.cc.

virtual BasePrefetcher::~BasePrefetcher ( )
inlinevirtual

Definition at line 126 of file base.hh.

Member Function Documentation

Addr BasePrefetcher::blockAddress ( Addr  a) const
protected

Determine the address of the block in which a lays.

Definition at line 137 of file base.cc.

References blkSize.

Addr BasePrefetcher::blockIndex ( Addr  a) const
protected

Determine the address of a at block granularity.

Definition at line 143 of file base.cc.

References lBlkSize.

virtual PacketPtr BasePrefetcher::getPacket ( )
pure virtual

Implemented in QueuedPrefetcher.

Referenced by Cache::getNextQueueEntry().

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

Determine if address is in cache.

Definition at line 113 of file base.cc.

References cache, and BaseCache::inCache().

Referenced by QueuedPrefetcher::insert(), and observeAccess().

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

Determine if address is in cache miss queue.

Definition at line 122 of file base.cc.

References cache, and BaseCache::inMissQueue().

Referenced by QueuedPrefetcher::insert(), and observeAccess().

virtual Tick BasePrefetcher::nextPrefetchReadyTime ( ) const
pure virtual
virtual Tick BasePrefetcher::notify ( const PacketPtr pkt)
pure virtual

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

Return values
Timeof next prefetch availability, or MaxTick if none.

Implemented in QueuedPrefetcher.

Referenced by Cache::recvTimingReq().

bool BasePrefetcher::observeAccess ( const PacketPtr pkt) const
protected
Addr BasePrefetcher::pageAddress ( Addr  a) const
protected

Determine the address of the page in which a lays.

Definition at line 149 of file base.cc.

References pageBytes, and roundDown().

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

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

Definition at line 161 of file base.cc.

References lBlkSize.

Addr BasePrefetcher::pageOffset ( Addr  a) const
protected

Determine the page-offset of a.

Definition at line 155 of file base.cc.

References pageBytes.

void BasePrefetcher::regStats ( )
virtual

Register statistics for this object.

Reimplemented from SimObject.

Reimplemented in QueuedPrefetcher.

Definition at line 76 of file base.cc.

References Stats::DataWrap< Derived, InfoProxyType >::desc(), SimObject::name(), Stats::DataWrap< Derived, InfoProxyType >::name(), pfIssued, and ClockedObject::regStats().

Referenced by QueuedPrefetcher::regStats().

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

Determine if addresses are on the same page.

Definition at line 131 of file base.cc.

References pageBytes, and roundDown().

Referenced by TaggedPrefetcher::calculatePrefetch(), and StridePrefetcher::calculatePrefetch().

void BasePrefetcher::setCache ( BaseCache _cache)

Definition at line 67 of file base.cc.

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

Referenced by Cache::Cache().

Member Data Documentation

unsigned BasePrefetcher::blkSize
protected
BaseCache* BasePrefetcher::cache
protected

Pointr to the parent cache.

Definition at line 66 of file base.hh.

Referenced by inCache(), inMissQueue(), and setCache().

unsigned BasePrefetcher::lBlkSize
protected

log_2(block size of the parent cache).

Definition at line 72 of file base.hh.

Referenced by blockIndex(), pageIthBlockAddress(), and setCache().

MasterID BasePrefetcher::masterId
protected

Request id for prefetches.

Definition at line 93 of file base.hh.

Referenced by QueuedPrefetcher::insert().

bool BasePrefetcher::onData
protected

Consult prefetcher on data accesses?

Definition at line 87 of file base.hh.

Referenced by observeAccess().

bool BasePrefetcher::onInst
protected

Consult prefetcher on instruction accesses?

Definition at line 90 of file base.hh.

Referenced by observeAccess(), and StridePrefetcher::StridePrefetcher().

bool BasePrefetcher::onMiss
protected

Only consult prefetcher on cache misses?

Definition at line 78 of file base.hh.

Referenced by observeAccess().

bool BasePrefetcher::onRead
protected

Consult prefetcher on reads?

Definition at line 81 of file base.hh.

Referenced by observeAccess().

bool BasePrefetcher::onWrite
protected

Consult prefetcher on reads?

Definition at line 84 of file base.hh.

Referenced by observeAccess().

const Addr BasePrefetcher::pageBytes
protected

Definition at line 95 of file base.hh.

Referenced by pageAddress(), pageOffset(), and samePage().

Stats::Scalar BasePrefetcher::pfIssued
protected

Definition at line 120 of file base.hh.

Referenced by QueuedPrefetcher::getPacket(), and regStats().

System* BasePrefetcher::system
protected

System we belong to.

Definition at line 75 of file base.hh.


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

Generated on Fri Jun 9 2017 13:04:03 for gem5 by doxygen 1.8.6