CacheMemory.hh revision 10969
112037Sandreas.sandberg@arm.com/* 212037Sandreas.sandberg@arm.com * Copyright (c) 1999-2012 Mark D. Hill and David A. Wood 311986Sandreas.sandberg@arm.com * All rights reserved. 411986Sandreas.sandberg@arm.com * 511986Sandreas.sandberg@arm.com * Redistribution and use in source and binary forms, with or without 611986Sandreas.sandberg@arm.com * modification, are permitted provided that the following conditions are 711986Sandreas.sandberg@arm.com * met: redistributions of source code must retain the above copyright 811986Sandreas.sandberg@arm.com * notice, this list of conditions and the following disclaimer; 911986Sandreas.sandberg@arm.com * redistributions in binary form must reproduce the above copyright 1011986Sandreas.sandberg@arm.com * notice, this list of conditions and the following disclaimer in the 1111986Sandreas.sandberg@arm.com * documentation and/or other materials provided with the distribution; 1211986Sandreas.sandberg@arm.com * neither the name of the copyright holders nor the names of its 1311986Sandreas.sandberg@arm.com * contributors may be used to endorse or promote products derived from 1411986Sandreas.sandberg@arm.com * this software without specific prior written permission. 1511986Sandreas.sandberg@arm.com * 1611986Sandreas.sandberg@arm.com * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 1711986Sandreas.sandberg@arm.com * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 1811986Sandreas.sandberg@arm.com * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 1911986Sandreas.sandberg@arm.com * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 2011986Sandreas.sandberg@arm.com * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 2111986Sandreas.sandberg@arm.com * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 2211986Sandreas.sandberg@arm.com * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 2312037Sandreas.sandberg@arm.com * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 2411986Sandreas.sandberg@arm.com * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 2511986Sandreas.sandberg@arm.com * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 2611986Sandreas.sandberg@arm.com * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 2711986Sandreas.sandberg@arm.com */ 2811986Sandreas.sandberg@arm.com 2911986Sandreas.sandberg@arm.com#ifndef __MEM_RUBY_STRUCTURES_CACHEMEMORY_HH__ 3011986Sandreas.sandberg@arm.com#define __MEM_RUBY_STRUCTURES_CACHEMEMORY_HH__ 3111986Sandreas.sandberg@arm.com 3211986Sandreas.sandberg@arm.com#include <string> 3311986Sandreas.sandberg@arm.com#include <vector> 3411986Sandreas.sandberg@arm.com 3511986Sandreas.sandberg@arm.com#include "base/hashmap.hh" 36#include "base/statistics.hh" 37#include "mem/protocol/CacheRequestType.hh" 38#include "mem/protocol/CacheResourceType.hh" 39#include "mem/protocol/RubyRequest.hh" 40#include "mem/ruby/common/DataBlock.hh" 41#include "mem/ruby/slicc_interface/AbstractCacheEntry.hh" 42#include "mem/ruby/slicc_interface/RubySlicc_ComponentMapping.hh" 43#include "mem/ruby/structures/BankedArray.hh" 44#include "mem/ruby/structures/LRUPolicy.hh" 45#include "mem/ruby/structures/PseudoLRUPolicy.hh" 46#include "mem/ruby/system/CacheRecorder.hh" 47#include "params/RubyCache.hh" 48#include "sim/sim_object.hh" 49 50class CacheMemory : public SimObject 51{ 52 public: 53 typedef RubyCacheParams Params; 54 CacheMemory(const Params *p); 55 ~CacheMemory(); 56 57 void init(); 58 59 // Public Methods 60 // perform a cache access and see if we hit or not. Return true on a hit. 61 bool tryCacheAccess(const Address& address, RubyRequestType type, 62 DataBlock*& data_ptr); 63 64 // similar to above, but doesn't require full access check 65 bool testCacheAccess(const Address& address, RubyRequestType type, 66 DataBlock*& data_ptr); 67 68 // tests to see if an address is present in the cache 69 bool isTagPresent(const Address& address) const; 70 71 // Returns true if there is: 72 // a) a tag match on this address or there is 73 // b) an unused line in the same cache "way" 74 bool cacheAvail(const Address& address) const; 75 76 // find an unused entry and sets the tag appropriate for the address 77 AbstractCacheEntry* allocate(const Address& address, AbstractCacheEntry* new_entry); 78 void allocateVoid(const Address& address, AbstractCacheEntry* new_entry) 79 { 80 allocate(address, new_entry); 81 } 82 83 // Explicitly free up this address 84 void deallocate(const Address& address); 85 86 // Returns with the physical address of the conflicting cache line 87 Address cacheProbe(const Address& address) const; 88 89 // looks an address up in the cache 90 AbstractCacheEntry* lookup(const Address& address); 91 const AbstractCacheEntry* lookup(const Address& address) const; 92 93 Cycles getLatency() const { return m_latency; } 94 Cycles getTagLatency() const { return tagArray.getLatency(); } 95 Cycles getDataLatency() const { return dataArray.getLatency(); } 96 97 98 // Hook for checkpointing the contents of the cache 99 void recordCacheContents(int cntrl, CacheRecorder* tr) const; 100 101 // Set this address to most recently used 102 void setMRU(const Address& address); 103 104 void setLocked (const Address& addr, int context); 105 void clearLocked (const Address& addr); 106 bool isLocked (const Address& addr, int context); 107 108 // Print cache contents 109 void print(std::ostream& out) const; 110 void printData(std::ostream& out) const; 111 112 void regStats(); 113 bool checkResourceAvailable(CacheResourceType res, Address addr); 114 void recordRequestType(CacheRequestType requestType); 115 116 public: 117 Stats::Scalar m_demand_hits; 118 Stats::Scalar m_demand_misses; 119 Stats::Formula m_demand_accesses; 120 121 Stats::Scalar m_sw_prefetches; 122 Stats::Scalar m_hw_prefetches; 123 Stats::Formula m_prefetches; 124 125 Stats::Vector m_accessModeType; 126 127 Stats::Scalar numDataArrayReads; 128 Stats::Scalar numDataArrayWrites; 129 Stats::Scalar numTagArrayReads; 130 Stats::Scalar numTagArrayWrites; 131 132 Stats::Scalar numTagArrayStalls; 133 Stats::Scalar numDataArrayStalls; 134 135 private: 136 // convert a Address to its location in the cache 137 int64 addressToCacheSet(const Address& address) const; 138 139 // Given a cache tag: returns the index of the tag in a set. 140 // returns -1 if the tag is not found. 141 int findTagInSet(int64 line, const Address& tag) const; 142 int findTagInSetIgnorePermissions(int64 cacheSet, 143 const Address& tag) const; 144 145 // Private copy constructor and assignment operator 146 CacheMemory(const CacheMemory& obj); 147 CacheMemory& operator=(const CacheMemory& obj); 148 149 private: 150 Cycles m_latency; 151 152 // Data Members (m_prefix) 153 bool m_is_instruction_only_cache; 154 155 // The first index is the # of cache lines. 156 // The second index is the the amount associativity. 157 m5::hash_map<Address, int> m_tag_index; 158 std::vector<std::vector<AbstractCacheEntry*> > m_cache; 159 160 AbstractReplacementPolicy *m_replacementPolicy_ptr; 161 162 BankedArray dataArray; 163 BankedArray tagArray; 164 165 int m_cache_size; 166 std::string m_policy; 167 int m_cache_num_sets; 168 int m_cache_num_set_bits; 169 int m_cache_assoc; 170 int m_start_index_bit; 171 bool m_resource_stalls; 172}; 173 174std::ostream& operator<<(std::ostream& out, const CacheMemory& obj); 175 176#endif // __MEM_RUBY_STRUCTURES_CACHEMEMORY_HH__ 177