gem5  v20.1.0.0
Public Types | Public Member Functions | Public Attributes | Private Member Functions | Private Attributes | List of all members
CacheMemory Class Reference

#include <CacheMemory.hh>

Inheritance diagram for CacheMemory:
SimObject EventManager Serializable Drainable Stats::Group

Public Types

typedef RubyCacheParams Params
 
typedef std::shared_ptr< ReplacementDataReplData
 
- Public Types inherited from SimObject
typedef SimObjectParams Params
 

Public Member Functions

 CacheMemory (const Params *p)
 
 ~CacheMemory ()
 
void init ()
 init() is called after all C++ SimObjects have been created and all ports are connected. More...
 
bool tryCacheAccess (Addr address, RubyRequestType type, DataBlock *&data_ptr)
 
bool testCacheAccess (Addr address, RubyRequestType type, DataBlock *&data_ptr)
 
bool isTagPresent (Addr address) const
 
bool cacheAvail (Addr address) const
 
AbstractCacheEntrygetNullEntry () const
 
AbstractCacheEntryallocate (Addr address, AbstractCacheEntry *new_entry)
 
void allocateVoid (Addr address, AbstractCacheEntry *new_entry)
 
void deallocate (Addr address)
 
Addr cacheProbe (Addr address) const
 
AbstractCacheEntrylookup (Addr address)
 
const AbstractCacheEntrylookup (Addr address) const
 
Cycles getTagLatency () const
 
Cycles getDataLatency () const
 
bool isBlockInvalid (int64_t cache_set, int64_t loc)
 
bool isBlockNotBusy (int64_t cache_set, int64_t loc)
 
void recordCacheContents (int cntrl, CacheRecorder *tr) const
 
void setMRU (Addr address)
 
void setMRU (Addr addr, int occupancy)
 
void setMRU (AbstractCacheEntry *entry)
 
int getReplacementWeight (int64_t set, int64_t loc)
 
void setLocked (Addr addr, int context)
 
void clearLocked (Addr addr)
 
void clearLockedAll (int context)
 
bool isLocked (Addr addr, int context)
 
void print (std::ostream &out) const
 
void printData (std::ostream &out) const
 
void regStats ()
 Callback to set stat parameters. More...
 
bool checkResourceAvailable (CacheResourceType res, Addr addr)
 
void recordRequestType (CacheRequestType requestType, Addr addr)
 
void htmAbortTransaction ()
 
void htmCommitTransaction ()
 
int getCacheSize () const
 
int getCacheAssoc () const
 
int getNumBlocks () const
 
Addr getAddressAtIdx (int idx) const
 
- Public Member Functions inherited from SimObject
const Paramsparams () const
 
 SimObject (const Params *_params)
 
virtual ~SimObject ()
 
virtual const std::string name () const
 
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 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 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 Stats::Group
 Group (Group *parent, const char *name=nullptr)
 Construct a new statistics group. More...
 
virtual ~Group ()
 
virtual void resetStats ()
 Callback to reset stats. More...
 
virtual void preDumpStats ()
 Callback before stats are dumped. More...
 
