DirectoryMemory.cc revision 8688 
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
35using namespace std;
36
37int DirectoryMemory::m_num_directories = 0;
38int DirectoryMemory::m_num_directories_bits = 0;
39uint64_t DirectoryMemory::m_total_size_bytes = 0;
40int DirectoryMemory::m_numa_high_bit = 0;
41
42DirectoryMemory::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
54void
55DirectoryMemory::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        g_system_ptr->registerSparseMemory(m_sparseMemory);
62    } else {
63        m_entries = new AbstractEntry*[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() - 1;
75    }
76    assert(m_numa_high_bit != 0);
77}
78
79DirectoryMemory::~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
94void
95DirectoryMemory::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
107void
108DirectoryMemory::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
122uint64
123DirectoryMemory::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 + 1,
129                                   m_numa_high_bit);
130    return ret;
131}
132
133bool
134DirectoryMemory::isPresent(PhysAddress address)
135{
136    bool ret = (mapAddressToDirectoryVersion(address) == m_version);
137    return ret;
138}
139
140uint64
141DirectoryMemory::mapAddressToLocalIdx(PhysAddress address)
142{
143    uint64 ret;
144    if (m_num_directories_bits > 0) {
145        ret = address.bitRemove(m_numa_high_bit - m_num_directories_bits + 1,
146                                m_numa_high_bit);
147    } else {
148        ret = address.getAddress();
149    }
150
151    return ret >> (RubySystem::getBlockSizeBits());
152}
153
154AbstractEntry*
155DirectoryMemory::lookup(PhysAddress address)
156{
157    assert(isPresent(address));
158    DPRINTF(RubyCache, "Looking up address: %s\n", address);
159
160    if (m_use_map) {
161        return m_sparseMemory->lookup(address);
162    } else {
163        uint64_t idx = mapAddressToLocalIdx(address);
164        assert(idx < m_num_entries);
165        return m_entries[idx];
166    }
167}
168
169AbstractEntry*
170DirectoryMemory::allocate(const PhysAddress& address, AbstractEntry* entry)
171{
172    assert(isPresent(address));
173    uint64 idx;
174    DPRINTF(RubyCache, "Looking up address: %s\n", address);
175
176    if (m_use_map) {
177        m_sparseMemory->add(address, entry);
178        entry->changePermission(AccessPermission_Read_Write);
179    } else {
180        idx = mapAddressToLocalIdx(address);
181        assert(idx < m_num_entries);
182        entry->getDataBlk().assign(m_ram->getBlockPtr(address));
183        entry->changePermission(AccessPermission_Read_Only);
184        m_entries[idx] = entry;
185    }
186
187    return entry;
188}
189
190void
191DirectoryMemory::invalidateBlock(PhysAddress address)
192{
193    if (m_use_map) {
194        assert(m_sparseMemory->exist(address));
195        m_sparseMemory->remove(address);
196    }
197#if 0
198    else {
199        assert(isPresent(address));
200
201        Index index = address.memoryModuleIndex();
202
203        if (index < 0 || index > m_size) {
204            ERROR_MSG("Directory Memory Assertion: "
205                      "accessing memory out of range.");
206        }
207
208        if (m_entries[index] != NULL){
209            delete m_entries[index];
210            m_entries[index] = NULL;
211        }
212    }
213#endif
214}
215
216void
217DirectoryMemory::print(ostream& out) const
218{
219}
220
221void
222DirectoryMemory::printStats(ostream& out) const
223{
224    if (m_use_map) {
225        m_sparseMemory->printStats(out);
226    }
227}
228
229DirectoryMemory *
230RubyDirectoryMemoryParams::create()
231{
232    return new DirectoryMemory(this);
233}
234