summaryrefslogtreecommitdiff
path: root/src/mem/ruby/common/Address.hh
blob: 7da5ed0fe982354fa6041262617bcbf27784d44d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277

/*
 * Copyright (c) 1999 Mark D. Hill and David A. Wood
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met: redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer;
 * redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution;
 * neither the name of the copyright holders nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/*
 * $Id$
 */

#ifndef ADDRESS_H
#define ADDRESS_H

#include <iomanip>

#include "base/hashmap.hh"
#include "mem/ruby/common/Global.hh"
#include "mem/ruby/system/System.hh"
#include "mem/ruby/system/NodeID.hh"
#include "mem/ruby/system/MachineID.hh"

const int ADDRESS_WIDTH = 64; // address width in bytes

class Address;
typedef Address PhysAddress;
typedef Address VirtAddress;

class Address {
public:
  // Constructors
  Address() { m_address = 0; }
  explicit Address(physical_address_t address) { m_address = address; }

  Address(const Address& obj);
  Address& operator=(const Address& obj);

  // Destructor
  //  ~Address();

  // Public Methods

  void setAddress(physical_address_t address) { m_address = address; }
  physical_address_t getAddress() const {return m_address;}
  // selects bits inclusive
  physical_address_t bitSelect(int small, int big) const;
  physical_address_t bitRemove(int small, int big) const;
  physical_address_t maskLowOrderBits(int number) const;
  physical_address_t maskHighOrderBits(int number) const;
  physical_address_t shiftLowOrderBits(int number) const;
  physical_address_t getLineAddress() const
    { return bitSelect(RubySystem::getBlockSizeBits(), ADDRESS_WIDTH); }
  physical_address_t getOffset() const
    { return bitSelect(0, RubySystem::getBlockSizeBits()-1); }

  void makeLineAddress() { m_address = maskLowOrderBits(RubySystem::getBlockSizeBits()); }
  // returns the next stride address based on line address
  void makeNextStrideAddress( int stride) {
    m_address = maskLowOrderBits(RubySystem::getBlockSizeBits())
      + RubySystem::getBlockSizeBytes()*stride;
  }
  int getBankSetNum() const;
  int getBankSetDist() const;

  Index memoryModuleIndex() const;

  void print(ostream& out) const;
  void output(ostream& out) const;
  void input(istream& in);

  void setOffset( int offset ){
    // first, zero out the offset bits
    makeLineAddress();
    m_address |= (physical_address_t) offset;
  }

private:
  // Private Methods

  // Private copy constructor and assignment operator
  //  Address(const Address& obj);
  //  Address& operator=(const Address& obj);

  // Data Members (m_ prefix)
  physical_address_t m_address;
};

inline
Address line_address(const Address& addr) { Address temp(addr); temp.makeLineAddress(); return temp; }

// Output operator declaration
ostream& operator<<(ostream& out, const Address& obj);
// comparison operator declaration
bool operator==(const Address& obj1, const Address& obj2);
bool operator!=(const Address& obj1, const Address& obj2);
bool operator<(const Address& obj1, const Address& obj2);
/* Address& operator=(const physical_address_t address); */

inline
bool operator<(const Address& obj1, const Address& obj2)
{
  return obj1.getAddress() < obj2.getAddress();
}

// ******************* Definitions *******************

// Output operator definition
inline
ostream& operator<<(ostream& out, const Address& obj)
{
  obj.print(out);
  out << flush;
  return out;
}

inline
bool operator==(const Address& obj1, const Address& obj2)
{
  return (obj1.getAddress() == obj2.getAddress());
}

inline
bool operator!=(const Address& obj1, const Address& obj2)
{
  return (obj1.getAddress() != obj2.getAddress());
}

