base.hh revision 12727
12810SN/A/* 212566Snikos.nikoleris@arm.com * Copyright (c) 2012-2014,2016-2017 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> 532810SN/A#include <string> 548229Snate@binkert.org 558229Snate@binkert.org#include "base/callback.hh" 5612727Snikos.nikoleris@arm.com#include "base/logging.hh" 572810SN/A#include "base/statistics.hh" 5812727Snikos.nikoleris@arm.com#include "base/types.hh" 5910815Sdavid.guillen@arm.com#include "mem/cache/blk.hh" 6012727Snikos.nikoleris@arm.com#include "mem/packet.hh" 619796Sprakash.ramrakhyani@arm.com#include "params/BaseTags.hh" 629796Sprakash.ramrakhyani@arm.com#include "sim/clocked_object.hh" 632810SN/A 642810SN/Aclass BaseCache; 652810SN/A 662810SN/A/** 672810SN/A * A common base class of Cache tagstore objects. 682810SN/A */ 699796Sprakash.ramrakhyani@arm.comclass BaseTags : public ClockedObject 702810SN/A{ 712810SN/A protected: 729796Sprakash.ramrakhyani@arm.com /** The block size of the cache. */ 739796Sprakash.ramrakhyani@arm.com const unsigned blkSize; 7411893Snikos.nikoleris@arm.com /** Mask out all bits that aren't part of the block offset. */ 7511893Snikos.nikoleris@arm.com const Addr blkMask; 769796Sprakash.ramrakhyani@arm.com /** The size of the cache. */ 779796Sprakash.ramrakhyani@arm.com const unsigned size; 7811722Ssophiane.senni@gmail.com /** The tag lookup latency of the cache. */ 7911722Ssophiane.senni@gmail.com const Cycles lookupLatency; 8011722Ssophiane.senni@gmail.com /** 8111722Ssophiane.senni@gmail.com * The total access latency of the cache. This latency 8211722Ssophiane.senni@gmail.com * is different depending on the cache access mode 8311722Ssophiane.senni@gmail.com * (parallel or sequential) 8411722Ssophiane.senni@gmail.com */ 8510693SMarco.Balboni@ARM.com const Cycles accessLatency; 862810SN/A /** Pointer to the parent cache. */ 872810SN/A BaseCache *cache; 882810SN/A 892810SN/A /** 902810SN/A * The number of tags that need to be touched to meet the warmup 912810SN/A * percentage. 922810SN/A */ 9312513Sodanrc@yahoo.com.br const unsigned warmupBound; 942810SN/A /** Marked true when the cache is warmed up. */ 952810SN/A bool warmedUp; 962810SN/A 976978SLisa.Hsu@amd.com /** the number of blocks in the cache */ 9812553Snikos.nikoleris@arm.com const unsigned numBlocks; 996978SLisa.Hsu@amd.com 10012629Sodanrc@yahoo.com.br /** The data blocks, 1 per cache block. */ 10112629Sodanrc@yahoo.com.br std::unique_ptr<uint8_t[]> dataBlks; 10212629Sodanrc@yahoo.com.br 1032810SN/A // Statistics 1042810SN/A /** 10512513Sodanrc@yahoo.com.br * TODO: It would be good if these stats were acquired after warmup. 1062810SN/A * @addtogroup CacheStatistics 1072810SN/A * @{ 1082810SN/A */ 1092810SN/A 1102810SN/A /** Per cycle average of the number of tags that hold valid data. */ 1115999Snate@binkert.org Stats::Average tagsInUse; 1122810SN/A 1132810SN/A /** The total number of references to a block before it is replaced. */ 1145999Snate@binkert.org Stats::Scalar totalRefs; 1152810SN/A 1162810SN/A /** 1172810SN/A * The number of reference counts sampled. This is different from 1182810SN/A * replacements because we sample all the valid blocks when the simulator 1192810SN/A * exits. 1202810SN/A */ 1215999Snate@binkert.org Stats::Scalar sampledRefs; 1222810SN/A 1232810SN/A /** 1242810SN/A * Average number of references to a block before is was replaced. 1252810SN/A * @todo This should change to an average stat once we have them. 1262810SN/A */ 1272810SN/A Stats::Formula avgRefs; 1282810SN/A 12912513Sodanrc@yahoo.com.br /** The cycle that the warmup percentage was hit. 0 on failure. */ 1305999Snate@binkert.org Stats::Scalar warmupCycle; 1316978SLisa.Hsu@amd.com 1328833Sdam.sunwoo@arm.com /** Average occupancy of each requestor using the cache */ 1336978SLisa.Hsu@amd.com Stats::AverageVector occupancies; 1346978SLisa.Hsu@amd.com 1358833Sdam.sunwoo@arm.com /** Average occ % of each requestor using the cache */ 1366978SLisa.Hsu@amd.com Stats::Formula avgOccs; 1376978SLisa.Hsu@amd.com 13810024Sdam.sunwoo@arm.com /** Occupancy of each context/cpu using the cache */ 13910024Sdam.sunwoo@arm.com Stats::Vector occupanciesTaskId; 14010024Sdam.sunwoo@arm.com 14110024Sdam.sunwoo@arm.com /** Occupancy of each context/cpu using the cache */ 14210024Sdam.sunwoo@arm.com Stats::Vector2d ageTaskId; 14310024Sdam.sunwoo@arm.com 14410024Sdam.sunwoo@arm.com /** Occ % of each context/cpu using the cache */ 14510024Sdam.sunwoo@arm.com Stats::Formula percentOccsTaskId; 14610024Sdam.sunwoo@arm.com 14710025Stimothy.jones@arm.com /** Number of tags consulted over all accesses. */ 14810025Stimothy.jones@arm.com Stats::Scalar tagAccesses; 14910025Stimothy.jones@arm.com /** Number of data blocks consulted over all accesses. */ 15010025Stimothy.jones@arm.com Stats::Scalar dataAccesses; 15110025Stimothy.jones@arm.com 1522810SN/A /** 1532810SN/A * @} 1542810SN/A */ 1552810SN/A 1562810SN/A public: 1579796Sprakash.ramrakhyani@arm.com typedef BaseTagsParams Params; 1589796Sprakash.ramrakhyani@arm.com BaseTags(const Params *p); 1592810SN/A 1602810SN/A /** 1612810SN/A * Destructor. 1622810SN/A */ 1632810SN/A virtual ~BaseTags() {} 1642810SN/A 1652810SN/A /** 1669796Sprakash.ramrakhyani@arm.com * Set the parent cache back pointer. 1672810SN/A * @param _cache Pointer to parent cache. 1682810SN/A */ 1692810SN/A void setCache(BaseCache *_cache); 1702810SN/A 1712810SN/A /** 1729796Sprakash.ramrakhyani@arm.com * Register local statistics. 1732810SN/A */ 1749796Sprakash.ramrakhyani@arm.com void regStats(); 1752810SN/A 1762810SN/A /** 1772810SN/A * Average in the reference count for valid blocks when the simulation 1782810SN/A * exits. 1792810SN/A */ 1802810SN/A virtual void cleanupRefs() {} 1817612SGene.Wu@arm.com 1827612SGene.Wu@arm.com /** 18310024Sdam.sunwoo@arm.com * Computes stats just prior to dump event 18410024Sdam.sunwoo@arm.com */ 18510024Sdam.sunwoo@arm.com virtual void computeStats() {} 18610024Sdam.sunwoo@arm.com 18710024Sdam.sunwoo@arm.com /** 1889663Suri.wiener@arm.com * Print all tags used 1899663Suri.wiener@arm.com */ 1909663Suri.wiener@arm.com virtual std::string print() const = 0; 19110815Sdavid.guillen@arm.com 19210815Sdavid.guillen@arm.com /** 19310815Sdavid.guillen@arm.com * Find a block using the memory address 19410815Sdavid.guillen@arm.com */ 19510815Sdavid.guillen@arm.com virtual CacheBlk * findBlock(Addr addr, bool is_secure) const = 0; 19610815Sdavid.guillen@arm.com 19710815Sdavid.guillen@arm.com /** 19811893Snikos.nikoleris@arm.com * Align an address to the block size. 19911893Snikos.nikoleris@arm.com * @param addr the address to align. 20011893Snikos.nikoleris@arm.com * @return The block address. 20111893Snikos.nikoleris@arm.com */ 20211893Snikos.nikoleris@arm.com Addr blkAlign(Addr addr) const 20311893Snikos.nikoleris@arm.com { 20411893Snikos.nikoleris@arm.com return addr & ~blkMask; 20511893Snikos.nikoleris@arm.com } 20611893Snikos.nikoleris@arm.com 20711893Snikos.nikoleris@arm.com /** 20810815Sdavid.guillen@arm.com * Calculate the block offset of an address. 20910815Sdavid.guillen@arm.com * @param addr the address to get the offset of. 21010815Sdavid.guillen@arm.com * @return the block offset. 21110815Sdavid.guillen@arm.com */ 21210815Sdavid.guillen@arm.com int extractBlkOffset(Addr addr) const 21310815Sdavid.guillen@arm.com { 21411893Snikos.nikoleris@arm.com return (addr & blkMask); 21510815Sdavid.guillen@arm.com } 21610815Sdavid.guillen@arm.com 21710941Sdavid.guillen@arm.com /** 21810941Sdavid.guillen@arm.com * Find the cache block given set and way 21910941Sdavid.guillen@arm.com * @param set The set of the block. 22010941Sdavid.guillen@arm.com * @param way The way of the block. 22110941Sdavid.guillen@arm.com * @return The cache block. 22210941Sdavid.guillen@arm.com */ 22310941Sdavid.guillen@arm.com virtual CacheBlk *findBlockBySetAndWay(int set, int way) const = 0; 22410941Sdavid.guillen@arm.com 22510941Sdavid.guillen@arm.com /** 22610941Sdavid.guillen@arm.com * Limit the allocation for the cache ways. 22710941Sdavid.guillen@arm.com * @param ways The maximum number of ways available for replacement. 22810941Sdavid.guillen@arm.com */ 22910941Sdavid.guillen@arm.com virtual void setWayAllocationMax(int ways) 23010941Sdavid.guillen@arm.com { 23110941Sdavid.guillen@arm.com panic("This tag class does not implement way allocation limit!\n"); 23210941Sdavid.guillen@arm.com } 23310941Sdavid.guillen@arm.com 23410941Sdavid.guillen@arm.com /** 23510941Sdavid.guillen@arm.com * Get the way allocation mask limit. 23610941Sdavid.guillen@arm.com * @return The maximum number of ways available for replacement. 23710941Sdavid.guillen@arm.com */ 23810941Sdavid.guillen@arm.com virtual int getWayAllocationMax() const 23910941Sdavid.guillen@arm.com { 24010941Sdavid.guillen@arm.com panic("This tag class does not implement way allocation limit!\n"); 24110941Sdavid.guillen@arm.com return -1; 24210941Sdavid.guillen@arm.com } 24310941Sdavid.guillen@arm.com 24412566Snikos.nikoleris@arm.com /** 24512704Snikos.nikoleris@arm.com * This function updates the tags when a block is invalidated 24612704Snikos.nikoleris@arm.com * 24712704Snikos.nikoleris@arm.com * @param blk A valid block to invalidate. 24812566Snikos.nikoleris@arm.com */ 24912566Snikos.nikoleris@arm.com virtual void invalidate(CacheBlk *blk) 25012566Snikos.nikoleris@arm.com { 25112566Snikos.nikoleris@arm.com assert(blk); 25212566Snikos.nikoleris@arm.com assert(blk->isValid()); 25312704Snikos.nikoleris@arm.com 25412566Snikos.nikoleris@arm.com tagsInUse--; 25512566Snikos.nikoleris@arm.com occupancies[blk->srcMasterId]--; 25612704Snikos.nikoleris@arm.com totalRefs += blk->refCount; 25712704Snikos.nikoleris@arm.com sampledRefs++; 25812704Snikos.nikoleris@arm.com 25912704Snikos.nikoleris@arm.com blk->invalidate(); 26012566Snikos.nikoleris@arm.com } 26110815Sdavid.guillen@arm.com 26212600Sodanrc@yahoo.com.br /** 26312600Sodanrc@yahoo.com.br * Find replacement victim based on address. 26412600Sodanrc@yahoo.com.br * 26512600Sodanrc@yahoo.com.br * @param addr Address to find a victim for. 26612600Sodanrc@yahoo.com.br * @return Cache block to be replaced. 26712600Sodanrc@yahoo.com.br */ 26812600Sodanrc@yahoo.com.br virtual CacheBlk* findVictim(Addr addr) = 0; 26912600Sodanrc@yahoo.com.br 27011870Snikos.nikoleris@arm.com virtual CacheBlk* accessBlock(Addr addr, bool is_secure, Cycles &lat) = 0; 27110815Sdavid.guillen@arm.com 27210815Sdavid.guillen@arm.com virtual Addr extractTag(Addr addr) const = 0; 27310815Sdavid.guillen@arm.com 27412636Sodanrc@yahoo.com.br /** 27512636Sodanrc@yahoo.com.br * Insert the new block into the cache and update stats. 27612636Sodanrc@yahoo.com.br * 27712636Sodanrc@yahoo.com.br * @param pkt Packet holding the address to update 27812636Sodanrc@yahoo.com.br * @param blk The block to update. 27912636Sodanrc@yahoo.com.br */ 28012636Sodanrc@yahoo.com.br virtual void insertBlock(PacketPtr pkt, CacheBlk *blk); 28110815Sdavid.guillen@arm.com 28212574Sodanrc@yahoo.com.br /** 28312574Sodanrc@yahoo.com.br * Regenerate the block address. 28412574Sodanrc@yahoo.com.br * 28512574Sodanrc@yahoo.com.br * @param block The block. 28612574Sodanrc@yahoo.com.br * @return the block address. 28712574Sodanrc@yahoo.com.br */ 28812574Sodanrc@yahoo.com.br virtual Addr regenerateBlkAddr(const CacheBlk* blk) const = 0; 28910815Sdavid.guillen@arm.com 29010815Sdavid.guillen@arm.com virtual int extractSet(Addr addr) const = 0; 29110815Sdavid.guillen@arm.com 29210815Sdavid.guillen@arm.com virtual void forEachBlk(CacheBlkVisitor &visitor) = 0; 2932810SN/A}; 2942810SN/A 2952810SN/Aclass BaseTagsCallback : public Callback 2962810SN/A{ 2972810SN/A BaseTags *tags; 2982810SN/A public: 2992810SN/A BaseTagsCallback(BaseTags *t) : tags(t) {} 3002810SN/A virtual void process() { tags->cleanupRefs(); }; 3012810SN/A}; 3022810SN/A 30310024Sdam.sunwoo@arm.comclass BaseTagsDumpCallback : public Callback 30410024Sdam.sunwoo@arm.com{ 30510024Sdam.sunwoo@arm.com BaseTags *tags; 30610024Sdam.sunwoo@arm.com public: 30710024Sdam.sunwoo@arm.com BaseTagsDumpCallback(BaseTags *t) : tags(t) {} 30810024Sdam.sunwoo@arm.com virtual void process() { tags->computeStats(); }; 30910024Sdam.sunwoo@arm.com}; 31010024Sdam.sunwoo@arm.com 31112492Sodanrc@yahoo.com.br#endif //__MEM_CACHE_TAGS_BASE_HH__ 312