]>
Commit | Line | Data |
---|---|---|
ef017502 AD |
1 | /* Base bitset stuff. |
2 | Copyright (C) 2002 Free Software Foundation, Inc. | |
3 | Contributed by Michael Hayes (m.hayes@elec.canterbury.ac.nz). | |
4 | ||
5 | This program is free software; you can redistribute it and/or modify | |
6 | it under the terms of the GNU General Public License as published by | |
7 | the Free Software Foundation; either version 2 of the License, or | |
8 | (at your option) any later version. | |
9 | ||
10 | This program is distributed in the hope that it will be useful, | |
11 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
13 | GNU General Public License for more details. | |
14 | ||
15 | You should have received a copy of the GNU General Public License | |
16 | along with this program; if not, write to the Free Software | |
17 | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ | |
18 | ||
19 | #ifndef _BBITSET_H | |
20 | #define _BBITSET_H | |
21 | ||
613f5e1a | 22 | #include "libiberty.h" |
ef017502 AD |
23 | |
24 | #ifdef HAVE_LIMITS_H | |
25 | #include <limits.h> | |
26 | #endif | |
27 | ||
28 | /* Currently we support three flavours of bitsets: | |
6aa452a6 | 29 | BITSET_ARRAY: Array of bits (fixed size, fast for dense bitsets). |
ef017502 | 30 | BITSET_LIST: Linked list of array of bits (variable size, least storage |
6aa452a6 | 31 | for large very sparse sets). |
613f5e1a | 32 | BITSET_TABLE: Expandable table of pointers to array of bits |
6aa452a6 | 33 | (variable size, less storage for large sparse sets). |
613f5e1a AD |
34 | |
35 | BITSET_STATS: Wrapper bitset for internal use only. | |
ef017502 | 36 | */ |
613f5e1a AD |
37 | enum bitset_type {BITSET_ARRAY, BITSET_LIST, BITSET_TABLE, BITSET_TYPE_NUM, |
38 | BITSET_STATS}; | |
39 | #define BITSET_TYPE_NAMES {"abitset", "lbitset", "ebitset"} | |
ef017502 | 40 | |
6aa452a6 AD |
41 | extern const char * const bitset_type_names[]; |
42 | ||
613f5e1a | 43 | enum bitset_alloc_type {BITSET_MALLOC, BITSET_OBALLOC}; |
ef017502 AD |
44 | |
45 | /* Non-zero to use inline functions instead of macros. */ | |
46 | #define BITSET_INLINE 0 | |
47 | ||
ef017502 AD |
48 | /* Data type used to store a word of bits. */ |
49 | typedef unsigned long bitset_word; | |
50f095c9 | 50 | #define BITSET_WORD_BITS ((unsigned) (CHAR_BIT * sizeof (bitset_word))) |
ef017502 | 51 | |
50f095c9 PE |
52 | /* Bit index. In theory we might need a type wider than size_t, but |
53 | in practice we lose at most a factor of CHAR_BIT by going with | |
f6ebdb31 PE |
54 | size_t, and that is good enough. If this type is changed to be |
55 | wider than size_t, the code needs to be modified to check for | |
56 | overflow when converting bit counts to byte or word counts. | |
57 | The bit and word index types must be unsigned. */ | |
50f095c9 | 58 | typedef size_t bitset_bindex; |
ef017502 AD |
59 | |
60 | /* Word index. */ | |
50f095c9 | 61 | typedef size_t bitset_windex; |
ef017502 | 62 | |
f6ebdb31 PE |
63 | /* Maximum values for commonly-used unsigned types. BITSET_SIZE_MAX |
64 | always equals SIZE_MAX, but some older systems lack SIZE_MAX. */ | |
65 | #define BITSET_BINDEX_MAX ((bitset_bindex) -1) | |
5beedd9b PE |
66 | |
67 | /* Limit max word index to the maximum value of a signed integer | |
68 | to simplify cache disabling. */ | |
69 | #define BITSET_WINDEX_MAX (((bitset_windex) -1) >> 1) | |
f6ebdb31 | 70 | #define BITSET_SIZE_MAX ((size_t) -1) |
ef017502 | 71 | |
50f095c9 | 72 | #define BITSET_MSB ((bitset_word) 1 << (BITSET_WORD_BITS - 1)) |
ef017502 AD |
73 | |
74 | #define BITSET_LIST_SIZE 1024 | |
75 | ||
613f5e1a AD |
76 | enum bitset_ops {BITSET_OP_ZERO, BITSET_OP_ONES, |
77 | BITSET_OP_COPY, BITSET_OP_NOT, | |
ef017502 AD |
78 | BITSET_OP_EMPTY_P, BITSET_OP_EQUAL_P, |
79 | BITSET_OP_SUBSET_P, BITSET_OP_DISJOINT_P, | |
613f5e1a | 80 | BITSET_OP_AND, BITSET_OP_OR, BITSET_OP_XOR, BITSET_OP_ANDN, |
ef017502 AD |
81 | BITSET_OP_OR_AND, BITSET_OP_AND_OR, BITSET_OP_ANDN_OR}; |
82 | ||
6aa452a6 AD |
83 | struct bbitset_struct |
84 | { | |
85 | const struct bitset_vtable * vtable; | |
86 | bitset_windex cindex; /* Cache word index. */ | |
87 | bitset_windex csize; /* Cache size in words. */ | |
88 | bitset_word *cdata; /* Cache data pointer. */ | |
89 | /* Perhaps we could sacrifice another word to indicate | |
90 | that the bitset is known to be zero, that a bit has been set | |
91 | in the cache, and that a bit has been cleared in the cache. | |
92 | This would speed up some of the searches but slightly slow down | |
93 | bit set/reset operations of cached bits. */ | |
94 | }; | |
95 | ||
96 | ||
97 | typedef struct bitset_struct *bitset; | |
98 | ||
99 | ||
100 | /* The contents of this structure should be considered private. */ | |
101 | struct bitset_vtable | |
102 | { | |
103 | void (*set) PARAMS ((struct bitset_struct *, bitset_bindex)); | |
104 | void (*reset) PARAMS ((struct bitset_struct *, bitset_bindex)); | |
105 | int (*toggle) PARAMS ((struct bitset_struct *, bitset_bindex)); | |
106 | int (*test) PARAMS ((struct bitset_struct *, bitset_bindex)); | |
f6ebdb31 PE |
107 | bitset_bindex (*size) PARAMS ((struct bitset_struct *)); |
108 | bitset_bindex (*count) PARAMS ((struct bitset_struct *)); | |
6aa452a6 AD |
109 | |
110 | int (*empty_p) PARAMS ((struct bitset_struct *)); | |
111 | void (*ones) PARAMS ((struct bitset_struct *)); | |
112 | void (*zero) PARAMS ((struct bitset_struct *)); | |
113 | ||
114 | void (*copy) PARAMS ((struct bitset_struct *, struct bitset_struct *)); | |
115 | int (*disjoint_p) PARAMS ((struct bitset_struct *, struct bitset_struct *)); | |
116 | int (*equal_p) PARAMS ((struct bitset_struct *, struct bitset_struct *)); | |
117 | void (*not) PARAMS ((struct bitset_struct *, struct bitset_struct *)); | |
118 | int (*subset_p) PARAMS ((struct bitset_struct *, struct bitset_struct *)); | |
119 | ||
120 | void (*and) PARAMS ((struct bitset_struct *, struct bitset_struct *, | |
121 | struct bitset_struct *)); | |
122 | int (*and_cmp) PARAMS ((struct bitset_struct *, struct bitset_struct *, | |
123 | struct bitset_struct *)); | |
124 | void (*andn) PARAMS ((struct bitset_struct *, struct bitset_struct *, | |
125 | struct bitset_struct *)); | |
126 | int (*andn_cmp) PARAMS ((struct bitset_struct *, struct bitset_struct *, | |
127 | struct bitset_struct *)); | |
128 | void (*or) PARAMS ((struct bitset_struct *, struct bitset_struct *, | |
129 | struct bitset_struct *)); | |
130 | int (*or_cmp) PARAMS ((struct bitset_struct *, struct bitset_struct *, | |
131 | struct bitset_struct *)); | |
132 | void (*xor) PARAMS ((struct bitset_struct *, struct bitset_struct *, | |
133 | struct bitset_struct *)); | |
134 | int (*xor_cmp) PARAMS ((struct bitset_struct *, struct bitset_struct *, | |
135 | struct bitset_struct *)); | |
136 | ||
137 | void (*and_or) PARAMS ((struct bitset_struct *, struct bitset_struct *, | |
138 | struct bitset_struct *, struct bitset_struct *)); | |
139 | int (*and_or_cmp) PARAMS ((struct bitset_struct *, struct bitset_struct *, | |
140 | struct bitset_struct *, struct bitset_struct *)); | |
141 | void (*andn_or) PARAMS ((struct bitset_struct *, struct bitset_struct *, | |
142 | struct bitset_struct *, struct bitset_struct *)); | |
143 | int (*andn_or_cmp) PARAMS ((struct bitset_struct *, struct bitset_struct *, | |
144 | struct bitset_struct *, struct bitset_struct *)); | |
145 | void (*or_and) PARAMS ((struct bitset_struct *, struct bitset_struct *, | |
146 | struct bitset_struct *, struct bitset_struct *)); | |
147 | int (*or_and_cmp) PARAMS ((struct bitset_struct *, struct bitset_struct *, | |
148 | struct bitset_struct *, struct bitset_struct *)); | |
149 | ||
f6ebdb31 PE |
150 | bitset_bindex (*list) PARAMS ((struct bitset_struct *, bitset_bindex *, |
151 | bitset_bindex, bitset_bindex *)); | |
152 | bitset_bindex (*list_reverse) PARAMS ((struct bitset_struct *, | |
153 | bitset_bindex *, bitset_bindex, | |
154 | bitset_bindex *)); | |
6aa452a6 AD |
155 | void (*free) PARAMS ((struct bitset_struct *)); |
156 | enum bitset_type type; | |
157 | }; | |
158 | ||
159 | #define BITSET_COMPATIBLE_(BSET1, BSET2) ((BSET1)->b.vtable == (BSET2)->b.vtable) | |
160 | ||
161 | #define BITSET_CHECK2_(DST, SRC) \ | |
162 | if (!BITSET_COMPATIBLE_ (DST, SRC)) abort (); | |
163 | ||
164 | #define BITSET_CHECK3_(DST, SRC1, SRC2) \ | |
165 | if (!BITSET_COMPATIBLE_ (DST, SRC1) \ | |
166 | || !BITSET_COMPATIBLE_ (DST, SRC2)) abort (); | |
167 | ||
168 | #define BITSET_CHECK4_(DST, SRC1, SRC2, SRC3) \ | |
169 | if (!BITSET_COMPATIBLE_ (DST, SRC1) || !BITSET_COMPATIBLE_ (DST, SRC2) \ | |
170 | || !BITSET_COMPATIBLE_ (DST, SRC3)) abort (); | |
171 | ||
172 | ||
ef017502 | 173 | /* Return size in bits of bitset SRC. */ |
6aa452a6 AD |
174 | #define BITSET_SIZE_(SRC) (SRC)->b.vtable->size (SRC) |
175 | ||
176 | /* Return number of bits set in bitset SRC. */ | |
177 | #define BITSET_COUNT_(SRC) (SRC)->b.vtable->count (SRC) | |
ef017502 AD |
178 | |
179 | /* Return type of bitset SRC. */ | |
6aa452a6 | 180 | #define BITSET_TYPE_(DST) (DST)->b.vtable->type |
ef017502 AD |
181 | |
182 | /* Set bit BITNO in bitset DST. */ | |
6aa452a6 | 183 | #define BITSET_SET_(DST, BITNO) (DST)->b.vtable->set (DST, BITNO) |
ef017502 AD |
184 | |
185 | /* Reset bit BITNO in bitset DST. */ | |
6aa452a6 AD |
186 | #define BITSET_RESET_(DST, BITNO) (DST)->b.vtable->reset (DST, BITNO) |
187 | ||
188 | /* Toggle bit BITNO in bitset DST. */ | |
189 | #define BITSET_TOGGLE_(DST, BITNO) (DST)->b.vtable->toggle (DST, BITNO) | |
ef017502 AD |
190 | |
191 | /* Return non-zero if bit BITNO in bitset SRC is set. */ | |
6aa452a6 | 192 | #define BITSET_TEST_(SRC, BITNO) (SRC)->b.vtable->test (SRC, BITNO) |
ef017502 AD |
193 | |
194 | /* Free bitset SRC. */ | |
195 | #define BITSET_FREE_(SRC)\ | |
6aa452a6 | 196 | ((SRC)->b.vtable->free ? (SRC)->b.vtable->free (SRC) :(void)0) |
ef017502 | 197 | |
ef017502 | 198 | |
6aa452a6 AD |
199 | /* Return SRC == 0. */ |
200 | #define BITSET_EMPTY_P_(SRC) (SRC)->b.vtable->empty_p (SRC) | |
ef017502 | 201 | |
6aa452a6 AD |
202 | /* DST = ~0. */ |
203 | #define BITSET_ONES_(DST) (DST)->b.vtable->ones (DST) | |
ef017502 AD |
204 | |
205 | /* DST = 0. */ | |
6aa452a6 | 206 | #define BITSET_ZERO_(DST) (DST)->b.vtable->zero (DST) |
ef017502 | 207 | |
ef017502 | 208 | |
6aa452a6 AD |
209 | |
210 | /* DST = SRC. */ | |
211 | #define BITSET_COPY_(DST, SRC) (SRC)->b.vtable->copy (DST, SRC) | |
212 | ||
213 | /* Return DST & SRC == 0. */ | |
214 | #define BITSET_DISJOINT_P_(DST, SRC) (SRC)->b.vtable->disjoint_p (DST, SRC) | |
ef017502 AD |
215 | |
216 | /* Return DST == SRC. */ | |
6aa452a6 AD |
217 | #define BITSET_EQUAL_P_(DST, SRC) (SRC)->b.vtable->equal_p (DST, SRC) |
218 | ||
219 | /* DST = ~SRC. */ | |
220 | #define BITSET_NOT_(DST, SRC) (SRC)->b.vtable->not (DST, SRC) | |
ef017502 AD |
221 | |
222 | /* Return DST == DST | SRC. */ | |
6aa452a6 | 223 | #define BITSET_SUBSET_P_(DST, SRC) (SRC)->b.vtable->subset_p (DST, SRC) |
ef017502 | 224 | |
ef017502 | 225 | |
6aa452a6 AD |
226 | /* DST = SRC1 & SRC2. */ |
227 | #define BITSET_AND_(DST, SRC1, SRC2) (SRC1)->b.vtable->and (DST, SRC1, SRC2) | |
228 | #define BITSET_AND_CMP_(DST, SRC1, SRC2) (SRC1)->b.vtable->and_cmp (DST, SRC1, SRC2) | |
ef017502 | 229 | |
6aa452a6 AD |
230 | /* DST = SRC1 & ~SRC2. */ |
231 | #define BITSET_ANDN_(DST, SRC1, SRC2) (SRC1)->b.vtable->andn (DST, SRC1, SRC2) | |
232 | #define BITSET_ANDN_CMP_(DST, SRC1, SRC2) (SRC1)->b.vtable->andn_cmp (DST, SRC1, SRC2) | |
ef017502 AD |
233 | |
234 | /* DST = SRC1 | SRC2. */ | |
6aa452a6 AD |
235 | #define BITSET_OR_(DST, SRC1, SRC2) (SRC1)->b.vtable->or (DST, SRC1, SRC2) |
236 | #define BITSET_OR_CMP_(DST, SRC1, SRC2) (SRC1)->b.vtable->or_cmp (DST, SRC1, SRC2) | |
ef017502 AD |
237 | |
238 | /* DST = SRC1 ^ SRC2. */ | |
6aa452a6 AD |
239 | #define BITSET_XOR_(DST, SRC1, SRC2) (SRC1)->b.vtable->xor (DST, SRC1, SRC2) |
240 | #define BITSET_XOR_CMP_(DST, SRC1, SRC2) (SRC1)->b.vtable->xor_cmp (DST, SRC1, SRC2) | |
ef017502 | 241 | |
ef017502 | 242 | |
ef017502 | 243 | |
ef017502 AD |
244 | /* DST = (SRC1 & SRC2) | SRC3. Return non-zero if |
245 | DST != (SRC1 & SRC2) | SRC3. */ | |
6aa452a6 AD |
246 | #define BITSET_AND_OR_(DST, SRC1, SRC2, SRC3) \ |
247 | (SRC1)->b.vtable->and_or (DST, SRC1, SRC2, SRC3) | |
248 | #define BITSET_AND_OR_CMP_(DST, SRC1, SRC2, SRC3) \ | |
249 | (SRC1)->b.vtable->and_or_cmp (DST, SRC1, SRC2, SRC3) | |
250 | ||
251 | /* DST = (SRC1 & ~SRC2) | SRC3. Return non-zero if | |
252 | DST != (SRC1 & ~SRC2) | SRC3. */ | |
253 | #define BITSET_ANDN_OR_(DST, SRC1, SRC2, SRC3) \ | |
254 | (SRC1)->b.vtable->andn_or (DST, SRC1, SRC2, SRC3) | |
255 | #define BITSET_ANDN_OR_CMP_(DST, SRC1, SRC2, SRC3) \ | |
256 | (SRC1)->b.vtable->andn_or_cmp (DST, SRC1, SRC2, SRC3) | |
ef017502 AD |
257 | |
258 | /* DST = (SRC1 | SRC2) & SRC3. Return non-zero if | |
259 | DST != (SRC1 | SRC2) & SRC3. */ | |
6aa452a6 AD |
260 | #define BITSET_OR_AND_(DST, SRC1, SRC2, SRC3) \ |
261 | (SRC1)->b.vtable->or_and (DST, SRC1, SRC2, SRC3) | |
262 | #define BITSET_OR_AND_CMP_(DST, SRC1, SRC2, SRC3) \ | |
263 | (SRC1)->b.vtable->or_and_cmp (DST, SRC1, SRC2, SRC3) | |
ef017502 | 264 | |
ef017502 | 265 | |
613f5e1a | 266 | /* Find list of up to NUM bits set in BSET starting from and including |
ef017502 AD |
267 | *NEXT. Return with actual number of bits found and with *NEXT |
268 | indicating where search stopped. */ | |
269 | #define BITSET_LIST_(BSET, LIST, NUM, NEXT) \ | |
6aa452a6 | 270 | (BSET)->b.vtable->list (BSET, LIST, NUM, NEXT) |
ef017502 AD |
271 | |
272 | /* Find reverse list of up to NUM bits set in BSET starting from and | |
273 | including NEXT. Return with actual number of bits found and with | |
274 | *NEXT indicating where search stopped. */ | |
6aa452a6 AD |
275 | #define BITSET_LIST_REVERSE_(BSET, LIST, NUM, NEXT) \ |
276 | (BSET)->b.vtable->list_reverse (BSET, LIST, NUM, NEXT) | |
ef017502 AD |
277 | |
278 | ||
6aa452a6 AD |
279 | /* Private functions for bitset implementations. */ |
280 | ||
281 | extern int bitset_toggle_ PARAMS ((bitset, bitset_bindex)); | |
ef017502 | 282 | |
f6ebdb31 | 283 | extern bitset_bindex bitset_count_ PARAMS ((bitset)); |
ef017502 | 284 | |
6aa452a6 | 285 | extern int bitset_copy_ PARAMS ((bitset, bitset)); |
ef017502 | 286 | |
6aa452a6 | 287 | extern int bitset_and_or_cmp_ PARAMS ((bitset, bitset, bitset, bitset)); |
ef017502 | 288 | |
6aa452a6 | 289 | extern int bitset_andn_or_cmp_ PARAMS ((bitset, bitset, bitset, bitset)); |
ef017502 | 290 | |
6aa452a6 | 291 | extern int bitset_or_and_cmp_ PARAMS ((bitset, bitset, bitset, bitset)); |
ef017502 AD |
292 | |
293 | #endif /* _BBITSET_H */ |