2 * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
6 * This file may be distributed and/or modified under the terms of the
7 * GNU General Public License version 2 as published by the Free Software
8 * Foundation and appearing in the file LICENSE.GPL included in the
9 * packaging of this file.
11 * Licensees holding valid libFirm Professional Edition licenses may use
12 * this file in accordance with the libFirm Commercial License.
13 * Agreement provided with the Software.
15 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * @brief helper functions for working with raw bitsets
24 * @author Matthias Braun
27 * Raw bitsets are constructed from unsigned int arrays. Additional information
28 * like the size of the bitset or the used memory are not stored for
31 * These bitsets need less space than bitset_t and their representation
32 * as int arrays allows having constant bitsets in the ro data segment.
33 * They should for smaller bitset, whose length is known through other means
34 * (a typical usage case is a set of cpu registers)
36 * The bitset is built as an array of unsigned integers. It is assumed that
37 * exactly 32 bits may be put into each element of the array. If there are
38 * remaining bits, then they should be 0
40 #ifndef FIRM_ADT_RAW_BITSET_H
41 #define FIRM_ADT_RAW_BITSET_H
47 /** The base type for raw bitsets. */
48 typedef unsigned int rawbs_base_t;
50 #define BITS_PER_ELEM (sizeof(rawbs_base_t) * 8)
51 #define BITSET_SIZE_ELEMS(size_bits) ((size_bits)/BITS_PER_ELEM + 1)
52 #define BITSET_SIZE_BYTES(size_bits) (BITSET_SIZE_ELEMS(size_bits) * sizeof(rawbs_base_t))
53 #define BITSET_ELEM(bitset,pos) bitset[pos / BITS_PER_ELEM]
56 * Allocate an empty raw bitset on the heap.
58 * @param size number of bits in the bitset
60 * @return the new bitset
62 static INLINE unsigned *rbitset_malloc(unsigned size) {
63 unsigned size_bytes = BITSET_SIZE_BYTES(size);
64 unsigned *res = xmalloc(size_bytes);
65 memset(res, 0, size_bytes);
71 * Allocate an empty raw bitset on the stack.
73 * @param res will contain the newly allocated bitset
74 * @param size number of bits in the bitset
76 #define rbitset_alloca(res, size) \
78 unsigned size_bytes = BITSET_SIZE_BYTES(size); \
79 res = alloca(size_bytes); \
80 memset(res, 0, size_bytes); \
84 * Allocate an empty raw bitset on an obstack.
86 * @param obst the obstack where the bitset is allocated on
87 * @param size number of bits in the bitset
89 * @return the new bitset
91 static INLINE unsigned *rbitset_obstack_alloc(struct obstack *obst, unsigned size) {
92 unsigned size_bytes = BITSET_SIZE_BYTES(size);
93 unsigned *res = obstack_alloc(obst, size_bytes);
94 memset(res, 0, size_bytes);
100 * Allocate an empty raw bitset including the size on an obstack.
101 * The size of this bitset can be accessed by bitset[-1].
103 * @param obst the obstack where the bitset is allocated on
104 * @param size number of bits in the bitset
106 * @return the new bitset
108 static INLINE unsigned *rbitset_w_size_obstack_alloc(struct obstack *obst, unsigned size) {
109 unsigned size_bytes = BITSET_SIZE_BYTES(size);
110 unsigned *res = obstack_alloc(obst, size_bytes + sizeof(unsigned));
113 memset(res, 0, size_bytes);
118 /** Return the size of a bitset allocated with a *_w_size_* function */
119 #define rbitset_size(set) (set)[-1]
122 * Duplicate a raw bitset on an obstack.
124 * @param obst the obstack where the bitset is allocated on
125 * @param old_bitset the bitset to be duplicated
126 * @param size number of bits in the bitset
128 * @return the new bitset
131 unsigned *rbitset_duplicate_obstack_alloc(struct obstack *obst,
132 const unsigned *old_bitset,
135 unsigned size_bytes = BITSET_SIZE_BYTES(size);
136 unsigned *res = obstack_alloc(obst, size_bytes);
137 memcpy(res, old_bitset, size_bytes);
143 * Check if a bitset is empty, ie all bits cleared.
145 static INLINE int rbitset_is_empty(unsigned *bitset, unsigned size) {
146 unsigned i, size_bytes = BITSET_SIZE_BYTES(size);
147 for (i = 0; i < size_bytes; ++i)
148 if (bitset[i]) return 0;
153 * Set a bit at position pos.
155 * @param bitset the bitset
156 * @param pos the position of the bit to be set
158 static INLINE void rbitset_set(unsigned *bitset, unsigned pos) {
159 BITSET_ELEM(bitset,pos) |= 1 << (pos % BITS_PER_ELEM);
163 * Clear a bit at position pos.
165 * @param bitset the bitset
166 * @param pos the position of the bit to be clear
168 static INLINE void rbitset_clear(unsigned *bitset, unsigned pos) {
169 BITSET_ELEM(bitset, pos) &= ~(1 << (pos % BITS_PER_ELEM));
173 * Clear all bits in a given bitset.
175 * @param bitset the bitset
176 * @param size number of bits in the bitset
178 static INLINE void rbitset_clear_all(unsigned *bitset, unsigned size) {
179 unsigned size_bytes = BITSET_SIZE_BYTES(size);
180 memset(bitset, 0, size_bytes);
184 * Check if a bit is set at position pos.
186 * @param bitset the bitset
187 * @param pos the position of the bit to check
189 static INLINE int rbitset_is_set(const unsigned *bitset, unsigned pos) {
190 return BITSET_ELEM(bitset, pos) & (1 << (pos % BITS_PER_ELEM));
194 * Calculate the number of set bits (number of elements).
196 * @param bitset the bitset
198 static INLINE unsigned rbitset_popcnt(const unsigned *bitset, unsigned size) {
200 unsigned n = BITSET_SIZE_ELEMS(size);
202 const unsigned *elem = bitset;
204 for(pos = 0; pos < n; ++pos) {
205 res += _bitset_inside_pop(elem);
212 static INLINE unsigned rbitset_next(const unsigned *bitset, unsigned pos, int set) {
214 unsigned elem_pos = pos / BITS_PER_ELEM;
215 unsigned bit_pos = pos % BITS_PER_ELEM;
217 unsigned elem = bitset[elem_pos];
220 * Mask out the bits smaller than pos in the current unit.
221 * We are only interested in bits set higher than pos.
223 unsigned in_elem_mask = (1 << bit_pos) - 1;
227 p = _bitset_inside_ntz_value(elem & ~in_elem_mask);
229 /* If there is a bit set in the current elem, exit. */
230 if(p < BITS_PER_ELEM) {
231 return elem_pos * BITS_PER_ELEM + p;
234 /* Else search for set bits in the next units. */
237 elem = bitset[elem_pos];
241 p = _bitset_inside_ntz_value(elem);
242 if(p < BITS_PER_ELEM) {
243 return elem_pos * BITS_PER_ELEM + p;
252 * Inplace Intersection of two sets.
254 static INLINE void rbitset_and(unsigned *bitset1, const unsigned *bitset2,
257 unsigned i, n = BITSET_SIZE_ELEMS(size);
259 for(i = 0; i < n; ++i) {
260 bitset1[i] &= bitset2[i];
265 * Inplace Union of two sets.
267 static INLINE void rbitset_or(unsigned *bitset1, const unsigned *bitset2,
270 unsigned i, n = BITSET_SIZE_ELEMS(size);
272 for(i = 0; i < n; ++i) {
273 bitset1[i] |= bitset2[i];
278 * Remove all bits in bitset2 from bitset 1.
280 static INLINE void rbitset_andnot(unsigned *bitset1, const unsigned *bitset2,
283 unsigned i, n = BITSET_SIZE_ELEMS(size);
285 for(i = 0; i < n; ++i) {
286 bitset1[i] &= ~bitset2[i];
291 * Xor of two bitsets.
293 static INLINE void rbitset_xor(unsigned *bitset1, const unsigned *bitset2,
296 unsigned i, n = BITSET_SIZE_ELEMS(size);
298 for(i = 0; i < n; ++i) {
299 bitset1[i] ^= bitset2[i];
303 static INLINE int rbitset_equal(const unsigned *bitset1,
304 const unsigned *bitset2, size_t size)
306 unsigned i, n = BITSET_SIZE_ELEMS(size);
308 for(i = 0; i < n; ++i) {
309 if(bitset1[i] != bitset2[i])
316 * Copy a raw bitset into an bitset.
320 static INLINE void rbitset_copy_to_bitset(const unsigned *rbitset, bitset_t *bitset) {
321 // TODO optimize me (or remove me)
322 unsigned i, n = bitset_size(bitset);
323 for(i = 0; i < n; ++i) {
324 if(rbitset_is_set(rbitset, i))
325 bitset_set(bitset, i);
329 #endif /* FIRM_ADT_RAW_BITSET_H */