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