base_set_assoc.hh revision 13219
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 5112728Snikos.nikoleris@arm.com#include <functional> 5212727Snikos.nikoleris@arm.com#include <string> 5312548Sodanrc@yahoo.com.br#include <vector> 5410263Satgutier@umich.edu 5512727Snikos.nikoleris@arm.com#include "base/logging.hh" 5612727Snikos.nikoleris@arm.com#include "base/types.hh" 5712684Sodanrc@yahoo.com.br#include "debug/CacheRepl.hh" 5811486Snikos.nikoleris@arm.com#include "mem/cache/base.hh" 5911486Snikos.nikoleris@arm.com#include "mem/cache/blk.hh" 6012684Sodanrc@yahoo.com.br#include "mem/cache/replacement_policies/base.hh" 6110263Satgutier@umich.edu#include "mem/cache/tags/base.hh" 6213219Sodanrc@yahoo.com.br#include "mem/cache/tags/indexing_policies/base.hh" 6310263Satgutier@umich.edu#include "params/BaseSetAssoc.hh" 6410263Satgutier@umich.edu 6510263Satgutier@umich.edu/** 6613219Sodanrc@yahoo.com.br * A basic cache tag store. 6710263Satgutier@umich.edu * @sa \ref gem5MemorySystem "gem5 Memory System" 6810263Satgutier@umich.edu * 6912600Sodanrc@yahoo.com.br * The BaseSetAssoc placement policy divides the cache into s sets of w 7013219Sodanrc@yahoo.com.br * cache lines (ways). 7110263Satgutier@umich.edu */ 7210263Satgutier@umich.educlass BaseSetAssoc : public BaseTags 7310263Satgutier@umich.edu{ 7410263Satgutier@umich.edu public: 7510263Satgutier@umich.edu /** Typedef the block type used in this tag store. */ 7610263Satgutier@umich.edu typedef CacheBlk BlkType; 7710263Satgutier@umich.edu 7810263Satgutier@umich.edu protected: 7910941Sdavid.guillen@arm.com /** The allocatable associativity of the cache (alloc mask). */ 8010941Sdavid.guillen@arm.com unsigned allocAssoc; 8112548Sodanrc@yahoo.com.br 8212548Sodanrc@yahoo.com.br /** The cache blocks. */ 8312548Sodanrc@yahoo.com.br std::vector<BlkType> blks; 8412548Sodanrc@yahoo.com.br 8510263Satgutier@umich.edu /** Whether tags and data are accessed sequentially. */ 8610263Satgutier@umich.edu const bool sequentialAccess; 8710263Satgutier@umich.edu 8812600Sodanrc@yahoo.com.br /** Replacement policy */ 8912600Sodanrc@yahoo.com.br BaseReplacementPolicy *replacementPolicy; 9012600Sodanrc@yahoo.com.br 9112600Sodanrc@yahoo.com.br public: 9210263Satgutier@umich.edu /** Convenience typedef. */ 9310263Satgutier@umich.edu typedef BaseSetAssocParams Params; 9410263Satgutier@umich.edu 9510263Satgutier@umich.edu /** 9610263Satgutier@umich.edu * Construct and initialize this tag store. 9710263Satgutier@umich.edu */ 9810263Satgutier@umich.edu BaseSetAssoc(const Params *p); 9910263Satgutier@umich.edu 10010263Satgutier@umich.edu /** 10110263Satgutier@umich.edu * Destructor 10210263Satgutier@umich.edu */ 10312548Sodanrc@yahoo.com.br virtual ~BaseSetAssoc() {}; 10410263Satgutier@umich.edu 10510263Satgutier@umich.edu /** 10613216Sodanrc@yahoo.com.br * Initialize blocks and set the parent cache back pointer. 10713216Sodanrc@yahoo.com.br * 10813216Sodanrc@yahoo.com.br * @param _cache Pointer to parent cache. 10913216Sodanrc@yahoo.com.br */ 11013216Sodanrc@yahoo.com.br void init(BaseCache *_cache) override; 11113216Sodanrc@yahoo.com.br 11213216Sodanrc@yahoo.com.br /** 11312745Sodanrc@yahoo.com.br * This function updates the tags when a block is invalidated. It also 11412745Sodanrc@yahoo.com.br * updates the replacement data. 11512684Sodanrc@yahoo.com.br * 11612684Sodanrc@yahoo.com.br * @param blk The block to invalidate. 11712684Sodanrc@yahoo.com.br */ 11812684Sodanrc@yahoo.com.br void invalidate(CacheBlk *blk) override; 11912684Sodanrc@yahoo.com.br 12012684Sodanrc@yahoo.com.br /** 12110263Satgutier@umich.edu * Access block and update replacement data. May not succeed, in which case 12211484Snikos.nikoleris@arm.com * nullptr is returned. This has all the implications of a cache 12310263Satgutier@umich.edu * access and should only be used as such. Returns the access latency as a 12410263Satgutier@umich.edu * side effect. 12510263Satgutier@umich.edu * @param addr The address to find. 12610263Satgutier@umich.edu * @param is_secure True if the target memory space is secure. 12710263Satgutier@umich.edu * @param lat The access latency. 12810263Satgutier@umich.edu * @return Pointer to the cache block if found. 12910263Satgutier@umich.edu */ 13011870Snikos.nikoleris@arm.com CacheBlk* accessBlock(Addr addr, bool is_secure, Cycles &lat) override 13110263Satgutier@umich.edu { 13212555Sodanrc@yahoo.com.br BlkType *blk = findBlock(addr, is_secure); 13310263Satgutier@umich.edu 13410263Satgutier@umich.edu // Access all tags in parallel, hence one in each way. The data side 13510263Satgutier@umich.edu // either accesses all blocks in parallel, or one block sequentially on 13610263Satgutier@umich.edu // a hit. Sequential access with a miss doesn't access data. 13710941Sdavid.guillen@arm.com tagAccesses += allocAssoc; 13810263Satgutier@umich.edu if (sequentialAccess) { 13911484Snikos.nikoleris@arm.com if (blk != nullptr) { 14010263Satgutier@umich.edu dataAccesses += 1; 14110263Satgutier@umich.edu } 14210263Satgutier@umich.edu } else { 14310941Sdavid.guillen@arm.com dataAccesses += allocAssoc; 14410263Satgutier@umich.edu } 14510263Satgutier@umich.edu 14611484Snikos.nikoleris@arm.com if (blk != nullptr) { 14711722Ssophiane.senni@gmail.com // If a cache hit 14811722Ssophiane.senni@gmail.com lat = accessLatency; 14911722Ssophiane.senni@gmail.com // Check if the block to be accessed is available. If not, 15011722Ssophiane.senni@gmail.com // apply the accessLatency on top of block->whenReady. 15111722Ssophiane.senni@gmail.com if (blk->whenReady > curTick() && 15211722Ssophiane.senni@gmail.com cache->ticksToCycles(blk->whenReady - curTick()) > 15311722Ssophiane.senni@gmail.com accessLatency) { 15411722Ssophiane.senni@gmail.com lat = cache->ticksToCycles(blk->whenReady - curTick()) + 15511722Ssophiane.senni@gmail.com accessLatency; 15610263Satgutier@umich.edu } 15712600Sodanrc@yahoo.com.br 15812684Sodanrc@yahoo.com.br // Update number of references to accessed block 15912684Sodanrc@yahoo.com.br blk->refCount++; 16012684Sodanrc@yahoo.com.br 16112600Sodanrc@yahoo.com.br // Update replacement data of accessed block 16212684Sodanrc@yahoo.com.br replacementPolicy->touch(blk->replacementData); 16311722Ssophiane.senni@gmail.com } else { 16411722Ssophiane.senni@gmail.com // If a cache miss 16511722Ssophiane.senni@gmail.com lat = lookupLatency; 16610263Satgutier@umich.edu } 16710263Satgutier@umich.edu 16810263Satgutier@umich.edu return blk; 16910263Satgutier@umich.edu } 17010263Satgutier@umich.edu 17110263Satgutier@umich.edu /** 17212744Sodanrc@yahoo.com.br * Find replacement victim based on address. The list of evicted blocks 17312744Sodanrc@yahoo.com.br * only contains the victim. 17412600Sodanrc@yahoo.com.br * 17512600Sodanrc@yahoo.com.br * @param addr Address to find a victim for. 17612746Sodanrc@yahoo.com.br * @param is_secure True if the target memory space is secure. 17712744Sodanrc@yahoo.com.br * @param evict_blks Cache blocks to be evicted. 17812600Sodanrc@yahoo.com.br * @return Cache block to be replaced. 17910263Satgutier@umich.edu */ 18012746Sodanrc@yahoo.com.br CacheBlk* findVictim(Addr addr, const bool is_secure, 18112746Sodanrc@yahoo.com.br std::vector<CacheBlk*>& evict_blks) const override 18210263Satgutier@umich.edu { 18313219Sodanrc@yahoo.com.br // Get possible entries to be victimized 18413219Sodanrc@yahoo.com.br const std::vector<ReplaceableEntry*> entries = 18513219Sodanrc@yahoo.com.br indexingPolicy->getPossibleEntries(addr); 18612684Sodanrc@yahoo.com.br 18712600Sodanrc@yahoo.com.br // Choose replacement victim from replacement candidates 18812684Sodanrc@yahoo.com.br CacheBlk* victim = static_cast<CacheBlk*>(replacementPolicy->getVictim( 18913219Sodanrc@yahoo.com.br entries)); 19012684Sodanrc@yahoo.com.br 19112744Sodanrc@yahoo.com.br // There is only one eviction for this replacement 19212744Sodanrc@yahoo.com.br evict_blks.push_back(victim); 19312744Sodanrc@yahoo.com.br 19412684Sodanrc@yahoo.com.br DPRINTF(CacheRepl, "set %x, way %x: selecting blk for replacement\n", 19513218Sodanrc@yahoo.com.br victim->getSet(), victim->getWay()); 19612684Sodanrc@yahoo.com.br 19712684Sodanrc@yahoo.com.br return victim; 19812600Sodanrc@yahoo.com.br } 19910263Satgutier@umich.edu 20012600Sodanrc@yahoo.com.br /** 20112636Sodanrc@yahoo.com.br * Insert the new block into the cache and update replacement data. 20212636Sodanrc@yahoo.com.br * 20313215Sodanrc@yahoo.com.br * @param addr Address of the block. 20413215Sodanrc@yahoo.com.br * @param is_secure Whether the block is in secure space or not. 20513215Sodanrc@yahoo.com.br * @param src_master_ID The source requestor ID. 20613215Sodanrc@yahoo.com.br * @param task_ID The new task ID. 20710263Satgutier@umich.edu * @param blk The block to update. 20810263Satgutier@umich.edu */ 20913215Sodanrc@yahoo.com.br void insertBlock(const Addr addr, const bool is_secure, 21013215Sodanrc@yahoo.com.br const int src_master_ID, const uint32_t task_ID, 21113215Sodanrc@yahoo.com.br CacheBlk *blk) override 21212636Sodanrc@yahoo.com.br { 21312636Sodanrc@yahoo.com.br // Insert block 21413215Sodanrc@yahoo.com.br BaseTags::insertBlock(addr, is_secure, src_master_ID, task_ID, blk); 21510274Smitch.hayenga@arm.com 21612745Sodanrc@yahoo.com.br // Increment tag counter 21712745Sodanrc@yahoo.com.br tagsInUse++; 21812745Sodanrc@yahoo.com.br 21912636Sodanrc@yahoo.com.br // Update replacement policy 22012684Sodanrc@yahoo.com.br replacementPolicy->reset(blk->replacementData); 22112636Sodanrc@yahoo.com.br } 22210263Satgutier@umich.edu 22310263Satgutier@umich.edu /** 22410941Sdavid.guillen@arm.com * Limit the allocation for the cache ways. 22510941Sdavid.guillen@arm.com * @param ways The maximum number of ways available for replacement. 22610941Sdavid.guillen@arm.com */ 22711169Sandreas.hansson@arm.com virtual void setWayAllocationMax(int ways) override 22810941Sdavid.guillen@arm.com { 22910941Sdavid.guillen@arm.com fatal_if(ways < 1, "Allocation limit must be greater than zero"); 23010941Sdavid.guillen@arm.com allocAssoc = ways; 23110941Sdavid.guillen@arm.com } 23210941Sdavid.guillen@arm.com 23310941Sdavid.guillen@arm.com /** 23410941Sdavid.guillen@arm.com * Get the way allocation mask limit. 23510941Sdavid.guillen@arm.com * @return The maximum number of ways available for replacement. 23610941Sdavid.guillen@arm.com */ 23711169Sandreas.hansson@arm.com virtual int getWayAllocationMax() const override 23810941Sdavid.guillen@arm.com { 23910941Sdavid.guillen@arm.com return allocAssoc; 24010941Sdavid.guillen@arm.com } 24110941Sdavid.guillen@arm.com 24210941Sdavid.guillen@arm.com /** 24313219Sodanrc@yahoo.com.br * Regenerate the block address from the tag and indexing location. 24412574Sodanrc@yahoo.com.br * 24512574Sodanrc@yahoo.com.br * @param block The block. 24612574Sodanrc@yahoo.com.br * @return the block address. 24710263Satgutier@umich.edu */ 24812574Sodanrc@yahoo.com.br Addr regenerateBlkAddr(const CacheBlk* blk) const override 24910263Satgutier@umich.edu { 25013219Sodanrc@yahoo.com.br return indexingPolicy->regenerateAddr(blk->tag, blk); 25110263Satgutier@umich.edu } 25210263Satgutier@umich.edu 25312728Snikos.nikoleris@arm.com void forEachBlk(std::function<void(CacheBlk &)> visitor) override { 25412728Snikos.nikoleris@arm.com for (CacheBlk& blk : blks) { 25512728Snikos.nikoleris@arm.com visitor(blk); 25612728Snikos.nikoleris@arm.com } 25712728Snikos.nikoleris@arm.com } 25810263Satgutier@umich.edu 25912728Snikos.nikoleris@arm.com bool anyBlk(std::function<bool(CacheBlk &)> visitor) override { 26012679Sodanrc@yahoo.com.br for (CacheBlk& blk : blks) { 26112728Snikos.nikoleris@arm.com if (visitor(blk)) { 26212728Snikos.nikoleris@arm.com return true; 26312728Snikos.nikoleris@arm.com } 26410263Satgutier@umich.edu } 26512728Snikos.nikoleris@arm.com return false; 26610263Satgutier@umich.edu } 26710263Satgutier@umich.edu}; 26810263Satgutier@umich.edu 26912492Sodanrc@yahoo.com.br#endif //__MEM_CACHE_TAGS_BASE_SET_ASSOC_HH__ 270