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