DirectoryMemory.hh revision 7039 
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#ifndef __MEM_RUBY_SYSTEM_DIRECTORYMEMORY_HH__
30#define __MEM_RUBY_SYSTEM_DIRECTORYMEMORY_HH__
31
32#include "mem/protocol/Directory_Entry.hh"
33#include "mem/ruby/common/Address.hh"
34#include "mem/ruby/common/Global.hh"
35#include "mem/ruby/system/MemoryVector.hh"
36#include "mem/ruby/system/SparseMemory.hh"
37#include "params/RubyDirectoryMemory.hh"
38#include "sim/sim_object.hh"
39
40class DirectoryMemory : public SimObject
41{
42  public:
43    typedef RubyDirectoryMemoryParams Params;
44    DirectoryMemory(const Params *p);
45    ~DirectoryMemory();
46
47    void init();
48
49    uint64 mapAddressToLocalIdx(PhysAddress address);
50    static uint64 mapAddressToDirectoryVersion(PhysAddress address);
51
52    bool isSparseImplementation() { return m_use_map; }
53    uint64 getSize() { return m_size_bytes; }
54
55    void printConfig(ostream& out) const;
56    static void printGlobalConfig(ostream & out);
57    bool isPresent(PhysAddress address);
58    Directory_Entry& lookup(PhysAddress address);
59
60    void invalidateBlock(PhysAddress address);
61
62    void print(ostream& out) const;
63    void printStats(ostream& out) const;
64
65  private:
66    // Private copy constructor and assignment operator
67    DirectoryMemory(const DirectoryMemory& obj);
68    DirectoryMemory& operator=(const DirectoryMemory& obj);
69
70  private:
71    const string m_name;
72    Directory_Entry **m_entries;
73    // int m_size;  // # of memory module blocks this directory is
74                    // responsible for
75    uint64 m_size_bytes;
76    uint64 m_size_bits;
77    uint64 m_num_entries;
78    int m_version;
79
80    static int m_num_directories;
81    static int m_num_directories_bits;
82    static uint64_t m_total_size_bytes;
83    static int m_numa_high_bit;
84
85    MemoryVector* m_ram;
86    SparseMemory* m_sparseMemory;
87    bool m_use_map;
88    int m_map_levels;
89};
90
91inline ostream&
92operator<<(ostream& out, const DirectoryMemory& obj)
93{
94    obj.print(out);
95    out << flush;
96    return out;
97}
98
99#endif // __MEM_RUBY_SYSTEM_DIRECTORYMEMORY_HH__
100