1/*
2 * Copyright (c) 1999 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_COMMON_ADDRESS_HH__
30#define __MEM_RUBY_COMMON_ADDRESS_HH__
31
32#include <cassert>
33#include <iomanip>
34
35#include "base/hashmap.hh"
36#include "mem/ruby/common/TypeDefines.hh"
37
38const int ADDRESS_WIDTH = 64; // address width in bytes
39
40class Address;
41typedef Address PhysAddress;
42typedef Address VirtAddress;
43
44class Address
45{
46 public:
47 Address()
48 : m_address(0)
49 { }
50
51 explicit
52 Address(physical_address_t address)
53 : m_address(address)
54 { }
55
56 Address(const Address& obj);
57 Address& operator=(const Address& obj);
58
59 void setAddress(physical_address_t address) { m_address = address; }
60 physical_address_t getAddress() const {return m_address;}
61 // selects bits inclusive
62 physical_address_t bitSelect(int small, int big) const;
63 physical_address_t bitRemove(int small, int big) const;
64 physical_address_t maskLowOrderBits(int number) const;
65 physical_address_t maskHighOrderBits(int number) const;
66 physical_address_t shiftLowOrderBits(int number) const;
67
68 physical_address_t getLineAddress() const;
69 physical_address_t getOffset() const;
70 void makeLineAddress();
71 void makeNextStrideAddress(int stride);
72
73 int getBankSetNum() const;
74 int getBankSetDist() const;
75
76 Index memoryModuleIndex() const;
77
78 void print(std::ostream& out) const;
79 void output(std::ostream& out) const;
80 void input(std::istream& in);
81
82 void
83 setOffset(int offset)
84 {
85 // first, zero out the offset bits
86 makeLineAddress();
87 m_address |= (physical_address_t) offset;
88 }
89
90 private:
91 physical_address_t m_address;
92};
93
94inline Address
95line_address(const Address& addr)
96{
97 Address temp(addr);
98 temp.makeLineAddress();
99 return temp;
100}
101
102inline bool
103operator<(const Address& obj1, const Address& obj2)
104{
105 return obj1.getAddress() < obj2.getAddress();
106}
107
108inline std::ostream&
109operator<<(std::ostream& out, const Address& obj)
110{
111 obj.print(out);
112 out << std::flush;
113 return out;
114}
115
116inline bool
117operator==(const Address& obj1, const Address& obj2)
118{
119 return (obj1.getAddress() == obj2.getAddress());
120}
121
122inline bool
123operator!=(const Address& obj1, const Address& obj2)
124{
125 return (obj1.getAddress() != obj2.getAddress());
126}
127
128// rips bits inclusive
129inline physical_address_t
130Address::bitSelect(int small, int big) const
131{
132 physical_address_t mask;
133 assert((unsigned)big >= (unsigned)small);
134
135 if (big >= ADDRESS_WIDTH - 1) {
136 return (m_address >> small);
137 } else {
138 mask = ~((physical_address_t)~0 << (big + 1));
139 // FIXME - this is slow to manipulate a 64-bit number using 32-bits
140 physical_address_t partial = (m_address & mask);
141 return (partial >> small);
142 }
143}
144
145// removes bits inclusive
146inline physical_address_t
147Address::bitRemove(int small, int big) const
148{
149 physical_address_t mask;
150 assert((unsigned)big >= (unsigned)small);
151
152 if (small >= ADDRESS_WIDTH - 1) {
153 return m_address;
154 } else if (big >= ADDRESS_WIDTH - 1) {
155 mask = (physical_address_t)~0 >> small;
156 return (m_address & mask);
157 } else if (small == 0) {
158 mask = (physical_address_t)~0 << big;
159 return (m_address & mask);
160 } else {
161 mask = ~((physical_address_t)~0 << small);
162 physical_address_t lower_bits = m_address & mask;
163 mask = (physical_address_t)~0 << (big + 1);
164 physical_address_t higher_bits = m_address & mask;
165
166 // Shift the valid high bits over the removed section
167 higher_bits = higher_bits >> (big - small + 1);
168 return (higher_bits | lower_bits);
169 }
170}
171
172inline physical_address_t
173Address::maskLowOrderBits(int number) const
174{
175 physical_address_t mask;
176
177 if (number >= ADDRESS_WIDTH - 1) {
178 mask = ~0;
179 } else {
180 mask = (physical_address_t)~0 << number;
181 }
182 return (m_address & mask);
183}
184
185inline physical_address_t
186Address::maskHighOrderBits(int number) const
187{
188 physical_address_t mask;
189
190 if (number >= ADDRESS_WIDTH - 1) {
191 mask = ~0;
192 } else {
193 mask = (physical_address_t)~0 >> number;
194 }
195 return (m_address & mask);
196}
197
198inline physical_address_t
199Address::shiftLowOrderBits(int number) const
200{
201 return (m_address >> number);
202}
203
204class Address;
205namespace __hash_namespace {
206template <> struct hash<Address>
207{
208 size_t
209 operator()(const Address &s) const
210 {
211 return (size_t)s.getAddress();
212 }
213};
214} // namespace __hash_namespace
215
216namespace std {
217template <> struct equal_to<Address>
218{
219 bool
220 operator()(const Address& s1, const Address& s2) const
221 {
222 return s1 == s2;
223 }
224};
225} // namespace std
226
227#endif // __MEM_RUBY_COMMON_ADDRESS_HH__