base_set_assoc.hh revision 12566
110263Satgutier@umich.edu/* 212566Snikos.nikoleris@arm.com * Copyright (c) 2012-2014,2017 ARM Limited 310263Satgutier@umich.edu * All rights reserved. 410263Satgutier@umich.edu * 510263Satgutier@umich.edu * The license below extends only to copyright in the software and shall 610263Satgutier@umich.edu * not be construed as granting a license to any other intellectual 710263Satgutier@umich.edu * property including but not limited to intellectual property relating 810263Satgutier@umich.edu * to a hardware implementation of the functionality of the software 910263Satgutier@umich.edu * licensed hereunder. You may use the software subject to the license 1010263Satgutier@umich.edu * terms below provided that you ensure that this notice is replicated 1110263Satgutier@umich.edu * unmodified and in its entirety in all distributions of the software, 1210263Satgutier@umich.edu * modified or unmodified, in source code or in binary form. 1310263Satgutier@umich.edu * 1410263Satgutier@umich.edu * Copyright (c) 2003-2005,2014 The Regents of The University of Michigan 1510263Satgutier@umich.edu * All rights reserved. 1610263Satgutier@umich.edu * 1710263Satgutier@umich.edu * Redistribution and use in source and binary forms, with or without 1810263Satgutier@umich.edu * modification, are permitted provided that the following conditions are 1910263Satgutier@umich.edu * met: redistributions of source code must retain the above copyright 2010263Satgutier@umich.edu * notice, this list of conditions and the following disclaimer; 2110263Satgutier@umich.edu * redistributions in binary form must reproduce the above copyright 2210263Satgutier@umich.edu * notice, this list of conditions and the following disclaimer in the 2310263Satgutier@umich.edu * documentation and/or other materials provided with the distribution; 2410263Satgutier@umich.edu * neither the name of the copyright holders nor the names of its 2510263Satgutier@umich.edu * contributors may be used to endorse or promote products derived from 2610263Satgutier@umich.edu * this software without specific prior written permission. 2710263Satgutier@umich.edu * 2810263Satgutier@umich.edu * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 2910263Satgutier@umich.edu * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 3010263Satgutier@umich.edu * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 3110263Satgutier@umich.edu * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 3210263Satgutier@umich.edu * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 3310263Satgutier@umich.edu * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 3410263Satgutier@umich.edu * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 3510263Satgutier@umich.edu * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 3610263Satgutier@umich.edu * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 3710263Satgutier@umich.edu * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 3810263Satgutier@umich.edu * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 3910263Satgutier@umich.edu * 4010263Satgutier@umich.edu * Authors: Erik Hallnor 4110263Satgutier@umich.edu */ 4210263Satgutier@umich.edu 4310263Satgutier@umich.edu/** 4410263Satgutier@umich.edu * @file 4510263Satgutier@umich.edu * Declaration of a base set associative tag store. 4610263Satgutier@umich.edu */ 4710263Satgutier@umich.edu 4812492Sodanrc@yahoo.com.br#ifndef __MEM_CACHE_TAGS_BASE_SET_ASSOC_HH__ 4912492Sodanrc@yahoo.com.br#define __MEM_CACHE_TAGS_BASE_SET_ASSOC_HH__ 5010263Satgutier@umich.edu 5110263Satgutier@umich.edu#include <cassert> 5210263Satgutier@umich.edu#include <cstring> 5312548Sodanrc@yahoo.com.br#include <memory> 5412548Sodanrc@yahoo.com.br#include <vector> 5510263Satgutier@umich.edu 5611486Snikos.nikoleris@arm.com#include "mem/cache/base.hh" 5711486Snikos.nikoleris@arm.com#include "mem/cache/blk.hh" 5810263Satgutier@umich.edu#include "mem/cache/tags/base.hh" 5910263Satgutier@umich.edu#include "mem/cache/tags/cacheset.hh" 6010263Satgutier@umich.edu#include "mem/packet.hh" 6110263Satgutier@umich.edu#include "params/BaseSetAssoc.hh" 6210263Satgutier@umich.edu 6310263Satgutier@umich.edu/** 6410263Satgutier@umich.edu * A BaseSetAssoc cache tag store. 6510263Satgutier@umich.edu * @sa \ref gem5MemorySystem "gem5 Memory System" 6610263Satgutier@umich.edu * 6710263Satgutier@umich.edu * The BaseSetAssoc tags provide a base, as well as the functionality 6810263Satgutier@umich.edu * common to any set associative tags. Any derived class must implement 6910263Satgutier@umich.edu * the methods related to the specifics of the actual replacment policy. 7010263Satgutier@umich.edu * These are: 7110263Satgutier@umich.edu * 7210263Satgutier@umich.edu * BlkType* accessBlock(); 7310263Satgutier@umich.edu * BlkType* findVictim(); 7410263Satgutier@umich.edu * void insertBlock(); 7510263Satgutier@umich.edu */ 7610263Satgutier@umich.educlass BaseSetAssoc : public BaseTags 7710263Satgutier@umich.edu{ 7810263Satgutier@umich.edu public: 7910263Satgutier@umich.edu /** Typedef the block type used in this tag store. */ 8010263Satgutier@umich.edu typedef CacheBlk BlkType; 8110263Satgutier@umich.edu /** Typedef the set type used in this tag store. */ 8210263Satgutier@umich.edu typedef CacheSet<CacheBlk> SetType; 8310263Satgutier@umich.edu 8410263Satgutier@umich.edu 8510263Satgutier@umich.edu protected: 8610263Satgutier@umich.edu /** The associativity of the cache. */ 8710263Satgutier@umich.edu const unsigned assoc; 8810941Sdavid.guillen@arm.com /** The allocatable associativity of the cache (alloc mask). */ 8910941Sdavid.guillen@arm.com unsigned allocAssoc; 9012548Sodanrc@yahoo.com.br 9112548Sodanrc@yahoo.com.br /** The cache blocks. */ 9212548Sodanrc@yahoo.com.br std::vector<BlkType> blks; 9312548Sodanrc@yahoo.com.br /** The data blocks, 1 per cache block. */ 9412548Sodanrc@yahoo.com.br std::unique_ptr<uint8_t[]> dataBlks; 9512548Sodanrc@yahoo.com.br 9610263Satgutier@umich.edu /** The number of sets in the cache. */ 9710263Satgutier@umich.edu const unsigned numSets; 9812548Sodanrc@yahoo.com.br 9910263Satgutier@umich.edu /** Whether tags and data are accessed sequentially. */ 10010263Satgutier@umich.edu const bool sequentialAccess; 10110263Satgutier@umich.edu 10210263Satgutier@umich.edu /** The cache sets. */ 10312548Sodanrc@yahoo.com.br std::vector<SetType> sets; 10410263Satgutier@umich.edu 10510263Satgutier@umich.edu /** The amount to shift the address to get the set. */ 10610263Satgutier@umich.edu int setShift; 10710263Satgutier@umich.edu /** The amount to shift the address to get the tag. */ 10810263Satgutier@umich.edu int tagShift; 10910263Satgutier@umich.edu /** Mask out all bits that aren't part of the set index. */ 11010263Satgutier@umich.edu unsigned setMask; 11110263Satgutier@umich.edu 11210263Satgutier@umich.edupublic: 11310263Satgutier@umich.edu 11410263Satgutier@umich.edu /** Convenience typedef. */ 11510263Satgutier@umich.edu typedef BaseSetAssocParams Params; 11610263Satgutier@umich.edu 11710263Satgutier@umich.edu /** 11810263Satgutier@umich.edu * Construct and initialize this tag store. 11910263Satgutier@umich.edu */ 12010263Satgutier@umich.edu BaseSetAssoc(const Params *p); 12110263Satgutier@umich.edu 12210263Satgutier@umich.edu /** 12310263Satgutier@umich.edu * Destructor 12410263Satgutier@umich.edu */ 12512548Sodanrc@yahoo.com.br virtual ~BaseSetAssoc() {}; 12610263Satgutier@umich.edu 12710263Satgutier@umich.edu /** 12810941Sdavid.guillen@arm.com * Find the cache block given set and way 12910941Sdavid.guillen@arm.com * @param set The set of the block. 13010941Sdavid.guillen@arm.com * @param way The way of the block. 13110941Sdavid.guillen@arm.com * @return The cache block. 13210941Sdavid.guillen@arm.com */ 13311169Sandreas.hansson@arm.com CacheBlk *findBlockBySetAndWay(int set, int way) const override; 13410941Sdavid.guillen@arm.com 13510941Sdavid.guillen@arm.com /** 13610263Satgutier@umich.edu * Access block and update replacement data. May not succeed, in which case 13711484Snikos.nikoleris@arm.com * nullptr is returned. This has all the implications of a cache 13810263Satgutier@umich.edu * access and should only be used as such. Returns the access latency as a 13910263Satgutier@umich.edu * side effect. 14010263Satgutier@umich.edu * @param addr The address to find. 14110263Satgutier@umich.edu * @param is_secure True if the target memory space is secure. 14210263Satgutier@umich.edu * @param lat The access latency. 14310263Satgutier@umich.edu * @return Pointer to the cache block if found. 14410263Satgutier@umich.edu */ 14511870Snikos.nikoleris@arm.com CacheBlk* accessBlock(Addr addr, bool is_secure, Cycles &lat) override 14610263Satgutier@umich.edu { 14712555Sodanrc@yahoo.com.br BlkType *blk = findBlock(addr, is_secure); 14810263Satgutier@umich.edu 14910263Satgutier@umich.edu // Access all tags in parallel, hence one in each way. The data side 15010263Satgutier@umich.edu // either accesses all blocks in parallel, or one block sequentially on 15110263Satgutier@umich.edu // a hit. Sequential access with a miss doesn't access data. 15210941Sdavid.guillen@arm.com tagAccesses += allocAssoc; 15310263Satgutier@umich.edu if (sequentialAccess) { 15411484Snikos.nikoleris@arm.com if (blk != nullptr) { 15510263Satgutier@umich.edu dataAccesses += 1; 15610263Satgutier@umich.edu } 15710263Satgutier@umich.edu } else { 15810941Sdavid.guillen@arm.com dataAccesses += allocAssoc; 15910263Satgutier@umich.edu } 16010263Satgutier@umich.edu 16111484Snikos.nikoleris@arm.com if (blk != nullptr) { 16211722Ssophiane.senni@gmail.com // If a cache hit 16311722Ssophiane.senni@gmail.com lat = accessLatency; 16411722Ssophiane.senni@gmail.com // Check if the block to be accessed is available. If not, 16511722Ssophiane.senni@gmail.com // apply the accessLatency on top of block->whenReady. 16611722Ssophiane.senni@gmail.com if (blk->whenReady > curTick() && 16711722Ssophiane.senni@gmail.com cache->ticksToCycles(blk->whenReady - curTick()) > 16811722Ssophiane.senni@gmail.com accessLatency) { 16911722Ssophiane.senni@gmail.com lat = cache->ticksToCycles(blk->whenReady - curTick()) + 17011722Ssophiane.senni@gmail.com accessLatency; 17110263Satgutier@umich.edu } 17210263Satgutier@umich.edu blk->refCount += 1; 17311722Ssophiane.senni@gmail.com } else { 17411722Ssophiane.senni@gmail.com // If a cache miss 17511722Ssophiane.senni@gmail.com lat = lookupLatency; 17610263Satgutier@umich.edu } 17710263Satgutier@umich.edu 17810263Satgutier@umich.edu return blk; 17910263Satgutier@umich.edu } 18010263Satgutier@umich.edu 18110263Satgutier@umich.edu /** 18210263Satgutier@umich.edu * Finds the given address in the cache, do not update replacement data. 18310263Satgutier@umich.edu * i.e. This is a no-side-effect find of a block. 18410263Satgutier@umich.edu * @param addr The address to find. 18510263Satgutier@umich.edu * @param is_secure True if the target memory space is secure. 18610263Satgutier@umich.edu * @param asid The address space ID. 18710263Satgutier@umich.edu * @return Pointer to the cache block if found. 18810263Satgutier@umich.edu */ 18911169Sandreas.hansson@arm.com CacheBlk* findBlock(Addr addr, bool is_secure) const override; 19010263Satgutier@umich.edu 19110263Satgutier@umich.edu /** 19210263Satgutier@umich.edu * Find an invalid block to evict for the address provided. 19310263Satgutier@umich.edu * If there are no invalid blocks, this will return the block 19410263Satgutier@umich.edu * in the least-recently-used position. 19510263Satgutier@umich.edu * @param addr The addr to a find a replacement candidate for. 19610263Satgutier@umich.edu * @return The candidate block. 19710263Satgutier@umich.edu */ 19811169Sandreas.hansson@arm.com CacheBlk* findVictim(Addr addr) override 19910263Satgutier@umich.edu { 20011484Snikos.nikoleris@arm.com BlkType *blk = nullptr; 20110263Satgutier@umich.edu int set = extractSet(addr); 20210263Satgutier@umich.edu 20310263Satgutier@umich.edu // prefer to evict an invalid block 20410941Sdavid.guillen@arm.com for (int i = 0; i < allocAssoc; ++i) { 20510263Satgutier@umich.edu blk = sets[set].blks[i]; 20610941Sdavid.guillen@arm.com if (!blk->isValid()) 20710263Satgutier@umich.edu break; 20810263Satgutier@umich.edu } 20910263Satgutier@umich.edu 21010263Satgutier@umich.edu return blk; 21110263Satgutier@umich.edu } 21210263Satgutier@umich.edu 21310263Satgutier@umich.edu /** 21410263Satgutier@umich.edu * Insert the new block into the cache. 21510263Satgutier@umich.edu * @param pkt Packet holding the address to update 21610263Satgutier@umich.edu * @param blk The block to update. 21710263Satgutier@umich.edu */ 21811169Sandreas.hansson@arm.com void insertBlock(PacketPtr pkt, CacheBlk *blk) override 21910263Satgutier@umich.edu { 22010263Satgutier@umich.edu Addr addr = pkt->getAddr(); 22110263Satgutier@umich.edu MasterID master_id = pkt->req->masterId(); 22210263Satgutier@umich.edu uint32_t task_id = pkt->req->taskId(); 22310274Smitch.hayenga@arm.com 22410263Satgutier@umich.edu if (!blk->isTouched) { 22510263Satgutier@umich.edu if (!warmedUp && tagsInUse.value() >= warmupBound) { 22610263Satgutier@umich.edu warmedUp = true; 22710263Satgutier@umich.edu warmupCycle = curTick(); 22810263Satgutier@umich.edu } 22910263Satgutier@umich.edu } 23010263Satgutier@umich.edu 23110263Satgutier@umich.edu // If we're replacing a block that was previously valid update 23210263Satgutier@umich.edu // stats for it. This can't be done in findBlock() because a 23310263Satgutier@umich.edu // found block might not actually be replaced there if the 23410263Satgutier@umich.edu // coherence protocol says it can't be. 23510263Satgutier@umich.edu if (blk->isValid()) { 23610263Satgutier@umich.edu replacements[0]++; 23710263Satgutier@umich.edu totalRefs += blk->refCount; 23810263Satgutier@umich.edu ++sampledRefs; 23910263Satgutier@umich.edu 24012554Snikos.nikoleris@arm.com invalidate(blk); 24110263Satgutier@umich.edu blk->invalidate(); 24210263Satgutier@umich.edu } 24310263Satgutier@umich.edu 24412557Sodanrc@yahoo.com.br // Previous block, if existed, has been removed, and now we have 24512557Sodanrc@yahoo.com.br // to insert the new one and mark it as touched 24612557Sodanrc@yahoo.com.br tagsInUse++; 24710263Satgutier@umich.edu blk->isTouched = true; 24810274Smitch.hayenga@arm.com 24910263Satgutier@umich.edu // Set tag for new block. Caller is responsible for setting status. 25010263Satgutier@umich.edu blk->tag = extractTag(addr); 25110263Satgutier@umich.edu 25210263Satgutier@umich.edu // deal with what we are bringing in 25310263Satgutier@umich.edu assert(master_id < cache->system->maxMasters()); 25410263Satgutier@umich.edu occupancies[master_id]++; 25510263Satgutier@umich.edu blk->srcMasterId = master_id; 25610263Satgutier@umich.edu blk->task_id = task_id; 25710263Satgutier@umich.edu blk->tickInserted = curTick(); 25810263Satgutier@umich.edu 25910263Satgutier@umich.edu // We only need to write into one tag and one data block. 26010263Satgutier@umich.edu tagAccesses += 1; 26110263Satgutier@umich.edu dataAccesses += 1; 26210263Satgutier@umich.edu } 26310263Satgutier@umich.edu 26410263Satgutier@umich.edu /** 26510941Sdavid.guillen@arm.com * Limit the allocation for the cache ways. 26610941Sdavid.guillen@arm.com * @param ways The maximum number of ways available for replacement. 26710941Sdavid.guillen@arm.com */ 26811169Sandreas.hansson@arm.com virtual void setWayAllocationMax(int ways) override 26910941Sdavid.guillen@arm.com { 27010941Sdavid.guillen@arm.com fatal_if(ways < 1, "Allocation limit must be greater than zero"); 27110941Sdavid.guillen@arm.com allocAssoc = ways; 27210941Sdavid.guillen@arm.com } 27310941Sdavid.guillen@arm.com 27410941Sdavid.guillen@arm.com /** 27510941Sdavid.guillen@arm.com * Get the way allocation mask limit. 27610941Sdavid.guillen@arm.com * @return The maximum number of ways available for replacement. 27710941Sdavid.guillen@arm.com */ 27811169Sandreas.hansson@arm.com virtual int getWayAllocationMax() const override 27910941Sdavid.guillen@arm.com { 28010941Sdavid.guillen@arm.com return allocAssoc; 28110941Sdavid.guillen@arm.com } 28210941Sdavid.guillen@arm.com 28310941Sdavid.guillen@arm.com /** 28410263Satgutier@umich.edu * Generate the tag from the given address. 28510263Satgutier@umich.edu * @param addr The address to get the tag from. 28610263Satgutier@umich.edu * @return The tag of the address. 28710263Satgutier@umich.edu */ 28811169Sandreas.hansson@arm.com Addr extractTag(Addr addr) const override 28910263Satgutier@umich.edu { 29010263Satgutier@umich.edu return (addr >> tagShift); 29110263Satgutier@umich.edu } 29210263Satgutier@umich.edu 29310263Satgutier@umich.edu /** 29410263Satgutier@umich.edu * Calculate the set index from the address. 29510263Satgutier@umich.edu * @param addr The address to get the set from. 29610263Satgutier@umich.edu * @return The set index of the address. 29710263Satgutier@umich.edu */ 29811169Sandreas.hansson@arm.com int extractSet(Addr addr) const override 29910263Satgutier@umich.edu { 30010263Satgutier@umich.edu return ((addr >> setShift) & setMask); 30110263Satgutier@umich.edu } 30210263Satgutier@umich.edu 30310263Satgutier@umich.edu /** 30410263Satgutier@umich.edu * Regenerate the block address from the tag. 30510263Satgutier@umich.edu * @param tag The tag of the block. 30610263Satgutier@umich.edu * @param set The set of the block. 30710263Satgutier@umich.edu * @return The block address. 30810263Satgutier@umich.edu */ 30911169Sandreas.hansson@arm.com Addr regenerateBlkAddr(Addr tag, unsigned set) const override 31010263Satgutier@umich.edu { 31110263Satgutier@umich.edu return ((tag << tagShift) | ((Addr)set << setShift)); 31210263Satgutier@umich.edu } 31310263Satgutier@umich.edu 31410263Satgutier@umich.edu /** 31510263Satgutier@umich.edu * Called at end of simulation to complete average block reference stats. 31610263Satgutier@umich.edu */ 31711169Sandreas.hansson@arm.com void cleanupRefs() override; 31810263Satgutier@umich.edu 31910263Satgutier@umich.edu /** 32010263Satgutier@umich.edu * Print all tags used 32110263Satgutier@umich.edu */ 32211169Sandreas.hansson@arm.com std::string print() const override; 32310263Satgutier@umich.edu 32410263Satgutier@umich.edu /** 32510263Satgutier@umich.edu * Called prior to dumping stats to compute task occupancy 32610263Satgutier@umich.edu */ 32711169Sandreas.hansson@arm.com void computeStats() override; 32810263Satgutier@umich.edu 32910263Satgutier@umich.edu /** 33010263Satgutier@umich.edu * Visit each block in the tag store and apply a visitor to the 33110263Satgutier@umich.edu * block. 33210263Satgutier@umich.edu * 33310263Satgutier@umich.edu * The visitor should be a function (or object that behaves like a 33410263Satgutier@umich.edu * function) that takes a cache block reference as its parameter 33510263Satgutier@umich.edu * and returns a bool. A visitor can request the traversal to be 33610263Satgutier@umich.edu * stopped by returning false, returning true causes it to be 33710263Satgutier@umich.edu * called for the next block in the tag store. 33810263Satgutier@umich.edu * 33910263Satgutier@umich.edu * \param visitor Visitor to call on each block. 34010263Satgutier@umich.edu */ 34111168Sandreas.hansson@arm.com void forEachBlk(CacheBlkVisitor &visitor) override { 34210263Satgutier@umich.edu for (unsigned i = 0; i < numSets * assoc; ++i) { 34310263Satgutier@umich.edu if (!visitor(blks[i])) 34410263Satgutier@umich.edu return; 34510263Satgutier@umich.edu } 34610263Satgutier@umich.edu } 34710263Satgutier@umich.edu}; 34810263Satgutier@umich.edu 34912492Sodanrc@yahoo.com.br#endif //__MEM_CACHE_TAGS_BASE_SET_ASSOC_HH__ 350