gem5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | List of all members
LRU Class Reference

#include <lru.hh>

Inheritance diagram for LRU:
BaseSetAssoc BaseTags ClockedObject SimObject Clocked EventManager Serializable Drainable

Public Types

typedef LRUParams Params
 Convenience typedef. More...
 
- Public Types inherited from BaseSetAssoc
typedef CacheBlk BlkType
 Typedef the block type used in this tag store. More...
 
typedef CacheSet< CacheBlkSetType
 Typedef the set type used in this tag store. More...
 
typedef BaseSetAssocParams Params
 Convenience typedef. More...
 
- Public Types inherited from BaseTags
typedef BaseTagsParams Params
 
- Public Types inherited from ClockedObject
typedef ClockedObjectParams Params
 Parameters of ClockedObject. More...
 
- Public Types inherited from SimObject
typedef SimObjectParams Params
 

Public Member Functions

 LRU (const Params *p)
 Construct and initialize this tag store. More...
 
 ~LRU ()
 Destructor. More...
 
CacheBlkaccessBlock (Addr addr, bool is_secure, Cycles &lat)
 Access block and update replacement data. More...
 
CacheBlkfindVictim (Addr addr)
 Find an invalid block to evict for the address provided. More...
 
void insertBlock (PacketPtr pkt, BlkType *blk)
 Insert the new block into the cache. More...
 
void invalidate (CacheBlk *blk)
 Invalidate the given block. More...
 
- Public Member Functions inherited from BaseSetAssoc
 BaseSetAssoc (const Params *p)
 Construct and initialize this tag store. More...
 
virtual ~BaseSetAssoc ()
 Destructor. More...
 
CacheBlkfindBlockBySetAndWay (int set, int way) const override
 Find the cache block given set and way. More...
 
CacheBlkfindBlock (Addr addr, bool is_secure) const override
 Finds the given address in the cache, do not update replacement data. More...
 
virtual void setWayAllocationMax (int ways) override
 Limit the allocation for the cache ways. More...
 
virtual int getWayAllocationMax () const override
 Get the way allocation mask limit. More...
 
Addr extractTag (Addr addr) const override
 Generate the tag from the given address. More...
 
int extractSet (Addr addr) const override
 Calculate the set index from the address. More...
 
Addr regenerateBlkAddr (Addr tag, unsigned set) const override
 Regenerate the block address from the tag. More...
 
void cleanupRefs () override
 Called at end of simulation to complete average block reference stats. More...
 
std::string print () const override
 Print all tags used. More...
 
void computeStats () override
 Called prior to dumping stats to compute task occupancy. More...
 
void forEachBlk (CacheBlkVisitor &visitor) override
 Visit each block in the tag store and apply a visitor to the block. More...
 
- Public Member Functions inherited from BaseTags
 BaseTags (const Params *p)
 
virtual ~BaseTags ()
 Destructor. More...
 
void setCache (BaseCache *_cache)
 Set the parent cache back pointer. More...
 
void regStats ()
 Register local statistics. More...
 
Addr blkAlign (Addr addr) const
 Align an address to the block size. More...
 
int extractBlkOffset (Addr addr) const
 Calculate the block offset of an address. 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
 

Additional Inherited Members

- 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
 
- 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 inherited from BaseSetAssoc
const unsigned assoc
 The associativity of the cache. More...
 
unsigned allocAssoc
 The allocatable associativity of the cache (alloc mask). More...
 
const unsigned numSets
 The number of sets in the cache. More...
 
const bool sequentialAccess
 Whether tags and data are accessed sequentially. More...
 
SetTypesets
 The cache sets. More...
 
BlkTypeblks
 The cache blocks. More...
 
uint8_t * dataBlks
 The data blocks, 1 per cache block. More...
 
int setShift
 The amount to shift the address to get the set. More...
 
int tagShift
 The amount to shift the address to get the tag. More...
 
unsigned setMask
 Mask out all bits that aren't part of the set index. More...
 
- Protected Attributes inherited from BaseTags
const unsigned blkSize
 The block size of the cache. More...
 
const Addr blkMask
 Mask out all bits that aren't part of the block offset. More...
 
const unsigned size
 The size of the cache. More...
 
const Cycles lookupLatency
 The tag lookup latency of the cache. More...
 
const Cycles accessLatency
 The total access latency of the cache. More...
 
