1*e4b17023SJohn Marino /* Simple bitmaps.
2*e4b17023SJohn Marino Copyright (C) 1999, 2000, 2002, 2003, 2004, 2006, 2007, 2008, 2010
3*e4b17023SJohn Marino Free Software Foundation, Inc.
4*e4b17023SJohn Marino
5*e4b17023SJohn Marino This file is part of GCC.
6*e4b17023SJohn Marino
7*e4b17023SJohn Marino GCC is free software; you can redistribute it and/or modify it under
8*e4b17023SJohn Marino the terms of the GNU General Public License as published by the Free
9*e4b17023SJohn Marino Software Foundation; either version 3, or (at your option) any later
10*e4b17023SJohn Marino version.
11*e4b17023SJohn Marino
12*e4b17023SJohn Marino GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13*e4b17023SJohn Marino WARRANTY; without even the implied warranty of MERCHANTABILITY or
14*e4b17023SJohn Marino FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15*e4b17023SJohn Marino for more details.
16*e4b17023SJohn Marino
17*e4b17023SJohn Marino You should have received a copy of the GNU General Public License
18*e4b17023SJohn Marino along with GCC; see the file COPYING3. If not see
19*e4b17023SJohn Marino <http://www.gnu.org/licenses/>. */
20*e4b17023SJohn Marino
21*e4b17023SJohn Marino #ifndef GCC_SBITMAP_H
22*e4b17023SJohn Marino #define GCC_SBITMAP_H
23*e4b17023SJohn Marino
24*e4b17023SJohn Marino /* It's not clear yet whether using bitmap.[ch] will be a win.
25*e4b17023SJohn Marino It should be straightforward to convert so for now we keep things simple
26*e4b17023SJohn Marino while more important issues are dealt with. */
27*e4b17023SJohn Marino
28*e4b17023SJohn Marino #define SBITMAP_ELT_BITS ((unsigned) HOST_BITS_PER_WIDEST_FAST_INT)
29*e4b17023SJohn Marino #define SBITMAP_ELT_TYPE unsigned HOST_WIDEST_FAST_INT
30*e4b17023SJohn Marino
31*e4b17023SJohn Marino /* Can't use SBITMAP_ELT_BITS in this macro because it contains a
32*e4b17023SJohn Marino cast. There is no perfect macro in GCC to test against. This
33*e4b17023SJohn Marino suffices for roughly 99% of the hosts we run on, and the rest
34*e4b17023SJohn Marino don't have 256 bit integers. */
35*e4b17023SJohn Marino #if HOST_BITS_PER_WIDEST_FAST_INT > 255
36*e4b17023SJohn Marino #error Need to increase size of datatype used for popcount
37*e4b17023SJohn Marino #endif
38*e4b17023SJohn Marino
39*e4b17023SJohn Marino struct simple_bitmap_def
40*e4b17023SJohn Marino {
41*e4b17023SJohn Marino unsigned char *popcount; /* Population count. */
42*e4b17023SJohn Marino unsigned int n_bits; /* Number of bits. */
43*e4b17023SJohn Marino unsigned int size; /* Size in elements. */
44*e4b17023SJohn Marino SBITMAP_ELT_TYPE elms[1]; /* The elements. */
45*e4b17023SJohn Marino };
46*e4b17023SJohn Marino
47*e4b17023SJohn Marino /* Return the set size needed for N elements. */
48*e4b17023SJohn Marino #define SBITMAP_SET_SIZE(N) (((N) + SBITMAP_ELT_BITS - 1) / SBITMAP_ELT_BITS)
49*e4b17023SJohn Marino #define SBITMAP_SIZE_BYTES(BITMAP) ((BITMAP)->size * sizeof (SBITMAP_ELT_TYPE))
50*e4b17023SJohn Marino
51*e4b17023SJohn Marino /* Test if bit number bitno in the bitmap is set. */
52*e4b17023SJohn Marino #define TEST_BIT(BITMAP, BITNO) \
53*e4b17023SJohn Marino ((BITMAP)->elms [(BITNO) / SBITMAP_ELT_BITS] >> (BITNO) % SBITMAP_ELT_BITS & 1)
54*e4b17023SJohn Marino
55*e4b17023SJohn Marino /* Set bit number BITNO in the sbitmap MAP. Updates population count
56*e4b17023SJohn Marino if this bitmap has one. */
57*e4b17023SJohn Marino
58*e4b17023SJohn Marino static inline void
SET_BIT(sbitmap map,unsigned int bitno)59*e4b17023SJohn Marino SET_BIT (sbitmap map, unsigned int bitno)
60*e4b17023SJohn Marino {
61*e4b17023SJohn Marino if (map->popcount)
62*e4b17023SJohn Marino {
63*e4b17023SJohn Marino bool oldbit;
64*e4b17023SJohn Marino oldbit = TEST_BIT (map, bitno);
65*e4b17023SJohn Marino if (!oldbit)
66*e4b17023SJohn Marino map->popcount[bitno / SBITMAP_ELT_BITS]++;
67*e4b17023SJohn Marino }
68*e4b17023SJohn Marino map->elms[bitno / SBITMAP_ELT_BITS]
69*e4b17023SJohn Marino |= (SBITMAP_ELT_TYPE) 1 << (bitno) % SBITMAP_ELT_BITS;
70*e4b17023SJohn Marino }
71*e4b17023SJohn Marino
72*e4b17023SJohn Marino
73*e4b17023SJohn Marino
74*e4b17023SJohn Marino /* Reset bit number BITNO in the sbitmap MAP. Updates population
75*e4b17023SJohn Marino count if this bitmap has one. */
76*e4b17023SJohn Marino
77*e4b17023SJohn Marino static inline void
RESET_BIT(sbitmap map,unsigned int bitno)78*e4b17023SJohn Marino RESET_BIT (sbitmap map, unsigned int bitno)
79*e4b17023SJohn Marino {
80*e4b17023SJohn Marino if (map->popcount)
81*e4b17023SJohn Marino {
82*e4b17023SJohn Marino bool oldbit;
83*e4b17023SJohn Marino oldbit = TEST_BIT (map, bitno);
84*e4b17023SJohn Marino if (oldbit)
85*e4b17023SJohn Marino map->popcount[bitno / SBITMAP_ELT_BITS]--;
86*e4b17023SJohn Marino }
87*e4b17023SJohn Marino map->elms[bitno / SBITMAP_ELT_BITS]
88*e4b17023SJohn Marino &= ~((SBITMAP_ELT_TYPE) 1 << (bitno) % SBITMAP_ELT_BITS);
89*e4b17023SJohn Marino }
90*e4b17023SJohn Marino
91*e4b17023SJohn Marino /* The iterator for sbitmap. */
92*e4b17023SJohn Marino typedef struct {
93*e4b17023SJohn Marino /* The pointer to the first word of the bitmap. */
94*e4b17023SJohn Marino const SBITMAP_ELT_TYPE *ptr;
95*e4b17023SJohn Marino
96*e4b17023SJohn Marino /* The size of the bitmap. */
97*e4b17023SJohn Marino unsigned int size;
98*e4b17023SJohn Marino
99*e4b17023SJohn Marino /* The current word index. */
100*e4b17023SJohn Marino unsigned int word_num;
101*e4b17023SJohn Marino
102*e4b17023SJohn Marino /* The current bit index (not modulo SBITMAP_ELT_BITS). */
103*e4b17023SJohn Marino unsigned int bit_num;
104*e4b17023SJohn Marino
105*e4b17023SJohn Marino /* The words currently visited. */
106*e4b17023SJohn Marino SBITMAP_ELT_TYPE word;
107*e4b17023SJohn Marino } sbitmap_iterator;
108*e4b17023SJohn Marino
109*e4b17023SJohn Marino /* Initialize the iterator I with sbitmap BMP and the initial index
110*e4b17023SJohn Marino MIN. */
111*e4b17023SJohn Marino
112*e4b17023SJohn Marino static inline void
sbitmap_iter_init(sbitmap_iterator * i,const_sbitmap bmp,unsigned int min)113*e4b17023SJohn Marino sbitmap_iter_init (sbitmap_iterator *i, const_sbitmap bmp, unsigned int min)
114*e4b17023SJohn Marino {
115*e4b17023SJohn Marino i->word_num = min / (unsigned int) SBITMAP_ELT_BITS;
116*e4b17023SJohn Marino i->bit_num = min;
117*e4b17023SJohn Marino i->size = bmp->size;
118*e4b17023SJohn Marino i->ptr = bmp->elms;
119*e4b17023SJohn Marino
120*e4b17023SJohn Marino if (i->word_num >= i->size)
121*e4b17023SJohn Marino i->word = 0;
122*e4b17023SJohn Marino else
123*e4b17023SJohn Marino i->word = (i->ptr[i->word_num]
124*e4b17023SJohn Marino >> (i->bit_num % (unsigned int) SBITMAP_ELT_BITS));
125*e4b17023SJohn Marino }
126*e4b17023SJohn Marino
127*e4b17023SJohn Marino /* Return true if we have more bits to visit, in which case *N is set
128*e4b17023SJohn Marino to the index of the bit to be visited. Otherwise, return
129*e4b17023SJohn Marino false. */
130*e4b17023SJohn Marino
131*e4b17023SJohn Marino static inline bool
sbitmap_iter_cond(sbitmap_iterator * i,unsigned int * n)132*e4b17023SJohn Marino sbitmap_iter_cond (sbitmap_iterator *i, unsigned int *n)
133*e4b17023SJohn Marino {
134*e4b17023SJohn Marino /* Skip words that are zeros. */
135*e4b17023SJohn Marino for (; i->word == 0; i->word = i->ptr[i->word_num])
136*e4b17023SJohn Marino {
137*e4b17023SJohn Marino i->word_num++;
138*e4b17023SJohn Marino
139*e4b17023SJohn Marino /* If we have reached the end, break. */
140*e4b17023SJohn Marino if (i->word_num >= i->size)
141*e4b17023SJohn Marino return false;
142*e4b17023SJohn Marino
143*e4b17023SJohn Marino i->bit_num = i->word_num * SBITMAP_ELT_BITS;
144*e4b17023SJohn Marino }
145*e4b17023SJohn Marino
146*e4b17023SJohn Marino /* Skip bits that are zero. */
147*e4b17023SJohn Marino for (; (i->word & 1) == 0; i->word >>= 1)
148*e4b17023SJohn Marino i->bit_num++;
149*e4b17023SJohn Marino
150*e4b17023SJohn Marino *n = i->bit_num;
151*e4b17023SJohn Marino
152*e4b17023SJohn Marino return true;
153*e4b17023SJohn Marino }
154*e4b17023SJohn Marino
155*e4b17023SJohn Marino /* Advance to the next bit. */
156*e4b17023SJohn Marino
157*e4b17023SJohn Marino static inline void
sbitmap_iter_next(sbitmap_iterator * i)158*e4b17023SJohn Marino sbitmap_iter_next (sbitmap_iterator *i)
159*e4b17023SJohn Marino {
160*e4b17023SJohn Marino i->word >>= 1;
161*e4b17023SJohn Marino i->bit_num++;
162*e4b17023SJohn Marino }
163*e4b17023SJohn Marino
164*e4b17023SJohn Marino /* Loop over all elements of SBITMAP, starting with MIN. In each
165*e4b17023SJohn Marino iteration, N is set to the index of the bit being visited. ITER is
166*e4b17023SJohn Marino an instance of sbitmap_iterator used to iterate the bitmap. */
167*e4b17023SJohn Marino
168*e4b17023SJohn Marino #define EXECUTE_IF_SET_IN_SBITMAP(SBITMAP, MIN, N, ITER) \
169*e4b17023SJohn Marino for (sbitmap_iter_init (&(ITER), (SBITMAP), (MIN)); \
170*e4b17023SJohn Marino sbitmap_iter_cond (&(ITER), &(N)); \
171*e4b17023SJohn Marino sbitmap_iter_next (&(ITER)))
172*e4b17023SJohn Marino
173*e4b17023SJohn Marino #define EXECUTE_IF_SET_IN_SBITMAP_REV(SBITMAP, N, CODE) \
174*e4b17023SJohn Marino do { \
175*e4b17023SJohn Marino unsigned int word_num_; \
176*e4b17023SJohn Marino unsigned int bit_num_; \
177*e4b17023SJohn Marino unsigned int size_ = (SBITMAP)->size; \
178*e4b17023SJohn Marino SBITMAP_ELT_TYPE *ptr_ = (SBITMAP)->elms; \
179*e4b17023SJohn Marino \
180*e4b17023SJohn Marino for (word_num_ = size_; word_num_ > 0; word_num_--) \
181*e4b17023SJohn Marino { \
182*e4b17023SJohn Marino SBITMAP_ELT_TYPE word_ = ptr_[word_num_ - 1]; \
183*e4b17023SJohn Marino \
184*e4b17023SJohn Marino if (word_ != 0) \
185*e4b17023SJohn Marino for (bit_num_ = SBITMAP_ELT_BITS; bit_num_ > 0; bit_num_--) \
186*e4b17023SJohn Marino { \
187*e4b17023SJohn Marino SBITMAP_ELT_TYPE _mask = (SBITMAP_ELT_TYPE)1 << (bit_num_ - 1);\
188*e4b17023SJohn Marino \
189*e4b17023SJohn Marino if ((word_ & _mask) != 0) \
190*e4b17023SJohn Marino { \
191*e4b17023SJohn Marino word_ &= ~ _mask; \
192*e4b17023SJohn Marino (N) = (word_num_ - 1) * SBITMAP_ELT_BITS + bit_num_ - 1;\
193*e4b17023SJohn Marino CODE; \
194*e4b17023SJohn Marino if (word_ == 0) \
195*e4b17023SJohn Marino break; \
196*e4b17023SJohn Marino } \
197*e4b17023SJohn Marino } \
198*e4b17023SJohn Marino } \
199*e4b17023SJohn Marino } while (0)
200*e4b17023SJohn Marino
201*e4b17023SJohn Marino #define sbitmap_free(MAP) (free((MAP)->popcount), free((MAP)))
202*e4b17023SJohn Marino #define sbitmap_vector_free(VEC) free(VEC)
203*e4b17023SJohn Marino
204*e4b17023SJohn Marino struct int_list;
205*e4b17023SJohn Marino
206*e4b17023SJohn Marino extern void dump_sbitmap (FILE *, const_sbitmap);
207*e4b17023SJohn Marino extern void dump_sbitmap_file (FILE *, const_sbitmap);
208*e4b17023SJohn Marino extern void dump_sbitmap_vector (FILE *, const char *, const char *, sbitmap *,
209*e4b17023SJohn Marino int);
210*e4b17023SJohn Marino extern sbitmap sbitmap_alloc (unsigned int);
211*e4b17023SJohn Marino extern sbitmap sbitmap_alloc_with_popcount (unsigned int);
212*e4b17023SJohn Marino extern sbitmap *sbitmap_vector_alloc (unsigned int, unsigned int);
213*e4b17023SJohn Marino extern sbitmap sbitmap_resize (sbitmap, unsigned int, int);
214*e4b17023SJohn Marino extern void sbitmap_copy (sbitmap, const_sbitmap);
215*e4b17023SJohn Marino extern void sbitmap_copy_n (sbitmap, const_sbitmap, unsigned int);
216*e4b17023SJohn Marino extern int sbitmap_equal (const_sbitmap, const_sbitmap);
217*e4b17023SJohn Marino extern bool sbitmap_empty_p (const_sbitmap);
218*e4b17023SJohn Marino extern bool sbitmap_range_empty_p (const_sbitmap, unsigned int, unsigned int);
219*e4b17023SJohn Marino extern void sbitmap_zero (sbitmap);
220*e4b17023SJohn Marino extern void sbitmap_ones (sbitmap);
221*e4b17023SJohn Marino extern void sbitmap_vector_zero (sbitmap *, unsigned int);
222*e4b17023SJohn Marino extern void sbitmap_vector_ones (sbitmap *, unsigned int);
223*e4b17023SJohn Marino
224*e4b17023SJohn Marino extern void sbitmap_union_of_diff (sbitmap, const_sbitmap, const_sbitmap, const_sbitmap);
225*e4b17023SJohn Marino extern bool sbitmap_union_of_diff_cg (sbitmap, const_sbitmap, const_sbitmap, const_sbitmap);
226*e4b17023SJohn Marino extern void sbitmap_difference (sbitmap, const_sbitmap, const_sbitmap);
227*e4b17023SJohn Marino extern void sbitmap_not (sbitmap, const_sbitmap);
228*e4b17023SJohn Marino extern void sbitmap_a_or_b_and_c (sbitmap, const_sbitmap, const_sbitmap, const_sbitmap);
229*e4b17023SJohn Marino extern bool sbitmap_a_or_b_and_c_cg (sbitmap, const_sbitmap, const_sbitmap, const_sbitmap);
230*e4b17023SJohn Marino extern void sbitmap_a_and_b_or_c (sbitmap, const_sbitmap, const_sbitmap, const_sbitmap);
231*e4b17023SJohn Marino extern bool sbitmap_a_and_b_or_c_cg (sbitmap, const_sbitmap, const_sbitmap, const_sbitmap);
232*e4b17023SJohn Marino extern bool sbitmap_any_common_bits (const_sbitmap, const_sbitmap);
233*e4b17023SJohn Marino extern void sbitmap_a_and_b (sbitmap, const_sbitmap, const_sbitmap);
234*e4b17023SJohn Marino extern bool sbitmap_a_and_b_cg (sbitmap, const_sbitmap, const_sbitmap);
235*e4b17023SJohn Marino extern void sbitmap_a_or_b (sbitmap, const_sbitmap, const_sbitmap);
236*e4b17023SJohn Marino extern bool sbitmap_a_or_b_cg (sbitmap, const_sbitmap, const_sbitmap);
237*e4b17023SJohn Marino extern void sbitmap_a_xor_b (sbitmap, const_sbitmap, const_sbitmap);
238*e4b17023SJohn Marino extern bool sbitmap_a_xor_b_cg (sbitmap, const_sbitmap, const_sbitmap);
239*e4b17023SJohn Marino extern bool sbitmap_a_subset_b_p (const_sbitmap, const_sbitmap);
240*e4b17023SJohn Marino
241*e4b17023SJohn Marino extern int sbitmap_first_set_bit (const_sbitmap);
242*e4b17023SJohn Marino extern int sbitmap_last_set_bit (const_sbitmap);
243*e4b17023SJohn Marino
244*e4b17023SJohn Marino extern void sbitmap_intersect_of_predsucc (sbitmap, sbitmap *, int,
245*e4b17023SJohn Marino struct int_list **);
246*e4b17023SJohn Marino #define sbitmap_intersect_of_predecessors sbitmap_intersect_of_predsucc
247*e4b17023SJohn Marino #define sbitmap_intersect_of_successors sbitmap_intersect_of_predsucc
248*e4b17023SJohn Marino
249*e4b17023SJohn Marino extern void sbitmap_union_of_predsucc (sbitmap, sbitmap *, int,
250*e4b17023SJohn Marino struct int_list **);
251*e4b17023SJohn Marino #define sbitmap_union_of_predecessors sbitmap_union_of_predsucc
252*e4b17023SJohn Marino #define sbitmap_union_of_successors sbitmap_union_of_predsucc
253*e4b17023SJohn Marino
254*e4b17023SJohn Marino /* Intersection and Union of preds/succs using the new flow graph
255*e4b17023SJohn Marino structure instead of the pred/succ arrays. */
256*e4b17023SJohn Marino
257*e4b17023SJohn Marino extern void sbitmap_intersection_of_succs (sbitmap, sbitmap *, int);
258*e4b17023SJohn Marino extern void sbitmap_intersection_of_preds (sbitmap, sbitmap *, int);
259*e4b17023SJohn Marino extern void sbitmap_union_of_succs (sbitmap, sbitmap *, int);
260*e4b17023SJohn Marino extern void sbitmap_union_of_preds (sbitmap, sbitmap *, int);
261*e4b17023SJohn Marino
262*e4b17023SJohn Marino extern void debug_sbitmap (const_sbitmap);
263*e4b17023SJohn Marino extern sbitmap sbitmap_realloc (sbitmap, unsigned int);
264*e4b17023SJohn Marino extern unsigned long sbitmap_popcount(const_sbitmap, unsigned long);
265*e4b17023SJohn Marino extern void sbitmap_verify_popcount (const_sbitmap);
266*e4b17023SJohn Marino #endif /* ! GCC_SBITMAP_H */
267