inline
physical_address_t Address::bitSelect(int small, int big) const // rips bits inclusive
{
  physical_address_t mask;
  assert((unsigned)big >= (unsigned)small);

  if (big >= ADDRESS_WIDTH - 1) {
    return (m_address >> small);
  } else {
    mask = ~((physical_address_t)~0 << (big + 1));
    // FIXME - this is slow to manipulate a 64-bit number using 32-bits
    physical_address_t partial = (m_address & mask);
    return (partial >> small);
  }
}

// removes bits inclusive
inline
physical_address_t Address::bitRemove(int small, int big) const
{
    physical_address_t mask;
    assert((unsigned)big >= (unsigned)small);
    
    if (small >= ADDRESS_WIDTH - 1) {
        return m_address;
    } else if (big >= ADDRESS_WIDTH - 1) {
        mask = (physical_address_t)~0 >> small;
        return (m_address & mask);
    } else if (small == 0) {
        mask = (physical_address_t)~0 << big;
        return (m_address & mask);
    } else {
        mask = ~((physical_address_t)~0 << small);
        physical_address_t lower_bits = m_address & mask;
        mask = (physical_address_t)~0 << (big + 1);
        physical_address_t higher_bits = m_address & mask;

        //
        // Shift the valid high bits over the removed section
        //
        higher_bits = higher_bits >> (big - small);
        return (higher_bits | lower_bits);
    }
}

inline
physical_address_t Address::maskLowOrderBits(int number) const
{
  physical_address_t mask;

  if (number >= ADDRESS_WIDTH - 1) {
    mask = ~0;
  } else {
    mask = (physical_address_t)~0 << number;
  }
  return (m_address & mask);
}

inline
physical_address_t Address::maskHighOrderBits(int number) const
{
  physical_address_t mask;

  if (number >= ADDRESS_WIDTH - 1) {
    mask = ~0;
  } else {
    mask = (physical_address_t)~0 >> number;
  }
  return (m_address & mask);
}

inline
physical_address_t Address::shiftLowOrderBits(int number) const
{
  return (m_address >> number);
}

inline
integer_t Address::memoryModuleIndex() const
{
  integer_t index = bitSelect(RubySystem::getBlockSizeBits()+RubySystem::getMemorySizeBits(), ADDRESS_WIDTH);
  assert (index >= 0);
  return index;

  //  Index indexHighPortion = address.bitSelect(MEMORY_SIZE_BITS-1, PAGE_SIZE_BITS+NUMBER_OF_MEMORY_MODULE_BITS);
  //  Index indexLowPortion  = address.bitSelect(DATA_BLOCK_BITS, PAGE_SIZE_BITS-1);

  //Index index = indexLowPortion | (indexHighPortion << (PAGE_SIZE_BITS - DATA_BLOCK_BITS));

  /*
  Round-robin mapping of addresses, at page size granularity

ADDRESS_WIDTH    MEMORY_SIZE_BITS        PAGE_SIZE_BITS  DATA_BLOCK_BITS
  |                    |                       |               |
 \ /                  \ /                     \ /             \ /       0
  -----------------------------------------------------------------------
  |       unused        |xxxxxxxxxxxxxxx|       |xxxxxxxxxxxxxxx|       |
  |                     |xxxxxxxxxxxxxxx|       |xxxxxxxxxxxxxxx|       |
  -----------------------------------------------------------------------
                        indexHighPortion         indexLowPortion
                                        <------->
                               NUMBER_OF_MEMORY_MODULE_BITS
  */
}

inline
void Address::print(ostream& out) const
{
    using namespace std;
    out << "[" << hex << "0x" << m_address << "," << " line 0x" << maskLowOrderBits(RubySystem::getBlockSizeBits()) << dec << "]" << flush;
}

class Address;
namespace __hash_namespace {
  template <> struct hash<Address>
  {
    size_t operator()(const Address &s) const { return (size_t) s.getAddress(); }
  };
}
namespace std {
  template <> struct equal_to<Address>
  {
    bool operator()(const Address& s1, const Address& s2) const { return s1 == s2; }
  };
}

#endif //ADDRESS_H