2 * Copyright (c) 2002-2005 The Regents of The University of Michigan
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met: redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer;
9 * redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution;
12 * neither the name of the copyright holders nor the names of its
13 * contributors may be used to endorse or promote products derived from
14 * this software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 * Authors: Erik Hallnor
36 * Describes a cache based on template policies.
42 #include "base/compression/base.hh"
43 #include "base/misc.hh" // fatal, panic, and warn
44 #include "cpu/smt.hh" // SMT_MAX_THREADS
46 #include "mem/cache/base_cache.hh"
47 #include "mem/cache/cache_blk.hh"
48 #include "mem/cache/miss/mshr.hh"
50 #include "sim/eventq.hh"
56 * A template-policy based cache. The behavior of the cache can be altered by
57 * supplying different template policies. TagStore handles all tag and data
58 * storage @sa TagStore. Buffering handles all misses and writes/writebacks
59 * @sa MissQueue. Coherence handles all coherence policy details @sa
60 * UniCoherence, SimpleMultiCoherence.
62 template <class TagStore, class Coherence>
63 class Cache : public BaseCache
66 /** Define the type of cache block to use. */
67 typedef typename TagStore::BlkType BlkType;
68 /** A typedef for a list of BlkType pointers. */
69 typedef typename TagStore::BlkList BlkList;
75 class CpuSidePort : public CachePort
78 CpuSidePort(const std::string &_name,
79 Cache<TagStore,Coherence> *_cache);
81 // BaseCache::CachePort just has a BaseCache *; this function
82 // lets us get back the type info we lost when we stored the
83 // cache pointer there.
84 Cache<TagStore,Coherence> *myCache() {
85 return static_cast<Cache<TagStore,Coherence> *>(cache);
88 virtual void getDeviceAddressRanges(AddrRangeList &resp,
91 virtual bool recvTiming(PacketPtr pkt);
93 virtual Tick recvAtomic(PacketPtr pkt);
95 virtual void recvFunctional(PacketPtr pkt);
98 class MemSidePort : public CachePort
101 MemSidePort(const std::string &_name,
102 Cache<TagStore,Coherence> *_cache);
104 // BaseCache::CachePort just has a BaseCache *; this function
105 // lets us get back the type info we lost when we stored the
106 // cache pointer there.
107 Cache<TagStore,Coherence> *myCache() {
108 return static_cast<Cache<TagStore,Coherence> *>(cache);
113 void processSendEvent();
115 virtual void getDeviceAddressRanges(AddrRangeList &resp,
118 virtual bool recvTiming(PacketPtr pkt);
120 virtual void recvRetry();
122 virtual Tick recvAtomic(PacketPtr pkt);
124 virtual void recvFunctional(PacketPtr pkt);
126 typedef EventWrapper<MemSidePort, &MemSidePort::processSendEvent>
130 /** Tag and data Storage */
133 /** Coherence protocol. */
134 Coherence *coherence;
137 BasePrefetcher *prefetcher;
140 * Can this cache should allocate a block on a line-sized write miss.
142 const bool doFastWrites;
144 const bool prefetchMiss;
147 * Handle a replacement for the given request.
148 * @param blk A pointer to the block, usually NULL
149 * @param pkt The memory request to satisfy.
150 * @param new_state The new state of the block.
151 * @param writebacks A list to store any generated writebacks.
153 BlkType* doReplacement(BlkType *blk, PacketPtr pkt,
154 CacheBlk::State new_state, PacketList &writebacks);
157 * Does all the processing necessary to perform the provided request.
158 * @param pkt The memory request to perform.
159 * @param lat The latency of the access.
160 * @param writebacks List for any writebacks that need to be performed.
161 * @param update True if the replacement data should be updated.
162 * @return Pointer to the cache block touched by the request. NULL if it
165 bool access(PacketPtr pkt, BlkType *&blk, int &lat);
168 *Handle doing the Compare and Swap function for SPARC.
170 void cmpAndSwap(BlkType *blk, PacketPtr pkt);
173 * Populates a cache block and handles all outstanding requests for the
174 * satisfied fill request. This version takes two memory requests. One
175 * contains the fill data, the other is an optional target to satisfy.
176 * Used for Cache::probe.
177 * @param pkt The memory request with the fill data.
178 * @param blk The cache block if it already exists.
179 * @param writebacks List for any writebacks that need to be performed.
180 * @return Pointer to the new cache block.
182 BlkType *handleFill(PacketPtr pkt, BlkType *blk,
183 PacketList &writebacks);
185 void satisfyCpuSideRequest(PacketPtr pkt, BlkType *blk);
186 bool satisfyMSHR(MSHR *mshr, PacketPtr pkt, BlkType *blk);
188 void doTimingSupplyResponse(PacketPtr req_pkt, uint8_t *blk_data,
189 bool already_copied);
192 * Sets the blk to the new state.
193 * @param blk The cache block being snooped.
194 * @param new_state The new coherence state for the block.
196 void handleSnoop(PacketPtr ptk, BlkType *blk,
197 bool is_timing, bool is_deferred);
200 * Create a writeback request for the given block.
201 * @param blk The block to writeback.
202 * @return The writeback request for the block.
204 PacketPtr writebackBlk(BlkType *blk);
212 Coherence *coherence;
213 BaseCache::Params baseParams;
214 BasePrefetcher*prefetcher;
216 const bool doFastWrites;
217 const bool prefetchMiss;
219 Params(TagStore *_tags, Coherence *coh,
220 BaseCache::Params params,
221 BasePrefetcher *_prefetcher,
222 bool prefetch_access, int hit_latency,
225 : tags(_tags), coherence(coh),
227 prefetcher(_prefetcher), prefetchAccess(prefetch_access),
228 doFastWrites(do_fast_writes),
229 prefetchMiss(prefetch_miss)
234 /** Instantiates a basic cache object. */
235 Cache(const std::string &_name, Params ¶ms);
237 virtual Port *getPort(const std::string &if_name, int idx = -1);
238 virtual void deletePortRefs(Port *p);
243 * Performs the access specified by the request.
244 * @param pkt The request to perform.
245 * @return The result of the access.
247 bool timingAccess(PacketPtr pkt);
250 * Performs the access specified by the request.
251 * @param pkt The request to perform.
252 * @return The result of the access.
254 Tick atomicAccess(PacketPtr pkt);
257 * Performs the access specified by the request.
258 * @param pkt The request to perform.
259 * @return The result of the access.
261 void functionalAccess(PacketPtr pkt, CachePort *otherSidePort);
264 * Handles a response (cache line fill/write ack) from the bus.
265 * @param pkt The request being responded to.
267 void handleResponse(PacketPtr pkt);
270 * Snoops bus transactions to maintain coherence.
271 * @param pkt The current bus transaction.
273 void snoopTiming(PacketPtr pkt);
276 * Snoop for the provided request in the cache and return the estimated
277 * time of completion.
278 * @param pkt The memory request to snoop
279 * @return The estimated completion time.
281 Tick snoopAtomic(PacketPtr pkt);
284 * Squash all requests associated with specified thread.
285 * intended for use by I-cache.
286 * @param threadNum The thread to squash.
288 void squash(int threadNum);
291 * Selects a outstanding request to service.
292 * @return The request to service, NULL if none found.
294 PacketPtr getBusPacket(PacketPtr cpu_pkt, BlkType *blk,
295 bool needsExclusive);
297 PacketPtr getTimingPacket();
300 * Marks a request as in service (sent on the bus). This can have side
301 * effect since storage for no response commands is deallocated once they
302 * are successfully sent.
303 * @param pkt The request that was sent on the bus.
305 void markInService(MSHR *mshr);
308 * Perform the given writeback request.
309 * @param pkt The writeback request.
311 void doWriteback(PacketPtr pkt);
314 * Return whether there are any outstanding misses.
316 bool outstandingMisses() const
318 return mshrQueue.allocated != 0;
321 CacheBlk *findBlock(Addr addr) {
322 return tags->findBlock(addr);
325 bool inCache(Addr addr) {
326 return (tags->findBlock(addr) != 0);
329 bool inMissQueue(Addr addr) {
330 return (mshrQueue.findMatch(addr) != 0);
334 #endif // __CACHE_HH__