cache.hh revision 10815
12810Srdreslin@umich.edu/* 210343SCurtis.Dunham@arm.com * Copyright (c) 2012-2014 ARM Limited 38702Sandreas.hansson@arm.com * All rights reserved. 48702Sandreas.hansson@arm.com * 58702Sandreas.hansson@arm.com * The license below extends only to copyright in the software and shall 68702Sandreas.hansson@arm.com * not be construed as granting a license to any other intellectual 78702Sandreas.hansson@arm.com * property including but not limited to intellectual property relating 88702Sandreas.hansson@arm.com * to a hardware implementation of the functionality of the software 98702Sandreas.hansson@arm.com * licensed hereunder. You may use the software subject to the license 108702Sandreas.hansson@arm.com * terms below provided that you ensure that this notice is replicated 118702Sandreas.hansson@arm.com * unmodified and in its entirety in all distributions of the software, 128702Sandreas.hansson@arm.com * modified or unmodified, in source code or in binary form. 138702Sandreas.hansson@arm.com * 142810Srdreslin@umich.edu * Copyright (c) 2002-2005 The Regents of The University of Michigan 152810Srdreslin@umich.edu * All rights reserved. 162810Srdreslin@umich.edu * 172810Srdreslin@umich.edu * Redistribution and use in source and binary forms, with or without 182810Srdreslin@umich.edu * modification, are permitted provided that the following conditions are 192810Srdreslin@umich.edu * met: redistributions of source code must retain the above copyright 202810Srdreslin@umich.edu * notice, this list of conditions and the following disclaimer; 212810Srdreslin@umich.edu * redistributions in binary form must reproduce the above copyright 222810Srdreslin@umich.edu * notice, this list of conditions and the following disclaimer in the 232810Srdreslin@umich.edu * documentation and/or other materials provided with the distribution; 242810Srdreslin@umich.edu * neither the name of the copyright holders nor the names of its 252810Srdreslin@umich.edu * contributors may be used to endorse or promote products derived from 262810Srdreslin@umich.edu * this software without specific prior written permission. 272810Srdreslin@umich.edu * 282810Srdreslin@umich.edu * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 292810Srdreslin@umich.edu * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 302810Srdreslin@umich.edu * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 312810Srdreslin@umich.edu * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 322810Srdreslin@umich.edu * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 332810Srdreslin@umich.edu * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 342810Srdreslin@umich.edu * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 352810Srdreslin@umich.edu * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 362810Srdreslin@umich.edu * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 372810Srdreslin@umich.edu * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 382810Srdreslin@umich.edu * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 392810Srdreslin@umich.edu * 402810Srdreslin@umich.edu * Authors: Erik Hallnor 412810Srdreslin@umich.edu * Dave Greene 422810Srdreslin@umich.edu * Steve Reinhardt 434458Sstever@eecs.umich.edu * Ron Dreslinski 448856Sandreas.hansson@arm.com * Andreas Hansson 452810Srdreslin@umich.edu */ 462810Srdreslin@umich.edu 472810Srdreslin@umich.edu/** 482810Srdreslin@umich.edu * @file 492810Srdreslin@umich.edu * Describes a cache based on template policies. 502810Srdreslin@umich.edu */ 512810Srdreslin@umich.edu 522810Srdreslin@umich.edu#ifndef __CACHE_HH__ 532810Srdreslin@umich.edu#define __CACHE_HH__ 542810Srdreslin@umich.edu 552810Srdreslin@umich.edu#include "base/misc.hh" // fatal, panic, and warn 565338Sstever@gmail.com#include "mem/cache/base.hh" 575338Sstever@gmail.com#include "mem/cache/blk.hh" 585338Sstever@gmail.com#include "mem/cache/mshr.hh" 5910815Sdavid.guillen@arm.com#include "mem/cache/tags/base.hh" 604458Sstever@eecs.umich.edu#include "sim/eventq.hh" 614458Sstever@eecs.umich.edu 622813Srdreslin@umich.edu//Forward decleration 633861Sstever@eecs.umich.educlass BasePrefetcher; 642810Srdreslin@umich.edu 652810Srdreslin@umich.edu/** 662810Srdreslin@umich.edu * A template-policy based cache. The behavior of the cache can be altered by 672810Srdreslin@umich.edu * supplying different template policies. TagStore handles all tag and data 689264Sdjordje.kovacevic@arm.com * storage @sa TagStore, \ref gem5MemorySystem "gem5 Memory System" 692810Srdreslin@umich.edu */ 702810Srdreslin@umich.educlass Cache : public BaseCache 712810Srdreslin@umich.edu{ 722810Srdreslin@umich.edu public: 7310815Sdavid.guillen@arm.com 7410815Sdavid.guillen@arm.com /** A typedef for a list of CacheBlk pointers. */ 7510815Sdavid.guillen@arm.com typedef std::list<CacheBlk*> BlkList; 762810Srdreslin@umich.edu 772810Srdreslin@umich.edu protected: 782810Srdreslin@umich.edu 798856Sandreas.hansson@arm.com /** 808856Sandreas.hansson@arm.com * The CPU-side port extends the base cache slave port with access 818856Sandreas.hansson@arm.com * functions for functional, atomic and timing requests. 828856Sandreas.hansson@arm.com */ 838856Sandreas.hansson@arm.com class CpuSidePort : public CacheSlavePort 843738Sstever@eecs.umich.edu { 858856Sandreas.hansson@arm.com private: 863738Sstever@eecs.umich.edu 878856Sandreas.hansson@arm.com // a pointer to our specific cache implementation 8810815Sdavid.guillen@arm.com Cache *cache; 893738Sstever@eecs.umich.edu 908856Sandreas.hansson@arm.com protected: 914478Sstever@eecs.umich.edu 928975Sandreas.hansson@arm.com virtual bool recvTimingSnoopResp(PacketPtr pkt); 938948Sandreas.hansson@arm.com 948975Sandreas.hansson@arm.com virtual bool recvTimingReq(PacketPtr pkt); 953738Sstever@eecs.umich.edu 963738Sstever@eecs.umich.edu virtual Tick recvAtomic(PacketPtr pkt); 973738Sstever@eecs.umich.edu 983738Sstever@eecs.umich.edu virtual void recvFunctional(PacketPtr pkt); 998856Sandreas.hansson@arm.com 1009090Sandreas.hansson@arm.com virtual AddrRangeList getAddrRanges() const; 1018856Sandreas.hansson@arm.com 1028856Sandreas.hansson@arm.com public: 1038856Sandreas.hansson@arm.com 10410815Sdavid.guillen@arm.com CpuSidePort(const std::string &_name, Cache *_cache, 1058856Sandreas.hansson@arm.com const std::string &_label); 1068856Sandreas.hansson@arm.com 1073738Sstever@eecs.umich.edu }; 1083738Sstever@eecs.umich.edu 1098856Sandreas.hansson@arm.com /** 1108914Sandreas.hansson@arm.com * Override the default behaviour of sendDeferredPacket to enable 1118914Sandreas.hansson@arm.com * the memory-side cache port to also send requests based on the 1128914Sandreas.hansson@arm.com * current MSHR status. This queue has a pointer to our specific 1138914Sandreas.hansson@arm.com * cache implementation and is used by the MemSidePort. 1148914Sandreas.hansson@arm.com */ 11510713Sandreas.hansson@arm.com class CacheReqPacketQueue : public ReqPacketQueue 1168914Sandreas.hansson@arm.com { 1178914Sandreas.hansson@arm.com 1188914Sandreas.hansson@arm.com protected: 1198914Sandreas.hansson@arm.com 12010815Sdavid.guillen@arm.com Cache &cache; 12110713Sandreas.hansson@arm.com SnoopRespPacketQueue &snoopRespQueue; 1228914Sandreas.hansson@arm.com 1238914Sandreas.hansson@arm.com public: 1248914Sandreas.hansson@arm.com 12510815Sdavid.guillen@arm.com CacheReqPacketQueue(Cache &cache, MasterPort &port, 12610713Sandreas.hansson@arm.com SnoopRespPacketQueue &snoop_resp_queue, 12710713Sandreas.hansson@arm.com const std::string &label) : 12810713Sandreas.hansson@arm.com ReqPacketQueue(cache, port, label), cache(cache), 12910713Sandreas.hansson@arm.com snoopRespQueue(snoop_resp_queue) { } 1308914Sandreas.hansson@arm.com 1318914Sandreas.hansson@arm.com /** 1328914Sandreas.hansson@arm.com * Override the normal sendDeferredPacket and do not only 1338914Sandreas.hansson@arm.com * consider the transmit list (used for responses), but also 1348914Sandreas.hansson@arm.com * requests. 1358914Sandreas.hansson@arm.com */ 1368914Sandreas.hansson@arm.com virtual void sendDeferredPacket(); 1378914Sandreas.hansson@arm.com 1388914Sandreas.hansson@arm.com }; 1398914Sandreas.hansson@arm.com 1408914Sandreas.hansson@arm.com /** 1418856Sandreas.hansson@arm.com * The memory-side port extends the base cache master port with 1428856Sandreas.hansson@arm.com * access functions for functional, atomic and timing snoops. 1438856Sandreas.hansson@arm.com */ 1448856Sandreas.hansson@arm.com class MemSidePort : public CacheMasterPort 1453738Sstever@eecs.umich.edu { 1468856Sandreas.hansson@arm.com private: 1473738Sstever@eecs.umich.edu 1488914Sandreas.hansson@arm.com /** The cache-specific queue. */ 14910713Sandreas.hansson@arm.com CacheReqPacketQueue _reqQueue; 15010713Sandreas.hansson@arm.com 15110713Sandreas.hansson@arm.com SnoopRespPacketQueue _snoopRespQueue; 1528914Sandreas.hansson@arm.com 1538856Sandreas.hansson@arm.com // a pointer to our specific cache implementation 15410815Sdavid.guillen@arm.com Cache *cache; 1553738Sstever@eecs.umich.edu 1568856Sandreas.hansson@arm.com protected: 1574478Sstever@eecs.umich.edu 1588975Sandreas.hansson@arm.com virtual void recvTimingSnoopReq(PacketPtr pkt); 1598948Sandreas.hansson@arm.com 1608975Sandreas.hansson@arm.com virtual bool recvTimingResp(PacketPtr pkt); 1613738Sstever@eecs.umich.edu 1628948Sandreas.hansson@arm.com virtual Tick recvAtomicSnoop(PacketPtr pkt); 1633738Sstever@eecs.umich.edu 1648948Sandreas.hansson@arm.com virtual void recvFunctionalSnoop(PacketPtr pkt); 1654458Sstever@eecs.umich.edu 1668856Sandreas.hansson@arm.com public: 1678856Sandreas.hansson@arm.com 16810815Sdavid.guillen@arm.com MemSidePort(const std::string &_name, Cache *_cache, 1698856Sandreas.hansson@arm.com const std::string &_label); 1703738Sstever@eecs.umich.edu }; 1713738Sstever@eecs.umich.edu 1722810Srdreslin@umich.edu /** Tag and data Storage */ 17310815Sdavid.guillen@arm.com BaseTags *tags; 1744626Sstever@eecs.umich.edu 1752810Srdreslin@umich.edu /** Prefetcher */ 1763861Sstever@eecs.umich.edu BasePrefetcher *prefetcher; 1772810Srdreslin@umich.edu 1784671Sstever@eecs.umich.edu /** Temporary cache block for occasional transitory use */ 17910815Sdavid.guillen@arm.com CacheBlk *tempBlock; 1804671Sstever@eecs.umich.edu 1812810Srdreslin@umich.edu /** 1825707Shsul@eecs.umich.edu * This cache should allocate a block on a line-sized write miss. 1833860Sstever@eecs.umich.edu */ 1843860Sstever@eecs.umich.edu const bool doFastWrites; 1853860Sstever@eecs.umich.edu 1865875Ssteve.reinhardt@amd.com /** 18710345SCurtis.Dunham@arm.com * Turn line-sized writes into WriteInvalidate transactions. 18810345SCurtis.Dunham@arm.com */ 18910345SCurtis.Dunham@arm.com void promoteWholeLineWrites(PacketPtr pkt); 19010345SCurtis.Dunham@arm.com 19110345SCurtis.Dunham@arm.com /** 1925875Ssteve.reinhardt@amd.com * Notify the prefetcher on every access, not just misses. 1935875Ssteve.reinhardt@amd.com */ 1945875Ssteve.reinhardt@amd.com const bool prefetchOnAccess; 1953860Sstever@eecs.umich.edu 1963860Sstever@eecs.umich.edu /** 1979063SAli.Saidi@ARM.com * @todo this is a temporary workaround until the 4-phase code is committed. 1989063SAli.Saidi@ARM.com * upstream caches need this packet until true is returned, so hold it for 1999063SAli.Saidi@ARM.com * deletion until a subsequent call 2009063SAli.Saidi@ARM.com */ 2019063SAli.Saidi@ARM.com std::vector<PacketPtr> pendingDelete; 2029063SAli.Saidi@ARM.com 2039063SAli.Saidi@ARM.com /** 2043860Sstever@eecs.umich.edu * Does all the processing necessary to perform the provided request. 2053860Sstever@eecs.umich.edu * @param pkt The memory request to perform. 20610048Saminfar@gmail.com * @param blk The cache block to be updated. 2073860Sstever@eecs.umich.edu * @param lat The latency of the access. 2083860Sstever@eecs.umich.edu * @param writebacks List for any writebacks that need to be performed. 2095707Shsul@eecs.umich.edu * @return Boolean indicating whether the request was satisfied. 2103860Sstever@eecs.umich.edu */ 21110815Sdavid.guillen@arm.com bool access(PacketPtr pkt, CacheBlk *&blk, 2129288Sandreas.hansson@arm.com Cycles &lat, PacketList &writebacks); 2134219Srdreslin@umich.edu 2144219Srdreslin@umich.edu /** 2154219Srdreslin@umich.edu *Handle doing the Compare and Swap function for SPARC. 2164219Srdreslin@umich.edu */ 21710815Sdavid.guillen@arm.com void cmpAndSwap(CacheBlk *blk, PacketPtr pkt); 2183860Sstever@eecs.umich.edu 2193860Sstever@eecs.umich.edu /** 22010028SGiacomo.Gabrielli@arm.com * Find a block frame for new block at address addr targeting the 22110028SGiacomo.Gabrielli@arm.com * given security space, assuming that the block is not currently 22210028SGiacomo.Gabrielli@arm.com * in the cache. Append writebacks if any to provided packet 22310028SGiacomo.Gabrielli@arm.com * list. Return free block frame. May return NULL if there are 22410028SGiacomo.Gabrielli@arm.com * no replaceable blocks at the moment. 2255350Sstever@gmail.com */ 22610815Sdavid.guillen@arm.com CacheBlk *allocateBlock(Addr addr, bool is_secure, PacketList &writebacks); 2275350Sstever@gmail.com 2285350Sstever@gmail.com /** 2293860Sstever@eecs.umich.edu * Populates a cache block and handles all outstanding requests for the 2303860Sstever@eecs.umich.edu * satisfied fill request. This version takes two memory requests. One 2313860Sstever@eecs.umich.edu * contains the fill data, the other is an optional target to satisfy. 2324626Sstever@eecs.umich.edu * @param pkt The memory request with the fill data. 2333860Sstever@eecs.umich.edu * @param blk The cache block if it already exists. 2343860Sstever@eecs.umich.edu * @param writebacks List for any writebacks that need to be performed. 2353860Sstever@eecs.umich.edu * @return Pointer to the new cache block. 2363860Sstever@eecs.umich.edu */ 23710815Sdavid.guillen@arm.com CacheBlk *handleFill(PacketPtr pkt, CacheBlk *blk, 2384626Sstever@eecs.umich.edu PacketList &writebacks); 2393860Sstever@eecs.umich.edu 2409548Sandreas.hansson@arm.com 2419548Sandreas.hansson@arm.com /** 2429548Sandreas.hansson@arm.com * Performs the access specified by the request. 2439548Sandreas.hansson@arm.com * @param pkt The request to perform. 2449548Sandreas.hansson@arm.com * @return The result of the access. 2459548Sandreas.hansson@arm.com */ 2469548Sandreas.hansson@arm.com bool recvTimingReq(PacketPtr pkt); 2479548Sandreas.hansson@arm.com 2489548Sandreas.hansson@arm.com /** 2499548Sandreas.hansson@arm.com * Handles a response (cache line fill/write ack) from the bus. 2509548Sandreas.hansson@arm.com * @param pkt The response packet 2519548Sandreas.hansson@arm.com */ 2529548Sandreas.hansson@arm.com void recvTimingResp(PacketPtr pkt); 2539548Sandreas.hansson@arm.com 2549548Sandreas.hansson@arm.com /** 2559548Sandreas.hansson@arm.com * Snoops bus transactions to maintain coherence. 2569548Sandreas.hansson@arm.com * @param pkt The current bus transaction. 2579548Sandreas.hansson@arm.com */ 2589548Sandreas.hansson@arm.com void recvTimingSnoopReq(PacketPtr pkt); 2599548Sandreas.hansson@arm.com 2609548Sandreas.hansson@arm.com /** 2619548Sandreas.hansson@arm.com * Handle a snoop response. 2629548Sandreas.hansson@arm.com * @param pkt Snoop response packet 2639548Sandreas.hansson@arm.com */ 2649548Sandreas.hansson@arm.com void recvTimingSnoopResp(PacketPtr pkt); 2659548Sandreas.hansson@arm.com 2669548Sandreas.hansson@arm.com /** 2679548Sandreas.hansson@arm.com * Performs the access specified by the request. 2689548Sandreas.hansson@arm.com * @param pkt The request to perform. 2699782Sandreas.hansson@arm.com * @return The number of ticks required for the access. 2709548Sandreas.hansson@arm.com */ 2719782Sandreas.hansson@arm.com Tick recvAtomic(PacketPtr pkt); 2729548Sandreas.hansson@arm.com 2739548Sandreas.hansson@arm.com /** 2749548Sandreas.hansson@arm.com * Snoop for the provided request in the cache and return the estimated 2759782Sandreas.hansson@arm.com * time taken. 2769548Sandreas.hansson@arm.com * @param pkt The memory request to snoop 2779782Sandreas.hansson@arm.com * @return The number of ticks required for the snoop. 2789548Sandreas.hansson@arm.com */ 2799782Sandreas.hansson@arm.com Tick recvAtomicSnoop(PacketPtr pkt); 2809548Sandreas.hansson@arm.com 2819548Sandreas.hansson@arm.com /** 2829548Sandreas.hansson@arm.com * Performs the access specified by the request. 2839548Sandreas.hansson@arm.com * @param pkt The request to perform. 2849548Sandreas.hansson@arm.com * @param fromCpuSide from the CPU side port or the memory side port 2859548Sandreas.hansson@arm.com */ 2869548Sandreas.hansson@arm.com void functionalAccess(PacketPtr pkt, bool fromCpuSide); 2879548Sandreas.hansson@arm.com 28810815Sdavid.guillen@arm.com void satisfyCpuSideRequest(PacketPtr pkt, CacheBlk *blk, 2897667Ssteve.reinhardt@amd.com bool deferred_response = false, 2907667Ssteve.reinhardt@amd.com bool pending_downgrade = false); 29110815Sdavid.guillen@arm.com bool satisfyMSHR(MSHR *mshr, PacketPtr pkt, CacheBlk *blk); 2924626Sstever@eecs.umich.edu 29310563Sandreas.hansson@arm.com void doTimingSupplyResponse(PacketPtr req_pkt, const uint8_t *blk_data, 2945319Sstever@gmail.com bool already_copied, bool pending_inval); 2953860Sstever@eecs.umich.edu 2963860Sstever@eecs.umich.edu /** 2973860Sstever@eecs.umich.edu * Sets the blk to the new state. 2983860Sstever@eecs.umich.edu * @param blk The cache block being snooped. 2993860Sstever@eecs.umich.edu * @param new_state The new coherence state for the block. 3003860Sstever@eecs.umich.edu */ 30110815Sdavid.guillen@arm.com void handleSnoop(PacketPtr ptk, CacheBlk *blk, 3025319Sstever@gmail.com bool is_timing, bool is_deferred, bool pending_inval); 3033860Sstever@eecs.umich.edu 3043860Sstever@eecs.umich.edu /** 3053860Sstever@eecs.umich.edu * Create a writeback request for the given block. 3063860Sstever@eecs.umich.edu * @param blk The block to writeback. 3073860Sstever@eecs.umich.edu * @return The writeback request for the block. 3083860Sstever@eecs.umich.edu */ 30910815Sdavid.guillen@arm.com PacketPtr writebackBlk(CacheBlk *blk); 3103860Sstever@eecs.umich.edu 3119347SAndreas.Sandberg@arm.com 3129347SAndreas.Sandberg@arm.com void memWriteback(); 3139347SAndreas.Sandberg@arm.com void memInvalidate(); 3149347SAndreas.Sandberg@arm.com bool isDirty() const; 3159347SAndreas.Sandberg@arm.com 3169347SAndreas.Sandberg@arm.com /** 3179347SAndreas.Sandberg@arm.com * Cache block visitor that writes back dirty cache blocks using 3189347SAndreas.Sandberg@arm.com * functional writes. 3199347SAndreas.Sandberg@arm.com * 3209347SAndreas.Sandberg@arm.com * \return Always returns true. 3219347SAndreas.Sandberg@arm.com */ 32210815Sdavid.guillen@arm.com bool writebackVisitor(CacheBlk &blk); 3239347SAndreas.Sandberg@arm.com /** 3249347SAndreas.Sandberg@arm.com * Cache block visitor that invalidates all blocks in the cache. 3259347SAndreas.Sandberg@arm.com * 3269347SAndreas.Sandberg@arm.com * @warn Dirty cache lines will not be written back to memory. 3279347SAndreas.Sandberg@arm.com * 3289347SAndreas.Sandberg@arm.com * \return Always returns true. 3299347SAndreas.Sandberg@arm.com */ 33010815Sdavid.guillen@arm.com bool invalidateVisitor(CacheBlk &blk); 3319347SAndreas.Sandberg@arm.com 3329445SAndreas.Sandberg@ARM.com /** 3332982Sstever@eecs.umich.edu * Squash all requests associated with specified thread. 3342810Srdreslin@umich.edu * intended for use by I-cache. 3352982Sstever@eecs.umich.edu * @param threadNum The thread to squash. 3362810Srdreslin@umich.edu */ 3374626Sstever@eecs.umich.edu void squash(int threadNum); 3384626Sstever@eecs.umich.edu 3394626Sstever@eecs.umich.edu /** 3405365Sstever@gmail.com * Generate an appropriate downstream bus request packet for the 3415365Sstever@gmail.com * given parameters. 3425365Sstever@gmail.com * @param cpu_pkt The upstream request that needs to be satisfied. 3435365Sstever@gmail.com * @param blk The block currently in the cache corresponding to 3445365Sstever@gmail.com * cpu_pkt (NULL if none). 3455365Sstever@gmail.com * @param needsExclusive Indicates that an exclusive copy is required 3465365Sstever@gmail.com * even if the request in cpu_pkt doesn't indicate that. 3475365Sstever@gmail.com * @return A new Packet containing the request, or NULL if the 3485365Sstever@gmail.com * current request in cpu_pkt should just be forwarded on. 3494626Sstever@eecs.umich.edu */ 35010815Sdavid.guillen@arm.com PacketPtr getBusPacket(PacketPtr cpu_pkt, CacheBlk *blk, 3519529Sandreas.hansson@arm.com bool needsExclusive) const; 3525365Sstever@gmail.com 3535365Sstever@gmail.com /** 3545365Sstever@gmail.com * Return the next MSHR to service, either a pending miss from the 3555365Sstever@gmail.com * mshrQueue, a buffered write from the write buffer, or something 3565365Sstever@gmail.com * from the prefetcher. This function is responsible for 3575365Sstever@gmail.com * prioritizing among those sources on the fly. 3585365Sstever@gmail.com */ 3594626Sstever@eecs.umich.edu MSHR *getNextMSHR(); 3605365Sstever@gmail.com 3615365Sstever@gmail.com /** 3625365Sstever@gmail.com * Selects an outstanding request to service. Called when the 3635365Sstever@gmail.com * cache gets granted the downstream bus in timing mode. 3645365Sstever@gmail.com * @return The request to service, NULL if none found. 3655365Sstever@gmail.com */ 3664628Sstever@eecs.umich.edu PacketPtr getTimingPacket(); 3674626Sstever@eecs.umich.edu 3684626Sstever@eecs.umich.edu /** 36910679Sandreas.hansson@arm.com * Marks a request as in service (sent on the bus). This can have 37010679Sandreas.hansson@arm.com * side effect since storage for no response commands is 37110679Sandreas.hansson@arm.com * deallocated once they are successfully sent. Also remember if 37210679Sandreas.hansson@arm.com * we are expecting a dirty response from another cache, 37310679Sandreas.hansson@arm.com * effectively making this MSHR the ordering point. 3744626Sstever@eecs.umich.edu */ 37510679Sandreas.hansson@arm.com void markInService(MSHR *mshr, bool pending_dirty_resp); 3764626Sstever@eecs.umich.edu 3774626Sstever@eecs.umich.edu /** 3784626Sstever@eecs.umich.edu * Return whether there are any outstanding misses. 3794626Sstever@eecs.umich.edu */ 3804626Sstever@eecs.umich.edu bool outstandingMisses() const 3812810Srdreslin@umich.edu { 3824626Sstever@eecs.umich.edu return mshrQueue.allocated != 0; 3832810Srdreslin@umich.edu } 3842810Srdreslin@umich.edu 38510028SGiacomo.Gabrielli@arm.com CacheBlk *findBlock(Addr addr, bool is_secure) const { 38610028SGiacomo.Gabrielli@arm.com return tags->findBlock(addr, is_secure); 3872810Srdreslin@umich.edu } 3882810Srdreslin@umich.edu 38910028SGiacomo.Gabrielli@arm.com bool inCache(Addr addr, bool is_secure) const { 39010028SGiacomo.Gabrielli@arm.com return (tags->findBlock(addr, is_secure) != 0); 3913861Sstever@eecs.umich.edu } 3923861Sstever@eecs.umich.edu 39310028SGiacomo.Gabrielli@arm.com bool inMissQueue(Addr addr, bool is_secure) const { 39410028SGiacomo.Gabrielli@arm.com return (mshrQueue.findMatch(addr, is_secure) != 0); 3953861Sstever@eecs.umich.edu } 3965875Ssteve.reinhardt@amd.com 3975875Ssteve.reinhardt@amd.com /** 3985875Ssteve.reinhardt@amd.com * Find next request ready time from among possible sources. 3995875Ssteve.reinhardt@amd.com */ 4009529Sandreas.hansson@arm.com Tick nextMSHRReadyTime() const; 4019529Sandreas.hansson@arm.com 4029529Sandreas.hansson@arm.com public: 4039529Sandreas.hansson@arm.com /** Instantiates a basic cache object. */ 4049796Sprakash.ramrakhyani@arm.com Cache(const Params *p); 4059529Sandreas.hansson@arm.com 4069813Srioshering@gmail.com /** Non-default destructor is needed to deallocate memory. */ 4079813Srioshering@gmail.com virtual ~Cache(); 4089813Srioshering@gmail.com 4099529Sandreas.hansson@arm.com void regStats(); 4108985SAli.Saidi@ARM.com 4118985SAli.Saidi@ARM.com /** serialize the state of the caches 4128985SAli.Saidi@ARM.com * We currently don't support checkpointing cache state, so this panics. 4138985SAli.Saidi@ARM.com */ 4148985SAli.Saidi@ARM.com virtual void serialize(std::ostream &os); 4158985SAli.Saidi@ARM.com void unserialize(Checkpoint *cp, const std::string §ion); 4162810Srdreslin@umich.edu}; 4172810Srdreslin@umich.edu 41810815Sdavid.guillen@arm.com/** 41910815Sdavid.guillen@arm.com * Wrap a method and present it as a cache block visitor. 42010815Sdavid.guillen@arm.com * 42110815Sdavid.guillen@arm.com * For example the forEachBlk method in the tag arrays expects a 42210815Sdavid.guillen@arm.com * callable object/function as their parameter. This class wraps a 42310815Sdavid.guillen@arm.com * method in an object and presents callable object that adheres to 42410815Sdavid.guillen@arm.com * the cache block visitor protocol. 42510815Sdavid.guillen@arm.com */ 42610815Sdavid.guillen@arm.comclass CacheBlkVisitorWrapper : public CacheBlkVisitor 42710815Sdavid.guillen@arm.com{ 42810815Sdavid.guillen@arm.com public: 42910815Sdavid.guillen@arm.com typedef bool (Cache::*VisitorPtr)(CacheBlk &blk); 43010815Sdavid.guillen@arm.com 43110815Sdavid.guillen@arm.com CacheBlkVisitorWrapper(Cache &_cache, VisitorPtr _visitor) 43210815Sdavid.guillen@arm.com : cache(_cache), visitor(_visitor) {} 43310815Sdavid.guillen@arm.com 43410815Sdavid.guillen@arm.com bool operator()(CacheBlk &blk) M5_ATTR_OVERRIDE { 43510815Sdavid.guillen@arm.com return (cache.*visitor)(blk); 43610815Sdavid.guillen@arm.com } 43710815Sdavid.guillen@arm.com 43810815Sdavid.guillen@arm.com private: 43910815Sdavid.guillen@arm.com Cache &cache; 44010815Sdavid.guillen@arm.com VisitorPtr visitor; 44110815Sdavid.guillen@arm.com}; 44210815Sdavid.guillen@arm.com 44310815Sdavid.guillen@arm.com/** 44410815Sdavid.guillen@arm.com * Cache block visitor that determines if there are dirty blocks in a 44510815Sdavid.guillen@arm.com * cache. 44610815Sdavid.guillen@arm.com * 44710815Sdavid.guillen@arm.com * Use with the forEachBlk method in the tag array to determine if the 44810815Sdavid.guillen@arm.com * array contains dirty blocks. 44910815Sdavid.guillen@arm.com */ 45010815Sdavid.guillen@arm.comclass CacheBlkIsDirtyVisitor : public CacheBlkVisitor 45110815Sdavid.guillen@arm.com{ 45210815Sdavid.guillen@arm.com public: 45310815Sdavid.guillen@arm.com CacheBlkIsDirtyVisitor() 45410815Sdavid.guillen@arm.com : _isDirty(false) {} 45510815Sdavid.guillen@arm.com 45610815Sdavid.guillen@arm.com bool operator()(CacheBlk &blk) M5_ATTR_OVERRIDE { 45710815Sdavid.guillen@arm.com if (blk.isDirty()) { 45810815Sdavid.guillen@arm.com _isDirty = true; 45910815Sdavid.guillen@arm.com return false; 46010815Sdavid.guillen@arm.com } else { 46110815Sdavid.guillen@arm.com return true; 46210815Sdavid.guillen@arm.com } 46310815Sdavid.guillen@arm.com } 46410815Sdavid.guillen@arm.com 46510815Sdavid.guillen@arm.com /** 46610815Sdavid.guillen@arm.com * Does the array contain a dirty line? 46710815Sdavid.guillen@arm.com * 46810815Sdavid.guillen@arm.com * \return true if yes, false otherwise. 46910815Sdavid.guillen@arm.com */ 47010815Sdavid.guillen@arm.com bool isDirty() const { return _isDirty; }; 47110815Sdavid.guillen@arm.com 47210815Sdavid.guillen@arm.com private: 47310815Sdavid.guillen@arm.com bool _isDirty; 47410815Sdavid.guillen@arm.com}; 47510815Sdavid.guillen@arm.com 4762810Srdreslin@umich.edu#endif // __CACHE_HH__ 477