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