DirectoryMemory.hh (11073:a8afeb8bc3f0) DirectoryMemory.hh (12065:e3e51756dfef)
1/*
1/*
2 * Copyright (c) 2017 ARM Limited
3 * All rights reserved.
4 *
5 * The license below extends only to copyright in the software and shall
6 * not be construed as granting a license to any other intellectual
7 * property including but not limited to intellectual property relating
8 * to a hardware implementation of the functionality of the software
9 * licensed hereunder. You may use the software subject to the license
10 * terms below provided that you ensure that this notice is replicated
11 * unmodified and in its entirety in all distributions of the software,
12 * modified or unmodified, in source code or in binary form.
13 *
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
14 * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
15 * All rights reserved.
16 *
17 * Redistribution and use in source and binary forms, with or without
18 * modification, are permitted provided that the following conditions are
19 * met: redistributions of source code must retain the above copyright
20 * notice, this list of conditions and the following disclaimer;
21 * redistributions in binary form must reproduce the above copyright
22 * notice, this list of conditions and the following disclaimer in the
23 * documentation and/or other materials provided with the distribution;
24 * neither the name of the copyright holders nor the names of its
25 * contributors may be used to endorse or promote products derived from
26 * this software without specific prior written permission.
27 *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 */
40
41#ifndef __MEM_RUBY_STRUCTURES_DIRECTORYMEMORY_HH__
42#define __MEM_RUBY_STRUCTURES_DIRECTORYMEMORY_HH__
43
44#include <iostream>
45#include <string>
46
47#include "base/addr_range.hh"
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
48#include "mem/protocol/DirectoryRequestType.hh"
49#include "mem/ruby/common/Address.hh"
50#include "mem/ruby/slicc_interface/AbstractEntry.hh"
51#include "params/RubyDirectoryMemory.hh"
52#include "sim/sim_object.hh"
53
54class DirectoryMemory : public SimObject
55{
56 public:
57 typedef RubyDirectoryMemoryParams Params;
58 DirectoryMemory(const Params *p);
59 ~DirectoryMemory();
60
61 void init();
62
63 /**
64 * Return the index in the directory based on an address
65 *
66 * This function transforms an address which belongs to a not
67 * necessarily continuous vector of address ranges into a flat
68 * address that we use to index in the directory
69 *
70 * @param an input address
71 * @return the corresponding index in the directory
72 *
73 */
50 uint64_t mapAddressToLocalIdx(Addr address);
74 uint64_t mapAddressToLocalIdx(Addr address);
51 static uint64_t mapAddressToDirectoryVersion(Addr address);
52
53 uint64_t getSize() { return m_size_bytes; }
54
55 bool isPresent(Addr address);
56 AbstractEntry *lookup(Addr address);
57 AbstractEntry *allocate(Addr address, AbstractEntry* new_entry);
58
59 void print(std::ostream& out) const;
60 void recordRequestType(DirectoryRequestType requestType);
61
62 private:
63 // Private copy constructor and assignment operator
64 DirectoryMemory(const DirectoryMemory& obj);
65 DirectoryMemory& operator=(const DirectoryMemory& obj);
66
67 private:
68 const std::string m_name;
69 AbstractEntry **m_entries;
70 // int m_size; // # of memory module blocks this directory is
71 // responsible for
72 uint64_t m_size_bytes;
73 uint64_t m_size_bits;
74 uint64_t m_num_entries;
75
76 uint64_t getSize() { return m_size_bytes; }
77
78 bool isPresent(Addr address);
79 AbstractEntry *lookup(Addr address);
80 AbstractEntry *allocate(Addr address, AbstractEntry* new_entry);
81
82 void print(std::ostream& out) const;
83 void recordRequestType(DirectoryRequestType requestType);
84
85 private:
86 // Private copy constructor and assignment operator
87 DirectoryMemory(const DirectoryMemory& obj);
88 DirectoryMemory& operator=(const DirectoryMemory& obj);
89
90 private:
91 const std::string m_name;
92 AbstractEntry **m_entries;
93 // int m_size; // # of memory module blocks this directory is
94 // responsible for
95 uint64_t m_size_bytes;
96 uint64_t m_size_bits;
97 uint64_t m_num_entries;
75 int m_version;
76
98
77 static int m_num_directories;
78 static int m_num_directories_bits;
79 static int m_numa_high_bit;
99 /**
100 * The address range for which the directory responds. Normally
101 * this is all possible memory addresses.
102 */
103 const AddrRangeList addrRanges;
80};
81
82inline std::ostream&
83operator<<(std::ostream& out, const DirectoryMemory& obj)
84{
85 obj.print(out);
86 out << std::flush;
87 return out;
88}
89
90#endif // __MEM_RUBY_STRUCTURES_DIRECTORYMEMORY_HH__
104};
105
106inline std::ostream&
107operator<<(std::ostream& out, const DirectoryMemory& obj)
108{
109 obj.print(out);
110 out << std::flush;
111 return out;
112}
113
114#endif // __MEM_RUBY_STRUCTURES_DIRECTORYMEMORY_HH__