void addStat (Stats::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...
 
 Group ()=delete
 
 Group (const Group &)=delete
 
Groupoperator= (const Group &)=delete
 

Public Attributes

Stats::Scalar m_demand_hits
 
Stats::Scalar m_demand_misses
 
Stats::Formula m_demand_accesses
 
Stats::Scalar m_sw_prefetches
 
Stats::Scalar m_hw_prefetches
 
Stats::Formula m_prefetches
 
Stats::Vector m_accessModeType
 
Stats::Scalar numDataArrayReads
 
Stats::Scalar numDataArrayWrites
 
Stats::Scalar numTagArrayReads
 
Stats::Scalar numTagArrayWrites
 
Stats::Scalar numTagArrayStalls
 
Stats::Scalar numDataArrayStalls
 
Stats::Histogram htmTransCommitReadSet
 
Stats::Histogram htmTransCommitWriteSet
 
Stats::Histogram htmTransAbortReadSet
 
Stats::Histogram htmTransAbortWriteSet
 

Private Member Functions

int64_t addressToCacheSet (Addr address) const
 
int findTagInSet (int64_t line, Addr tag) const
 
int findTagInSetIgnorePermissions (int64_t cacheSet, Addr tag) const
 
 CacheMemory (const CacheMemory &obj)
 
CacheMemoryoperator= (const CacheMemory &obj)
 

Private Attributes

bool m_is_instruction_only_cache
 
std::unordered_map< Addr, int > m_tag_index
 
std::vector< std::vector< AbstractCacheEntry * > > m_cache
 
BaseReplacementPolicym_replacementPolicy_ptr
 We use BaseReplacementPolicy from Classic system here, hence we can use different replacement policies from Classic system in Ruby system. More...
 
BankedArray dataArray
 
BankedArray tagArray
 
int m_cache_size
 
int m_cache_num_sets
 
int m_cache_num_set_bits
 
int m_cache_assoc
 
int m_start_index_bit
 
bool m_resource_stalls
 
int m_block_size
 
std::vector< std::vector< ReplData > > replacement_data
 We store all the ReplacementData in a 2-dimensional array. More...
 
bool m_use_occupancy
 Set to true when using WeightedLRU replacement policy, otherwise, set to false. More...
 

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 ()
 Gets the fully-qualified name of the active section. More...
 
static void serializeAll (const std::string &cpt_dir)
 Serializes all the SimObjects. More...
 
static void unserializeGlobals (CheckpointIn &cp)
 
- 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 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 63 of file CacheMemory.hh.

Member Typedef Documentation

◆ Params

typedef RubyCacheParams CacheMemory::Params

Definition at line 66 of file CacheMemory.hh.

◆ ReplData

typedef std::shared_ptr<ReplacementData> CacheMemory::ReplData

Definition at line 67 of file CacheMemory.hh.

Constructor & Destructor Documentation

◆ CacheMemory() [1/2]

CacheMemory::CacheMemory ( const Params p)

◆ ~CacheMemory()

CacheMemory::~CacheMemory ( )

◆ CacheMemory() [2/2]

CacheMemory::CacheMemory ( const CacheMemory obj)
private

Member Function Documentation

◆ addressToCacheSet()

int64_t CacheMemory::addressToCacheSet ( Addr  address) const
private

◆ allocate()

AbstractCacheEntry * CacheMemory::allocate ( Addr  address,
AbstractCacheEntry new_entry 
)

◆ allocateVoid()

void CacheMemory::allocateVoid ( Addr  address,
AbstractCacheEntry new_entry 
)
inline

Definition at line 99 of file CacheMemory.hh.

References allocate().

◆ cacheAvail()

bool CacheMemory::cacheAvail ( Addr  address) const

◆ cacheProbe()

Addr CacheMemory::cacheProbe ( Addr  address) const

◆ checkResourceAvailable()

bool CacheMemory::checkResourceAvailable ( CacheResourceType  res,
Addr  addr 
)

◆ clearLocked()

void CacheMemory::clearLocked ( Addr  addr)

Definition at line 487 of file CacheMemory.cc.

References AbstractCacheEntry::clearLocked(), DPRINTF, and lookup().

◆ clearLockedAll()

void CacheMemory::clearLockedAll ( int  context)

◆ deallocate()

void CacheMemory::deallocate ( Addr  address)

◆ findTagInSet()

int CacheMemory::findTagInSet ( int64_t  line,
Addr  tag 
) const
private

Definition at line 136 of file CacheMemory.cc.

References m_cache, m_tag_index, and makeLineAddress().

Referenced by lookup().

◆ findTagInSetIgnorePermissions()

int CacheMemory::findTagInSetIgnorePermissions ( int64_t  cacheSet,
Addr  tag 
) const
private

Definition at line 151 of file CacheMemory.cc.

References m_tag_index, and makeLineAddress().

◆ getAddressAtIdx()

Addr CacheMemory::getAddressAtIdx ( int  idx) const

◆ getCacheAssoc()

int CacheMemory::getCacheAssoc ( ) const
inline

Definition at line 177 of file CacheMemory.hh.

References m_cache_assoc.

◆ getCacheSize()

int CacheMemory::getCacheSize ( ) const
inline

Definition at line 176 of file CacheMemory.hh.

References m_cache_size.

◆ getDataLatency()

Cycles CacheMemory::getDataLatency ( ) const
inline

Definition at line 115 of file CacheMemory.hh.

References dataArray, and BankedArray::getLatency().

◆ getNullEntry()

AbstractCacheEntry* CacheMemory::getNullEntry ( ) const
inline

Definition at line 92 of file CacheMemory.hh.

◆ getNumBlocks()

int CacheMemory::getNumBlocks ( ) const
inline

Definition at line 178 of file CacheMemory.hh.

References m_cache_assoc, and m_cache_num_sets.

Referenced by VIPERCoalescer::invTCP().

◆ getReplacementWeight()

int CacheMemory::getReplacementWeight ( int64_t  set,
int64_t  loc 
)

Definition at line 400 of file CacheMemory.cc.

References m_cache, m_cache_assoc, and m_cache_num_sets.

◆ getTagLatency()

Cycles CacheMemory::getTagLatency ( ) const
inline

Definition at line 114 of file CacheMemory.hh.

References BankedArray::getLatency(), and tagArray.

◆ htmAbortTransaction()

void CacheMemory::htmAbortTransaction ( )

◆ htmCommitTransaction()

void CacheMemory::htmCommitTransaction ( )

◆ init()

void CacheMemory::init ( )
virtual

init() is called after all C++ SimObjects have been created and all ports are connected.

Initializations that are independent of unserialization but rely on a fully instantiated and connected SimObject graph should be done here.

Reimplemented from SimObject.

Definition at line 90 of file CacheMemory.cc.

References floorLog2(), RubySystem::getBlockSizeBytes(), ArmISA::i, BaseReplacementPolicy::instantiateEntry(), ArmISA::j, m_block_size, m_cache, m_cache_assoc, m_cache_num_set_bits, m_cache_num_sets, m_cache_size, m_replacementPolicy_ptr, and replacement_data.

◆ isBlockInvalid()

bool CacheMemory::isBlockInvalid ( int64_t  cache_set,
int64_t  loc 
)

Definition at line 706 of file CacheMemory.cc.

References m_cache.

◆ isBlockNotBusy()

bool CacheMemory::isBlockNotBusy ( int64_t  cache_set,
int64_t  loc 
)

Definition at line 712 of file CacheMemory.cc.

References m_cache.

◆ isLocked()

bool CacheMemory::isLocked ( Addr  addr,
int  context 
)

◆ isTagPresent()

bool CacheMemory::isTagPresent ( Addr  address) const

Definition at line 231 of file CacheMemory.cc.

References DPRINTF, and lookup().

Referenced by allocate().

◆ lookup() [1/2]

AbstractCacheEntry * CacheMemory::lookup ( Addr  address)

◆ lookup() [2/2]

const AbstractCacheEntry * CacheMemory::lookup ( Addr  address) const

Definition at line 353 of file CacheMemory.cc.

References addressToCacheSet(), findTagInSet(), m_cache, and makeLineAddress().

◆ operator=()

CacheMemory& CacheMemory::operator= ( const CacheMemory obj)
private

◆ print()

void CacheMemory::print ( std::ostream &  out) const

Definition at line 453 of file CacheMemory.cc.

References ArmISA::i, ArmISA::j, m_cache, m_cache_assoc, m_cache_num_sets, and SimObject::name().

Referenced by operator<<().

◆ printData()

void CacheMemory::printData ( std::ostream &  out) const

Definition at line 472 of file CacheMemory.cc.

◆ recordCacheContents()

void CacheMemory::recordCacheContents ( int  cntrl,
CacheRecorder tr 
) const

◆ recordRequestType()

void CacheMemory::recordRequestType ( CacheRequestType  requestType,
Addr  addr 
)

◆ regStats()

void CacheMemory::regStats ( )
virtual

◆ setLocked()

void CacheMemory::setLocked ( Addr  addr,
int  context 
)

Definition at line 478 of file CacheMemory.cc.

References DPRINTF, lookup(), and AbstractCacheEntry::setLocked().

◆ setMRU() [1/3]

void CacheMemory::setMRU ( AbstractCacheEntry entry)

◆ setMRU() [2/3]

void CacheMemory::setMRU ( Addr  addr,
int  occupancy 
)

◆ setMRU() [3/3]

void CacheMemory::setMRU ( Addr  address)

◆ testCacheAccess()

bool CacheMemory::testCacheAccess ( Addr  address,
RubyRequestType  type,
DataBlock *&  data_ptr 
)

◆ tryCacheAccess()

bool CacheMemory::tryCacheAccess ( Addr  address,
RubyRequestType  type,
DataBlock *&  data_ptr 
)

Member Data Documentation

◆ dataArray

BankedArray CacheMemory::dataArray
private

Definition at line 209 of file CacheMemory.hh.

Referenced by checkResourceAvailable(), getDataLatency(), and recordRequestType().

◆ htmTransAbortReadSet

Stats::Histogram CacheMemory::htmTransAbortReadSet

Definition at line 173 of file CacheMemory.hh.

Referenced by htmAbortTransaction(), and regStats().

◆ htmTransAbortWriteSet

Stats::Histogram CacheMemory::htmTransAbortWriteSet

Definition at line 174 of file CacheMemory.hh.

Referenced by htmAbortTransaction(), and regStats().

◆ htmTransCommitReadSet

Stats::Histogram CacheMemory::htmTransCommitReadSet

Definition at line 171 of file CacheMemory.hh.

Referenced by htmCommitTransaction(), and regStats().

◆ htmTransCommitWriteSet

Stats::Histogram CacheMemory::htmTransCommitWriteSet

Definition at line 172 of file CacheMemory.hh.

Referenced by htmCommitTransaction(), and regStats().

◆ m_accessModeType

Stats::Vector CacheMemory::m_accessModeType

Definition at line 160 of file CacheMemory.hh.

Referenced by regStats().

◆ m_block_size

int CacheMemory::m_block_size
private

Definition at line 218 of file CacheMemory.hh.

Referenced by CacheMemory(), and init().

◆ m_cache

std::vector<std::vector<AbstractCacheEntry*> > CacheMemory::m_cache
private

◆ m_cache_assoc

int CacheMemory::m_cache_assoc
private

◆ m_cache_num_set_bits

int CacheMemory::m_cache_num_set_bits
private

Definition at line 214 of file CacheMemory.hh.

Referenced by addressToCacheSet(), and init().

◆ m_cache_num_sets

int CacheMemory::m_cache_num_sets
private

◆ m_cache_size

int CacheMemory::m_cache_size
private

Definition at line 212 of file CacheMemory.hh.

Referenced by CacheMemory(), getCacheSize(), and init().

◆ m_demand_accesses

Stats::Formula CacheMemory::m_demand_accesses

Definition at line 154 of file CacheMemory.hh.

Referenced by regStats().

◆ m_demand_hits

Stats::Scalar CacheMemory::m_demand_hits

Definition at line 152 of file CacheMemory.hh.

Referenced by regStats().

◆ m_demand_misses

Stats::Scalar CacheMemory::m_demand_misses

Definition at line 153 of file CacheMemory.hh.

Referenced by regStats().

◆ m_hw_prefetches

Stats::Scalar CacheMemory::m_hw_prefetches

Definition at line 157 of file CacheMemory.hh.

Referenced by regStats().

◆ m_is_instruction_only_cache

bool CacheMemory::m_is_instruction_only_cache
private

Definition at line 196 of file CacheMemory.hh.

Referenced by CacheMemory(), and recordCacheContents().

◆ m_prefetches

Stats::Formula CacheMemory::m_prefetches

Definition at line 158 of file CacheMemory.hh.

Referenced by regStats().

◆ m_replacementPolicy_ptr

BaseReplacementPolicy* CacheMemory::m_replacementPolicy_ptr
private

We use BaseReplacementPolicy from Classic system here, hence we can use different replacement policies from Classic system in Ruby system.

Definition at line 207 of file CacheMemory.hh.

Referenced by allocate(), CacheMemory(), cacheProbe(), deallocate(), init(), setMRU(), testCacheAccess(), tryCacheAccess(), and ~CacheMemory().

◆ m_resource_stalls

bool CacheMemory::m_resource_stalls
private

Definition at line 217 of file CacheMemory.hh.

Referenced by CacheMemory(), checkResourceAvailable(), and recordRequestType().

◆ m_start_index_bit

int CacheMemory::m_start_index_bit
private

Definition at line 216 of file CacheMemory.hh.

Referenced by addressToCacheSet(), and CacheMemory().

◆ m_sw_prefetches

Stats::Scalar CacheMemory::m_sw_prefetches

Definition at line 156 of file CacheMemory.hh.

Referenced by regStats().

◆ m_tag_index

std::unordered_map<Addr, int> CacheMemory::m_tag_index
private

Definition at line 200 of file CacheMemory.hh.

Referenced by allocate(), deallocate(), findTagInSet(), and findTagInSetIgnorePermissions().

◆ m_use_occupancy

bool CacheMemory::m_use_occupancy
private

Set to true when using WeightedLRU replacement policy, otherwise, set to false.

Definition at line 234 of file CacheMemory.hh.

Referenced by CacheMemory(), and setMRU().

◆ numDataArrayReads

Stats::Scalar CacheMemory::numDataArrayReads

Definition at line 162 of file CacheMemory.hh.

Referenced by recordRequestType(), and regStats().

◆ numDataArrayStalls

Stats::Scalar CacheMemory::numDataArrayStalls

Definition at line 168 of file CacheMemory.hh.

Referenced by checkResourceAvailable(), and regStats().

◆ numDataArrayWrites

Stats::Scalar CacheMemory::numDataArrayWrites

Definition at line 163 of file CacheMemory.hh.

Referenced by recordRequestType(), and regStats().

◆ numTagArrayReads

Stats::Scalar CacheMemory::numTagArrayReads

Definition at line 164 of file CacheMemory.hh.

Referenced by recordRequestType(), and regStats().

◆ numTagArrayStalls

Stats::Scalar CacheMemory::numTagArrayStalls

Definition at line 167 of file CacheMemory.hh.

Referenced by checkResourceAvailable(), and regStats().

◆ numTagArrayWrites

Stats::Scalar CacheMemory::numTagArrayWrites

Definition at line 165 of file CacheMemory.hh.

Referenced by recordRequestType(), and regStats().

◆ replacement_data

std::vector<std::vector<ReplData> > CacheMemory::replacement_data
private

We store all the ReplacementData in a 2-dimensional array.

By doing this, we can use all replacement policies from Classic system. Ruby cache will deallocate cache entry every time we evict the cache block so we cannot store the ReplacementData inside the cache entry. Instantiate ReplacementData for multiple times will break replacement policy like TreePLRU.

Definition at line 228 of file CacheMemory.hh.

Referenced by allocate(), and init().

◆ tagArray

BankedArray CacheMemory::tagArray
private

Definition at line 210 of file CacheMemory.hh.

Referenced by checkResourceAvailable(), getTagLatency(), and recordRequestType().


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

Generated on Wed Sep 30 2020 14:02:22 for gem5 by doxygen 1.8.17