cache.hh revision 5338
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 445338Sstever@gmail.com#include "mem/cache/base.hh" 455338Sstever@gmail.com#include "mem/cache/blk.hh" 465338Sstever@gmail.com#include "mem/cache/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, 765314Sstever@gmail.com const std::string &_label, 774965Ssaidi@eecs.umich.edu std::vector<Range<Addr> > filterRanges); 783738Sstever@eecs.umich.edu 793738Sstever@eecs.umich.edu // BaseCache::CachePort just has a BaseCache *; this function 803738Sstever@eecs.umich.edu // lets us get back the type info we lost when we stored the 813738Sstever@eecs.umich.edu // cache pointer there. 824672Sstever@eecs.umich.edu Cache<TagStore> *myCache() { 834672Sstever@eecs.umich.edu return static_cast<Cache<TagStore> *>(cache); 843738Sstever@eecs.umich.edu } 853738Sstever@eecs.umich.edu 864478Sstever@eecs.umich.edu virtual void getDeviceAddressRanges(AddrRangeList &resp, 874478Sstever@eecs.umich.edu bool &snoop); 884478Sstever@eecs.umich.edu 893738Sstever@eecs.umich.edu virtual bool recvTiming(PacketPtr pkt); 903738Sstever@eecs.umich.edu 913738Sstever@eecs.umich.edu virtual Tick recvAtomic(PacketPtr pkt); 923738Sstever@eecs.umich.edu 933738Sstever@eecs.umich.edu virtual void recvFunctional(PacketPtr pkt); 943738Sstever@eecs.umich.edu }; 953738Sstever@eecs.umich.edu 963738Sstever@eecs.umich.edu class MemSidePort : public CachePort 973738Sstever@eecs.umich.edu { 983738Sstever@eecs.umich.edu public: 993738Sstever@eecs.umich.edu MemSidePort(const std::string &_name, 1004965Ssaidi@eecs.umich.edu Cache<TagStore> *_cache, 1015314Sstever@gmail.com const std::string &_label, 1024965Ssaidi@eecs.umich.edu std::vector<Range<Addr> > filterRanges); 1033738Sstever@eecs.umich.edu 1043738Sstever@eecs.umich.edu // BaseCache::CachePort just has a BaseCache *; this function 1053738Sstever@eecs.umich.edu // lets us get back the type info we lost when we stored the 1063738Sstever@eecs.umich.edu // cache pointer there. 1074672Sstever@eecs.umich.edu Cache<TagStore> *myCache() { 1084672Sstever@eecs.umich.edu return static_cast<Cache<TagStore> *>(cache); 1093738Sstever@eecs.umich.edu } 1103738Sstever@eecs.umich.edu 1114626Sstever@eecs.umich.edu void sendPacket(); 1124626Sstever@eecs.umich.edu 1134626Sstever@eecs.umich.edu void processSendEvent(); 1144458Sstever@eecs.umich.edu 1154478Sstever@eecs.umich.edu virtual void getDeviceAddressRanges(AddrRangeList &resp, 1164478Sstever@eecs.umich.edu bool &snoop); 1174478Sstever@eecs.umich.edu 1183738Sstever@eecs.umich.edu virtual bool recvTiming(PacketPtr pkt); 1193738Sstever@eecs.umich.edu 1204458Sstever@eecs.umich.edu virtual void recvRetry(); 1214458Sstever@eecs.umich.edu 1223738Sstever@eecs.umich.edu virtual Tick recvAtomic(PacketPtr pkt); 1233738Sstever@eecs.umich.edu 1243738Sstever@eecs.umich.edu virtual void recvFunctional(PacketPtr pkt); 1254458Sstever@eecs.umich.edu 1264626Sstever@eecs.umich.edu typedef EventWrapper<MemSidePort, &MemSidePort::processSendEvent> 1274626Sstever@eecs.umich.edu SendEvent; 1283738Sstever@eecs.umich.edu }; 1293738Sstever@eecs.umich.edu 1302810Srdreslin@umich.edu /** Tag and data Storage */ 1312810Srdreslin@umich.edu TagStore *tags; 1324626Sstever@eecs.umich.edu 1332810Srdreslin@umich.edu /** Prefetcher */ 1343861Sstever@eecs.umich.edu BasePrefetcher *prefetcher; 1352810Srdreslin@umich.edu 1364671Sstever@eecs.umich.edu /** Temporary cache block for occasional transitory use */ 1374671Sstever@eecs.umich.edu BlkType *tempBlock; 1384671Sstever@eecs.umich.edu 1392810Srdreslin@umich.edu /** 1403860Sstever@eecs.umich.edu * Can this cache should allocate a block on a line-sized write miss. 1413860Sstever@eecs.umich.edu */ 1423860Sstever@eecs.umich.edu const bool doFastWrites; 1433860Sstever@eecs.umich.edu 1443860Sstever@eecs.umich.edu const bool prefetchMiss; 1453860Sstever@eecs.umich.edu 1463860Sstever@eecs.umich.edu /** 1473860Sstever@eecs.umich.edu * Handle a replacement for the given request. 1483860Sstever@eecs.umich.edu * @param blk A pointer to the block, usually NULL 1493860Sstever@eecs.umich.edu * @param pkt The memory request to satisfy. 1503860Sstever@eecs.umich.edu * @param new_state The new state of the block. 1513860Sstever@eecs.umich.edu * @param writebacks A list to store any generated writebacks. 1523860Sstever@eecs.umich.edu */ 1534626Sstever@eecs.umich.edu BlkType* doReplacement(BlkType *blk, PacketPtr pkt, 1543860Sstever@eecs.umich.edu CacheBlk::State new_state, PacketList &writebacks); 1553860Sstever@eecs.umich.edu 1563860Sstever@eecs.umich.edu /** 1573860Sstever@eecs.umich.edu * Does all the processing necessary to perform the provided request. 1583860Sstever@eecs.umich.edu * @param pkt The memory request to perform. 1593860Sstever@eecs.umich.edu * @param lat The latency of the access. 1603860Sstever@eecs.umich.edu * @param writebacks List for any writebacks that need to be performed. 1613860Sstever@eecs.umich.edu * @param update True if the replacement data should be updated. 1623860Sstever@eecs.umich.edu * @return Pointer to the cache block touched by the request. NULL if it 1633860Sstever@eecs.umich.edu * was a miss. 1643860Sstever@eecs.umich.edu */ 1654628Sstever@eecs.umich.edu bool access(PacketPtr pkt, BlkType *&blk, int &lat); 1664219Srdreslin@umich.edu 1674219Srdreslin@umich.edu /** 1684219Srdreslin@umich.edu *Handle doing the Compare and Swap function for SPARC. 1694219Srdreslin@umich.edu */ 1704626Sstever@eecs.umich.edu void cmpAndSwap(BlkType *blk, PacketPtr pkt); 1713860Sstever@eecs.umich.edu 1723860Sstever@eecs.umich.edu /** 1733860Sstever@eecs.umich.edu * Populates a cache block and handles all outstanding requests for the 1743860Sstever@eecs.umich.edu * satisfied fill request. This version takes two memory requests. One 1753860Sstever@eecs.umich.edu * contains the fill data, the other is an optional target to satisfy. 1763860Sstever@eecs.umich.edu * Used for Cache::probe. 1774626Sstever@eecs.umich.edu * @param pkt The memory request with the fill data. 1783860Sstever@eecs.umich.edu * @param blk The cache block if it already exists. 1793860Sstever@eecs.umich.edu * @param writebacks List for any writebacks that need to be performed. 1803860Sstever@eecs.umich.edu * @return Pointer to the new cache block. 1813860Sstever@eecs.umich.edu */ 1824626Sstever@eecs.umich.edu BlkType *handleFill(PacketPtr pkt, BlkType *blk, 1834626Sstever@eecs.umich.edu PacketList &writebacks); 1843860Sstever@eecs.umich.edu 1854665Sstever@eecs.umich.edu void satisfyCpuSideRequest(PacketPtr pkt, BlkType *blk); 1864628Sstever@eecs.umich.edu bool satisfyMSHR(MSHR *mshr, PacketPtr pkt, BlkType *blk); 1874626Sstever@eecs.umich.edu 1884670Sstever@eecs.umich.edu void doTimingSupplyResponse(PacketPtr req_pkt, uint8_t *blk_data, 1895319Sstever@gmail.com bool already_copied, bool pending_inval); 1903860Sstever@eecs.umich.edu 1913860Sstever@eecs.umich.edu /** 1923860Sstever@eecs.umich.edu * Sets the blk to the new state. 1933860Sstever@eecs.umich.edu * @param blk The cache block being snooped. 1943860Sstever@eecs.umich.edu * @param new_state The new coherence state for the block. 1953860Sstever@eecs.umich.edu */ 1964670Sstever@eecs.umich.edu void handleSnoop(PacketPtr ptk, BlkType *blk, 1975319Sstever@gmail.com bool is_timing, bool is_deferred, bool pending_inval); 1983860Sstever@eecs.umich.edu 1993860Sstever@eecs.umich.edu /** 2003860Sstever@eecs.umich.edu * Create a writeback request for the given block. 2013860Sstever@eecs.umich.edu * @param blk The block to writeback. 2023860Sstever@eecs.umich.edu * @return The writeback request for the block. 2033860Sstever@eecs.umich.edu */ 2043860Sstever@eecs.umich.edu PacketPtr writebackBlk(BlkType *blk); 2053860Sstever@eecs.umich.edu 2062810Srdreslin@umich.edu public: 2072810Srdreslin@umich.edu /** Instantiates a basic cache object. */ 2085034Smilesck@eecs.umich.edu Cache(const Params *p, TagStore *tags, BasePrefetcher *prefetcher); 2092810Srdreslin@umich.edu 2103738Sstever@eecs.umich.edu virtual Port *getPort(const std::string &if_name, int idx = -1); 2114190Ssaidi@eecs.umich.edu virtual void deletePortRefs(Port *p); 2122813Srdreslin@umich.edu 2132810Srdreslin@umich.edu void regStats(); 2142810Srdreslin@umich.edu 2152810Srdreslin@umich.edu /** 2162810Srdreslin@umich.edu * Performs the access specified by the request. 2172982Sstever@eecs.umich.edu * @param pkt The request to perform. 2182810Srdreslin@umich.edu * @return The result of the access. 2192810Srdreslin@umich.edu */ 2204626Sstever@eecs.umich.edu bool timingAccess(PacketPtr pkt); 2212810Srdreslin@umich.edu 2222810Srdreslin@umich.edu /** 2234626Sstever@eecs.umich.edu * Performs the access specified by the request. 2244626Sstever@eecs.umich.edu * @param pkt The request to perform. 2254626Sstever@eecs.umich.edu * @return The result of the access. 2262810Srdreslin@umich.edu */ 2274626Sstever@eecs.umich.edu Tick atomicAccess(PacketPtr pkt); 2282810Srdreslin@umich.edu 2292810Srdreslin@umich.edu /** 2304626Sstever@eecs.umich.edu * Performs the access specified by the request. 2314626Sstever@eecs.umich.edu * @param pkt The request to perform. 2324626Sstever@eecs.umich.edu * @return The result of the access. 2332810Srdreslin@umich.edu */ 2345314Sstever@gmail.com void functionalAccess(PacketPtr pkt, CachePort *incomingPort, 2355314Sstever@gmail.com CachePort *otherSidePort); 2363293Srdreslin@umich.edu 2373293Srdreslin@umich.edu /** 2382810Srdreslin@umich.edu * Handles a response (cache line fill/write ack) from the bus. 2392982Sstever@eecs.umich.edu * @param pkt The request being responded to. 2402810Srdreslin@umich.edu */ 2414626Sstever@eecs.umich.edu void handleResponse(PacketPtr pkt); 2422810Srdreslin@umich.edu 2432810Srdreslin@umich.edu /** 2442810Srdreslin@umich.edu * Snoops bus transactions to maintain coherence. 2452982Sstever@eecs.umich.edu * @param pkt The current bus transaction. 2462810Srdreslin@umich.edu */ 2474626Sstever@eecs.umich.edu void snoopTiming(PacketPtr pkt); 2482810Srdreslin@umich.edu 2494626Sstever@eecs.umich.edu /** 2504626Sstever@eecs.umich.edu * Snoop for the provided request in the cache and return the estimated 2514626Sstever@eecs.umich.edu * time of completion. 2524626Sstever@eecs.umich.edu * @param pkt The memory request to snoop 2534626Sstever@eecs.umich.edu * @return The estimated completion time. 2544626Sstever@eecs.umich.edu */ 2554626Sstever@eecs.umich.edu Tick snoopAtomic(PacketPtr pkt); 2562810Srdreslin@umich.edu 2572810Srdreslin@umich.edu /** 2582982Sstever@eecs.umich.edu * Squash all requests associated with specified thread. 2592810Srdreslin@umich.edu * intended for use by I-cache. 2602982Sstever@eecs.umich.edu * @param threadNum The thread to squash. 2612810Srdreslin@umich.edu */ 2624626Sstever@eecs.umich.edu void squash(int threadNum); 2634626Sstever@eecs.umich.edu 2644626Sstever@eecs.umich.edu /** 2654626Sstever@eecs.umich.edu * Selects a outstanding request to service. 2664626Sstever@eecs.umich.edu * @return The request to service, NULL if none found. 2674626Sstever@eecs.umich.edu */ 2684628Sstever@eecs.umich.edu PacketPtr getBusPacket(PacketPtr cpu_pkt, BlkType *blk, 2694628Sstever@eecs.umich.edu bool needsExclusive); 2704626Sstever@eecs.umich.edu MSHR *getNextMSHR(); 2714628Sstever@eecs.umich.edu PacketPtr getTimingPacket(); 2724626Sstever@eecs.umich.edu 2734626Sstever@eecs.umich.edu /** 2744626Sstever@eecs.umich.edu * Marks a request as in service (sent on the bus). This can have side 2754626Sstever@eecs.umich.edu * effect since storage for no response commands is deallocated once they 2764626Sstever@eecs.umich.edu * are successfully sent. 2774626Sstever@eecs.umich.edu * @param pkt The request that was sent on the bus. 2784626Sstever@eecs.umich.edu */ 2794626Sstever@eecs.umich.edu void markInService(MSHR *mshr); 2804626Sstever@eecs.umich.edu 2814626Sstever@eecs.umich.edu /** 2824626Sstever@eecs.umich.edu * Perform the given writeback request. 2834626Sstever@eecs.umich.edu * @param pkt The writeback request. 2844626Sstever@eecs.umich.edu */ 2854626Sstever@eecs.umich.edu void doWriteback(PacketPtr pkt); 2864626Sstever@eecs.umich.edu 2874626Sstever@eecs.umich.edu /** 2884626Sstever@eecs.umich.edu * Return whether there are any outstanding misses. 2894626Sstever@eecs.umich.edu */ 2904626Sstever@eecs.umich.edu bool outstandingMisses() const 2912810Srdreslin@umich.edu { 2924626Sstever@eecs.umich.edu return mshrQueue.allocated != 0; 2932810Srdreslin@umich.edu } 2942810Srdreslin@umich.edu 2954626Sstever@eecs.umich.edu CacheBlk *findBlock(Addr addr) { 2964626Sstever@eecs.umich.edu return tags->findBlock(addr); 2972810Srdreslin@umich.edu } 2982810Srdreslin@umich.edu 2993861Sstever@eecs.umich.edu bool inCache(Addr addr) { 3003861Sstever@eecs.umich.edu return (tags->findBlock(addr) != 0); 3013861Sstever@eecs.umich.edu } 3023861Sstever@eecs.umich.edu 3033861Sstever@eecs.umich.edu bool inMissQueue(Addr addr) { 3044626Sstever@eecs.umich.edu return (mshrQueue.findMatch(addr) != 0); 3053861Sstever@eecs.umich.edu } 3062810Srdreslin@umich.edu}; 3072810Srdreslin@umich.edu 3082810Srdreslin@umich.edu#endif // __CACHE_HH__ 309