src/mem/ruby/system/DirectoryMemory.cc

   1 /*
   2  * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
   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
  29 #include "base/intmath.hh"
  30 #include "mem/ruby/slicc_interface/RubySlicc_Util.hh"
  31 #include "mem/ruby/system/DirectoryMemory.hh"
  32 #include "mem/ruby/system/System.hh"
  33
  34 using namespace std;
  35
  36 int DirectoryMemory::m_num_directories = 0;
  37 int DirectoryMemory::m_num_directories_bits = 0;
  38 uint64_t DirectoryMemory::m_total_size_bytes = 0;
  39 int DirectoryMemory::m_numa_high_bit = 0;
  40
  41 DirectoryMemory::DirectoryMemory(const Params *p)
  42     : SimObject(p)
  43 {
  44     m_version = p->version;
  45     m_size_bytes = p->size;
  46     m_size_bits = floorLog2(m_size_bytes);
  47     m_num_entries = 0;
  48     m_use_map = p->use_map;
  49     m_map_levels = p->map_levels;
  50     m_numa_high_bit = p->numa_high_bit;
  51 }
  52
  53 void
  54 DirectoryMemory::init()
  55 {
  56     m_num_entries = m_size_bytes / RubySystem::getBlockSizeBytes();
  57
  58     if (m_use_map) {
  59         int entry_bits = floorLog2(m_num_entries);
  60         assert(entry_bits >= m_map_levels);
  61         m_sparseMemory = new SparseMemory(entry_bits, m_map_levels);
  62     } else {
  63         m_entries = new Directory_Entry*[m_num_entries];
  64         for (int i = 0; i < m_num_entries; i++)
  65             m_entries[i] = NULL;
  66         m_ram = g_system_ptr->getMemoryVector();
  67     }
  68
  69     m_num_directories++;
  70     m_num_directories_bits = floorLog2(m_num_directories);
  71     m_total_size_bytes += m_size_bytes;
  72
  73     if (m_numa_high_bit == 0) {
  74         m_numa_high_bit = RubySystem::getMemorySizeBits();
  75     }
  76     assert(m_numa_high_bit != 0);
  77 }
  78
  79 DirectoryMemory::~DirectoryMemory()
  80 {
  81     // free up all the directory entries
  82     if (m_entries != NULL) {
  83         for (uint64 i = 0; i < m_num_entries; i++) {
  84             if (m_entries[i] != NULL) {
  85                 delete m_entries[i];
  86             }
  87         }
  88         delete [] m_entries;
  89     } else if (m_use_map) {
  90         delete m_sparseMemory;
  91     }
  92 }
  93
  94 void
  95 DirectoryMemory::printConfig(ostream& out) const
  96 {
  97     out << "DirectoryMemory module config: " << m_name << endl
  98         << "  version: " << m_version << endl
  99         << "  memory_bits: " << m_size_bits << endl
 100         << "  memory_size_bytes: " << m_size_bytes << endl
 101         << "  memory_size_Kbytes: " << double(m_size_bytes) / (1<<10) << endl
 102         << "  memory_size_Mbytes: " << double(m_size_bytes) / (1<<20) << endl
 103         << "  memory_size_Gbytes: " << double(m_size_bytes) / (1<<30) << endl;
 104 }
 105
 106 // Static method
 107 void
 108 DirectoryMemory::printGlobalConfig(ostream & out)
 109 {
 110     out << "DirectoryMemory Global Config: " << endl;
 111     out << "  number of directory memories: " << m_num_directories << endl;
 112     if (m_num_directories > 1) {
 113         out << "  number of selection bits: " << m_num_directories_bits << endl
 114             << "  selection bits: " << m_numa_high_bit
 115             << "-" << m_numa_high_bit-m_num_directories_bits
 116             << endl;
 117     }
 118     out << "  total memory size bytes: " << m_total_size_bytes << endl;
 119     out << "  total memory bits: " << floorLog2(m_total_size_bytes) << endl;
 120 }
 121
 122 uint64
 123 DirectoryMemory::mapAddressToDirectoryVersion(PhysAddress address)
 124 {
 125     if (m_num_directories_bits == 0)
 126         return 0;
 127
 128     uint64 ret = address.bitSelect(m_numa_high_bit - m_num_directories_bits,
 129                                    m_numa_high_bit);
 130     return ret;
 131 }
 132
 133 bool
 134 DirectoryMemory::isPresent(PhysAddress address)
 135 {
 136     bool ret = (mapAddressToDirectoryVersion(address) == m_version);
 137     return ret;
 138 }
 139
 140 uint64
 141 DirectoryMemory::mapAddressToLocalIdx(PhysAddress address)
 142 {
 143     uint64 ret = address.bitRemove(m_numa_high_bit - m_num_directories_bits,
 144                                    m_numa_high_bit)
 145         >> (RubySystem::getBlockSizeBits());
 146     return ret;
 147 }
 148
 149 Directory_Entry&
 150 DirectoryMemory::lookup(PhysAddress address)
 151 {
 152     assert(isPresent(address));
 153     Directory_Entry* entry;
 154     uint64 idx;
 155     DEBUG_EXPR(CACHE_COMP, HighPrio, address);
 156
 157     if (m_use_map) {
 158         if (m_sparseMemory->exist(address)) {
 159             entry = m_sparseMemory->lookup(address);
 160             assert(entry != NULL);
 161         } else {
 162             // Note: SparseMemory internally creates a new Directory Entry
 163             m_sparseMemory->add(address);
 164             entry = m_sparseMemory->lookup(address);
 165         }
 166     } else {
 167         idx = mapAddressToLocalIdx(address);
 168         assert(idx < m_num_entries);
 169         entry = m_entries[idx];
 170
 171         if (entry == NULL) {
 172             entry = new Directory_Entry();
 173             entry->getDataBlk().assign(m_ram->getBlockPtr(address));
 174             m_entries[idx] = entry;
 175         }
 176     }
 177
 178     return *entry;
 179 }
 180
 181 #if 0
 182 Directory_Entry&
 183 DirectoryMemory::lookup(PhysAddress address)
 184 {
 185     assert(isPresent(address));
 186     Index index = address.memoryModuleIndex();
 187
 188     if (index < 0 || index > m_size) {
 189         WARN_EXPR(address.getAddress());
 190         WARN_EXPR(index);
 191         WARN_EXPR(m_size);
 192         ERROR_MSG("Directory Memory Assertion: accessing memory out of range");
 193     }
 194     Directory_Entry* entry = m_entries[index];
 195
 196     // allocate the directory entry on demand.
 197     if (entry == NULL) {
 198         entry = new Directory_Entry;
 199         entry->getDataBlk().assign(m_ram->getBlockPtr(address));
 200
 201         // store entry to the table
 202         m_entries[index] = entry;
 203     }
 204
 205     return *entry;
 206 }
 207 #endif
 208
 209 void
 210 DirectoryMemory::invalidateBlock(PhysAddress address)
 211 {
 212     if (m_use_map) {
 213         assert(m_sparseMemory->exist(address));
 214         m_sparseMemory->remove(address);
 215     }
 216 #if 0
 217     else {
 218         assert(isPresent(address));
 219
 220         Index index = address.memoryModuleIndex();
 221
 222         if (index < 0 || index > m_size) {
 223             ERROR_MSG("Directory Memory Assertion: "
 224                       "accessing memory out of range.");
 225         }
 226
 227         if (m_entries[index] != NULL){
 228             delete m_entries[index];
 229             m_entries[index] = NULL;
 230         }
 231     }
 232 #endif
 233 }
 234
 235 void
 236 DirectoryMemory::print(ostream& out) const
 237 {
 238 }
 239
 240 void
 241 DirectoryMemory::printStats(ostream& out) const
 242 {
 243     if (m_use_map) {
 244         m_sparseMemory->printStats(out);
 245     }
 246 }
 247
 248 DirectoryMemory *
 249 RubyDirectoryMemoryParams::create()
 250 {
 251     return new DirectoryMemory(this);
 252 }