1/* 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// modified by Dan Gibson on 05/20/05 to accomidate FASTER 30// >32 set lengths, using an array of ints w/ 32 bits/int 31 32#ifndef __MEM_RUBY_COMMON_SET_HH__ 33#define __MEM_RUBY_COMMON_SET_HH__ 34
| 1/* 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// modified by Dan Gibson on 05/20/05 to accomidate FASTER 30// >32 set lengths, using an array of ints w/ 32 bits/int 31 32#ifndef __MEM_RUBY_COMMON_SET_HH__ 33#define __MEM_RUBY_COMMON_SET_HH__ 34
|
| 35#include <bitset> 36#include <cassert>
|
35#include <iostream>
| 37#include <iostream>
|
36#include <limits>
| |
37
| 38
|
| 39#include "base/misc.hh"
|
38#include "mem/ruby/common/TypeDefines.hh" 39
| 40#include "mem/ruby/common/TypeDefines.hh" 41
|
40/* 41 * This defines the number of longs (32-bits on 32 bit machines, 42 * 64-bit on 64-bit AMD machines) to use to hold the set... 43 * the default is 4, allowing 128 or 256 different members 44 * of the set. 45 * 46 * This should never need to be changed for correctness reasons, 47 * though increasing it will increase performance for larger 48 * set sizes at the cost of a (much) larger memory footprint 49 * 50 */ 51const int NUMBER_WORDS_PER_SET = 1;
| 42// Change for systems with more than 64 controllers of a particular type. 43const int NUMBER_BITS_PER_SET = 64;
|
52 53class Set 54{ 55 private:
| 44 45class Set 46{ 47 private:
|
56 int m_nSize; // the number of bits in this set 57 int m_nArrayLen; // the number of 32-bit words that are 58 // held in the array
| 48 // Number of bits in use in this set. 49 int m_nSize; 50 std::bitset<NUMBER_BITS_PER_SET> bits;
|
59
| 51
|
60 // Changed 5/24/05 for static allocation of array 61 // note that "long" corresponds to 32 bits on a 32-bit machine, 62 // 64 bits if the -m64 parameter is passed to g++, which it is 63 // for an AMD opteron under our configuration
| 52 public: 53 Set() : m_nSize(0) {}
|
64
| 54
|
65 // an word array to hold the bits in the set 66 unsigned long *m_p_nArray; 67 unsigned long m_p_nArray_Static[NUMBER_WORDS_PER_SET];
| 55 Set(int size) : m_nSize(size) 56 { 57 if (size > NUMBER_BITS_PER_SET) 58 fatal("Number of bits(%d) < size specified(%d). " 59 "Increase the number of bits and recompile.\n", 60 NUMBER_BITS_PER_SET, size); 61 }
|
68
| 62
|
69 static const int LONG_BITS = 70 std::numeric_limits<unsigned long>::digits + 1; 71 static const int INDEX_SHIFT = LONG_BITS == 64 ? 6 : 5; 72 static const int INDEX_MASK = (1 << INDEX_SHIFT) - 1;
| 63 Set(const Set& obj) : m_nSize(obj.m_nSize), bits(obj.bits) {} 64 ~Set() {}
|
73
| 65
|
74 void clearExcess();
| 66 Set& operator=(const Set& obj) 67 { 68 m_nSize = obj.m_nSize; 69 bits = obj.bits; 70 return *this; 71 }
|
75
| 72
|
76 public: 77 Set(); 78 Set(int size); 79 Set(const Set& obj); 80 ~Set(); 81 82 Set& operator=(const Set& obj); 83
| |
84 void 85 add(NodeID index) 86 {
| 73 void 74 add(NodeID index) 75 {
|
87 m_p_nArray[index >> INDEX_SHIFT] |= 88 (((unsigned long) 1) << (index & INDEX_MASK));
| 76 bits.set(index);
|
89 } 90
| 77 } 78
|
91 void addSet(const Set& set);
| 79 /* 80 * This function should set all the bits in the current set that are 81 * already set in the parameter set 82 */ 83 void 84 addSet(const Set& obj) 85 { 86 assert(m_nSize == obj.m_nSize); 87 bits |= obj.bits; 88 }
|
92
| 89
|
| 90 /* 91 * This function clears bits that are =1 in the parameter set 92 */
|
93 void 94 remove(NodeID index) 95 {
| 93 void 94 remove(NodeID index) 95 {
|
96 m_p_nArray[index >> INDEX_SHIFT] &= 97 ~(((unsigned long)1) << (index & INDEX_MASK));
| 96 bits.reset(index);
|
98 } 99
| 97 } 98
|
100 void removeSet(const Set& set); 101
| 99 /* 100 * This function clears bits that are =1 in the parameter set 101 */
|
102 void
| 102 void
|
103 clear()
| 103 removeSet(const Set& obj)
|
104 {
| 104 {
|
105 for (int i = 0; i < m_nArrayLen; i++) 106 m_p_nArray[i] = 0;
| 105 assert(m_nSize == obj.m_nSize); 106 bits &= (~obj.bits);
|
107 } 108
| 107 } 108
|
109 void broadcast(); 110 int count() const; 111 bool isEqual(const Set& set) const;
| 109 void clear() { bits.reset(); }
|
112
| 110
|
| 111 /* 112 * this function sets all bits in the set 113 */ 114 void broadcast() 115 { 116 bits.set(); 117 for (int j = m_nSize; j < NUMBER_BITS_PER_SET; ++j) { 118 bits.reset(j); 119 } 120 } 121 122 /* 123 * This function returns the population count of 1's in the set 124 */ 125 int count() const { return bits.count(); } 126 127 /* 128 * This function checks for set equality 129 */ 130 bool 131 isEqual(const Set& obj) const 132 { 133 assert(m_nSize == obj.m_nSize); 134 return bits == obj.bits; 135 } 136
|
113 // return the logical OR of this set and orSet
| 137 // return the logical OR of this set and orSet
|
114 Set OR(const Set& orSet) const;
| 138 Set 139 OR(const Set& obj) const 140 { 141 assert(m_nSize == obj.m_nSize); 142 Set r(m_nSize); 143 r.bits = bits | obj.bits; 144 return r; 145 };
|
115 116 // return the logical AND of this set and andSet
| 146 147 // return the logical AND of this set and andSet
|
117 Set AND(const Set& andSet) const;
| 148 Set 149 AND(const Set& obj) const 150 { 151 assert(m_nSize == obj.m_nSize); 152 Set r(m_nSize); 153 r.bits = bits & obj.bits; 154 return r; 155 }
|
118 119 // Returns true if the intersection of the two sets is empty 120 bool
| 156 157 // Returns true if the intersection of the two sets is empty 158 bool
|
121 intersectionIsEmpty(const Set& other_set) const
| 159 intersectionIsEmpty(const Set& obj) const
|
122 {
| 160 {
|
123 for (int i = 0; i < m_nArrayLen; i++) 124 if (m_p_nArray[i] & other_set.m_p_nArray[i]) 125 return false; 126 return true;
| 161 std::bitset<NUMBER_BITS_PER_SET> r = bits & obj.bits; 162 return r.none();
|
127 } 128
| 163 } 164
|
129 bool isSuperset(const Set& test) const; 130 bool isSubset(const Set& test) const { return test.isSuperset(*this); } 131
| 165 /* 166 * Returns false if a bit is set in the parameter set that is NOT set 167 * in this set 168 */
|
132 bool
| 169 bool
|
133 isElement(NodeID element) const
| 170 isSuperset(const Set& test) const
|
134 {
| 171 {
|
135 return (m_p_nArray[element>>INDEX_SHIFT] & 136 (((unsigned long)1) << (element & INDEX_MASK))) != 0;
| 172 assert(m_nSize == test.m_nSize); 173 std::bitset<NUMBER_BITS_PER_SET> r = bits | test.bits; 174 return (r == bits);
|
137 } 138
| 175 } 176
|
139 bool isBroadcast() const; 140 bool isEmpty() const;
| 177 bool isSubset(const Set& test) const { return test.isSuperset(*this); }
|
141
| 178
|
142 NodeID smallestElement() const;
| 179 bool isElement(NodeID element) const { return bits.test(element); }
|
143
| 180
|
144 void setSize(int size);
| 181 /* 182 * this function returns true iff all bits in use are set 183 */ 184 bool 185 isBroadcast() const 186 { 187 return (bits.count() == m_nSize); 188 }
|
145
| 189
|
146 NodeID 147 elementAt(int index) const
| 190 bool isEmpty() const { return bits.none(); } 191 192 NodeID smallestElement() const
|
148 {
| 193 {
|
149 if (isElement(index)) 150 return (NodeID)true; 151 else 152 return 0;
| 194 for (int i = 0; i < m_nSize; ++i) { 195 if (bits.test(i)) { 196 return i; 197 } 198 } 199 panic("No smallest element of an empty set.");
|
153 } 154
| 200 } 201
|
| 202 bool elementAt(int index) const { return bits[index]; } 203
|
155 int getSize() const { return m_nSize; } 156
| 204 int getSize() const { return m_nSize; } 205
|
157 void print(std::ostream& out) const;
| 206 void 207 setSize(int size) 208 { 209 if (size > NUMBER_BITS_PER_SET) 210 fatal("Number of bits(%d) < size specified(%d). " 211 "Increase the number of bits and recompile.\n", 212 NUMBER_BITS_PER_SET, size); 213 m_nSize = size; 214 bits.reset(); 215 } 216 217 void print(std::ostream& out) const 218 { 219 out << "[Set (" << m_nSize << "): " << bits << "]"; 220 }
|
158}; 159 160inline std::ostream& 161operator<<(std::ostream& out, const Set& obj) 162{ 163 obj.print(out); 164 out << std::flush; 165 return out; 166} 167 168#endif // __MEM_RUBY_COMMON_SET_HH__
| 221}; 222 223inline std::ostream& 224operator<<(std::ostream& out, const Set& obj) 225{ 226 obj.print(out); 227 out << std::flush; 228 return out; 229} 230 231#endif // __MEM_RUBY_COMMON_SET_HH__
|