base_set_assoc.hh revision 13218
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" 6210263Satgutier@umich.edu#include "params/BaseSetAssoc.hh" 6310263Satgutier@umich.edu 6410263Satgutier@umich.edu/** 6510263Satgutier@umich.edu * A BaseSetAssoc cache tag store. 6610263Satgutier@umich.edu * @sa \ref gem5MemorySystem "gem5 Memory System" 6710263Satgutier@umich.edu * 6812600Sodanrc@yahoo.com.br * The BaseSetAssoc placement policy divides the cache into s sets of w 6912600Sodanrc@yahoo.com.br * cache lines (ways). A cache line is mapped onto a set, and can be placed 7012600Sodanrc@yahoo.com.br * into any of the ways of this set. 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 /** Typedef the set type used in this tag store. */ 7813217Sodanrc@yahoo.com.br typedef std::vector<CacheBlk*> SetType; 7910263Satgutier@umich.edu 8010263Satgutier@umich.edu protected: 8110263Satgutier@umich.edu /** The associativity of the cache. */ 8210263Satgutier@umich.edu const unsigned assoc; 8310941Sdavid.guillen@arm.com /** The allocatable associativity of the cache (alloc mask). */ 8410941Sdavid.guillen@arm.com unsigned allocAssoc; 8512548Sodanrc@yahoo.com.br 8612548Sodanrc@yahoo.com.br /** The cache blocks. */ 8712548Sodanrc@yahoo.com.br std::vector<BlkType> blks; 8812548Sodanrc@yahoo.com.br 8910263Satgutier@umich.edu /** The number of sets in the cache. */ 9010263Satgutier@umich.edu const unsigned numSets; 9112548Sodanrc@yahoo.com.br 9210263Satgutier@umich.edu /** Whether tags and data are accessed sequentially. */ 9310263Satgutier@umich.edu const bool sequentialAccess; 9410263Satgutier@umich.edu 9510263Satgutier@umich.edu /** The cache sets. */ 9612548Sodanrc@yahoo.com.br std::vector<SetType> sets; 9710263Satgutier@umich.edu 9810263Satgutier@umich.edu /** The amount to shift the address to get the set. */ 9910263Satgutier@umich.edu int setShift; 10010263Satgutier@umich.edu /** The amount to shift the address to get the tag. */ 10110263Satgutier@umich.edu int tagShift; 10210263Satgutier@umich.edu /** Mask out all bits that aren't part of the set index. */ 10310263Satgutier@umich.edu unsigned setMask; 10410263Satgutier@umich.edu 10512600Sodanrc@yahoo.com.br /** Replacement policy */ 10612600Sodanrc@yahoo.com.br BaseReplacementPolicy *replacementPolicy; 10712600Sodanrc@yahoo.com.br 10813217Sodanrc@yahoo.com.br /** 10913217Sodanrc@yahoo.com.br * Find all possible block locations for insertion and replacement of 11013217Sodanrc@yahoo.com.br * an address. Should be called immediately before ReplacementPolicy's 11113217Sodanrc@yahoo.com.br * findVictim() not to break cache resizing. 11213217Sodanrc@yahoo.com.br * Returns blocks in all ways belonging to the set of the address. 11313217Sodanrc@yahoo.com.br * 11413217Sodanrc@yahoo.com.br * @param addr The addr to a find possible locations for. 11513217Sodanrc@yahoo.com.br * @return The possible locations. 11613217Sodanrc@yahoo.com.br */ 11713217Sodanrc@yahoo.com.br std::vector<ReplaceableEntry*> getPossibleLocations(const Addr addr) const 11813217Sodanrc@yahoo.com.br override 11913217Sodanrc@yahoo.com.br { 12013217Sodanrc@yahoo.com.br std::vector<ReplaceableEntry*> locations; 12113217Sodanrc@yahoo.com.br for (const auto& blk : sets[extractSet(addr)]) { 12213217Sodanrc@yahoo.com.br locations.push_back(static_cast<ReplaceableEntry*>(blk)); 12313217Sodanrc@yahoo.com.br } 12413217Sodanrc@yahoo.com.br return locations; 12513217Sodanrc@yahoo.com.br } 12613217Sodanrc@yahoo.com.br 12712600Sodanrc@yahoo.com.br public: 12810263Satgutier@umich.edu /** Convenience typedef. */ 12910263Satgutier@umich.edu typedef BaseSetAssocParams Params; 13010263Satgutier@umich.edu 13110263Satgutier@umich.edu /** 13210263Satgutier@umich.edu * Construct and initialize this tag store. 13310263Satgutier@umich.edu */ 13410263Satgutier@umich.edu BaseSetAssoc(const Params *p); 13510263Satgutier@umich.edu 13610263Satgutier@umich.edu /** 13710263Satgutier@umich.edu * Destructor 13810263Satgutier@umich.edu */ 13912548Sodanrc@yahoo.com.br virtual ~BaseSetAssoc() {}; 14010263Satgutier@umich.edu 14110263Satgutier@umich.edu /** 14213216Sodanrc@yahoo.com.br * Initialize blocks and set the parent cache back pointer. 14313216Sodanrc@yahoo.com.br * 14413216Sodanrc@yahoo.com.br * @param _cache Pointer to parent cache. 14513216Sodanrc@yahoo.com.br */ 14613216Sodanrc@yahoo.com.br void init(BaseCache *_cache) override; 14713216Sodanrc@yahoo.com.br 14813216Sodanrc@yahoo.com.br /** 14912745Sodanrc@yahoo.com.br * This function updates the tags when a block is invalidated. It also 15012745Sodanrc@yahoo.com.br * updates the replacement data. 15112684Sodanrc@yahoo.com.br * 15212684Sodanrc@yahoo.com.br * @param blk The block to invalidate. 15312684Sodanrc@yahoo.com.br */ 15412684Sodanrc@yahoo.com.br void invalidate(CacheBlk *blk) override; 15512684Sodanrc@yahoo.com.br 15612684Sodanrc@yahoo.com.br /** 15710263Satgutier@umich.edu * Access block and update replacement data. May not succeed, in which case 15811484Snikos.nikoleris@arm.com * nullptr is returned. This has all the implications of a cache 15910263Satgutier@umich.edu * access and should only be used as such. Returns the access latency as a 16010263Satgutier@umich.edu * side effect. 16110263Satgutier@umich.edu * @param addr The address to find. 16210263Satgutier@umich.edu * @param is_secure True if the target memory space is secure. 16310263Satgutier@umich.edu * @param lat The access latency. 16410263Satgutier@umich.edu * @return Pointer to the cache block if found. 16510263Satgutier@umich.edu */ 16611870Snikos.nikoleris@arm.com CacheBlk* accessBlock(Addr addr, bool is_secure, Cycles &lat) override 16710263Satgutier@umich.edu { 16812555Sodanrc@yahoo.com.br BlkType *blk = findBlock(addr, is_secure); 16910263Satgutier@umich.edu 17010263Satgutier@umich.edu // Access all tags in parallel, hence one in each way. The data side 17110263Satgutier@umich.edu // either accesses all blocks in parallel, or one block sequentially on 17210263Satgutier@umich.edu // a hit. Sequential access with a miss doesn't access data. 17310941Sdavid.guillen@arm.com tagAccesses += allocAssoc; 17410263Satgutier@umich.edu if (sequentialAccess) { 17511484Snikos.nikoleris@arm.com if (blk != nullptr) { 17610263Satgutier@umich.edu dataAccesses += 1; 17710263Satgutier@umich.edu } 17810263Satgutier@umich.edu } else { 17910941Sdavid.guillen@arm.com dataAccesses += allocAssoc; 18010263Satgutier@umich.edu } 18110263Satgutier@umich.edu 18211484Snikos.nikoleris@arm.com if (blk != nullptr) { 18311722Ssophiane.senni@gmail.com // If a cache hit 18411722Ssophiane.senni@gmail.com lat = accessLatency; 18511722Ssophiane.senni@gmail.com // Check if the block to be accessed is available. If not, 18611722Ssophiane.senni@gmail.com // apply the accessLatency on top of block->whenReady. 18711722Ssophiane.senni@gmail.com if (blk->whenReady > curTick() && 18811722Ssophiane.senni@gmail.com cache->ticksToCycles(blk->whenReady - curTick()) > 18911722Ssophiane.senni@gmail.com accessLatency) { 19011722Ssophiane.senni@gmail.com lat = cache->ticksToCycles(blk->whenReady - curTick()) + 19111722Ssophiane.senni@gmail.com accessLatency; 19210263Satgutier@umich.edu } 19312600Sodanrc@yahoo.com.br 19412684Sodanrc@yahoo.com.br // Update number of references to accessed block 19512684Sodanrc@yahoo.com.br blk->refCount++; 19612684Sodanrc@yahoo.com.br 19712600Sodanrc@yahoo.com.br // Update replacement data of accessed block 19812684Sodanrc@yahoo.com.br replacementPolicy->touch(blk->replacementData); 19911722Ssophiane.senni@gmail.com } else { 20011722Ssophiane.senni@gmail.com // If a cache miss 20111722Ssophiane.senni@gmail.com lat = lookupLatency; 20210263Satgutier@umich.edu } 20310263Satgutier@umich.edu 20410263Satgutier@umich.edu return blk; 20510263Satgutier@umich.edu } 20610263Satgutier@umich.edu 20710263Satgutier@umich.edu /** 20812743Sodanrc@yahoo.com.br * Find a block given set and way. 20912743Sodanrc@yahoo.com.br * 21012743Sodanrc@yahoo.com.br * @param set The set of the block. 21112743Sodanrc@yahoo.com.br * @param way The way of the block. 21212743Sodanrc@yahoo.com.br * @return The block. 21312743Sodanrc@yahoo.com.br */ 21412743Sodanrc@yahoo.com.br ReplaceableEntry* findBlockBySetAndWay(int set, int way) const override; 21512743Sodanrc@yahoo.com.br 21612743Sodanrc@yahoo.com.br /** 21712744Sodanrc@yahoo.com.br * Find replacement victim based on address. The list of evicted blocks 21812744Sodanrc@yahoo.com.br * only contains the victim. 21912600Sodanrc@yahoo.com.br * 22012600Sodanrc@yahoo.com.br * @param addr Address to find a victim for. 22112746Sodanrc@yahoo.com.br * @param is_secure True if the target memory space is secure. 22212744Sodanrc@yahoo.com.br * @param evict_blks Cache blocks to be evicted. 22312600Sodanrc@yahoo.com.br * @return Cache block to be replaced. 22410263Satgutier@umich.edu */ 22512746Sodanrc@yahoo.com.br CacheBlk* findVictim(Addr addr, const bool is_secure, 22612746Sodanrc@yahoo.com.br std::vector<CacheBlk*>& evict_blks) const override 22710263Satgutier@umich.edu { 22812684Sodanrc@yahoo.com.br // Get possible locations for the victim block 22913217Sodanrc@yahoo.com.br std::vector<ReplaceableEntry*> locations = getPossibleLocations(addr); 23012684Sodanrc@yahoo.com.br 23112600Sodanrc@yahoo.com.br // Choose replacement victim from replacement candidates 23212684Sodanrc@yahoo.com.br CacheBlk* victim = static_cast<CacheBlk*>(replacementPolicy->getVictim( 23312684Sodanrc@yahoo.com.br std::vector<ReplaceableEntry*>( 23412684Sodanrc@yahoo.com.br locations.begin(), locations.end()))); 23512684Sodanrc@yahoo.com.br 23612744Sodanrc@yahoo.com.br // There is only one eviction for this replacement 23712744Sodanrc@yahoo.com.br evict_blks.push_back(victim); 23812744Sodanrc@yahoo.com.br 23912684Sodanrc@yahoo.com.br DPRINTF(CacheRepl, "set %x, way %x: selecting blk for replacement\n", 24013218Sodanrc@yahoo.com.br victim->getSet(), victim->getWay()); 24112684Sodanrc@yahoo.com.br 24212684Sodanrc@yahoo.com.br return victim; 24312600Sodanrc@yahoo.com.br } 24410263Satgutier@umich.edu 24512600Sodanrc@yahoo.com.br /** 24612636Sodanrc@yahoo.com.br * Insert the new block into the cache and update replacement data. 24712636Sodanrc@yahoo.com.br * 24813215Sodanrc@yahoo.com.br * @param addr Address of the block. 24913215Sodanrc@yahoo.com.br * @param is_secure Whether the block is in secure space or not. 25013215Sodanrc@yahoo.com.br * @param src_master_ID The source requestor ID. 25113215Sodanrc@yahoo.com.br * @param task_ID The new task ID. 25210263Satgutier@umich.edu * @param blk The block to update. 25310263Satgutier@umich.edu */ 25413215Sodanrc@yahoo.com.br void insertBlock(const Addr addr, const bool is_secure, 25513215Sodanrc@yahoo.com.br const int src_master_ID, const uint32_t task_ID, 25613215Sodanrc@yahoo.com.br CacheBlk *blk) override 25712636Sodanrc@yahoo.com.br { 25812636Sodanrc@yahoo.com.br // Insert block 25913215Sodanrc@yahoo.com.br BaseTags::insertBlock(addr, is_secure, src_master_ID, task_ID, blk); 26010274Smitch.hayenga@arm.com 26112745Sodanrc@yahoo.com.br // Increment tag counter 26212745Sodanrc@yahoo.com.br tagsInUse++; 26312745Sodanrc@yahoo.com.br 26412636Sodanrc@yahoo.com.br // Update replacement policy 26512684Sodanrc@yahoo.com.br replacementPolicy->reset(blk->replacementData); 26612636Sodanrc@yahoo.com.br } 26710263Satgutier@umich.edu 26810263Satgutier@umich.edu /** 26910941Sdavid.guillen@arm.com * Limit the allocation for the cache ways. 27010941Sdavid.guillen@arm.com * @param ways The maximum number of ways available for replacement. 27110941Sdavid.guillen@arm.com */ 27211169Sandreas.hansson@arm.com virtual void setWayAllocationMax(int ways) override 27310941Sdavid.guillen@arm.com { 27410941Sdavid.guillen@arm.com fatal_if(ways < 1, "Allocation limit must be greater than zero"); 27510941Sdavid.guillen@arm.com allocAssoc = ways; 27610941Sdavid.guillen@arm.com } 27710941Sdavid.guillen@arm.com 27810941Sdavid.guillen@arm.com /** 27910941Sdavid.guillen@arm.com * Get the way allocation mask limit. 28010941Sdavid.guillen@arm.com * @return The maximum number of ways available for replacement. 28110941Sdavid.guillen@arm.com */ 28211169Sandreas.hansson@arm.com virtual int getWayAllocationMax() const override 28310941Sdavid.guillen@arm.com { 28410941Sdavid.guillen@arm.com return allocAssoc; 28510941Sdavid.guillen@arm.com } 28610941Sdavid.guillen@arm.com 28710941Sdavid.guillen@arm.com /** 28810263Satgutier@umich.edu * Generate the tag from the given address. 28910263Satgutier@umich.edu * @param addr The address to get the tag from. 29010263Satgutier@umich.edu * @return The tag of the address. 29110263Satgutier@umich.edu */ 29211169Sandreas.hansson@arm.com Addr extractTag(Addr addr) const override 29310263Satgutier@umich.edu { 29410263Satgutier@umich.edu return (addr >> tagShift); 29510263Satgutier@umich.edu } 29610263Satgutier@umich.edu 29710263Satgutier@umich.edu /** 29812574Sodanrc@yahoo.com.br * Regenerate the block address from the tag and set. 29912574Sodanrc@yahoo.com.br * 30012574Sodanrc@yahoo.com.br * @param block The block. 30112574Sodanrc@yahoo.com.br * @return the block address. 30210263Satgutier@umich.edu */ 30312574Sodanrc@yahoo.com.br Addr regenerateBlkAddr(const CacheBlk* blk) const override 30410263Satgutier@umich.edu { 30513218Sodanrc@yahoo.com.br const Addr set = blk->getSet() << setShift; 30613218Sodanrc@yahoo.com.br return ((blk->tag << tagShift) | set); 30710263Satgutier@umich.edu } 30810263Satgutier@umich.edu 30912728Snikos.nikoleris@arm.com void forEachBlk(std::function<void(CacheBlk &)> visitor) override { 31012728Snikos.nikoleris@arm.com for (CacheBlk& blk : blks) { 31112728Snikos.nikoleris@arm.com visitor(blk); 31212728Snikos.nikoleris@arm.com } 31312728Snikos.nikoleris@arm.com } 31410263Satgutier@umich.edu 31512728Snikos.nikoleris@arm.com bool anyBlk(std::function<bool(CacheBlk &)> visitor) override { 31612679Sodanrc@yahoo.com.br for (CacheBlk& blk : blks) { 31712728Snikos.nikoleris@arm.com if (visitor(blk)) { 31812728Snikos.nikoleris@arm.com return true; 31912728Snikos.nikoleris@arm.com } 32010263Satgutier@umich.edu } 32112728Snikos.nikoleris@arm.com return false; 32210263Satgutier@umich.edu } 32312731Sodanrc@yahoo.com.br 32412731Sodanrc@yahoo.com.br private: 32512731Sodanrc@yahoo.com.br /** 32612731Sodanrc@yahoo.com.br * Calculate the set index from the address. 32712731Sodanrc@yahoo.com.br * 32812731Sodanrc@yahoo.com.br * @param addr The address to get the set from. 32912731Sodanrc@yahoo.com.br * @return The set index of the address. 33012731Sodanrc@yahoo.com.br */ 33112731Sodanrc@yahoo.com.br int extractSet(Addr addr) const 33212731Sodanrc@yahoo.com.br { 33312731Sodanrc@yahoo.com.br return ((addr >> setShift) & setMask); 33412731Sodanrc@yahoo.com.br } 33510263Satgutier@umich.edu}; 33610263Satgutier@umich.edu 33712492Sodanrc@yahoo.com.br#endif //__MEM_CACHE_TAGS_BASE_SET_ASSOC_HH__ 338