12810SN/A/* 212728Snikos.nikoleris@arm.com * Copyright (c) 2012-2014,2016-2018 ARM Limited 39347SAndreas.Sandberg@arm.com * All rights reserved. 49347SAndreas.Sandberg@arm.com * 59347SAndreas.Sandberg@arm.com * The license below extends only to copyright in the software and shall 69347SAndreas.Sandberg@arm.com * not be construed as granting a license to any other intellectual 79347SAndreas.Sandberg@arm.com * property including but not limited to intellectual property relating 89347SAndreas.Sandberg@arm.com * to a hardware implementation of the functionality of the software 99347SAndreas.Sandberg@arm.com * licensed hereunder. You may use the software subject to the license 109347SAndreas.Sandberg@arm.com * terms below provided that you ensure that this notice is replicated 119347SAndreas.Sandberg@arm.com * unmodified and in its entirety in all distributions of the software, 129347SAndreas.Sandberg@arm.com * modified or unmodified, in source code or in binary form. 139347SAndreas.Sandberg@arm.com * 142810SN/A * Copyright (c) 2003-2005 The Regents of The University of Michigan 152810SN/A * All rights reserved. 162810SN/A * 172810SN/A * Redistribution and use in source and binary forms, with or without 182810SN/A * modification, are permitted provided that the following conditions are 192810SN/A * met: redistributions of source code must retain the above copyright 202810SN/A * notice, this list of conditions and the following disclaimer; 212810SN/A * redistributions in binary form must reproduce the above copyright 222810SN/A * notice, this list of conditions and the following disclaimer in the 232810SN/A * documentation and/or other materials provided with the distribution; 242810SN/A * neither the name of the copyright holders nor the names of its 252810SN/A * contributors may be used to endorse or promote products derived from 262810SN/A * this software without specific prior written permission. 272810SN/A * 282810SN/A * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 292810SN/A * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 302810SN/A * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 312810SN/A * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 322810SN/A * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 332810SN/A * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 342810SN/A * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 352810SN/A * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 362810SN/A * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 372810SN/A * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 382810SN/A * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 392810SN/A * 402810SN/A * Authors: Erik Hallnor 412810SN/A * Ron Dreslinski 422810SN/A */ 432810SN/A 442810SN/A/** 452810SN/A * @file 462810SN/A * Declaration of a common base class for cache tagstore objects. 472810SN/A */ 482810SN/A 4912492Sodanrc@yahoo.com.br#ifndef __MEM_CACHE_TAGS_BASE_HH__ 5012492Sodanrc@yahoo.com.br#define __MEM_CACHE_TAGS_BASE_HH__ 512810SN/A 5212727Snikos.nikoleris@arm.com#include <cassert> 5313941Sodanrc@yahoo.com.br#include <cstdint> 5412728Snikos.nikoleris@arm.com#include <functional> 552810SN/A#include <string> 568229Snate@binkert.org 578229Snate@binkert.org#include "base/callback.hh" 5812727Snikos.nikoleris@arm.com#include "base/logging.hh" 592810SN/A#include "base/statistics.hh" 6012727Snikos.nikoleris@arm.com#include "base/types.hh" 6113223Sodanrc@yahoo.com.br#include "mem/cache/cache_blk.hh" 6213752Sodanrc@yahoo.com.br#include "mem/packet.hh" 639796Sprakash.ramrakhyani@arm.com#include "params/BaseTags.hh" 649796Sprakash.ramrakhyani@arm.com#include "sim/clocked_object.hh" 652810SN/A 6613419Sodanrc@yahoo.com.brclass System; 6713219Sodanrc@yahoo.com.brclass IndexingPolicy; 6812773Sodanrc@yahoo.com.brclass ReplaceableEntry; 692810SN/A 702810SN/A/** 712810SN/A * A common base class of Cache tagstore objects. 722810SN/A */ 739796Sprakash.ramrakhyani@arm.comclass BaseTags : public ClockedObject 742810SN/A{ 752810SN/A protected: 769796Sprakash.ramrakhyani@arm.com /** The block size of the cache. */ 779796Sprakash.ramrakhyani@arm.com const unsigned blkSize; 7811893Snikos.nikoleris@arm.com /** Mask out all bits that aren't part of the block offset. */ 7911893Snikos.nikoleris@arm.com const Addr blkMask; 809796Sprakash.ramrakhyani@arm.com /** The size of the cache. */ 819796Sprakash.ramrakhyani@arm.com const unsigned size; 8211722Ssophiane.senni@gmail.com /** The tag lookup latency of the cache. */ 8311722Ssophiane.senni@gmail.com const Cycles lookupLatency; 8413418Sodanrc@yahoo.com.br 8513419Sodanrc@yahoo.com.br /** System we are currently operating in. */ 8613419Sodanrc@yahoo.com.br System *system; 872810SN/A 8813219Sodanrc@yahoo.com.br /** Indexing policy */ 8913219Sodanrc@yahoo.com.br BaseIndexingPolicy *indexingPolicy; 9013219Sodanrc@yahoo.com.br 912810SN/A /** 922810SN/A * The number of tags that need to be touched to meet the warmup 932810SN/A * percentage. 942810SN/A */ 9512513Sodanrc@yahoo.com.br const unsigned warmupBound; 962810SN/A /** Marked true when the cache is warmed up. */ 972810SN/A bool warmedUp; 982810SN/A 996978SLisa.Hsu@amd.com /** the number of blocks in the cache */ 10012553Snikos.nikoleris@arm.com const unsigned numBlocks; 1016978SLisa.Hsu@amd.com 10212629Sodanrc@yahoo.com.br /** The data blocks, 1 per cache block. */ 10312629Sodanrc@yahoo.com.br std::unique_ptr<uint8_t[]> dataBlks; 10412629Sodanrc@yahoo.com.br 1052810SN/A // Statistics 1062810SN/A /** 10712513Sodanrc@yahoo.com.br * TODO: It would be good if these stats were acquired after warmup. 1082810SN/A * @addtogroup CacheStatistics 1092810SN/A * @{ 1102810SN/A */ 1112810SN/A 1122810SN/A /** Per cycle average of the number of tags that hold valid data. */ 1135999Snate@binkert.org Stats::Average tagsInUse; 1142810SN/A 1152810SN/A /** The total number of references to a block before it is replaced. */ 1165999Snate@binkert.org Stats::Scalar totalRefs; 1172810SN/A 1182810SN/A /** 1192810SN/A * The number of reference counts sampled. This is different from 1202810SN/A * replacements because we sample all the valid blocks when the simulator 1212810SN/A * exits. 1222810SN/A */ 1235999Snate@binkert.org Stats::Scalar sampledRefs; 1242810SN/A 1252810SN/A /** 1262810SN/A * Average number of references to a block before is was replaced. 1272810SN/A * @todo This should change to an average stat once we have them. 1282810SN/A */ 1292810SN/A Stats::Formula avgRefs; 1302810SN/A 13112513Sodanrc@yahoo.com.br /** The cycle that the warmup percentage was hit. 0 on failure. */ 1325999Snate@binkert.org Stats::Scalar warmupCycle; 1336978SLisa.Hsu@amd.com 1348833Sdam.sunwoo@arm.com /** Average occupancy of each requestor using the cache */ 1356978SLisa.Hsu@amd.com Stats::AverageVector occupancies; 1366978SLisa.Hsu@amd.com 1378833Sdam.sunwoo@arm.com /** Average occ % of each requestor using the cache */ 1386978SLisa.Hsu@amd.com Stats::Formula avgOccs; 1396978SLisa.Hsu@amd.com 14010024Sdam.sunwoo@arm.com /** Occupancy of each context/cpu using the cache */ 14110024Sdam.sunwoo@arm.com Stats::Vector occupanciesTaskId; 14210024Sdam.sunwoo@arm.com 14310024Sdam.sunwoo@arm.com /** Occupancy of each context/cpu using the cache */ 14410024Sdam.sunwoo@arm.com Stats::Vector2d ageTaskId; 14510024Sdam.sunwoo@arm.com 14610024Sdam.sunwoo@arm.com /** Occ % of each context/cpu using the cache */ 14710024Sdam.sunwoo@arm.com Stats::Formula percentOccsTaskId; 14810024Sdam.sunwoo@arm.com 14910025Stimothy.jones@arm.com /** Number of tags consulted over all accesses. */ 15010025Stimothy.jones@arm.com Stats::Scalar tagAccesses; 15110025Stimothy.jones@arm.com /** Number of data blocks consulted over all accesses. */ 15210025Stimothy.jones@arm.com Stats::Scalar dataAccesses; 15310025Stimothy.jones@arm.com 1542810SN/A /** 1552810SN/A * @} 1562810SN/A */ 1572810SN/A 1582810SN/A public: 1599796Sprakash.ramrakhyani@arm.com typedef BaseTagsParams Params; 1609796Sprakash.ramrakhyani@arm.com BaseTags(const Params *p); 1612810SN/A 1622810SN/A /** 1632810SN/A * Destructor. 1642810SN/A */ 1652810SN/A virtual ~BaseTags() {} 1662810SN/A 1672810SN/A /** 16813419Sodanrc@yahoo.com.br * Initialize blocks. Must be overriden by every subclass that uses 16913419Sodanrc@yahoo.com.br * a block type different from its parent's, as the current Python 17013419Sodanrc@yahoo.com.br * code generation does not allow templates. 1712810SN/A */ 17213419Sodanrc@yahoo.com.br virtual void tagsInit() = 0; 1732810SN/A 1742810SN/A /** 1759796Sprakash.ramrakhyani@arm.com * Register local statistics. 1762810SN/A */ 1779796Sprakash.ramrakhyani@arm.com void regStats(); 1782810SN/A 1792810SN/A /** 1802810SN/A * Average in the reference count for valid blocks when the simulation 1812810SN/A * exits. 1822810SN/A */ 18312728Snikos.nikoleris@arm.com void cleanupRefs(); 1847612SGene.Wu@arm.com 1857612SGene.Wu@arm.com /** 18610024Sdam.sunwoo@arm.com * Computes stats just prior to dump event 18710024Sdam.sunwoo@arm.com */ 18812728Snikos.nikoleris@arm.com void computeStats(); 18910024Sdam.sunwoo@arm.com 19010024Sdam.sunwoo@arm.com /** 1919663Suri.wiener@arm.com * Print all tags used 1929663Suri.wiener@arm.com */ 19312728Snikos.nikoleris@arm.com std::string print(); 19410815Sdavid.guillen@arm.com 19510815Sdavid.guillen@arm.com /** 19613217Sodanrc@yahoo.com.br * Finds the block in the cache without touching it. 19713217Sodanrc@yahoo.com.br * 19813217Sodanrc@yahoo.com.br * @param addr The address to look for. 19913217Sodanrc@yahoo.com.br * @param is_secure True if the target memory space is secure. 20013217Sodanrc@yahoo.com.br * @return Pointer to the cache block. 20110815Sdavid.guillen@arm.com */ 20213217Sodanrc@yahoo.com.br virtual CacheBlk *findBlock(Addr addr, bool is_secure) const; 20310815Sdavid.guillen@arm.com 20410815Sdavid.guillen@arm.com /** 20512743Sodanrc@yahoo.com.br * Find a block given set and way. 20612743Sodanrc@yahoo.com.br * 20712743Sodanrc@yahoo.com.br * @param set The set of the block. 20812743Sodanrc@yahoo.com.br * @param way The way of the block. 20912743Sodanrc@yahoo.com.br * @return The block. 21012743Sodanrc@yahoo.com.br */ 21113219Sodanrc@yahoo.com.br virtual ReplaceableEntry* findBlockBySetAndWay(int set, int way) const; 21212743Sodanrc@yahoo.com.br 21312743Sodanrc@yahoo.com.br /** 21411893Snikos.nikoleris@arm.com * Align an address to the block size. 21511893Snikos.nikoleris@arm.com * @param addr the address to align. 21611893Snikos.nikoleris@arm.com * @return The block address. 21711893Snikos.nikoleris@arm.com */ 21811893Snikos.nikoleris@arm.com Addr blkAlign(Addr addr) const 21911893Snikos.nikoleris@arm.com { 22011893Snikos.nikoleris@arm.com return addr & ~blkMask; 22111893Snikos.nikoleris@arm.com } 22211893Snikos.nikoleris@arm.com 22311893Snikos.nikoleris@arm.com /** 22410815Sdavid.guillen@arm.com * Calculate the block offset of an address. 22510815Sdavid.guillen@arm.com * @param addr the address to get the offset of. 22610815Sdavid.guillen@arm.com * @return the block offset. 22710815Sdavid.guillen@arm.com */ 22810815Sdavid.guillen@arm.com int extractBlkOffset(Addr addr) const 22910815Sdavid.guillen@arm.com { 23011893Snikos.nikoleris@arm.com return (addr & blkMask); 23110815Sdavid.guillen@arm.com } 23210815Sdavid.guillen@arm.com 23310941Sdavid.guillen@arm.com /** 23410941Sdavid.guillen@arm.com * Limit the allocation for the cache ways. 23510941Sdavid.guillen@arm.com * @param ways The maximum number of ways available for replacement. 23610941Sdavid.guillen@arm.com */ 23710941Sdavid.guillen@arm.com virtual void setWayAllocationMax(int ways) 23810941Sdavid.guillen@arm.com { 23910941Sdavid.guillen@arm.com panic("This tag class does not implement way allocation limit!\n"); 24010941Sdavid.guillen@arm.com } 24110941Sdavid.guillen@arm.com 24210941Sdavid.guillen@arm.com /** 24310941Sdavid.guillen@arm.com * Get the way allocation mask limit. 24410941Sdavid.guillen@arm.com * @return The maximum number of ways available for replacement. 24510941Sdavid.guillen@arm.com */ 24610941Sdavid.guillen@arm.com virtual int getWayAllocationMax() const 24710941Sdavid.guillen@arm.com { 24810941Sdavid.guillen@arm.com panic("This tag class does not implement way allocation limit!\n"); 24910941Sdavid.guillen@arm.com return -1; 25010941Sdavid.guillen@arm.com } 25110941Sdavid.guillen@arm.com 25212566Snikos.nikoleris@arm.com /** 25312704Snikos.nikoleris@arm.com * This function updates the tags when a block is invalidated 25412704Snikos.nikoleris@arm.com * 25512704Snikos.nikoleris@arm.com * @param blk A valid block to invalidate. 25612566Snikos.nikoleris@arm.com */ 25712566Snikos.nikoleris@arm.com virtual void invalidate(CacheBlk *blk) 25812566Snikos.nikoleris@arm.com { 25912566Snikos.nikoleris@arm.com assert(blk); 26012566Snikos.nikoleris@arm.com assert(blk->isValid()); 26112704Snikos.nikoleris@arm.com 26212566Snikos.nikoleris@arm.com occupancies[blk->srcMasterId]--; 26312704Snikos.nikoleris@arm.com totalRefs += blk->refCount; 26412704Snikos.nikoleris@arm.com sampledRefs++; 26512704Snikos.nikoleris@arm.com 26612704Snikos.nikoleris@arm.com blk->invalidate(); 26712566Snikos.nikoleris@arm.com } 26810815Sdavid.guillen@arm.com 26912600Sodanrc@yahoo.com.br /** 27012744Sodanrc@yahoo.com.br * Find replacement victim based on address. If the address requires 27112744Sodanrc@yahoo.com.br * blocks to be evicted, their locations are listed for eviction. If a 27212744Sodanrc@yahoo.com.br * conventional cache is being used, the list only contains the victim. 27312744Sodanrc@yahoo.com.br * However, if using sector or compressed caches, the victim is one of 27412744Sodanrc@yahoo.com.br * the blocks to be evicted, but its location is the only one that will 27512744Sodanrc@yahoo.com.br * be assigned to the newly allocated block associated to this address. 27612744Sodanrc@yahoo.com.br * @sa insertBlock 27712600Sodanrc@yahoo.com.br * 27812600Sodanrc@yahoo.com.br * @param addr Address to find a victim for. 27912746Sodanrc@yahoo.com.br * @param is_secure True if the target memory space is secure. 28013941Sodanrc@yahoo.com.br * @param size Size, in bits, of new block to allocate. 28112744Sodanrc@yahoo.com.br * @param evict_blks Cache blocks to be evicted. 28212600Sodanrc@yahoo.com.br * @return Cache block to be replaced. 28312600Sodanrc@yahoo.com.br */ 28412746Sodanrc@yahoo.com.br virtual CacheBlk* findVictim(Addr addr, const bool is_secure, 28513941Sodanrc@yahoo.com.br const std::size_t size, 28612746Sodanrc@yahoo.com.br std::vector<CacheBlk*>& evict_blks) const = 0; 28712600Sodanrc@yahoo.com.br 28813418Sodanrc@yahoo.com.br /** 28913418Sodanrc@yahoo.com.br * Access block and update replacement data. May not succeed, in which case 29013418Sodanrc@yahoo.com.br * nullptr is returned. This has all the implications of a cache access and 29113418Sodanrc@yahoo.com.br * should only be used as such. Returns the tag lookup latency as a side 29213418Sodanrc@yahoo.com.br * effect. 29313418Sodanrc@yahoo.com.br * 29413418Sodanrc@yahoo.com.br * @param addr The address to find. 29513418Sodanrc@yahoo.com.br * @param is_secure True if the target memory space is secure. 29613418Sodanrc@yahoo.com.br * @param lat The latency of the tag lookup. 29713418Sodanrc@yahoo.com.br * @return Pointer to the cache block if found. 29813418Sodanrc@yahoo.com.br */ 29911870Snikos.nikoleris@arm.com virtual CacheBlk* accessBlock(Addr addr, bool is_secure, Cycles &lat) = 0; 30010815Sdavid.guillen@arm.com 30113219Sodanrc@yahoo.com.br /** 30213219Sodanrc@yahoo.com.br * Generate the tag from the given address. 30313219Sodanrc@yahoo.com.br * 30413219Sodanrc@yahoo.com.br * @param addr The address to get the tag from. 30513219Sodanrc@yahoo.com.br * @return The tag of the address. 30613219Sodanrc@yahoo.com.br */ 30713219Sodanrc@yahoo.com.br virtual Addr extractTag(const Addr addr) const; 30810815Sdavid.guillen@arm.com 30912636Sodanrc@yahoo.com.br /** 31012636Sodanrc@yahoo.com.br * Insert the new block into the cache and update stats. 31112636Sodanrc@yahoo.com.br * 31213752Sodanrc@yahoo.com.br * @param pkt Packet holding the address to update 31312636Sodanrc@yahoo.com.br * @param blk The block to update. 31412636Sodanrc@yahoo.com.br */ 31513752Sodanrc@yahoo.com.br virtual void insertBlock(const PacketPtr pkt, CacheBlk *blk); 31610815Sdavid.guillen@arm.com 31712574Sodanrc@yahoo.com.br /** 31812574Sodanrc@yahoo.com.br * Regenerate the block address. 31912574Sodanrc@yahoo.com.br * 32012574Sodanrc@yahoo.com.br * @param block The block. 32112574Sodanrc@yahoo.com.br * @return the block address. 32212574Sodanrc@yahoo.com.br */ 32312574Sodanrc@yahoo.com.br virtual Addr regenerateBlkAddr(const CacheBlk* blk) const = 0; 32410815Sdavid.guillen@arm.com 32512728Snikos.nikoleris@arm.com /** 32612728Snikos.nikoleris@arm.com * Visit each block in the tags and apply a visitor 32712728Snikos.nikoleris@arm.com * 32812728Snikos.nikoleris@arm.com * The visitor should be a std::function that takes a cache block 32912728Snikos.nikoleris@arm.com * reference as its parameter. 33012728Snikos.nikoleris@arm.com * 33112728Snikos.nikoleris@arm.com * @param visitor Visitor to call on each block. 33212728Snikos.nikoleris@arm.com */ 33312728Snikos.nikoleris@arm.com virtual void forEachBlk(std::function<void(CacheBlk &)> visitor) = 0; 33412728Snikos.nikoleris@arm.com 33512728Snikos.nikoleris@arm.com /** 33612728Snikos.nikoleris@arm.com * Find if any of the blocks satisfies a condition 33712728Snikos.nikoleris@arm.com * 33812728Snikos.nikoleris@arm.com * The visitor should be a std::function that takes a cache block 33912728Snikos.nikoleris@arm.com * reference as its parameter. The visitor will terminate the 34012728Snikos.nikoleris@arm.com * traversal early if the condition is satisfied. 34112728Snikos.nikoleris@arm.com * 34212728Snikos.nikoleris@arm.com * @param visitor Visitor to call on each block. 34312728Snikos.nikoleris@arm.com */ 34412728Snikos.nikoleris@arm.com virtual bool anyBlk(std::function<bool(CacheBlk &)> visitor) = 0; 34512728Snikos.nikoleris@arm.com 34612728Snikos.nikoleris@arm.com private: 34712728Snikos.nikoleris@arm.com /** 34812728Snikos.nikoleris@arm.com * Update the reference stats using data from the input block 34912728Snikos.nikoleris@arm.com * 35012728Snikos.nikoleris@arm.com * @param blk The input block 35112728Snikos.nikoleris@arm.com */ 35212728Snikos.nikoleris@arm.com void cleanupRefsVisitor(CacheBlk &blk); 35312728Snikos.nikoleris@arm.com 35412728Snikos.nikoleris@arm.com /** 35512728Snikos.nikoleris@arm.com * Update the occupancy and age stats using data from the input block 35612728Snikos.nikoleris@arm.com * 35712728Snikos.nikoleris@arm.com * @param blk The input block 35812728Snikos.nikoleris@arm.com */ 35912728Snikos.nikoleris@arm.com void computeStatsVisitor(CacheBlk &blk); 3602810SN/A}; 3612810SN/A 3622810SN/Aclass BaseTagsCallback : public Callback 3632810SN/A{ 3642810SN/A BaseTags *tags; 3652810SN/A public: 3662810SN/A BaseTagsCallback(BaseTags *t) : tags(t) {} 3672810SN/A virtual void process() { tags->cleanupRefs(); }; 3682810SN/A}; 3692810SN/A 37010024Sdam.sunwoo@arm.comclass BaseTagsDumpCallback : public Callback 37110024Sdam.sunwoo@arm.com{ 37210024Sdam.sunwoo@arm.com BaseTags *tags; 37310024Sdam.sunwoo@arm.com public: 37410024Sdam.sunwoo@arm.com BaseTagsDumpCallback(BaseTags *t) : tags(t) {} 37510024Sdam.sunwoo@arm.com virtual void process() { tags->computeStats(); }; 37610024Sdam.sunwoo@arm.com}; 37710024Sdam.sunwoo@arm.com 37812492Sodanrc@yahoo.com.br#endif //__MEM_CACHE_TAGS_BASE_HH__ 379