2 * Copyright (c) 1999 Mark D. Hill and David A. Wood
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.
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.
29 #ifndef __MEM_RUBY_COMMON_ADDRESS_HH__
30 #define __MEM_RUBY_COMMON_ADDRESS_HH__
35 #include "base/hashmap.hh"
36 #include "mem/ruby/common/Global.hh"
37 #include "mem/ruby/system/MachineID.hh"
38 #include "mem/ruby/system/NodeID.hh"
40 const int ADDRESS_WIDTH = 64; // address width in bytes
43 typedef Address PhysAddress;
44 typedef Address VirtAddress;
54 Address(physical_address_t address)
58 Address(const Address& obj);
59 Address& operator=(const Address& obj);
61 void setAddress(physical_address_t address) { m_address = address; }
62 physical_address_t getAddress() const {return m_address;}
63 // selects bits inclusive
64 physical_address_t bitSelect(int small, int big) const;
65 physical_address_t bitRemove(int small, int big) const;
66 physical_address_t maskLowOrderBits(int number) const;
67 physical_address_t maskHighOrderBits(int number) const;
68 physical_address_t shiftLowOrderBits(int number) const;
70 physical_address_t getLineAddress() const;
71 physical_address_t getOffset() const;
72 void makeLineAddress();
73 void makeNextStrideAddress(int stride);
75 int getBankSetNum() const;
76 int getBankSetDist() const;
78 Index memoryModuleIndex() const;
80 void print(std::ostream& out) const;
81 void output(std::ostream& out) const;
82 void input(std::istream& in);
87 // first, zero out the offset bits
89 m_address |= (physical_address_t) offset;
93 physical_address_t m_address;
97 line_address(const Address& addr)
100 temp.makeLineAddress();
105 operator<(const Address& obj1, const Address& obj2)
107 return obj1.getAddress() < obj2.getAddress();
111 operator<<(std::ostream& out, const Address& obj)
119 operator==(const Address& obj1, const Address& obj2)
121 return (obj1.getAddress() == obj2.getAddress());
125 operator!=(const Address& obj1, const Address& obj2)
127 return (obj1.getAddress() != obj2.getAddress());
130 // rips bits inclusive
131 inline physical_address_t
132 Address::bitSelect(int small, int big) const
134 physical_address_t mask;
135 assert((unsigned)big >= (unsigned)small);
137 if (big >= ADDRESS_WIDTH - 1) {
138 return (m_address >> small);
140 mask = ~((physical_address_t)~0 << (big + 1));
141 // FIXME - this is slow to manipulate a 64-bit number using 32-bits
142 physical_address_t partial = (m_address & mask);
143 return (partial >> small);
147 // removes bits inclusive
148 inline physical_address_t
149 Address::bitRemove(int small, int big) const
151 physical_address_t mask;
152 assert((unsigned)big >= (unsigned)small);
154 if (small >= ADDRESS_WIDTH - 1) {
156 } else if (big >= ADDRESS_WIDTH - 1) {
157 mask = (physical_address_t)~0 >> small;
158 return (m_address & mask);
159 } else if (small == 0) {
160 mask = (physical_address_t)~0 << big;
161 return (m_address & mask);
163 mask = ~((physical_address_t)~0 << small);
164 physical_address_t lower_bits = m_address & mask;
165 mask = (physical_address_t)~0 << (big + 1);
166 physical_address_t higher_bits = m_address & mask;
168 // Shift the valid high bits over the removed section
169 higher_bits = higher_bits >> (big - small + 1);
170 return (higher_bits | lower_bits);
174 inline physical_address_t
175 Address::maskLowOrderBits(int number) const
177 physical_address_t mask;
179 if (number >= ADDRESS_WIDTH - 1) {
182 mask = (physical_address_t)~0 << number;
184 return (m_address & mask);
187 inline physical_address_t
188 Address::maskHighOrderBits(int number) const
190 physical_address_t mask;
192 if (number >= ADDRESS_WIDTH - 1) {
195 mask = (physical_address_t)~0 >> number;
197 return (m_address & mask);
200 inline physical_address_t
201 Address::shiftLowOrderBits(int number) const
203 return (m_address >> number);
207 namespace __hash_namespace {
208 template <> struct hash<Address>
211 operator()(const Address &s) const
213 return (size_t)s.getAddress();
216 } // namespace __hash_namespace
219 template <> struct equal_to<Address>
222 operator()(const Address& s1, const Address& s2) const
229 #endif // __MEM_RUBY_COMMON_ADDRESS_HH__