Merge Gabe's changes from head.
[gem5.git] / src / mem / cache / tags / split_lru.cc
1 /*
2 * Copyright (c) 2004-2005 The Regents of The University of Michigan
3 * All rights reserved.
4 *
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.
15 *
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.
27 *
28 * Authors: Lisa Hsu
29 */
30
31 /**
32 * @file
33 * Definitions of LRU tag store for a partitioned cache.
34 */
35
36 #include <string>
37
38 #include "mem/cache/base_cache.hh"
39 #include "base/intmath.hh"
40 #include "mem/cache/tags/split_lru.hh"
41 #include "sim/core.hh"
42
43 using namespace std;
44
45 SplitBlk*
46 SplitCacheSet::findBlk(Addr tag) const
47 {
48 for (int i = 0; i < assoc; ++i) {
49 if (blks[i]->tag == tag && blks[i]->isValid()) {
50 return blks[i];
51 }
52 }
53 return 0;
54 }
55
56
57 void
58 SplitCacheSet::moveToHead(SplitBlk *blk)
59 {
60 // nothing to do if blk is already head
61 if (blks[0] == blk)
62 return;
63
64 // write 'next' block into blks[i], moving up from MRU toward LRU
65 // until we overwrite the block we moved to head.
66
67 // start by setting up to write 'blk' into blks[0]
68 int i = 0;
69 SplitBlk *next = blk;
70
71 do {
72 assert(i < assoc);
73 // swap blks[i] and next
74 SplitBlk *tmp = blks[i];
75 blks[i] = next;
76 next = tmp;
77 ++i;
78 } while (next != blk);
79 }
80
81
82 // create and initialize a LRU/MRU cache structure
83 SplitLRU::SplitLRU(int _numSets, int _blkSize, int _assoc, int _hit_latency, int _part) :
84 numSets(_numSets), blkSize(_blkSize), assoc(_assoc), hitLatency(_hit_latency), part(_part)
85 {
86 // Check parameters
87 if (blkSize < 4 || !isPowerOf2(blkSize)) {
88 fatal("Block size must be at least 4 and a power of 2");
89 }
90 if (numSets <= 0 || !isPowerOf2(numSets)) {
91 fatal("# of sets must be non-zero and a power of 2");
92 }
93 if (assoc <= 0) {
94 fatal("associativity must be greater than zero");
95 }
96 if (hitLatency <= 0) {
97 fatal("access latency must be greater than zero");
98 }
99
100 SplitBlk *blk;
101 int i, j, blkIndex;
102
103 blkMask = blkSize - 1;
104 setShift = floorLog2(blkSize);
105 setMask = numSets - 1;
106 tagShift = setShift + floorLog2(numSets);
107 warmedUp = false;
108 /** @todo Make warmup percentage a parameter. */
109 warmupBound = numSets * assoc;
110
111 sets = new SplitCacheSet[numSets];
112 blks = new SplitBlk[numSets * assoc];
113 // allocate data storage in one big chunk
114 dataBlks = new uint8_t[numSets*assoc*blkSize];
115
116 blkIndex = 0; // index into blks array
117 for (i = 0; i < numSets; ++i) {
118 sets[i].assoc = assoc;
119
120 sets[i].blks = new SplitBlk*[assoc];
121
122 // link in the data blocks
123 for (j = 0; j < assoc; ++j) {
124 // locate next cache block
125 blk = &blks[blkIndex];
126 blk->data = &dataBlks[blkSize*blkIndex];
127 ++blkIndex;
128
129 // invalidate new cache block
130 blk->status = 0;
131
132 //EGH Fix Me : do we need to initialize blk?
133
134 // Setting the tag to j is just to prevent long chains in the hash
135 // table; won't matter because the block is invalid
136 blk->tag = j;
137 blk->whenReady = 0;
138 blk->isTouched = false;
139 blk->size = blkSize;
140 sets[i].blks[j]=blk;
141 blk->set = i;
142 blk->part = part;
143 }
144 }
145 }
146
147 SplitLRU::~SplitLRU()
148 {
149 delete [] dataBlks;
150 delete [] blks;
151 delete [] sets;
152 }
153
154 void
155 SplitLRU::regStats(const std::string &name)
156 {
157 BaseTags::regStats(name);
158
159 hits
160 .name(name + ".hits")
161 .desc("number of hits on this partition")
162 .precision(0)
163 ;
164
165 misses
166 .name(name + ".misses")
167 .desc("number of misses in this partition")
168 .precision(0)
169 ;
170 }
171
172 // probe cache for presence of given block.
173 bool
174 SplitLRU::probe(Addr addr) const
175 {
176 // return(findBlock(Read, addr, asid) != 0);
177 Addr tag = extractTag(addr);
178 unsigned myset = extractSet(addr);
179
180 SplitBlk *blk = sets[myset].findBlk(tag);
181
182 return (blk != NULL); // true if in cache
183 }
184
185 SplitBlk*
186 SplitLRU::findBlock(Addr addr, int &lat)
187 {
188 Addr tag = extractTag(addr);
189 unsigned set = extractSet(addr);
190 SplitBlk *blk = sets[set].findBlk(tag);
191 lat = hitLatency;
192 if (blk != NULL) {
193 // move this block to head of the MRU list
194 sets[set].moveToHead(blk);
195 if (blk->whenReady > curTick && blk->whenReady - curTick > hitLatency){
196 lat = blk->whenReady - curTick;
197 }
198 blk->refCount += 1;
199 hits++;
200 }
201
202 return blk;
203 }
204
205
206 SplitBlk*
207 SplitLRU::findBlock(Addr addr) const
208 {
209 Addr tag = extractTag(addr);
210 unsigned set = extractSet(addr);
211 SplitBlk *blk = sets[set].findBlk(tag);
212 return blk;
213 }
214
215 SplitBlk*
216 SplitLRU::findReplacement(Addr addr, PacketList &writebacks)
217 {
218 unsigned set = extractSet(addr);
219 // grab a replacement candidate
220 SplitBlk *blk = sets[set].blks[assoc-1];
221 sets[set].moveToHead(blk);
222 if (blk->isValid()) {
223 replacements[0]++;
224 totalRefs += blk->refCount;
225 ++sampledRefs;
226 blk->refCount = 0;
227 } else if (!blk->isTouched) {
228 tagsInUse++;
229 blk->isTouched = true;
230 if (!warmedUp && tagsInUse.value() >= warmupBound) {
231 warmedUp = true;
232 warmupCycle = curTick;
233 }
234 }
235
236 misses++;
237
238 return blk;
239 }
240
241 void
242 SplitLRU::invalidateBlk(SplitLRU::BlkType *blk)
243 {
244 if (blk) {
245 blk->status = 0;
246 blk->isTouched = false;
247 tagsInUse--;
248 }
249 }
250
251 void
252 SplitLRU::cleanupRefs()
253 {
254 for (int i = 0; i < numSets*assoc; ++i) {
255 if (blks[i].isValid()) {
256 totalRefs += blks[i].refCount;
257 ++sampledRefs;
258 }
259 }
260 }