BaseCachecache
 Pointer to the parent cache. More...
 
int warmupBound
 The number of tags that need to be touched to meet the warmup percentage. More...
 
bool warmedUp
 Marked true when the cache is warmed up. More...
 
unsigned numBlocks
 the number of blocks in the cache More...
 
Stats::Vector replacements
 Number of replacements of valid blocks per thread. More...
 
Stats::Average tagsInUse
 Per cycle average of the number of tags that hold valid data. More...
 
Stats::Scalar totalRefs
 The total number of references to a block before it is replaced. More...
 
Stats::Scalar sampledRefs
 The number of reference counts sampled. More...
 
Stats::Formula avgRefs
 Average number of references to a block before is was replaced. More...
 
Stats::Scalar warmupCycle
 The cycle that the warmup percentage was hit. More...
 
Stats::AverageVector occupancies
 Average occupancy of each requestor using the cache. More...
 
Stats::Formula avgOccs
 Average occ % of each requestor using the cache. More...
 
Stats::Vector occupanciesTaskId
 Occupancy of each context/cpu using the cache. More...
 
Stats::Vector2d ageTaskId
 Occupancy of each context/cpu using the cache. More...
 
Stats::Formula percentOccsTaskId
 Occ % of each context/cpu using the cache. More...
 
Stats::Scalar tagAccesses
 Number of tags consulted over all accesses. More...
 
Stats::Scalar dataAccesses
 Number of data blocks consulted over all accesses. More...
 
- 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...
 

Detailed Description

Definition at line 56 of file lru.hh.

Member Typedef Documentation

typedef LRUParams LRU::Params

Convenience typedef.

Definition at line 60 of file lru.hh.

Constructor & Destructor Documentation

LRU::LRU ( const Params p)

Construct and initialize this tag store.

Definition at line 53 of file lru.cc.

LRU::~LRU ( )
inline

Destructor.

Definition at line 70 of file lru.hh.

Member Function Documentation

CacheBlk * LRU::accessBlock ( Addr  addr,
bool  is_secure,
Cycles lat 
)
virtual

Access block and update replacement data.

May not succeed, in which case nullptr is returned. This has all the implications of a cache access and should only be used as such. Returns the access latency as a side effect.

Parameters
addrThe address to find.
is_secureTrue if the target memory space is secure.
latThe access latency.
Returns
Pointer to the cache block if found.

Reimplemented from BaseSetAssoc.

Definition at line 59 of file lru.cc.

References BaseSetAssoc::accessBlock(), DPRINTF, CacheSet< Blktype >::moveToHead(), BaseSetAssoc::regenerateBlkAddr(), CacheBlk::set, BaseSetAssoc::sets, and CacheBlk::tag.

CacheBlk * LRU::findVictim ( Addr  addr)
virtual

Find an invalid block to evict for the address provided.

If there are no invalid blocks, this will return the block in the least-recently-used position.

Parameters
addrThe addr to a find a replacement candidate for.
Returns
The candidate block.

Reimplemented from BaseSetAssoc.

Definition at line 75 of file lru.cc.

References BaseSetAssoc::allocAssoc, BaseSetAssoc::assoc, ArmISA::b, CacheSet< Blktype >::blks, DPRINTF, BaseSetAssoc::extractSet(), ArmISA::i, CacheBlk::isValid(), BaseSetAssoc::regenerateBlkAddr(), BaseSetAssoc::sets, CacheBlk::tag, and CacheBlk::way.

void LRU::insertBlock ( PacketPtr  pkt,
BlkType blk 
)
virtual

Insert the new block into the cache.

Parameters
pktPacket holding the address to update
blkThe block to update.

Reimplemented from BaseSetAssoc.

Definition at line 98 of file lru.cc.

References BaseSetAssoc::extractSet(), Packet::getAddr(), BaseSetAssoc::insertBlock(), CacheSet< Blktype >::moveToHead(), and BaseSetAssoc::sets.

void LRU::invalidate ( CacheBlk blk)
virtual

Invalidate the given block.

Parameters
blkThe block to invalidate.

Reimplemented from BaseSetAssoc.

Definition at line 107 of file lru.cc.

References BaseSetAssoc::invalidate(), CacheSet< Blktype >::moveToTail(), CacheBlk::set, and BaseSetAssoc::sets.


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

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