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;

--- 18 unchanged lines hidden (view full) ---

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 <iostream>
36#include <limits>
37
38#include "mem/ruby/common/TypeDefines.hh"
39
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;
52
53class Set
54{
55 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
59
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
64
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];
68
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;
73
74 void clearExcess();
75
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 {
87 m_p_nArray[index >> INDEX_SHIFT] |=
88 (((unsigned long) 1) << (index & INDEX_MASK));
89 }
90
91 void addSet(const Set& set);
92
93 void
94 remove(NodeID index)
95 {
96 m_p_nArray[index >> INDEX_SHIFT] &=
97 ~(((unsigned long)1) << (index & INDEX_MASK));
98 }
99
100 void removeSet(const Set& set);
101
102 void
103 clear()
104 {
105 for (int i = 0; i < m_nArrayLen; i++)
106 m_p_nArray[i] = 0;
107 }
108
109 void broadcast();
110 int count() const;
111 bool isEqual(const Set& set) const;
112
113 // return the logical OR of this set and orSet
114 Set OR(const Set& orSet) const;
115
116 // return the logical AND of this set and andSet
117 Set AND(const Set& andSet) const;
118
119 // Returns true if the intersection of the two sets is empty
120 bool
121 intersectionIsEmpty(const Set& other_set) const
122 {
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;
127 }
128
129 bool isSuperset(const Set& test) const;
130 bool isSubset(const Set& test) const { return test.isSuperset(*this); }
131
132 bool
133 isElement(NodeID element) const
134 {
135 return (m_p_nArray[element>>INDEX_SHIFT] &
136 (((unsigned long)1) << (element & INDEX_MASK))) != 0;
137 }
138
139 bool isBroadcast() const;
140 bool isEmpty() const;
141
142 NodeID smallestElement() const;
143
144 void setSize(int size);
145
146 NodeID
147 elementAt(int index) const
148 {
149 if (isElement(index))
150 return (NodeID)true;
151 else
152 return 0;
153 }
154
155 int getSize() const { return m_nSize; }
156
157 void print(std::ostream& out) const;
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__