1 /* Functions to support general ended bitmaps.
2 Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
3 2006, 2007 Free Software Foundation, Inc.
5 This file is part of GCC.
7 GCC is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 2, or (at your option) any later
12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING. If not, write to the Free
19 Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA
25 #include "statistics.h"
27 /* Fundamental storage type for bitmap. */
29 typedef unsigned long BITMAP_WORD
;
30 /* BITMAP_WORD_BITS needs to be unsigned, but cannot contain casts as
31 it is used in preprocessor directives -- hence the 1u. */
32 #define BITMAP_WORD_BITS (CHAR_BIT * SIZEOF_LONG * 1u)
34 /* Number of words to use for each element in the linked list. */
36 #ifndef BITMAP_ELEMENT_WORDS
37 #define BITMAP_ELEMENT_WORDS ((128 + BITMAP_WORD_BITS - 1) / BITMAP_WORD_BITS)
40 /* Number of bits in each actual element of a bitmap. */
42 #define BITMAP_ELEMENT_ALL_BITS (BITMAP_ELEMENT_WORDS * BITMAP_WORD_BITS)
44 /* Obstack for allocating bitmaps and elements from. */
45 typedef struct bitmap_obstack
GTY (())
47 struct bitmap_element_def
*elements
;
48 struct bitmap_head_def
*heads
;
49 struct obstack
GTY ((skip
)) obstack
;
52 /* Bitmap set element. We use a linked list to hold only the bits that
53 are set. This allows for use to grow the bitset dynamically without
54 having to realloc and copy a giant bit array.
56 The free list is implemented as a list of lists. There is one
57 outer list connected together by prev fields. Each element of that
58 outer is an inner list (that may consist only of the outer list
59 element) that are connected by the next fields. The prev pointer
60 is undefined for interior elements. This allows
61 bitmap_elt_clear_from to be implemented in unit time rather than
62 linear in the number of elements to be freed. */
64 typedef struct bitmap_element_def
GTY(())
66 struct bitmap_element_def
*next
; /* Next element. */
67 struct bitmap_element_def
*prev
; /* Previous element. */
68 unsigned int indx
; /* regno/BITMAP_ELEMENT_ALL_BITS. */
69 BITMAP_WORD bits
[BITMAP_ELEMENT_WORDS
]; /* Bits that are set. */
72 struct bitmap_descriptor
;
73 /* Head of bitmap linked list. gengtype ignores ifdefs, but for
74 statistics we need to add a bitmap descriptor pointer. As it is
75 not collected, we can just GTY((skip)) it. */
77 typedef struct bitmap_head_def
GTY(()) {
78 bitmap_element
*first
; /* First element in linked list. */
79 bitmap_element
*current
; /* Last element looked at. */
80 unsigned int indx
; /* Index of last element looked at. */
81 bitmap_obstack
*obstack
; /* Obstack to allocate elements from.
82 If NULL, then use ggc_alloc. */
83 #ifdef GATHER_STATISTICS
84 struct bitmap_descriptor
GTY((skip
)) *desc
;
89 extern bitmap_element bitmap_zero_bits
; /* Zero bitmap element */
90 extern bitmap_obstack bitmap_default_obstack
; /* Default bitmap obstack */
92 /* Clear a bitmap by freeing up the linked list. */
93 extern void bitmap_clear (bitmap
);
95 /* Copy a bitmap to another bitmap. */
96 extern void bitmap_copy (bitmap
, bitmap
);
98 /* True if two bitmaps are identical. */
99 extern bool bitmap_equal_p (bitmap
, bitmap
);
101 /* True if the bitmaps intersect (their AND is non-empty). */
102 extern bool bitmap_intersect_p (bitmap
, bitmap
);
104 /* True if the complement of the second intersects the first (their
105 AND_COMPL is non-empty). */
106 extern bool bitmap_intersect_compl_p (bitmap
, bitmap
);
108 /* True if MAP is an empty bitmap. */
109 #define bitmap_empty_p(MAP) (!(MAP)->first)
111 /* Count the number of bits set in the bitmap. */
112 extern unsigned long bitmap_count_bits (bitmap
);
114 /* Boolean operations on bitmaps. The _into variants are two operand
115 versions that modify the first source operand. The other variants
116 are three operand versions that to not destroy the source bitmaps.
117 The operations supported are &, & ~, |, ^. */
118 extern void bitmap_and (bitmap
, bitmap
, bitmap
);
119 extern void bitmap_and_into (bitmap
, bitmap
);
120 extern bool bitmap_and_compl (bitmap
, bitmap
, bitmap
);
121 extern bool bitmap_and_compl_into (bitmap
, bitmap
);
122 #define bitmap_compl_and(DST, A, B) bitmap_and_compl (DST, B, A)
123 extern void bitmap_compl_and_into (bitmap
, bitmap
);
124 extern void bitmap_clear_range (bitmap
, unsigned int, unsigned int);
125 extern void bitmap_set_range (bitmap
, unsigned int, unsigned int);
126 extern bool bitmap_ior (bitmap
, bitmap
, bitmap
);
127 extern bool bitmap_ior_into (bitmap
, bitmap
);
128 extern void bitmap_xor (bitmap
, bitmap
, bitmap
);
129 extern void bitmap_xor_into (bitmap
, bitmap
);
131 /* DST = A | (B & ~C). Return true if DST changes. */
132 extern bool bitmap_ior_and_compl (bitmap DST
, bitmap A
, bitmap B
, bitmap C
);
133 /* A |= (B & ~C). Return true if A changes. */
134 extern bool bitmap_ior_and_compl_into (bitmap DST
, bitmap B
, bitmap C
);
136 /* Clear a single register in a register set. */
137 extern void bitmap_clear_bit (bitmap
, int);
139 /* Set a single register in a register set. */
140 extern void bitmap_set_bit (bitmap
, int);
142 /* Return true if a register is set in a register set. */
143 extern int bitmap_bit_p (bitmap
, int);
145 /* Debug functions to print a bitmap linked list. */
146 extern void debug_bitmap (bitmap
);
147 extern void debug_bitmap_file (FILE *, bitmap
);
149 /* Print a bitmap. */
150 extern void bitmap_print (FILE *, bitmap
, const char *, const char *);
152 /* Initialize and release a bitmap obstack. */
153 extern void bitmap_obstack_initialize (bitmap_obstack
*);
154 extern void bitmap_obstack_release (bitmap_obstack
*);
155 extern void bitmap_register (bitmap MEM_STAT_DECL
);
156 extern void dump_bitmap_statistics (void);
158 /* Initialize a bitmap header. OBSTACK indicates the bitmap obstack
159 to allocate from, NULL for GC'd bitmap. */
162 bitmap_initialize_stat (bitmap head
, bitmap_obstack
*obstack MEM_STAT_DECL
)
164 head
->first
= head
->current
= NULL
;
165 head
->obstack
= obstack
;
166 #ifdef GATHER_STATISTICS
167 bitmap_register (head PASS_MEM_STAT
);
170 #define bitmap_initialize(h,o) bitmap_initialize_stat (h,o MEM_STAT_INFO)
172 /* Allocate and free bitmaps from obstack, malloc and gc'd memory. */
173 extern bitmap
bitmap_obstack_alloc_stat (bitmap_obstack
*obstack MEM_STAT_DECL
);
174 #define bitmap_obstack_alloc(t) bitmap_obstack_alloc_stat (t MEM_STAT_INFO)
175 extern bitmap
bitmap_gc_alloc_stat (ALONE_MEM_STAT_DECL
);
176 #define bitmap_gc_alloc() bitmap_gc_alloc_stat (ALONE_MEM_STAT_INFO)
177 extern void bitmap_obstack_free (bitmap
);
179 /* A few compatibility/functions macros for compatibility with sbitmaps */
180 #define dump_bitmap(file, bitmap) bitmap_print (file, bitmap, "", "\n")
181 #define bitmap_zero(a) bitmap_clear (a)
182 extern unsigned bitmap_first_set_bit (bitmap
);
184 /* Compute bitmap hash (for purposes of hashing etc.) */
185 extern hashval_t
bitmap_hash(bitmap
);
187 /* Allocate a bitmap from a bit obstack. */
188 #define BITMAP_ALLOC(OBSTACK) bitmap_obstack_alloc (OBSTACK)
190 /* Allocate a gc'd bitmap. */
191 #define BITMAP_GGC_ALLOC() bitmap_gc_alloc ()
193 /* Do any cleanup needed on a bitmap when it is no longer used. */
194 #define BITMAP_FREE(BITMAP) \
195 ((void)(bitmap_obstack_free (BITMAP), (BITMAP) = NULL))
197 /* Iterator for bitmaps. */
201 /* Pointer to the current bitmap element. */
202 bitmap_element
*elt1
;
204 /* Pointer to 2nd bitmap element when two are involved. */
205 bitmap_element
*elt2
;
207 /* Word within the current element. */
210 /* Contents of the actually processed word. When finding next bit
211 it is shifted right, so that the actual bit is always the least
212 significant bit of ACTUAL. */
216 /* Initialize a single bitmap iterator. START_BIT is the first bit to
220 bmp_iter_set_init (bitmap_iterator
*bi
, bitmap map
,
221 unsigned start_bit
, unsigned *bit_no
)
223 bi
->elt1
= map
->first
;
226 /* Advance elt1 until it is not before the block containing start_bit. */
231 bi
->elt1
= &bitmap_zero_bits
;
235 if (bi
->elt1
->indx
>= start_bit
/ BITMAP_ELEMENT_ALL_BITS
)
237 bi
->elt1
= bi
->elt1
->next
;
240 /* We might have gone past the start bit, so reinitialize it. */
241 if (bi
->elt1
->indx
!= start_bit
/ BITMAP_ELEMENT_ALL_BITS
)
242 start_bit
= bi
->elt1
->indx
* BITMAP_ELEMENT_ALL_BITS
;
244 /* Initialize for what is now start_bit. */
245 bi
->word_no
= start_bit
/ BITMAP_WORD_BITS
% BITMAP_ELEMENT_WORDS
;
246 bi
->bits
= bi
->elt1
->bits
[bi
->word_no
];
247 bi
->bits
>>= start_bit
% BITMAP_WORD_BITS
;
249 /* If this word is zero, we must make sure we're not pointing at the
250 first bit, otherwise our incrementing to the next word boundary
251 will fail. It won't matter if this increment moves us into the
253 start_bit
+= !bi
->bits
;
258 /* Initialize an iterator to iterate over the intersection of two
259 bitmaps. START_BIT is the bit to commence from. */
262 bmp_iter_and_init (bitmap_iterator
*bi
, bitmap map1
, bitmap map2
,
263 unsigned start_bit
, unsigned *bit_no
)
265 bi
->elt1
= map1
->first
;
266 bi
->elt2
= map2
->first
;
268 /* Advance elt1 until it is not before the block containing
278 if (bi
->elt1
->indx
>= start_bit
/ BITMAP_ELEMENT_ALL_BITS
)
280 bi
->elt1
= bi
->elt1
->next
;
283 /* Advance elt2 until it is not before elt1. */
288 bi
->elt1
= bi
->elt2
= &bitmap_zero_bits
;
292 if (bi
->elt2
->indx
>= bi
->elt1
->indx
)
294 bi
->elt2
= bi
->elt2
->next
;
297 /* If we're at the same index, then we have some intersecting bits. */
298 if (bi
->elt1
->indx
== bi
->elt2
->indx
)
300 /* We might have advanced beyond the start_bit, so reinitialize
302 if (bi
->elt1
->indx
!= start_bit
/ BITMAP_ELEMENT_ALL_BITS
)
303 start_bit
= bi
->elt1
->indx
* BITMAP_ELEMENT_ALL_BITS
;
305 bi
->word_no
= start_bit
/ BITMAP_WORD_BITS
% BITMAP_ELEMENT_WORDS
;
306 bi
->bits
= bi
->elt1
->bits
[bi
->word_no
] & bi
->elt2
->bits
[bi
->word_no
];
307 bi
->bits
>>= start_bit
% BITMAP_WORD_BITS
;
311 /* Otherwise we must immediately advance elt1, so initialize for
313 bi
->word_no
= BITMAP_ELEMENT_WORDS
- 1;
317 /* If this word is zero, we must make sure we're not pointing at the
318 first bit, otherwise our incrementing to the next word boundary
319 will fail. It won't matter if this increment moves us into the
321 start_bit
+= !bi
->bits
;
326 /* Initialize an iterator to iterate over the bits in MAP1 & ~MAP2.
330 bmp_iter_and_compl_init (bitmap_iterator
*bi
, bitmap map1
, bitmap map2
,
331 unsigned start_bit
, unsigned *bit_no
)
333 bi
->elt1
= map1
->first
;
334 bi
->elt2
= map2
->first
;
336 /* Advance elt1 until it is not before the block containing start_bit. */
341 bi
->elt1
= &bitmap_zero_bits
;
345 if (bi
->elt1
->indx
>= start_bit
/ BITMAP_ELEMENT_ALL_BITS
)
347 bi
->elt1
= bi
->elt1
->next
;
350 /* Advance elt2 until it is not before elt1. */
351 while (bi
->elt2
&& bi
->elt2
->indx
< bi
->elt1
->indx
)
352 bi
->elt2
= bi
->elt2
->next
;
354 /* We might have advanced beyond the start_bit, so reinitialize for
356 if (bi
->elt1
->indx
!= start_bit
/ BITMAP_ELEMENT_ALL_BITS
)
357 start_bit
= bi
->elt1
->indx
* BITMAP_ELEMENT_ALL_BITS
;
359 bi
->word_no
= start_bit
/ BITMAP_WORD_BITS
% BITMAP_ELEMENT_WORDS
;
360 bi
->bits
= bi
->elt1
->bits
[bi
->word_no
];
361 if (bi
->elt2
&& bi
->elt1
->indx
== bi
->elt2
->indx
)
362 bi
->bits
&= ~bi
->elt2
->bits
[bi
->word_no
];
363 bi
->bits
>>= start_bit
% BITMAP_WORD_BITS
;
365 /* If this word is zero, we must make sure we're not pointing at the
366 first bit, otherwise our incrementing to the next word boundary
367 will fail. It won't matter if this increment moves us into the
369 start_bit
+= !bi
->bits
;
374 /* Advance to the next bit in BI. We don't advance to the next
378 bmp_iter_next (bitmap_iterator
*bi
, unsigned *bit_no
)
384 /* Advance to the next nonzero bit of a single bitmap, we will have
385 already advanced past the just iterated bit. Return true if there
386 is a bit to iterate. */
389 bmp_iter_set (bitmap_iterator
*bi
, unsigned *bit_no
)
391 /* If our current word is nonzero, it contains the bit we want. */
395 while (!(bi
->bits
& 1))
403 /* Round up to the word boundary. We might have just iterated past
404 the end of the last word, hence the -1. It is not possible for
405 bit_no to point at the beginning of the now last word. */
406 *bit_no
= ((*bit_no
+ BITMAP_WORD_BITS
- 1)
407 / BITMAP_WORD_BITS
* BITMAP_WORD_BITS
);
412 /* Find the next nonzero word in this elt. */
413 while (bi
->word_no
!= BITMAP_ELEMENT_WORDS
)
415 bi
->bits
= bi
->elt1
->bits
[bi
->word_no
];
418 *bit_no
+= BITMAP_WORD_BITS
;
422 /* Advance to the next element. */
423 bi
->elt1
= bi
->elt1
->next
;
426 *bit_no
= bi
->elt1
->indx
* BITMAP_ELEMENT_ALL_BITS
;
431 /* Advance to the next nonzero bit of an intersecting pair of
432 bitmaps. We will have already advanced past the just iterated bit.
433 Return true if there is a bit to iterate. */
436 bmp_iter_and (bitmap_iterator
*bi
, unsigned *bit_no
)
438 /* If our current word is nonzero, it contains the bit we want. */
442 while (!(bi
->bits
& 1))
450 /* Round up to the word boundary. We might have just iterated past
451 the end of the last word, hence the -1. It is not possible for
452 bit_no to point at the beginning of the now last word. */
453 *bit_no
= ((*bit_no
+ BITMAP_WORD_BITS
- 1)
454 / BITMAP_WORD_BITS
* BITMAP_WORD_BITS
);
459 /* Find the next nonzero word in this elt. */
460 while (bi
->word_no
!= BITMAP_ELEMENT_WORDS
)
462 bi
->bits
= bi
->elt1
->bits
[bi
->word_no
] & bi
->elt2
->bits
[bi
->word_no
];
465 *bit_no
+= BITMAP_WORD_BITS
;
469 /* Advance to the next identical element. */
472 /* Advance elt1 while it is less than elt2. We always want
473 to advance one elt. */
476 bi
->elt1
= bi
->elt1
->next
;
480 while (bi
->elt1
->indx
< bi
->elt2
->indx
);
482 /* Advance elt2 to be no less than elt1. This might not
484 while (bi
->elt2
->indx
< bi
->elt1
->indx
)
486 bi
->elt2
= bi
->elt2
->next
;
491 while (bi
->elt1
->indx
!= bi
->elt2
->indx
);
493 *bit_no
= bi
->elt1
->indx
* BITMAP_ELEMENT_ALL_BITS
;
498 /* Advance to the next nonzero bit in the intersection of
499 complemented bitmaps. We will have already advanced past the just
503 bmp_iter_and_compl (bitmap_iterator
*bi
, unsigned *bit_no
)
505 /* If our current word is nonzero, it contains the bit we want. */
509 while (!(bi
->bits
& 1))
517 /* Round up to the word boundary. We might have just iterated past
518 the end of the last word, hence the -1. It is not possible for
519 bit_no to point at the beginning of the now last word. */
520 *bit_no
= ((*bit_no
+ BITMAP_WORD_BITS
- 1)
521 / BITMAP_WORD_BITS
* BITMAP_WORD_BITS
);
526 /* Find the next nonzero word in this elt. */
527 while (bi
->word_no
!= BITMAP_ELEMENT_WORDS
)
529 bi
->bits
= bi
->elt1
->bits
[bi
->word_no
];
530 if (bi
->elt2
&& bi
->elt2
->indx
== bi
->elt1
->indx
)
531 bi
->bits
&= ~bi
->elt2
->bits
[bi
->word_no
];
534 *bit_no
+= BITMAP_WORD_BITS
;
538 /* Advance to the next element of elt1. */
539 bi
->elt1
= bi
->elt1
->next
;
543 /* Advance elt2 until it is no less than elt1. */
544 while (bi
->elt2
&& bi
->elt2
->indx
< bi
->elt1
->indx
)
545 bi
->elt2
= bi
->elt2
->next
;
547 *bit_no
= bi
->elt1
->indx
* BITMAP_ELEMENT_ALL_BITS
;
552 /* Loop over all bits set in BITMAP, starting with MIN and setting
553 BITNUM to the bit number. ITER is a bitmap iterator. BITNUM
554 should be treated as a read-only variable as it contains loop
557 #define EXECUTE_IF_SET_IN_BITMAP(BITMAP, MIN, BITNUM, ITER) \
558 for (bmp_iter_set_init (&(ITER), (BITMAP), (MIN), &(BITNUM)); \
559 bmp_iter_set (&(ITER), &(BITNUM)); \
560 bmp_iter_next (&(ITER), &(BITNUM)))
562 /* Loop over all the bits set in BITMAP1 & BITMAP2, starting with MIN
563 and setting BITNUM to the bit number. ITER is a bitmap iterator.
564 BITNUM should be treated as a read-only variable as it contains
567 #define EXECUTE_IF_AND_IN_BITMAP(BITMAP1, BITMAP2, MIN, BITNUM, ITER) \
568 for (bmp_iter_and_init (&(ITER), (BITMAP1), (BITMAP2), (MIN), \
570 bmp_iter_and (&(ITER), &(BITNUM)); \
571 bmp_iter_next (&(ITER), &(BITNUM)))
573 /* Loop over all the bits set in BITMAP1 & ~BITMAP2, starting with MIN
574 and setting BITNUM to the bit number. ITER is a bitmap iterator.
575 BITNUM should be treated as a read-only variable as it contains
578 #define EXECUTE_IF_AND_COMPL_IN_BITMAP(BITMAP1, BITMAP2, MIN, BITNUM, ITER) \
579 for (bmp_iter_and_compl_init (&(ITER), (BITMAP1), (BITMAP2), (MIN), \
581 bmp_iter_and_compl (&(ITER), &(BITNUM)); \
582 bmp_iter_next (&(ITER), &(BITNUM)))
584 #endif /* GCC_BITMAP_H */