2 * Copyright (c) 2003-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
33 * Declaration of a LRU tag store.
42 #include "mem/cache/cache_blk.hh" // base class
43 #include "mem/packet.hh" // for inlined functions
45 #include "mem/cache/tags/base_tags.hh"
52 class LRUBlk : public CacheBlk {
54 /** Has this block been touched? Used to aid calculation of warmup time. */
59 * An associative set of cache blocks.
64 /** The associativity of this set. */
67 /** Cache blocks in this set, maintained in LRU order 0 = MRU. */
71 * Find a block matching the tag in this set.
72 * @param asid The address space ID.
73 * @param tag The Tag to find.
74 * @return Pointer to the block if found.
76 LRUBlk* findBlk(Addr tag) const;
79 * Move the given block to the head of the list.
80 * @param blk The block to move.
82 void moveToHead(LRUBlk *blk);
86 * A LRU cache tag store.
88 class LRU : public BaseTags
91 /** Typedef the block type used in this tag store. */
92 typedef LRUBlk BlkType;
93 /** Typedef for a list of pointers to the local block class. */
94 typedef std::list<LRUBlk*> BlkList;
96 /** The number of sets in the cache. */
98 /** The number of bytes in a block. */
100 /** The associativity of the cache. */
102 /** The hit latency. */
103 const int hitLatency;
105 /** The cache sets. */
108 /** The cache blocks. */
110 /** The data blocks, 1 per cache block. */
113 /** The amount to shift the address to get the set. */
115 /** The amount to shift the address to get the tag. */
117 /** Mask out all bits that aren't part of the set index. */
119 /** Mask out all bits that aren't part of the block offset. */
124 * Construct and initialize this tag store.
125 * @param _numSets The number of sets in the cache.
126 * @param _blkSize The number of bytes in a block.
127 * @param _assoc The associativity of the cache.
128 * @param _hit_latency The latency in cycles for a hit.
130 LRU(int _numSets, int _blkSize, int _assoc, int _hit_latency);
138 * Return the block size.
139 * @return the block size.
147 * Return the subblock size. In the case of LRU it is always the block
149 * @return The block size.
151 int getSubBlockSize()
157 * Search for the address in the cache.
158 * @param asid The address space ID.
159 * @param addr The address to find.
160 * @return True if the address is in the cache.
162 bool probe(Addr addr) const;
165 * Invalidate the given block.
166 * @param blk The block to invalidate.
168 void invalidateBlk(BlkType *blk);
171 * Finds the given address in the cache and update replacement data.
172 * Returns the access latency as a side effect.
173 * @param addr The address to find.
174 * @param asid The address space ID.
175 * @param lat The access latency.
176 * @return Pointer to the cache block if found.
178 LRUBlk* findBlock(Addr addr, int &lat);
181 * Finds the given address in the cache, do not update replacement data.
182 * @param addr The address to find.
183 * @param asid The address space ID.
184 * @return Pointer to the cache block if found.
186 LRUBlk* findBlock(Addr addr) const;
189 * Find a replacement block for the address provided.
190 * @param pkt The request to a find a replacement candidate for.
191 * @param writebacks List for any writebacks to be performed.
192 * @return The block to place the replacement in.
194 LRUBlk* findReplacement(Addr addr, PacketList &writebacks);
197 * Generate the tag from the given address.
198 * @param addr The address to get the tag from.
199 * @return The tag of the address.
201 Addr extractTag(Addr addr) const
203 return (addr >> tagShift);
207 * Calculate the set index from the address.
208 * @param addr The address to get the set from.
209 * @return The set index of the address.
211 int extractSet(Addr addr) const
213 return ((addr >> setShift) & setMask);
217 * Get the block offset from an address.
218 * @param addr The address to get the offset of.
219 * @return The block offset.
221 int extractBlkOffset(Addr addr) const
223 return (addr & blkMask);
227 * Align an address to the block size.
228 * @param addr the address to align.
229 * @return The block address.
231 Addr blkAlign(Addr addr) const
233 return (addr & ~(Addr)blkMask);
237 * Regenerate the block address from the tag.
238 * @param tag The tag of the block.
239 * @param set The set of the block.
240 * @return The block address.
242 Addr regenerateBlkAddr(Addr tag, unsigned set) const
244 return ((tag << tagShift) | ((Addr)set << setShift));
248 * Return the hit latency.
249 * @return the hit latency.
251 int getHitLatency() const
257 * Read the data out of the internal storage of the given cache block.
258 * @param blk The cache block to read.
259 * @param data The buffer to read the data into.
260 * @return The cache block's data.
262 void readData(LRUBlk *blk, uint8_t *data)
264 std::memcpy(data, blk->data, blk->size);
268 * Write data into the internal storage of the given cache block. Since in
269 * LRU does not store data differently this just needs to update the size.
270 * @param blk The cache block to write.
271 * @param data The data to write.
272 * @param size The number of bytes to write.
273 * @param writebacks A list for any writebacks to be performed. May be
274 * needed when writing to a compressed block.
276 void writeData(LRUBlk *blk, uint8_t *data, int size,
277 PacketList & writebacks)
279 assert(size <= blkSize);
284 * Called at end of simulation to complete average block reference stats.
286 virtual void cleanupRefs();