2 * Copyright (c) 2012-2018 ARM Limited
5 * The license below extends only to copyright in the software and shall
6 * not be construed as granting a license to any other intellectual
7 * property including but not limited to intellectual property relating
8 * to a hardware implementation of the functionality of the software
9 * licensed hereunder. You may use the software subject to the license
10 * terms below provided that you ensure that this notice is replicated
11 * unmodified and in its entirety in all distributions of the software,
12 * modified or unmodified, in source code or in binary form.
14 * Copyright (c) 2003-2005 The Regents of The University of Michigan
15 * All rights reserved.
17 * Redistribution and use in source and binary forms, with or without
18 * modification, are permitted provided that the following conditions are
19 * met: redistributions of source code must retain the above copyright
20 * notice, this list of conditions and the following disclaimer;
21 * redistributions in binary form must reproduce the above copyright
22 * notice, this list of conditions and the following disclaimer in the
23 * documentation and/or other materials provided with the distribution;
24 * neither the name of the copyright holders nor the names of its
25 * contributors may be used to endorse or promote products derived from
26 * this software without specific prior written permission.
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40 * Authors: Erik Hallnor
45 * Definitions of a simple cache block class.
48 #ifndef __MEM_CACHE_CACHE_BLK_HH__
49 #define __MEM_CACHE_CACHE_BLK_HH__
57 #include "base/printable.hh"
58 #include "base/types.hh"
59 #include "mem/cache/replacement_policies/base.hh"
60 #include "mem/packet.hh"
61 #include "mem/request.hh"
64 * Cache block status bit assignments
66 enum CacheBlkStatusBits : unsigned {
67 /** valid, readable */
69 /** write permission */
71 /** read permission (yes, block can be valid but not readable) */
73 /** dirty (modified) */
75 /** block was a hardware prefetch yet unaccessed*/
76 BlkHWPrefetched = 0x20,
77 /** block holds data from the secure memory space */
82 * A Basic Cache block.
83 * Contains the tag, status, and a pointer to data.
85 class CacheBlk : public ReplaceableEntry
88 /** Task Id associated with this block */
91 /** Data block tag value. */
94 * Contains a copy of the data in this block for easy access. This is used
95 * for efficient execution when the data could be actually stored in
96 * another format (COW, compressed, sub-blocked, etc). In all cases the
97 * data stored here should be kept consistant with the actual data
98 * referenced by this block.
102 /** block state: OR of CacheBlkStatusBit */
103 typedef unsigned State;
105 /** The current status of this block. @sa CacheBlockStatusBits */
108 /** Which curTick() will this block be accessible */
111 /** Number of references to this block since it was brought in. */
114 /** holds the source requestor ID for this block. */
117 /** Tick on which the block was inserted in the cache. */
122 * Represents that the indicated thread context has a "lock" on
123 * the block, in the LL/SC sense.
127 ContextID contextId; // locking context
128 Addr lowAddr; // low address of lock range
129 Addr highAddr; // high address of lock range
131 // check for matching execution context, and an address that
132 // is within the lock
133 bool matches(const RequestPtr &req) const
135 Addr req_low = req->getPaddr();
136 Addr req_high = req_low + req->getSize() -1;
137 return (contextId == req->contextId()) &&
138 (req_low >= lowAddr) && (req_high <= highAddr);
141 // check if a request is intersecting and thus invalidating the lock
142 bool intersects(const RequestPtr &req) const
144 Addr req_low = req->getPaddr();
145 Addr req_high = req_low + req->getSize() - 1;
147 return (req_low <= highAddr) && (req_high >= lowAddr);
150 Lock(const RequestPtr &req)
151 : contextId(req->contextId()),
152 lowAddr(req->getPaddr()),
153 highAddr(lowAddr + req->getSize() - 1)
158 /** List of thread contexts that have performed a load-locked (LL)
159 * on the block since the last store. */
160 std::list<Lock> lockList;
163 CacheBlk() : data(nullptr)
168 CacheBlk(const CacheBlk&) = delete;
169 CacheBlk& operator=(const CacheBlk&) = delete;
170 virtual ~CacheBlk() {};
173 * Checks the write permissions of this block.
174 * @return True if the block is writable.
176 bool isWritable() const
178 const State needed_bits = BlkWritable | BlkValid;
179 return (status & needed_bits) == needed_bits;
183 * Checks the read permissions of this block. Note that a block
184 * can be valid but not readable if there is an outstanding write
186 * @return True if the block is readable.
188 bool isReadable() const
190 const State needed_bits = BlkReadable | BlkValid;
191 return (status & needed_bits) == needed_bits;
195 * Checks that a block is valid.
196 * @return True if the block is valid.
200 return (status & BlkValid) != 0;
204 * Invalidate the block and clear all state.
206 virtual void invalidate()
209 task_id = ContextSwitchTaskId::Unknown;
213 srcMasterId = Request::invldMasterId;
214 tickInserted = MaxTick;
219 * Check to see if a block has been written.
220 * @return True if the block is dirty.
224 return (status & BlkDirty) != 0;
228 * Check if this block was the result of a hardware prefetch, yet to
230 * @return True if the block was a hardware prefetch, unaccesed.
232 bool wasPrefetched() const
234 return (status & BlkHWPrefetched) != 0;
238 * Check if this block holds data from the secure memory space.
239 * @return True if the block holds data from the secure memory space.
241 bool isSecure() const
243 return (status & BlkSecure) != 0;
247 * Set member variables when a block insertion occurs. Resets reference
248 * count to 1 (the insertion counts as a reference), and touch block if
249 * it hadn't been touched previously. Sets the insertion tick to the
250 * current tick. Does not make block valid.
252 * @param tag Block address tag.
253 * @param is_secure Whether the block is in secure space or not.
254 * @param src_master_ID The source requestor ID.
255 * @param task_ID The new task ID.
257 virtual void insert(const Addr tag, const bool is_secure,
258 const int src_master_ID, const uint32_t task_ID);
261 * Track the fact that a local locked was issued to the
262 * block. Invalidate any previous LL to the same address.
264 void trackLoadLocked(PacketPtr pkt)
266 assert(pkt->isLLSC());
267 auto l = lockList.begin();
268 while (l != lockList.end()) {
269 if (l->intersects(pkt->req))
270 l = lockList.erase(l);
275 lockList.emplace_front(pkt->req);
279 * Clear the any load lock that intersect the request, and is from
280 * a different context.
282 void clearLoadLocks(const RequestPtr &req)
284 auto l = lockList.begin();
285 while (l != lockList.end()) {
286 if (l->intersects(req) && l->contextId != req->contextId()) {
287 l = lockList.erase(l);
295 * Pretty-print tag, set and way, and interpret state bits to readable form
296 * including mapping to a MOESI state.
298 * @return string with basic state information
300 virtual std::string print() const
308 * state writable dirty valid
315 * Note that only one cache ever has a block in Modified or
316 * Owned state, i.e., only one cache owns the block, or
317 * equivalently has the BlkDirty bit set. However, multiple
318 * caches on the same path to memory can have a block in the
319 * Exclusive state (despite the name). Exclusive means this
320 * cache has the only copy at this level of the hierarchy,
321 * i.e., there may be copies in caches above this cache (in
322 * various states), but there are no peers that have copies on
323 * this branch of the hierarchy, and no caches at or above
324 * this level on any other branch have copies either.
326 unsigned state = isWritable() << 2 | isDirty() << 1 | isValid();
329 case 0b111: s = 'M'; break;
330 case 0b011: s = 'O'; break;
331 case 0b101: s = 'E'; break;
332 case 0b001: s = 'S'; break;
333 case 0b000: s = 'I'; break;
334 default: s = 'T'; break; // @TODO add other types
336 return csprintf("state: %x (%c) valid: %d writable: %d readable: %d "
337 "dirty: %d | tag: %#x set: %#x way: %#x", status, s,
338 isValid(), isWritable(), isReadable(), isDirty(), tag,
343 * Handle interaction of load-locked operations and stores.
344 * @return True if write should proceed, false otherwise. Returns
345 * false only in the case of a failed store conditional.
347 bool checkWrite(PacketPtr pkt)
349 assert(pkt->isWrite());
352 if (!pkt->isLLSC() && lockList.empty())
355 const RequestPtr &req = pkt->req;
358 // it's a store conditional... have to check for matching
360 bool success = false;
362 auto l = lockList.begin();
363 while (!success && l != lockList.end()) {
364 if (l->matches(pkt->req)) {
365 // it's a store conditional, and as far as the
366 // memory system can tell, the requesting
367 // context's lock is still valid.
375 req->setExtraData(success ? 1 : 0);
376 // clear any intersected locks from other contexts (our LL
377 // should already have cleared them)
381 // a normal write, if there is any lock not from this
382 // context we clear the list, thus for a private cache we
383 // never clear locks on normal writes
391 * Special instance of CacheBlk for use with tempBlk that deals with its
392 * block address regeneration.
395 class TempCacheBlk final : public CacheBlk
399 * Copy of the block's address, used to regenerate tempBlock's address.
405 * Creates a temporary cache block, with its own storage.
406 * @param size The size (in bytes) of this cache block.
408 TempCacheBlk(unsigned size) : CacheBlk()
410 data = new uint8_t[size];
412 TempCacheBlk(const TempCacheBlk&) = delete;
413 TempCacheBlk& operator=(const TempCacheBlk&) = delete;
414 ~TempCacheBlk() { delete [] data; };
417 * Invalidate the block and clear all state.
419 void invalidate() override {
420 CacheBlk::invalidate();
425 void insert(const Addr addr, const bool is_secure,
426 const int src_master_ID=0, const uint32_t task_ID=0) override
440 * Get block's address.
442 * @return addr Address value.
451 * Simple class to provide virtual print() method on cache blocks
452 * without allocating a vtable pointer for every single cache block.
453 * Just wrap the CacheBlk object in an instance of this before passing
454 * to a function that requires a Printable object.
456 class CacheBlkPrintWrapper : public Printable
460 CacheBlkPrintWrapper(CacheBlk *_blk) : blk(_blk) {}
461 virtual ~CacheBlkPrintWrapper() {}
462 void print(std::ostream &o, int verbosity = 0,
463 const std::string &prefix = "") const;
466 #endif //__MEM_CACHE_CACHE_BLK_HH__