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__
36 #include "base/hashmap.hh"
37 #include "mem/ruby/common/TypeDefines.hh"
39 const uint32_t ADDRESS_WIDTH = 64; // address width in bytes
42 typedef Address PhysAddress;
43 typedef Address VirtAddress;
53 Address(physical_address_t address)
57 Address(const Address& obj);
58 Address& operator=(const Address& obj);
60 void setAddress(physical_address_t address) { m_address = address; }
61 physical_address_t getAddress() const {return m_address;}
62 // selects bits inclusive
63 physical_address_t bitSelect(int small, int big) const;
64 physical_address_t bitRemove(int small, int big) const;
65 physical_address_t maskLowOrderBits(int number) const;
66 physical_address_t maskHighOrderBits(int number) const;
67 physical_address_t shiftLowOrderBits(int number) const;
69 physical_address_t getLineAddress() const;
70 physical_address_t getOffset() const;
71 void makeLineAddress();
72 void makePageAddress();
73 void makeNextStrideAddress(int stride);
75 Index memoryModuleIndex() const;
77 void print(std::ostream& out) const;
78 void output(std::ostream& out) const;
79 void input(std::istream& in);
84 // first, zero out the offset bits
86 m_address |= (physical_address_t) offset;
90 physical_address_t m_address;
94 line_address(const Address& addr)
97 temp.makeLineAddress();
102 operator<(const Address& obj1, const Address& obj2)
104 return obj1.getAddress() < obj2.getAddress();
108 operator<<(std::ostream& out, const Address& obj)
116 operator==(const Address& obj1, const Address& obj2)
118 return (obj1.getAddress() == obj2.getAddress());
122 operator!=(const Address& obj1, const Address& obj2)
124 return (obj1.getAddress() != obj2.getAddress());
127 // rips bits inclusive
128 inline physical_address_t
129 Address::bitSelect(int small, int big) const
131 physical_address_t mask;
132 assert((unsigned)big >= (unsigned)small);
134 if (big >= ADDRESS_WIDTH - 1) {
135 return (m_address >> small);
137 mask = ~((physical_address_t)~0 << (big + 1));
138 // FIXME - this is slow to manipulate a 64-bit number using 32-bits
139 physical_address_t partial = (m_address & mask);
140 return (partial >> small);
144 // removes bits inclusive
145 inline physical_address_t
146 Address::bitRemove(int small, int big) const
148 physical_address_t mask;
149 assert((unsigned)big >= (unsigned)small);
151 if (small >= ADDRESS_WIDTH - 1) {
153 } else if (big >= ADDRESS_WIDTH - 1) {
154 mask = (physical_address_t)~0 >> small;
155 return (m_address & mask);
156 } else if (small == 0) {
157 mask = (physical_address_t)~0 << big;
158 return (m_address & mask);
160 mask = ~((physical_address_t)~0 << small);
161 physical_address_t lower_bits = m_address & mask;
162 mask = (physical_address_t)~0 << (big + 1);
163 physical_address_t higher_bits = m_address & mask;
165 // Shift the valid high bits over the removed section
166 higher_bits = higher_bits >> (big - small + 1);
167 return (higher_bits | lower_bits);
171 inline physical_address_t
172 Address::maskLowOrderBits(int number) const
174 physical_address_t mask;
176 if (number >= ADDRESS_WIDTH - 1) {
179 mask = (physical_address_t)~0 << number;
181 return (m_address & mask);
184 inline physical_address_t
185 Address::maskHighOrderBits(int number) const
187 physical_address_t mask;
189 if (number >= ADDRESS_WIDTH - 1) {
192 mask = (physical_address_t)~0 >> number;
194 return (m_address & mask);
197 inline physical_address_t
198 Address::shiftLowOrderBits(int number) const
200 return (m_address >> number);
203 Address next_stride_address(const Address& addr, int stride);
204 Address page_address(const Address& addr);
206 __hash_namespace_begin
207 template <> struct hash<Address>
210 operator()(const Address &s) const
212 return (size_t)s.getAddress();
218 template <> struct equal_to<Address>
221 operator()(const Address& s1, const Address& s2) const
228 #endif // __MEM_RUBY_COMMON_ADDRESS_HH__