gem5 v24.0.0.0
|
A common base class of Cache tagstore objects. More...
#include <base.hh>
Classes | |
struct | BaseTagStats |
TODO: It would be good if these stats were acquired after warmup. More... | |
Public Types | |
typedef BaseTagsParams | Params |
Public Types inherited from gem5::ClockedObject | |
using | Params = ClockedObjectParams |
Parameters of ClockedObject. | |
Public Types inherited from gem5::SimObject | |
typedef SimObjectParams | Params |
Public Member Functions | |
BaseTags (const Params &p) | |
virtual | ~BaseTags () |
Destructor. | |
virtual void | tagsInit ()=0 |
Initialize blocks. | |
void | cleanupRefs () |
Average in the reference count for valid blocks when the simulation exits. | |
void | computeStats () |
Computes stats just prior to dump event. | |
std::string | print () |
Print all tags used. | |
virtual CacheBlk * | findBlock (Addr addr, bool is_secure) const |
Finds the block in the cache without touching it. | |
virtual ReplaceableEntry * | findBlockBySetAndWay (int set, int way) const |
Find a block given set and way. | |
Addr | blkAlign (Addr addr) const |
Align an address to the block size. | |
int | extractBlkOffset (Addr addr) const |
Calculate the block offset of an address. | |
virtual void | setWayAllocationMax (int ways) |
Limit the allocation for the cache ways. | |
virtual int | getWayAllocationMax () const |
Get the way allocation mask limit. | |
virtual void | invalidate (CacheBlk *blk) |
This function updates the tags when a block is invalidated. | |
virtual CacheBlk * | findVictim (Addr addr, const bool is_secure, const std::size_t size, std::vector< CacheBlk * > &evict_blks, const uint64_t partition_id=0)=0 |
Find replacement victim based on address. | |
virtual CacheBlk * | accessBlock (const PacketPtr pkt, Cycles &lat)=0 |
Access block and update replacement data. | |
virtual Addr | extractTag (const Addr addr) const |
Generate the tag from the given address. | |
virtual void | insertBlock (const PacketPtr pkt, CacheBlk *blk) |
Insert the new block into the cache and update stats. | |
virtual void | moveBlock (CacheBlk *src_blk, CacheBlk *dest_blk) |
Move a block's metadata to another location decided by the replacement policy. | |
virtual Addr | regenerateBlkAddr (const CacheBlk *blk) const =0 |
Regenerate the block address. | |
void | forEachBlk (std::function< void(CacheBlk &)> visitor) |
Visit each block in the tags and apply a visitor. | |
virtual bool | anyBlk (std::function< bool(CacheBlk &)> visitor)=0 |
Find if any of the blocks satisfies a condition. | |
Public Member Functions inherited from gem5::ClockedObject | |
ClockedObject (const ClockedObjectParams &p) | |
void | serialize (CheckpointOut &cp) const override |
Serialize an object. | |
void | unserialize (CheckpointIn &cp) override |
Unserialize an object. | |
Public Member Functions inherited from gem5::SimObject | |
const Params & | params () 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. | |
virtual void | loadState (CheckpointIn &cp) |
loadState() is called on each SimObject when restoring from a checkpoint. | |
virtual void | initState () |
initState() is called on each SimObject when not restoring from a checkpoint. | |
virtual void | regProbePoints () |
Register probe points for this object. | |
virtual void | regProbeListeners () |
Register probe listeners for this object. | |
ProbeManager * | getProbeManager () |
Get the probe manager for this object. | |
virtual Port & | getPort (const std::string &if_name, PortID idx=InvalidPortID) |
Get a port with a given name and index. | |
virtual void | startup () |
startup() is the final initialization call before simulation. | |
DrainState | drain () override |
Provide a default implementation of the drain interface for objects that don't need draining. | |
virtual void | memWriteback () |
Write back dirty buffers to memory using functional writes. | |
virtual void | memInvalidate () |
Invalidate the contents of memory buffers. | |
void | serialize (CheckpointOut &cp) const override |
Serialize an object. | |
void | unserialize (CheckpointIn &cp) override |
Unserialize an object. | |
Public Member Functions inherited from gem5::EventManager | |
EventQueue * | eventQueue () 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. | |
void | setCurTick (Tick newVal) |
EventManager (EventManager &em) | |
Event manger manages events in the event queue. | |
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. | |
void | serializeSection (CheckpointOut &cp, const std::string &name) const |
void | unserializeSection (CheckpointIn &cp, const char *name) |
Unserialize an a child object. | |
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. | |
virtual void | notifyFork () |
Notify a child process of a fork. | |
Public Member Functions inherited from gem5::statistics::Group | |
Group (Group *parent, const char *name=nullptr) | |
Construct a new statistics group. | |
virtual | ~Group () |
virtual void | regStats () |
Callback to set stat parameters. | |
virtual void | resetStats () |
Callback to reset stats. | |
virtual void | preDumpStats () |
Callback before stats are dumped. | |
void | addStat (statistics::Info *info) |
Register a stat with this group. | |
const std::map< std::string, Group * > & | getStatGroups () const |
Get all child groups associated with this object. | |
const std::vector< Info * > & | getStats () const |
Get all stats associated with this object. | |
void | addStatGroup (const char *name, Group *block) |
Add a stat block as a child of this block. | |
const Info * | resolveStat (std::string name) const |
Resolve a stat by its name within this group. | |
void | mergeStatGroup (Group *block) |
Merge the contents (stats & children) of a block to this block. | |
Group ()=delete | |
Group (const Group &)=delete | |
Group & | operator= (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. | |
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. | |
Cycles | curCycle () const |
Determine the current cycle, corresponding to a tick aligned to a clock edge. | |
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. | |
uint64_t | frequency () const |
Tick | clockPeriod () const |
double | voltage () const |
Cycles | ticksToCycles (Tick t) const |
Tick | cyclesToTicks (Cycles c) const |
Protected Attributes | |
const unsigned | blkSize |
The block size of the cache. | |
const Addr | blkMask |
Mask out all bits that aren't part of the block offset. | |
const unsigned | size |
The size of the cache. | |
const Cycles | lookupLatency |
The tag lookup latency of the cache. | |
System * | system |
System we are currently operating in. | |
BaseIndexingPolicy * | indexingPolicy |
Indexing policy. | |
partitioning_policy::PartitionManager * | partitionManager |
Partitioning manager. | |
const unsigned | warmupBound |
The number of tags that need to be touched to meet the warmup percentage. | |
bool | warmedUp |
Marked true when the cache is warmed up. | |
const unsigned | numBlocks |
the number of blocks in the cache | |
std::unique_ptr< uint8_t[]> | dataBlks |
The data blocks, 1 per cache block. | |
gem5::BaseTags::BaseTagStats | stats |
Protected Attributes inherited from gem5::SimObject | |
const SimObjectParams & | _params |
Cached copy of the object parameters. | |
Protected Attributes inherited from gem5::EventManager | |
EventQueue * | eventq |
A pointer to this object's event queue. | |
Private Member Functions | |
void | cleanupRefsVisitor (CacheBlk &blk) |
Update the reference stats using data from the input block. | |
void | computeStatsVisitor (CacheBlk &blk) |
Update the occupancy and age stats using data from the input block. | |
Additional Inherited Members | |
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. | |
static SimObject * | find (const char *name) |
Find the SimObject with the given name and return a pointer to it. | |
static void | setSimObjectResolver (SimObjectResolver *resolver) |
There is a single object name resolver, and it is only set when simulation is restoring from checkpoints. | |
static SimObjectResolver * | getSimObjectResolver () |
There is a single object name resolver, and it is only set when simulation is restoring from checkpoints. | |
Static Public Member Functions inherited from gem5::Serializable | |
static const std::string & | currentSection () |
Gets the fully-qualified name of the active section. | |
static void | generateCheckpointOut (const std::string &cpt_dir, std::ofstream &outstream) |
Generate a checkpoint file so that the serialization can be routed to it. | |
Public Attributes inherited from gem5::ClockedObject | |
PowerState * | powerState |
Protected Member Functions inherited from gem5::Drainable | |
Drainable () | |
virtual | ~Drainable () |
virtual void | drainResume () |
Resume execution after a successful drain. | |
void | signalDrainDone () const |
Signal that an object is drained. | |
Protected Member Functions inherited from gem5::Clocked | |
Clocked (ClockDomain &clk_domain) | |
Create a clocked object and set the clock domain based on the parameters. | |
Clocked (Clocked &)=delete | |
Clocked & | operator= (Clocked &)=delete |
virtual | ~Clocked () |
Virtual destructor due to inheritance. | |
void | resetClock () const |
Reset the object's clock using the current global tick value. | |
virtual void | clockPeriodUpdated () |
A hook subclasses can implement so they can do any extra work that's needed when the clock rate is changed. | |
typedef BaseTagsParams gem5::BaseTags::Params |
gem5::BaseTags::BaseTags | ( | const Params & | p | ) |
Definition at line 62 of file base.cc.
References cleanupRefs(), and gem5::registerExitCallback().
|
inlinevirtual |
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 tag lookup latency as a side effect.
pkt | The packet holding the address to find. |
lat | The latency of the tag lookup. |
Implemented in gem5::BaseSetAssoc, gem5::FALRU, and gem5::SectorTags.
Referenced by gem5::BaseCache::access().
|
pure virtual |
Find if any of the blocks satisfies a condition.
The visitor should be a std::function that takes a cache block reference as its parameter. The visitor will terminate the traversal early if the condition is satisfied.
visitor | Visitor to call on each block. |
Implemented in gem5::BaseSetAssoc, gem5::CompressedTags, gem5::FALRU, and gem5::SectorTags.
Referenced by forEachBlk(), and gem5::BaseCache::isDirty().
Align an address to the block size.
addr | the address to align. |
Definition at line 218 of file base.hh.
References gem5::X86ISA::addr.
Referenced by gem5::FALRU::extractTag().
void gem5::BaseTags::cleanupRefs | ( | ) |
Average in the reference count for valid blocks when the simulation exits.
Definition at line 162 of file base.cc.
References cleanupRefsVisitor(), and forEachBlk().
Referenced by BaseTags().
|
private |
Update the reference stats using data from the input block.
blk | The input block |
Definition at line 153 of file base.cc.
References gem5::CacheBlk::getRefCount(), gem5::CacheEntry::isValid(), gem5::BaseTags::BaseTagStats::sampledRefs, stats, and gem5::BaseTags::BaseTagStats::totalRefs.
Referenced by cleanupRefs().
void gem5::BaseTags::computeStats | ( | ) |
Computes stats just prior to dump event.
Definition at line 193 of file base.cc.
References gem5::BaseTags::BaseTagStats::ageTaskId, computeStatsVisitor(), forEachBlk(), gem5::ArmISA::i, gem5::context_switch_task_id::NumTaskId, gem5::BaseTags::BaseTagStats::occupanciesTaskId, and stats.
|
private |
Update the occupancy and age stats using data from the input block.
blk | The input block |
Definition at line 168 of file base.cc.
References gem5::BaseTags::BaseTagStats::ageTaskId, gem5::CacheBlk::getAge(), gem5::CacheBlk::getTaskId(), gem5::CacheEntry::isValid(), gem5::sim_clock::as_int::ms, gem5::context_switch_task_id::NumTaskId, gem5::BaseTags::BaseTagStats::occupanciesTaskId, stats, and gem5::sim_clock::as_int::us.
Referenced by computeStats().
|
inline |
Calculate the block offset of an address.
addr | the address to get the offset of. |
Definition at line 228 of file base.hh.
References gem5::X86ISA::addr, and blkMask.
Referenced by gem5::BaseCache::satisfyRequest().
Generate the tag from the given address.
addr | The address to get the tag from. |
Reimplemented in gem5::FALRU.
Definition at line 147 of file base.cc.
References gem5::X86ISA::addr, gem5::BaseIndexingPolicy::extractTag(), and indexingPolicy.
Referenced by findBlock(), gem5::SectorTags::findBlock(), gem5::CompressedTags::findVictim(), gem5::SectorTags::findVictim(), and insertBlock().
Finds the block in the cache without touching it.
addr | The address to look for. |
is_secure | True if the target memory space is secure. |
Reimplemented in gem5::FALRU, and gem5::SectorTags.
Definition at line 82 of file base.cc.
References gem5::X86ISA::addr, extractTag(), gem5::BaseIndexingPolicy::getPossibleEntries(), indexingPolicy, and gem5::TaggedEntry::matchTag().
Referenced by gem5::Cache::access(), gem5::BaseSetAssoc::accessBlock(), gem5::BaseCache::functionalAccess(), gem5::BaseCache::getNextQueueEntry(), gem5::BaseCache::hasBeenPrefetched(), gem5::BaseCache::hasBeenPrefetched(), gem5::BaseCache::inCache(), gem5::Cache::recvAtomicSnoop(), gem5::BaseCache::recvTimingReq(), gem5::BaseCache::recvTimingResp(), gem5::Cache::recvTimingSnoopReq(), gem5::BaseCache::sendMSHRQueuePacket(), and gem5::Cache::sendMSHRQueuePacket().
|
virtual |
Find a block given set and way.
set | The set of the block. |
way | The way of the block. |
Reimplemented in gem5::FALRU.
Definition at line 76 of file base.cc.
References gem5::BaseIndexingPolicy::getEntry(), indexingPolicy, and gem5::ArmISA::set.
|
pure virtual |
Find replacement victim based on address.
If the address requires blocks to be evicted, their locations are listed for eviction. If a conventional cache is being used, the list only contains the victim. However, if using sector or compressed caches, the victim is one of the blocks to be evicted, but its location is the only one that will be assigned to the newly allocated block associated to this address.
addr | Address to find a victim for. |
is_secure | True if the target memory space is secure. |
size | Size, in bits, of new block to allocate. |
evict_blks | Cache blocks to be evicted. |
partition_id | Partition ID for resource management. |
Implemented in gem5::BaseSetAssoc, gem5::CompressedTags, gem5::FALRU, and gem5::SectorTags.
Referenced by gem5::BaseCache::allocateBlock(), and gem5::BaseCache::updateCompressionData().
void gem5::BaseTags::forEachBlk | ( | std::function< void(CacheBlk &)> | visitor | ) |
Visit each block in the tags and apply a visitor.
The visitor should be a std::function that takes a cache block reference as its parameter.
visitor | Visitor to call on each block. |
Definition at line 223 of file base.cc.
References anyBlk().
Referenced by cleanupRefs(), computeStats(), gem5::BaseCache::memInvalidate(), gem5::BaseCache::memWriteback(), and print().
|
inlinevirtual |
Get the way allocation mask limit.
Reimplemented in gem5::BaseSetAssoc.
Definition at line 246 of file base.hh.
References panic.
Insert the new block into the cache and update stats.
pkt | Packet holding the address to update |
blk | The block to update. |
Reimplemented in gem5::BaseSetAssoc, gem5::FALRU, and gem5::SectorTags.
Definition at line 104 of file base.cc.
References gem5::curTick(), gem5::BaseTags::BaseTagStats::dataAccesses, extractTag(), gem5::Packet::getAddr(), gem5::CacheBlk::insert(), gem5::Packet::isSecure(), gem5::CacheEntry::isValid(), gem5::BaseTags::BaseTagStats::occupancies, partitionManager, gem5::partitioning_policy::PartitionManager::readPacketPartitionID(), gem5::Packet::req, stats, gem5::BaseTags::BaseTagStats::tagAccesses, gem5::BaseTags::BaseTagStats::tagsInUse, gem5::statistics::ScalarBase< Derived, Stor >::value(), warmedUp, warmupBound, and gem5::BaseTags::BaseTagStats::warmupTick.
Referenced by gem5::BaseCache::allocateBlock(), gem5::BaseSetAssoc::insertBlock(), gem5::FALRU::insertBlock(), and gem5::SectorTags::insertBlock().
|
inlinevirtual |
This function updates the tags when a block is invalidated.
blk | A valid block to invalidate. |
Reimplemented in gem5::BaseSetAssoc, gem5::FALRU, and gem5::SectorTags.
Definition at line 257 of file base.hh.
References gem5::CacheBlk::getRefCount(), gem5::CacheBlk::getSrcRequestorId(), gem5::CacheBlk::invalidate(), gem5::CacheEntry::isValid(), gem5::BaseTags::BaseTagStats::occupancies, gem5::BaseTags::BaseTagStats::sampledRefs, stats, and gem5::BaseTags::BaseTagStats::totalRefs.
Referenced by gem5::BaseSetAssoc::invalidate(), gem5::FALRU::invalidate(), gem5::SectorTags::invalidate(), and gem5::BaseCache::invalidateBlock().
Move a block's metadata to another location decided by the replacement policy.
It behaves as a swap, however, since the destination block should be invalid, the result is a move.
src_blk | The source block. |
dest_blk | The destination block. Must be invalid. |
Reimplemented in gem5::BaseSetAssoc, gem5::FALRU, and gem5::SectorTags.
Definition at line 134 of file base.cc.
References gem5::CacheEntry::isValid().
Referenced by gem5::BaseSetAssoc::moveBlock(), gem5::SectorTags::moveBlock(), and gem5::BaseCache::updateCompressionData().
std::string gem5::BaseTags::print | ( | ) |
Print all tags used.
Definition at line 206 of file base.cc.
References gem5::csprintf(), and forEachBlk().
Referenced by gem5::Cache::recvTimingReq().
Regenerate the block address.
block | The block. |
Implemented in gem5::BaseSetAssoc, gem5::FALRU, and gem5::SectorTags.
Referenced by gem5::BaseCache::regenerateBlkAddr().
|
inlinevirtual |
Limit the allocation for the cache ways.
ways | The maximum number of ways available for replacement. |
Reimplemented in gem5::BaseSetAssoc.
Definition at line 237 of file base.hh.
References panic.
|
pure virtual |
Initialize blocks.
Must be overriden by every subclass that uses a block type different from its parent's, as the current Python code generation does not allow templates.
Implemented in gem5::BaseSetAssoc, gem5::CompressedTags, gem5::FALRU, and gem5::SectorTags.
|
protected |
Mask out all bits that aren't part of the block offset.
Definition at line 79 of file base.hh.
Referenced by extractBlkOffset().
|
protected |
The block size of the cache.
Definition at line 77 of file base.hh.
Referenced by gem5::BaseSetAssoc::BaseSetAssoc(), gem5::FALRU::CacheTracking::check(), gem5::FALRU::FALRU(), gem5::FALRU::CacheTracking::init(), gem5::SectorTags::SectorTags(), gem5::BaseSetAssoc::tagsInit(), gem5::CompressedTags::tagsInit(), gem5::FALRU::tagsInit(), and gem5::SectorTags::tagsInit().
|
protected |
The data blocks, 1 per cache block.
Definition at line 106 of file base.hh.
Referenced by gem5::BaseSetAssoc::tagsInit(), gem5::CompressedTags::tagsInit(), gem5::FALRU::tagsInit(), and gem5::SectorTags::tagsInit().
|
protected |
Indexing policy.
Definition at line 89 of file base.hh.
Referenced by extractTag(), findBlock(), gem5::SectorTags::findBlock(), findBlockBySetAndWay(), gem5::BaseSetAssoc::findVictim(), gem5::CompressedTags::findVictim(), gem5::SectorTags::findVictim(), gem5::BaseSetAssoc::regenerateBlkAddr(), gem5::SectorTags::regenerateBlkAddr(), gem5::BaseSetAssoc::tagsInit(), gem5::CompressedTags::tagsInit(), and gem5::SectorTags::tagsInit().
|
protected |
The tag lookup latency of the cache.
Definition at line 83 of file base.hh.
Referenced by gem5::BaseSetAssoc::accessBlock(), gem5::FALRU::accessBlock(), and gem5::SectorTags::accessBlock().
|
protected |
the number of blocks in the cache
Definition at line 103 of file base.hh.
Referenced by gem5::FALRU::anyBlk(), gem5::FALRU::FALRU(), gem5::BaseSetAssoc::tagsInit(), gem5::CompressedTags::tagsInit(), gem5::FALRU::tagsInit(), and gem5::SectorTags::tagsInit().
|
protected |
Partitioning manager.
Definition at line 92 of file base.hh.
Referenced by gem5::FALRU::FALRU(), gem5::BaseSetAssoc::findVictim(), gem5::CompressedTags::findVictim(), gem5::SectorTags::findVictim(), gem5::BaseSetAssoc::insertBlock(), insertBlock(), gem5::BaseSetAssoc::invalidate(), and gem5::SectorTags::SectorTags().
|
protected |
|
protected |
Referenced by gem5::BaseSetAssoc::accessBlock(), gem5::SectorTags::accessBlock(), cleanupRefsVisitor(), computeStats(), computeStatsVisitor(), gem5::BaseSetAssoc::insertBlock(), insertBlock(), gem5::FALRU::insertBlock(), gem5::SectorTags::insertBlock(), gem5::BaseSetAssoc::invalidate(), invalidate(), gem5::FALRU::invalidate(), gem5::SectorTags::invalidate(), and gem5::SectorTags::moveBlock().
|
protected |
System we are currently operating in.
Definition at line 86 of file base.hh.
Referenced by gem5::BaseTags::BaseTagStats::regStats().
|
protected |
Marked true when the cache is warmed up.
Definition at line 100 of file base.hh.
Referenced by insertBlock().
|
protected |
The number of tags that need to be touched to meet the warmup percentage.
Definition at line 98 of file base.hh.
Referenced by insertBlock().