cache.hh revision 4965
12810Srdreslin@umich.edu/* 22810Srdreslin@umich.edu * Copyright (c) 2002-2005 The Regents of The University of Michigan 32810Srdreslin@umich.edu * All rights reserved. 42810Srdreslin@umich.edu * 52810Srdreslin@umich.edu * Redistribution and use in source and binary forms, with or without 62810Srdreslin@umich.edu * modification, are permitted provided that the following conditions are 72810Srdreslin@umich.edu * met: redistributions of source code must retain the above copyright 82810Srdreslin@umich.edu * notice, this list of conditions and the following disclaimer; 92810Srdreslin@umich.edu * redistributions in binary form must reproduce the above copyright 102810Srdreslin@umich.edu * notice, this list of conditions and the following disclaimer in the 112810Srdreslin@umich.edu * documentation and/or other materials provided with the distribution; 122810Srdreslin@umich.edu * neither the name of the copyright holders nor the names of its 132810Srdreslin@umich.edu * contributors may be used to endorse or promote products derived from 142810Srdreslin@umich.edu * this software without specific prior written permission. 152810Srdreslin@umich.edu * 162810Srdreslin@umich.edu * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 172810Srdreslin@umich.edu * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 182810Srdreslin@umich.edu * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 192810Srdreslin@umich.edu * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 202810Srdreslin@umich.edu * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 212810Srdreslin@umich.edu * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 222810Srdreslin@umich.edu * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 232810Srdreslin@umich.edu * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 242810Srdreslin@umich.edu * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 252810Srdreslin@umich.edu * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 262810Srdreslin@umich.edu * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 272810Srdreslin@umich.edu * 282810Srdreslin@umich.edu * Authors: Erik Hallnor 292810Srdreslin@umich.edu * Dave Greene 302810Srdreslin@umich.edu * Steve Reinhardt 314458Sstever@eecs.umich.edu * Ron Dreslinski 322810Srdreslin@umich.edu */ 332810Srdreslin@umich.edu 342810Srdreslin@umich.edu/** 352810Srdreslin@umich.edu * @file 362810Srdreslin@umich.edu * Describes a cache based on template policies. 372810Srdreslin@umich.edu */ 382810Srdreslin@umich.edu 392810Srdreslin@umich.edu#ifndef __CACHE_HH__ 402810Srdreslin@umich.edu#define __CACHE_HH__ 412810Srdreslin@umich.edu 422810Srdreslin@umich.edu#include "base/misc.hh" // fatal, panic, and warn 432810Srdreslin@umich.edu 442810Srdreslin@umich.edu#include "mem/cache/base_cache.hh" 453860Sstever@eecs.umich.edu#include "mem/cache/cache_blk.hh" 464626Sstever@eecs.umich.edu#include "mem/cache/miss/mshr.hh" 472810Srdreslin@umich.edu 484458Sstever@eecs.umich.edu#include "sim/eventq.hh" 494458Sstever@eecs.umich.edu 502813Srdreslin@umich.edu//Forward decleration 513861Sstever@eecs.umich.educlass BasePrefetcher; 522810Srdreslin@umich.edu 532810Srdreslin@umich.edu/** 542810Srdreslin@umich.edu * A template-policy based cache. The behavior of the cache can be altered by 552810Srdreslin@umich.edu * supplying different template policies. TagStore handles all tag and data 564672Sstever@eecs.umich.edu * storage @sa TagStore. 572810Srdreslin@umich.edu */ 584672Sstever@eecs.umich.edutemplate <class TagStore> 592810Srdreslin@umich.educlass Cache : public BaseCache 602810Srdreslin@umich.edu{ 612810Srdreslin@umich.edu public: 622810Srdreslin@umich.edu /** Define the type of cache block to use. */ 632810Srdreslin@umich.edu typedef typename TagStore::BlkType BlkType; 643860Sstever@eecs.umich.edu /** A typedef for a list of BlkType pointers. */ 653860Sstever@eecs.umich.edu typedef typename TagStore::BlkList BlkList; 662810Srdreslin@umich.edu 672810Srdreslin@umich.edu bool prefetchAccess; 683738Sstever@eecs.umich.edu 692810Srdreslin@umich.edu protected: 702810Srdreslin@umich.edu 713738Sstever@eecs.umich.edu class CpuSidePort : public CachePort 723738Sstever@eecs.umich.edu { 733738Sstever@eecs.umich.edu public: 743738Sstever@eecs.umich.edu CpuSidePort(const std::string &_name, 754965Ssaidi@eecs.umich.edu Cache<TagStore> *_cache, 764965Ssaidi@eecs.umich.edu std::vector<Range<Addr> > filterRanges); 773738Sstever@eecs.umich.edu 783738Sstever@eecs.umich.edu // BaseCache::CachePort just has a BaseCache *; this function 793738Sstever@eecs.umich.edu // lets us get back the type info we lost when we stored the 803738Sstever@eecs.umich.edu // cache pointer there. 814672Sstever@eecs.umich.edu Cache<TagStore> *myCache() { 824672Sstever@eecs.umich.edu return static_cast<Cache<TagStore> *>(cache); 833738Sstever@eecs.umich.edu } 843738Sstever@eecs.umich.edu 854478Sstever@eecs.umich.edu virtual void getDeviceAddressRanges(AddrRangeList &resp, 864478Sstever@eecs.umich.edu bool &snoop); 874478Sstever@eecs.umich.edu 883738Sstever@eecs.umich.edu virtual bool recvTiming(PacketPtr pkt); 893738Sstever@eecs.umich.edu 903738Sstever@eecs.umich.edu virtual Tick recvAtomic(PacketPtr pkt); 913738Sstever@eecs.umich.edu 923738Sstever@eecs.umich.edu virtual void recvFunctional(PacketPtr pkt); 933738Sstever@eecs.umich.edu }; 943738Sstever@eecs.umich.edu 953738Sstever@eecs.umich.edu class MemSidePort : public CachePort 963738Sstever@eecs.umich.edu { 973738Sstever@eecs.umich.edu public: 983738Sstever@eecs.umich.edu MemSidePort(const std::string &_name, 994965Ssaidi@eecs.umich.edu Cache<TagStore> *_cache, 1004965Ssaidi@eecs.umich.edu std::vector<Range<Addr> > filterRanges); 1013738Sstever@eecs.umich.edu 1023738Sstever@eecs.umich.edu // BaseCache::CachePort just has a BaseCache *; this function 1033738Sstever@eecs.umich.edu // lets us get back the type info we lost when we stored the 1043738Sstever@eecs.umich.edu // cache pointer there. 1054672Sstever@eecs.umich.edu Cache<TagStore> *myCache() { 1064672Sstever@eecs.umich.edu return static_cast<Cache<TagStore> *>(cache); 1073738Sstever@eecs.umich.edu } 1083738Sstever@eecs.umich.edu 1094626Sstever@eecs.umich.edu void sendPacket(); 1104626Sstever@eecs.umich.edu 1114626Sstever@eecs.umich.edu void processSendEvent(); 1124458Sstever@eecs.umich.edu 1134478Sstever@eecs.umich.edu virtual void getDeviceAddressRanges(AddrRangeList &resp, 1144478Sstever@eecs.umich.edu bool &snoop); 1154478Sstever@eecs.umich.edu 1163738Sstever@eecs.umich.edu virtual bool recvTiming(PacketPtr pkt); 1173738Sstever@eecs.umich.edu 1184458Sstever@eecs.umich.edu virtual void recvRetry(); 1194458Sstever@eecs.umich.edu 1203738Sstever@eecs.umich.edu virtual Tick recvAtomic(PacketPtr pkt); 1213738Sstever@eecs.umich.edu 1223738Sstever@eecs.umich.edu virtual void recvFunctional(PacketPtr pkt); 1234458Sstever@eecs.umich.edu 1244626Sstever@eecs.umich.edu typedef EventWrapper<MemSidePort, &MemSidePort::processSendEvent> 1254626Sstever@eecs.umich.edu SendEvent; 1263738Sstever@eecs.umich.edu }; 1273738Sstever@eecs.umich.edu 1282810Srdreslin@umich.edu /** Tag and data Storage */ 1292810Srdreslin@umich.edu TagStore *tags; 1304626Sstever@eecs.umich.edu 1312810Srdreslin@umich.edu /** Prefetcher */ 1323861Sstever@eecs.umich.edu BasePrefetcher *prefetcher; 1332810Srdreslin@umich.edu 1344671Sstever@eecs.umich.edu /** Temporary cache block for occasional transitory use */ 1354671Sstever@eecs.umich.edu BlkType *tempBlock; 1364671Sstever@eecs.umich.edu 1372810Srdreslin@umich.edu /** 1383860Sstever@eecs.umich.edu * Can this cache should allocate a block on a line-sized write miss. 1393860Sstever@eecs.umich.edu */ 1403860Sstever@eecs.umich.edu const bool doFastWrites; 1413860Sstever@eecs.umich.edu 1423860Sstever@eecs.umich.edu const bool prefetchMiss; 1433860Sstever@eecs.umich.edu 1443860Sstever@eecs.umich.edu /** 1453860Sstever@eecs.umich.edu * Handle a replacement for the given request. 1463860Sstever@eecs.umich.edu * @param blk A pointer to the block, usually NULL 1473860Sstever@eecs.umich.edu * @param pkt The memory request to satisfy. 1483860Sstever@eecs.umich.edu * @param new_state The new state of the block. 1493860Sstever@eecs.umich.edu * @param writebacks A list to store any generated writebacks. 1503860Sstever@eecs.umich.edu */ 1514626Sstever@eecs.umich.edu BlkType* doReplacement(BlkType *blk, PacketPtr pkt, 1523860Sstever@eecs.umich.edu CacheBlk::State new_state, PacketList &writebacks); 1533860Sstever@eecs.umich.edu 1543860Sstever@eecs.umich.edu /** 1553860Sstever@eecs.umich.edu * Does all the processing necessary to perform the provided request. 1563860Sstever@eecs.umich.edu * @param pkt The memory request to perform. 1573860Sstever@eecs.umich.edu * @param lat The latency of the access. 1583860Sstever@eecs.umich.edu * @param writebacks List for any writebacks that need to be performed. 1593860Sstever@eecs.umich.edu * @param update True if the replacement data should be updated. 1603860Sstever@eecs.umich.edu * @return Pointer to the cache block touched by the request. NULL if it 1613860Sstever@eecs.umich.edu * was a miss. 1623860Sstever@eecs.umich.edu */ 1634628Sstever@eecs.umich.edu bool access(PacketPtr pkt, BlkType *&blk, int &lat); 1644219Srdreslin@umich.edu 1654219Srdreslin@umich.edu /** 1664219Srdreslin@umich.edu *Handle doing the Compare and Swap function for SPARC. 1674219Srdreslin@umich.edu */ 1684626Sstever@eecs.umich.edu void cmpAndSwap(BlkType *blk, PacketPtr pkt); 1693860Sstever@eecs.umich.edu 1703860Sstever@eecs.umich.edu /** 1713860Sstever@eecs.umich.edu * Populates a cache block and handles all outstanding requests for the 1723860Sstever@eecs.umich.edu * satisfied fill request. This version takes two memory requests. One 1733860Sstever@eecs.umich.edu * contains the fill data, the other is an optional target to satisfy. 1743860Sstever@eecs.umich.edu * Used for Cache::probe. 1754626Sstever@eecs.umich.edu * @param pkt The memory request with the fill data. 1763860Sstever@eecs.umich.edu * @param blk The cache block if it already exists. 1773860Sstever@eecs.umich.edu * @param writebacks List for any writebacks that need to be performed. 1783860Sstever@eecs.umich.edu * @return Pointer to the new cache block. 1793860Sstever@eecs.umich.edu */ 1804626Sstever@eecs.umich.edu BlkType *handleFill(PacketPtr pkt, BlkType *blk, 1814626Sstever@eecs.umich.edu PacketList &writebacks); 1823860Sstever@eecs.umich.edu 1834665Sstever@eecs.umich.edu void satisfyCpuSideRequest(PacketPtr pkt, BlkType *blk); 1844628Sstever@eecs.umich.edu bool satisfyMSHR(MSHR *mshr, PacketPtr pkt, BlkType *blk); 1854626Sstever@eecs.umich.edu 1864670Sstever@eecs.umich.edu void doTimingSupplyResponse(PacketPtr req_pkt, uint8_t *blk_data, 1874670Sstever@eecs.umich.edu bool already_copied); 1883860Sstever@eecs.umich.edu 1893860Sstever@eecs.umich.edu /** 1903860Sstever@eecs.umich.edu * Sets the blk to the new state. 1913860Sstever@eecs.umich.edu * @param blk The cache block being snooped. 1923860Sstever@eecs.umich.edu * @param new_state The new coherence state for the block. 1933860Sstever@eecs.umich.edu */ 1944670Sstever@eecs.umich.edu void handleSnoop(PacketPtr ptk, BlkType *blk, 1954908Sstever@eecs.umich.edu bool is_timing, bool is_deferred); 1963860Sstever@eecs.umich.edu 1973860Sstever@eecs.umich.edu /** 1983860Sstever@eecs.umich.edu * Create a writeback request for the given block. 1993860Sstever@eecs.umich.edu * @param blk The block to writeback. 2003860Sstever@eecs.umich.edu * @return The writeback request for the block. 2013860Sstever@eecs.umich.edu */ 2023860Sstever@eecs.umich.edu PacketPtr writebackBlk(BlkType *blk); 2033860Sstever@eecs.umich.edu 2042810Srdreslin@umich.edu public: 2052810Srdreslin@umich.edu 2062810Srdreslin@umich.edu class Params 2072810Srdreslin@umich.edu { 2082810Srdreslin@umich.edu public: 2092810Srdreslin@umich.edu TagStore *tags; 2102810Srdreslin@umich.edu BaseCache::Params baseParams; 2113861Sstever@eecs.umich.edu BasePrefetcher*prefetcher; 2122810Srdreslin@umich.edu bool prefetchAccess; 2133860Sstever@eecs.umich.edu const bool doFastWrites; 2143860Sstever@eecs.umich.edu const bool prefetchMiss; 2152810Srdreslin@umich.edu 2164672Sstever@eecs.umich.edu Params(TagStore *_tags, 2173315Sstever@eecs.umich.edu BaseCache::Params params, 2183861Sstever@eecs.umich.edu BasePrefetcher *_prefetcher, 2193860Sstever@eecs.umich.edu bool prefetch_access, int hit_latency, 2203860Sstever@eecs.umich.edu bool do_fast_writes, 2213860Sstever@eecs.umich.edu bool prefetch_miss) 2224672Sstever@eecs.umich.edu : tags(_tags), 2233315Sstever@eecs.umich.edu baseParams(params), 2242813Srdreslin@umich.edu prefetcher(_prefetcher), prefetchAccess(prefetch_access), 2253860Sstever@eecs.umich.edu doFastWrites(do_fast_writes), 2264626Sstever@eecs.umich.edu prefetchMiss(prefetch_miss) 2272810Srdreslin@umich.edu { 2282810Srdreslin@umich.edu } 2292810Srdreslin@umich.edu }; 2302810Srdreslin@umich.edu 2312810Srdreslin@umich.edu /** Instantiates a basic cache object. */ 2322812Srdreslin@umich.edu Cache(const std::string &_name, Params ¶ms); 2332810Srdreslin@umich.edu 2343738Sstever@eecs.umich.edu virtual Port *getPort(const std::string &if_name, int idx = -1); 2354190Ssaidi@eecs.umich.edu virtual void deletePortRefs(Port *p); 2362813Srdreslin@umich.edu 2372810Srdreslin@umich.edu void regStats(); 2382810Srdreslin@umich.edu 2392810Srdreslin@umich.edu /** 2402810Srdreslin@umich.edu * Performs the access specified by the request. 2412982Sstever@eecs.umich.edu * @param pkt The request to perform. 2422810Srdreslin@umich.edu * @return The result of the access. 2432810Srdreslin@umich.edu */ 2444626Sstever@eecs.umich.edu bool timingAccess(PacketPtr pkt); 2452810Srdreslin@umich.edu 2462810Srdreslin@umich.edu /** 2474626Sstever@eecs.umich.edu * Performs the access specified by the request. 2484626Sstever@eecs.umich.edu * @param pkt The request to perform. 2494626Sstever@eecs.umich.edu * @return The result of the access. 2502810Srdreslin@umich.edu */ 2514626Sstever@eecs.umich.edu Tick atomicAccess(PacketPtr pkt); 2522810Srdreslin@umich.edu 2532810Srdreslin@umich.edu /** 2544626Sstever@eecs.umich.edu * Performs the access specified by the request. 2554626Sstever@eecs.umich.edu * @param pkt The request to perform. 2564626Sstever@eecs.umich.edu * @return The result of the access. 2572810Srdreslin@umich.edu */ 2584626Sstever@eecs.umich.edu void functionalAccess(PacketPtr pkt, CachePort *otherSidePort); 2593293Srdreslin@umich.edu 2603293Srdreslin@umich.edu /** 2612810Srdreslin@umich.edu * Handles a response (cache line fill/write ack) from the bus. 2622982Sstever@eecs.umich.edu * @param pkt The request being responded to. 2632810Srdreslin@umich.edu */ 2644626Sstever@eecs.umich.edu void handleResponse(PacketPtr pkt); 2652810Srdreslin@umich.edu 2662810Srdreslin@umich.edu /** 2672810Srdreslin@umich.edu * Snoops bus transactions to maintain coherence. 2682982Sstever@eecs.umich.edu * @param pkt The current bus transaction. 2692810Srdreslin@umich.edu */ 2704626Sstever@eecs.umich.edu void snoopTiming(PacketPtr pkt); 2712810Srdreslin@umich.edu 2724626Sstever@eecs.umich.edu /** 2734626Sstever@eecs.umich.edu * Snoop for the provided request in the cache and return the estimated 2744626Sstever@eecs.umich.edu * time of completion. 2754626Sstever@eecs.umich.edu * @param pkt The memory request to snoop 2764626Sstever@eecs.umich.edu * @return The estimated completion time. 2774626Sstever@eecs.umich.edu */ 2784626Sstever@eecs.umich.edu Tick snoopAtomic(PacketPtr pkt); 2792810Srdreslin@umich.edu 2802810Srdreslin@umich.edu /** 2812982Sstever@eecs.umich.edu * Squash all requests associated with specified thread. 2822810Srdreslin@umich.edu * intended for use by I-cache. 2832982Sstever@eecs.umich.edu * @param threadNum The thread to squash. 2842810Srdreslin@umich.edu */ 2854626Sstever@eecs.umich.edu void squash(int threadNum); 2864626Sstever@eecs.umich.edu 2874626Sstever@eecs.umich.edu /** 2884626Sstever@eecs.umich.edu * Selects a outstanding request to service. 2894626Sstever@eecs.umich.edu * @return The request to service, NULL if none found. 2904626Sstever@eecs.umich.edu */ 2914628Sstever@eecs.umich.edu PacketPtr getBusPacket(PacketPtr cpu_pkt, BlkType *blk, 2924628Sstever@eecs.umich.edu bool needsExclusive); 2934626Sstever@eecs.umich.edu MSHR *getNextMSHR(); 2944628Sstever@eecs.umich.edu PacketPtr getTimingPacket(); 2954626Sstever@eecs.umich.edu 2964626Sstever@eecs.umich.edu /** 2974626Sstever@eecs.umich.edu * Marks a request as in service (sent on the bus). This can have side 2984626Sstever@eecs.umich.edu * effect since storage for no response commands is deallocated once they 2994626Sstever@eecs.umich.edu * are successfully sent. 3004626Sstever@eecs.umich.edu * @param pkt The request that was sent on the bus. 3014626Sstever@eecs.umich.edu */ 3024626Sstever@eecs.umich.edu void markInService(MSHR *mshr); 3034626Sstever@eecs.umich.edu 3044626Sstever@eecs.umich.edu /** 3054626Sstever@eecs.umich.edu * Perform the given writeback request. 3064626Sstever@eecs.umich.edu * @param pkt The writeback request. 3074626Sstever@eecs.umich.edu */ 3084626Sstever@eecs.umich.edu void doWriteback(PacketPtr pkt); 3094626Sstever@eecs.umich.edu 3104626Sstever@eecs.umich.edu /** 3114626Sstever@eecs.umich.edu * Return whether there are any outstanding misses. 3124626Sstever@eecs.umich.edu */ 3134626Sstever@eecs.umich.edu bool outstandingMisses() const 3142810Srdreslin@umich.edu { 3154626Sstever@eecs.umich.edu return mshrQueue.allocated != 0; 3162810Srdreslin@umich.edu } 3172810Srdreslin@umich.edu 3184626Sstever@eecs.umich.edu CacheBlk *findBlock(Addr addr) { 3194626Sstever@eecs.umich.edu return tags->findBlock(addr); 3202810Srdreslin@umich.edu } 3212810Srdreslin@umich.edu 3223861Sstever@eecs.umich.edu bool inCache(Addr addr) { 3233861Sstever@eecs.umich.edu return (tags->findBlock(addr) != 0); 3243861Sstever@eecs.umich.edu } 3253861Sstever@eecs.umich.edu 3263861Sstever@eecs.umich.edu bool inMissQueue(Addr addr) { 3274626Sstever@eecs.umich.edu return (mshrQueue.findMatch(addr) != 0); 3283861Sstever@eecs.umich.edu } 3292810Srdreslin@umich.edu}; 3302810Srdreslin@umich.edu 3312810Srdreslin@umich.edu#endif // __CACHE_HH__ 332