1 /* Functions to support general ended bitmaps.
2 Copyright (C) 1997, 1998, 1999, 2000, 2001 Free Software Foundation, Inc.
4 This file is part of GCC.
6 GCC is free software; you can redistribute it and/or modify it under
7 the terms of the GNU General Public License as published by the Free
8 Software Foundation; either version 2, or (at your option) any later
11 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16 You should have received a copy of the GNU General Public License
17 along with GCC; see the file COPYING. If not, write to the Free
18 Software Foundation, 59 Temple Place - Suite 330, Boston, MA
29 /* Obstack to allocate bitmap elements from. */
30 static struct obstack bitmap_obstack
;
31 static int bitmap_obstack_init
= FALSE
;
37 #define INLINE __inline__
42 bitmap_element bitmap_zero_bits
; /* An element of all zero bits. */
43 static bitmap_element
*bitmap_free
; /* Freelist of bitmap elements. */
44 static GTY((deletable (""))) bitmap_element
*bitmap_ggc_free
;
46 static void bitmap_elem_to_freelist
PARAMS ((bitmap
, bitmap_element
*));
47 static void bitmap_element_free
PARAMS ((bitmap
, bitmap_element
*));
48 static bitmap_element
*bitmap_element_allocate
PARAMS ((bitmap
));
49 static int bitmap_element_zerop
PARAMS ((bitmap_element
*));
50 static void bitmap_element_link
PARAMS ((bitmap
, bitmap_element
*));
51 static bitmap_element
*bitmap_find_bit
PARAMS ((bitmap
, unsigned int));
53 /* Add ELEM to the appropriate freelist. */
55 bitmap_elem_to_freelist (head
, elt
)
59 if (head
->using_obstack
)
61 elt
->next
= bitmap_free
;
66 elt
->next
= bitmap_ggc_free
;
67 bitmap_ggc_free
= elt
;
71 /* Free a bitmap element. Since these are allocated off the
72 bitmap_obstack, "free" actually means "put onto the freelist". */
75 bitmap_element_free (head
, elt
)
79 bitmap_element
*next
= elt
->next
;
80 bitmap_element
*prev
= elt
->prev
;
88 if (head
->first
== elt
)
91 /* Since the first thing we try is to insert before current,
92 make current the next entry in preference to the previous. */
93 if (head
->current
== elt
)
95 head
->current
= next
!= 0 ? next
: prev
;
97 head
->indx
= head
->current
->indx
;
99 bitmap_elem_to_freelist (head
, elt
);
102 /* Allocate a bitmap element. The bits are cleared, but nothing else is. */
104 static INLINE bitmap_element
*
105 bitmap_element_allocate (head
)
108 bitmap_element
*element
;
110 if (head
->using_obstack
)
112 if (bitmap_free
!= 0)
114 element
= bitmap_free
;
115 bitmap_free
= element
->next
;
119 /* We can't use gcc_obstack_init to initialize the obstack since
120 print-rtl.c now calls bitmap functions, and bitmap is linked
121 into the gen* functions. */
122 if (!bitmap_obstack_init
)
124 bitmap_obstack_init
= TRUE
;
126 /* Let particular systems override the size of a chunk. */
127 #ifndef OBSTACK_CHUNK_SIZE
128 #define OBSTACK_CHUNK_SIZE 0
130 /* Let them override the alloc and free routines too. */
131 #ifndef OBSTACK_CHUNK_ALLOC
132 #define OBSTACK_CHUNK_ALLOC xmalloc
134 #ifndef OBSTACK_CHUNK_FREE
135 #define OBSTACK_CHUNK_FREE free
138 #if !defined(__GNUC__) || (__GNUC__ < 2)
139 #define __alignof__(type) 0
142 obstack_specify_allocation (&bitmap_obstack
, OBSTACK_CHUNK_SIZE
,
143 __alignof__ (bitmap_element
),
144 (void *(*) PARAMS ((long))) OBSTACK_CHUNK_ALLOC
,
145 (void (*) PARAMS ((void *))) OBSTACK_CHUNK_FREE
);
148 element
= (bitmap_element
*) obstack_alloc (&bitmap_obstack
,
149 sizeof (bitmap_element
));
154 if (bitmap_ggc_free
!= NULL
)
156 element
= bitmap_ggc_free
;
157 bitmap_ggc_free
= element
->next
;
160 element
= ggc_alloc (sizeof (bitmap_element
));
163 memset (element
->bits
, 0, sizeof (element
->bits
));
168 /* Release any memory allocated by bitmaps. */
171 bitmap_release_memory ()
174 if (bitmap_obstack_init
)
176 bitmap_obstack_init
= FALSE
;
177 obstack_free (&bitmap_obstack
, NULL
);
181 /* Return nonzero if all bits in an element are zero. */
184 bitmap_element_zerop (element
)
185 bitmap_element
*element
;
187 #if BITMAP_ELEMENT_WORDS == 2
188 return (element
->bits
[0] | element
->bits
[1]) == 0;
192 for (i
= 0; i
< BITMAP_ELEMENT_WORDS
; i
++)
193 if (element
->bits
[i
] != 0)
200 /* Link the bitmap element into the current bitmap linked list. */
203 bitmap_element_link (head
, element
)
205 bitmap_element
*element
;
207 unsigned int indx
= element
->indx
;
210 /* If this is the first and only element, set it in. */
211 if (head
->first
== 0)
213 element
->next
= element
->prev
= 0;
214 head
->first
= element
;
217 /* If this index is less than that of the current element, it goes someplace
218 before the current element. */
219 else if (indx
< head
->indx
)
221 for (ptr
= head
->current
;
222 ptr
->prev
!= 0 && ptr
->prev
->indx
> indx
;
227 ptr
->prev
->next
= element
;
229 head
->first
= element
;
231 element
->prev
= ptr
->prev
;
236 /* Otherwise, it must go someplace after the current element. */
239 for (ptr
= head
->current
;
240 ptr
->next
!= 0 && ptr
->next
->indx
< indx
;
245 ptr
->next
->prev
= element
;
247 element
->next
= ptr
->next
;
252 /* Set up so this is the first element searched. */
253 head
->current
= element
;
257 /* Clear a bitmap by freeing the linked list. */
263 bitmap_element
*element
, *next
;
265 for (element
= head
->first
; element
!= 0; element
= next
)
267 next
= element
->next
;
268 bitmap_elem_to_freelist (head
, element
);
271 head
->first
= head
->current
= 0;
274 /* Copy a bitmap to another bitmap. */
277 bitmap_copy (to
, from
)
281 bitmap_element
*from_ptr
, *to_ptr
= 0;
282 #if BITMAP_ELEMENT_WORDS != 2
288 /* Copy elements in forward direction one at a time */
289 for (from_ptr
= from
->first
; from_ptr
; from_ptr
= from_ptr
->next
)
291 bitmap_element
*to_elt
= bitmap_element_allocate (to
);
293 to_elt
->indx
= from_ptr
->indx
;
295 #if BITMAP_ELEMENT_WORDS == 2
296 to_elt
->bits
[0] = from_ptr
->bits
[0];
297 to_elt
->bits
[1] = from_ptr
->bits
[1];
299 for (i
= 0; i
< BITMAP_ELEMENT_WORDS
; i
++)
300 to_elt
->bits
[i
] = from_ptr
->bits
[i
];
303 /* Here we have a special case of bitmap_element_link, for the case
304 where we know the links are being entered in sequence. */
307 to
->first
= to
->current
= to_elt
;
308 to
->indx
= from_ptr
->indx
;
309 to_elt
->next
= to_elt
->prev
= 0;
313 to_elt
->prev
= to_ptr
;
315 to_ptr
->next
= to_elt
;
322 /* Find a bitmap element that would hold a bitmap's bit.
323 Update the `current' field even if we can't find an element that
324 would hold the bitmap's bit to make eventual allocation
327 static INLINE bitmap_element
*
328 bitmap_find_bit (head
, bit
)
332 bitmap_element
*element
;
333 unsigned HOST_WIDE_INT indx
= bit
/ BITMAP_ELEMENT_ALL_BITS
;
335 if (head
->current
== 0
336 || head
->indx
== indx
)
337 return head
->current
;
339 if (head
->indx
> indx
)
340 for (element
= head
->current
;
341 element
->prev
!= 0 && element
->indx
> indx
;
342 element
= element
->prev
)
346 for (element
= head
->current
;
347 element
->next
!= 0 && element
->indx
< indx
;
348 element
= element
->next
)
351 /* `element' is the nearest to the one we want. If it's not the one we
352 want, the one we want doesn't exist. */
353 head
->current
= element
;
354 head
->indx
= element
->indx
;
355 if (element
!= 0 && element
->indx
!= indx
)
361 /* Clear a single bit in a bitmap. */
364 bitmap_clear_bit (head
, bit
)
368 bitmap_element
*ptr
= bitmap_find_bit (head
, bit
);
372 unsigned bit_num
= bit
% (unsigned) HOST_BITS_PER_WIDE_INT
;
373 unsigned word_num
= ((bit
/ (unsigned) HOST_BITS_PER_WIDE_INT
)
374 % BITMAP_ELEMENT_WORDS
);
375 ptr
->bits
[word_num
] &= ~ (((unsigned HOST_WIDE_INT
) 1) << bit_num
);
377 /* If we cleared the entire word, free up the element */
378 if (bitmap_element_zerop (ptr
))
379 bitmap_element_free (head
, ptr
);
383 /* Set a single bit in a bitmap. */
386 bitmap_set_bit (head
, bit
)
390 bitmap_element
*ptr
= bitmap_find_bit (head
, bit
);
392 = ((bit
/ (unsigned) HOST_BITS_PER_WIDE_INT
) % BITMAP_ELEMENT_WORDS
);
393 unsigned bit_num
= bit
% (unsigned) HOST_BITS_PER_WIDE_INT
;
394 unsigned HOST_WIDE_INT bit_val
= ((unsigned HOST_WIDE_INT
) 1) << bit_num
;
398 ptr
= bitmap_element_allocate (head
);
399 ptr
->indx
= bit
/ BITMAP_ELEMENT_ALL_BITS
;
400 ptr
->bits
[word_num
] = bit_val
;
401 bitmap_element_link (head
, ptr
);
404 ptr
->bits
[word_num
] |= bit_val
;
407 /* Return whether a bit is set within a bitmap. */
410 bitmap_bit_p (head
, bit
)
418 ptr
= bitmap_find_bit (head
, bit
);
422 bit_num
= bit
% (unsigned) HOST_BITS_PER_WIDE_INT
;
424 = ((bit
/ (unsigned) HOST_BITS_PER_WIDE_INT
) % BITMAP_ELEMENT_WORDS
);
426 return (ptr
->bits
[word_num
] >> bit_num
) & 1;
429 /* Return the bit number of the first set bit in the bitmap, or -1
430 if the bitmap is empty. */
433 bitmap_first_set_bit (a
)
436 bitmap_element
*ptr
= a
->first
;
437 unsigned HOST_WIDE_INT word
;
438 unsigned word_num
, bit_num
;
443 #if BITMAP_ELEMENT_WORDS == 2
444 word_num
= 0, word
= ptr
->bits
[0];
446 word_num
= 1, word
= ptr
->bits
[1];
448 for (word_num
= 0; word_num
< BITMAP_ELEMENT_WORDS
; ++word_num
)
449 if ((word
= ptr
->bits
[word_num
]) != 0)
453 /* Binary search for the first set bit. */
454 /* ??? It'd be nice to know if ffs or ffsl was available. */
459 #if HOST_BITS_PER_WIDE_INT > 64
460 #error "Fill out the table."
462 #if HOST_BITS_PER_WIDE_INT > 32
463 if ((word
& 0xffffffff) == 0)
464 word
>>= 32, bit_num
+= 32;
466 if ((word
& 0xffff) == 0)
467 word
>>= 16, bit_num
+= 16;
468 if ((word
& 0xff) == 0)
469 word
>>= 8, bit_num
+= 8;
477 return (ptr
->indx
* BITMAP_ELEMENT_ALL_BITS
478 + word_num
* HOST_BITS_PER_WIDE_INT
482 /* Return the bit number of the last set bit in the bitmap, or -1
483 if the bitmap is empty. */
486 bitmap_last_set_bit (a
)
489 bitmap_element
*ptr
= a
->first
;
490 unsigned HOST_WIDE_INT word
;
491 unsigned word_num
, bit_num
;
496 while (ptr
->next
!= NULL
)
499 #if BITMAP_ELEMENT_WORDS == 2
500 word_num
= 1, word
= ptr
->bits
[1];
502 word_num
= 0, word
= ptr
->bits
[0];
504 for (word_num
= BITMAP_ELEMENT_WORDS
; word_num
-- > 0; )
505 if ((word
= ptr
->bits
[word_num
]) != 0)
509 /* Binary search for the last set bit. */
512 #if HOST_BITS_PER_WIDE_INT > 64
513 #error "Fill out the table."
515 #if HOST_BITS_PER_WIDE_INT > 32
516 if (word
& ~ (unsigned HOST_WIDE_INT
) 0xffffffff)
517 word
>>= 32, bit_num
+= 32;
519 if (word
& 0xffff0000)
520 word
>>= 16, bit_num
+= 16;
522 word
>>= 8, bit_num
+= 8;
524 word
>>= 4, bit_num
+= 4;
526 word
>>= 2, bit_num
+= 2;
530 return (ptr
->indx
* BITMAP_ELEMENT_ALL_BITS
531 + word_num
* HOST_BITS_PER_WIDE_INT
535 /* Store in bitmap TO the result of combining bitmap FROM1 and FROM2 using
536 a specific bit manipulation. Return true if TO changes. */
539 bitmap_operation (to
, from1
, from2
, operation
)
543 enum bitmap_bits operation
;
545 #define HIGHEST_INDEX (unsigned int) ~0
547 bitmap_element
*from1_ptr
= from1
->first
;
548 bitmap_element
*from2_ptr
= from2
->first
;
549 unsigned int indx1
= (from1_ptr
) ? from1_ptr
->indx
: HIGHEST_INDEX
;
550 unsigned int indx2
= (from2_ptr
) ? from2_ptr
->indx
: HIGHEST_INDEX
;
551 bitmap_element
*to_ptr
= to
->first
;
552 bitmap_element
*from1_tmp
;
553 bitmap_element
*from2_tmp
;
554 bitmap_element
*to_tmp
;
558 #if BITMAP_ELEMENT_WORDS == 2
561 unsigned HOST_WIDE_INT t0, t1, f10, f11, f20, f21; \
562 f10 = from1_tmp->bits[0]; \
563 f20 = from2_tmp->bits[0]; \
565 changed |= (t0 != to_tmp->bits[0]); \
566 f11 = from1_tmp->bits[1]; \
567 f21 = from2_tmp->bits[1]; \
569 changed |= (t1 != to_tmp->bits[1]); \
570 to_tmp->bits[0] = t0; \
571 to_tmp->bits[1] = t1; \
576 unsigned HOST_WIDE_INT t, f1, f2; \
578 for (i = 0; i < BITMAP_ELEMENT_WORDS; ++i) \
580 f1 = from1_tmp->bits[i]; \
581 f2 = from2_tmp->bits[i]; \
583 changed |= (t != to_tmp->bits[i]); \
584 to_tmp->bits[i] = t; \
589 to
->first
= to
->current
= 0;
591 while (from1_ptr
!= 0 || from2_ptr
!= 0)
593 /* Figure out whether we need to substitute zero elements for
598 from1_tmp
= from1_ptr
;
599 from2_tmp
= from2_ptr
;
600 from1_ptr
= from1_ptr
->next
;
601 indx1
= (from1_ptr
) ? from1_ptr
->indx
: HIGHEST_INDEX
;
602 from2_ptr
= from2_ptr
->next
;
603 indx2
= (from2_ptr
) ? from2_ptr
->indx
: HIGHEST_INDEX
;
605 else if (indx1
< indx2
)
608 from1_tmp
= from1_ptr
;
609 from2_tmp
= &bitmap_zero_bits
;
610 from1_ptr
= from1_ptr
->next
;
611 indx1
= (from1_ptr
) ? from1_ptr
->indx
: HIGHEST_INDEX
;
616 from1_tmp
= &bitmap_zero_bits
;
617 from2_tmp
= from2_ptr
;
618 from2_ptr
= from2_ptr
->next
;
619 indx2
= (from2_ptr
) ? from2_ptr
->indx
: HIGHEST_INDEX
;
622 /* Find the appropriate element from TO. Begin by discarding
623 elements that we've skipped. */
624 while (to_ptr
&& to_ptr
->indx
< indx
)
628 to_ptr
= to_ptr
->next
;
629 bitmap_elem_to_freelist (to
, to_tmp
);
631 if (to_ptr
&& to_ptr
->indx
== indx
)
634 to_ptr
= to_ptr
->next
;
637 to_tmp
= bitmap_element_allocate (to
);
639 /* Do the operation, and if any bits are set, link it into the
650 case BITMAP_AND_COMPL
:
657 case BITMAP_IOR_COMPL
:
665 if (! bitmap_element_zerop (to_tmp
))
668 bitmap_element_link (to
, to_tmp
);
672 bitmap_elem_to_freelist (to
, to_tmp
);
676 /* If we have elements of TO left over, free the lot. */
680 for (to_tmp
= to_ptr
; to_tmp
->next
; to_tmp
= to_tmp
->next
)
682 if (to
->using_obstack
)
684 to_tmp
->next
= bitmap_free
;
685 bitmap_free
= to_ptr
;
689 to_tmp
->next
= bitmap_ggc_free
;
690 bitmap_ggc_free
= to_ptr
;
699 /* Return true if two bitmaps are identical. */
702 bitmap_equal_p (a
, b
)
709 memset (&c
, 0, sizeof (c
));
710 ret
= ! bitmap_operation (&c
, a
, b
, BITMAP_XOR
);
716 /* Or into bitmap TO bitmap FROM1 and'ed with the complement of
720 bitmap_ior_and_compl (to
, from1
, from2
)
727 tmp
.first
= tmp
.current
= 0;
728 tmp
.using_obstack
= 0;
730 bitmap_operation (&tmp
, from1
, from2
, BITMAP_AND_COMPL
);
731 bitmap_operation (to
, to
, &tmp
, BITMAP_IOR
);
736 bitmap_union_of_diff (dst
, a
, b
, c
)
745 tmp
.first
= tmp
.current
= 0;
746 tmp
.using_obstack
= 0;
748 bitmap_operation (&tmp
, b
, c
, BITMAP_AND_COMPL
);
749 changed
= bitmap_operation (dst
, &tmp
, a
, BITMAP_IOR
);
755 /* Initialize a bitmap header. */
758 bitmap_initialize (head
, using_obstack
)
762 if (head
== NULL
&& ! using_obstack
)
763 head
= ggc_alloc (sizeof (*head
));
765 head
->first
= head
->current
= 0;
766 head
->using_obstack
= using_obstack
;
771 /* Debugging function to print out the contents of a bitmap. */
774 debug_bitmap_file (file
, head
)
780 fprintf (file
, "\nfirst = ");
781 fprintf (file
, HOST_PTR_PRINTF
, (PTR
) head
->first
);
782 fprintf (file
, " current = ");
783 fprintf (file
, HOST_PTR_PRINTF
, (PTR
) head
->current
);
784 fprintf (file
, " indx = %u\n", head
->indx
);
786 for (ptr
= head
->first
; ptr
; ptr
= ptr
->next
)
790 fprintf (file
, "\t");
791 fprintf (file
, HOST_PTR_PRINTF
, (PTR
) ptr
);
792 fprintf (file
, " next = ");
793 fprintf (file
, HOST_PTR_PRINTF
, (PTR
) ptr
->next
);
794 fprintf (file
, " prev = ");
795 fprintf (file
, HOST_PTR_PRINTF
, (PTR
) ptr
->prev
);
796 fprintf (file
, " indx = %u\n\t\tbits = {", ptr
->indx
);
798 for (i
= 0; i
< BITMAP_ELEMENT_WORDS
; i
++)
799 for (j
= 0; j
< HOST_BITS_PER_WIDE_INT
; j
++)
800 if ((ptr
->bits
[i
] >> j
) & 1)
804 fprintf (file
, "\n\t\t\t");
808 fprintf (file
, " %u", (ptr
->indx
* BITMAP_ELEMENT_ALL_BITS
809 + i
* HOST_BITS_PER_WIDE_INT
+ j
));
813 fprintf (file
, " }\n");
817 /* Function to be called from the debugger to print the contents
824 debug_bitmap_file (stdout
, head
);
827 /* Function to print out the contents of a bitmap. Unlike debug_bitmap_file,
828 it does not print anything but the bits. */
831 bitmap_print (file
, head
, prefix
, suffix
)
837 const char *comma
= "";
840 fputs (prefix
, file
);
841 EXECUTE_IF_SET_IN_BITMAP (head
, 0, i
,
843 fprintf (file
, "%s%d", comma
, i
);
846 fputs (suffix
, file
);
849 #include "gt-bitmap.h"