DirectoryMemory.cc revision 10314:94b6b28fc968 
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 "debug/RubyStats.hh"
32#include "mem/ruby/slicc_interface/RubySlicc_Util.hh"
33#include "mem/ruby/structures/DirectoryMemory.hh"
34#include "mem/ruby/system/System.hh"
35
36using namespace std;
37
38int DirectoryMemory::m_num_directories = 0;
39int DirectoryMemory::m_num_directories_bits = 0;
40uint64_t DirectoryMemory::m_total_size_bytes = 0;
41int DirectoryMemory::m_numa_high_bit = 0;
42
43DirectoryMemory::DirectoryMemory(const Params *p)
44    : SimObject(p)
45{
46    m_version = p->version;
47    m_size_bytes = p->size;
48    m_size_bits = floorLog2(m_size_bytes);
49    m_num_entries = 0;
50    m_use_map = p->use_map;
51    m_map_levels = p->map_levels;
52    m_numa_high_bit = p->numa_high_bit;
53}
54
55void
56DirectoryMemory::init()
57{
58    m_num_entries = m_size_bytes / RubySystem::getBlockSizeBytes();
59
60    if (m_use_map) {
61        m_sparseMemory = new SparseMemory(m_map_levels);
62        g_system_ptr->registerSparseMemory(m_sparseMemory);
63    } else {
64        m_entries = new AbstractEntry*[m_num_entries];
65        for (int i = 0; i < m_num_entries; i++)
66            m_entries[i] = NULL;
67        m_ram = g_system_ptr->getMemoryVector();
68    }
69
70    m_num_directories++;
71    m_num_directories_bits = ceilLog2(m_num_directories);
72    m_total_size_bytes += m_size_bytes;
73
74    if (m_numa_high_bit == 0) {
75        m_numa_high_bit = RubySystem::getMemorySizeBits() - 1;
76    }
77    assert(m_numa_high_bit != 0);
78}
79
80DirectoryMemory::~DirectoryMemory()
81{
82    // free up all the directory entries
83    if (m_entries != NULL) {
84        for (uint64 i = 0; i < m_num_entries; i++) {
85            if (m_entries[i] != NULL) {
86                delete m_entries[i];
87            }
88        }
89        delete [] m_entries;
90    } else if (m_use_map) {
91        delete m_sparseMemory;
92    }
93}
94
95uint64
96DirectoryMemory::mapAddressToDirectoryVersion(PhysAddress address)
97{
98    if (m_num_directories_bits == 0)
99        return 0;
100
101    uint64 ret = address.bitSelect(m_numa_high_bit - m_num_directories_bits + 1,
102                                   m_numa_high_bit);
103    return ret;
104}
105
106bool
107DirectoryMemory::isPresent(PhysAddress address)
108{
109    bool ret = (mapAddressToDirectoryVersion(address) == m_version);
110    return ret;
111}
112
113uint64
114DirectoryMemory::mapAddressToLocalIdx(PhysAddress address)
115{
116    uint64 ret;
117    if (m_num_directories_bits > 0) {
118        ret = address.bitRemove(m_numa_high_bit - m_num_directories_bits + 1,
119                                m_numa_high_bit);
120    } else {
121        ret = address.getAddress();
122    }
123
124    return ret >> (RubySystem::getBlockSizeBits());
125}
126
127AbstractEntry*
128DirectoryMemory::lookup(PhysAddress address)
129{
130    assert(isPresent(address));
131    DPRINTF(RubyCache, "Looking up address: %s\n", address);
132
133    if (m_use_map) {
134        return m_sparseMemory->lookup(address);
135    } else {
136        uint64_t idx = mapAddressToLocalIdx(address);
137        assert(idx < m_num_entries);
138        return m_entries[idx];
139    }
140}
141
142AbstractEntry*
143DirectoryMemory::allocate(const PhysAddress& address, AbstractEntry* entry)
144{
145    assert(isPresent(address));
146    uint64 idx;
147    DPRINTF(RubyCache, "Looking up address: %s\n", address);
148
149    if (m_use_map) {
150        m_sparseMemory->add(address, entry);
151        entry->changePermission(AccessPermission_Read_Write);
152    } else {
153        idx = mapAddressToLocalIdx(address);
154        assert(idx < m_num_entries);
155        entry->getDataBlk().assign(m_ram->getBlockPtr(address));
156        entry->changePermission(AccessPermission_Read_Only);
157        m_entries[idx] = entry;
158    }
159
160    return entry;
161}
162
163void
164DirectoryMemory::invalidateBlock(PhysAddress address)
165{
166    if (m_use_map) {
167        assert(m_sparseMemory->exist(address));
168        m_sparseMemory->remove(address);
169    }
170#if 0
171    else {
172        assert(isPresent(address));
173
174        int64 index = address.memoryModuleIndex();
175
176        if (index < 0 || index > m_size) {
177            ERROR_MSG("Directory Memory Assertion: "
178                      "accessing memory out of range.");
179        }
180
181        if (m_entries[index] != NULL){
182            delete m_entries[index];
183            m_entries[index] = NULL;
184        }
185    }
186#endif
187}
188
189void
190DirectoryMemory::print(ostream& out) const
191{
192}
193
194void
195DirectoryMemory::regStats()
196{
197    if (m_use_map) {
198        m_sparseMemory->regStats(name());
199    }
200}
201
202void
203DirectoryMemory::recordRequestType(DirectoryRequestType requestType) {
204    DPRINTF(RubyStats, "Recorded statistic: %s\n",
205            DirectoryRequestType_to_string(requestType));
206}
207
208DirectoryMemory *
209RubyDirectoryMemoryParams::create()
210{
211    return new DirectoryMemory(this);
212}
213