1 /* Functions to support general ended bitmaps.
2 Copyright (C) 1997, 1998, 1999, 2000, 2001, 2003
3 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, 59 Temple Place - Suite 330, Boston, MA
24 #include "coretypes.h"
32 /* Obstack to allocate bitmap elements from. */
33 static struct obstack bitmap_obstack;
34 static int bitmap_obstack_init = FALSE;
40 #define INLINE __inline__
45 bitmap_element bitmap_zero_bits; /* An element of all zero bits. */
46 static bitmap_element *bitmap_free; /* Freelist of bitmap elements. */
47 static GTY((deletable (""))) bitmap_element *bitmap_ggc_free;
49 static void bitmap_elem_to_freelist PARAMS ((bitmap, bitmap_element *));
50 static void bitmap_element_free PARAMS ((bitmap, bitmap_element *));
51 static bitmap_element *bitmap_element_allocate PARAMS ((bitmap));
52 static int bitmap_element_zerop PARAMS ((bitmap_element *));
53 static void bitmap_element_link PARAMS ((bitmap, bitmap_element *));
54 static bitmap_element *bitmap_find_bit PARAMS ((bitmap, unsigned int));
56 /* Add ELEM to the appropriate freelist. */
58 bitmap_elem_to_freelist (head, elt)
62 if (head->using_obstack)
64 elt->next = bitmap_free;
69 elt->next = bitmap_ggc_free;
70 bitmap_ggc_free = elt;
74 /* Free a bitmap element. Since these are allocated off the
75 bitmap_obstack, "free" actually means "put onto the freelist". */
78 bitmap_element_free (head, elt)
82 bitmap_element *next = elt->next;
83 bitmap_element *prev = elt->prev;
91 if (head->first == elt)
94 /* Since the first thing we try is to insert before current,
95 make current the next entry in preference to the previous. */
96 if (head->current == elt)
98 head->current = next != 0 ? next : prev;
100 head->indx = head->current->indx;
102 bitmap_elem_to_freelist (head, elt);
105 /* Allocate a bitmap element. The bits are cleared, but nothing else is. */
107 static INLINE bitmap_element *
108 bitmap_element_allocate (head)
111 bitmap_element *element;
113 if (head->using_obstack)
115 if (bitmap_free != 0)
117 element = bitmap_free;
118 bitmap_free = element->next;
122 /* We can't use gcc_obstack_init to initialize the obstack since
123 print-rtl.c now calls bitmap functions, and bitmap is linked
124 into the gen* functions. */
125 if (!bitmap_obstack_init)
127 bitmap_obstack_init = TRUE;
129 #if !defined(__GNUC__) || (__GNUC__ < 2)
130 #define __alignof__(type) 0
133 obstack_specify_allocation (&bitmap_obstack, OBSTACK_CHUNK_SIZE,
134 __alignof__ (bitmap_element),
139 element = (bitmap_element *) obstack_alloc (&bitmap_obstack,
140 sizeof (bitmap_element));
145 if (bitmap_ggc_free != NULL)
147 element = bitmap_ggc_free;
148 bitmap_ggc_free = element->next;
151 element = ggc_alloc (sizeof (bitmap_element));
154 memset (element->bits, 0, sizeof (element->bits));
159 /* Release any memory allocated by bitmaps. */
162 bitmap_release_memory ()
165 if (bitmap_obstack_init)
167 bitmap_obstack_init = FALSE;
168 obstack_free (&bitmap_obstack, NULL);
172 /* Return nonzero if all bits in an element are zero. */
175 bitmap_element_zerop (element)
176 bitmap_element *element;
178 #if BITMAP_ELEMENT_WORDS == 2
179 return (element->bits[0] | element->bits[1]) == 0;
183 for (i = 0; i < BITMAP_ELEMENT_WORDS; i++)
184 if (element->bits[i] != 0)
191 /* Link the bitmap element into the current bitmap linked list. */
194 bitmap_element_link (head, element)
196 bitmap_element *element;
198 unsigned int indx = element->indx;
201 /* If this is the first and only element, set it in. */
202 if (head->first == 0)
204 element->next = element->prev = 0;
205 head->first = element;
208 /* If this index is less than that of the current element, it goes someplace
209 before the current element. */
210 else if (indx < head->indx)
212 for (ptr = head->current;
213 ptr->prev != 0 && ptr->prev->indx > indx;
218 ptr->prev->next = element;
220 head->first = element;
222 element->prev = ptr->prev;
227 /* Otherwise, it must go someplace after the current element. */
230 for (ptr = head->current;
231 ptr->next != 0 && ptr->next->indx < indx;
236 ptr->next->prev = element;
238 element->next = ptr->next;
243 /* Set up so this is the first element searched. */
244 head->current = element;
248 /* Clear a bitmap by freeing the linked list. */
254 bitmap_element *element, *next;
256 for (element = head->first; element != 0; element = next)
258 next = element->next;
259 bitmap_elem_to_freelist (head, element);
262 head->first = head->current = 0;
265 /* Copy a bitmap to another bitmap. */
268 bitmap_copy (to, from)
272 bitmap_element *from_ptr, *to_ptr = 0;
273 #if BITMAP_ELEMENT_WORDS != 2
279 /* Copy elements in forward direction one at a time */
280 for (from_ptr = from->first; from_ptr; from_ptr = from_ptr->next)
282 bitmap_element *to_elt = bitmap_element_allocate (to);
284 to_elt->indx = from_ptr->indx;
286 #if BITMAP_ELEMENT_WORDS == 2
287 to_elt->bits[0] = from_ptr->bits[0];
288 to_elt->bits[1] = from_ptr->bits[1];
290 for (i = 0; i < BITMAP_ELEMENT_WORDS; i++)
291 to_elt->bits[i] = from_ptr->bits[i];
294 /* Here we have a special case of bitmap_element_link, for the case
295 where we know the links are being entered in sequence. */
298 to->first = to->current = to_elt;
299 to->indx = from_ptr->indx;
300 to_elt->next = to_elt->prev = 0;
304 to_elt->prev = to_ptr;
306 to_ptr->next = to_elt;
313 /* Find a bitmap element that would hold a bitmap's bit.
314 Update the `current' field even if we can't find an element that
315 would hold the bitmap's bit to make eventual allocation
318 static INLINE bitmap_element *
319 bitmap_find_bit (head, bit)
323 bitmap_element *element;
324 unsigned int indx = bit / BITMAP_ELEMENT_ALL_BITS;
326 if (head->current == 0
327 || head->indx == indx)
328 return head->current;
330 if (head->indx > indx)
331 for (element = head->current;
332 element->prev != 0 && element->indx > indx;
333 element = element->prev)
337 for (element = head->current;
338 element->next != 0 && element->indx < indx;
339 element = element->next)
342 /* `element' is the nearest to the one we want. If it's not the one we
343 want, the one we want doesn't exist. */
344 head->current = element;
345 head->indx = element->indx;
346 if (element != 0 && element->indx != indx)
352 /* Clear a single bit in a bitmap. */
355 bitmap_clear_bit (head, bit)
359 bitmap_element *ptr = bitmap_find_bit (head, bit);
363 unsigned bit_num = bit % BITMAP_WORD_BITS;
364 unsigned word_num = bit / BITMAP_WORD_BITS % BITMAP_ELEMENT_WORDS;
365 ptr->bits[word_num] &= ~ (((BITMAP_WORD) 1) << bit_num);
367 /* If we cleared the entire word, free up the element */
368 if (bitmap_element_zerop (ptr))
369 bitmap_element_free (head, ptr);
373 /* Set a single bit in a bitmap. */
376 bitmap_set_bit (head, bit)
380 bitmap_element *ptr = bitmap_find_bit (head, bit);
381 unsigned word_num = bit / BITMAP_WORD_BITS % BITMAP_ELEMENT_WORDS;
382 unsigned bit_num = bit % BITMAP_WORD_BITS;
383 BITMAP_WORD bit_val = ((BITMAP_WORD) 1) << bit_num;
387 ptr = bitmap_element_allocate (head);
388 ptr->indx = bit / BITMAP_ELEMENT_ALL_BITS;
389 ptr->bits[word_num] = bit_val;
390 bitmap_element_link (head, ptr);
393 ptr->bits[word_num] |= bit_val;
396 /* Return whether a bit is set within a bitmap. */
399 bitmap_bit_p (head, bit)
407 ptr = bitmap_find_bit (head, bit);
411 bit_num = bit % BITMAP_WORD_BITS;
412 word_num = bit / BITMAP_WORD_BITS % BITMAP_ELEMENT_WORDS;
414 return (ptr->bits[word_num] >> bit_num) & 1;
417 /* Return the bit number of the first set bit in the bitmap, or -1
418 if the bitmap is empty. */
421 bitmap_first_set_bit (a)
424 bitmap_element *ptr = a->first;
426 unsigned word_num, bit_num;
431 #if BITMAP_ELEMENT_WORDS == 2
432 word_num = 0, word = ptr->bits[0];
434 word_num = 1, word = ptr->bits[1];
436 for (word_num = 0; word_num < BITMAP_ELEMENT_WORDS; ++word_num)
437 if ((word = ptr->bits[word_num]) != 0)
441 /* Binary search for the first set bit. */
442 /* ??? It'd be nice to know if ffs or ffsl was available. */
447 #if nBITMAP_WORD_BITS > 64
448 #error "Fill out the table."
450 #if nBITMAP_WORD_BITS > 32
451 if ((word & 0xffffffff) == 0)
452 word >>= 32, bit_num += 32;
454 if ((word & 0xffff) == 0)
455 word >>= 16, bit_num += 16;
456 if ((word & 0xff) == 0)
457 word >>= 8, bit_num += 8;
465 return (ptr->indx * BITMAP_ELEMENT_ALL_BITS
466 + word_num * BITMAP_WORD_BITS
470 /* Return the bit number of the last set bit in the bitmap, or -1
471 if the bitmap is empty. */
474 bitmap_last_set_bit (a)
477 bitmap_element *ptr = a->first;
479 unsigned word_num, bit_num;
484 while (ptr->next != NULL)
487 #if BITMAP_ELEMENT_WORDS == 2
488 word_num = 1, word = ptr->bits[1];
490 word_num = 0, word = ptr->bits[0];
492 for (word_num = BITMAP_ELEMENT_WORDS; word_num-- > 0; )
493 if ((word = ptr->bits[word_num]) != 0)
497 /* Binary search for the last set bit. */
500 #if nBITMAP_WORD_BITS > 64
501 #error "Fill out the table."
503 #if nBITMAP_WORD_BITS > 32
504 if (word & ~(BITMAP_WORD)0xffffffff)
505 word >>= 32, bit_num += 32;
507 if (word & 0xffff0000)
508 word >>= 16, bit_num += 16;
510 word >>= 8, bit_num += 8;
512 word >>= 4, bit_num += 4;
514 word >>= 2, bit_num += 2;
518 return (ptr->indx * BITMAP_ELEMENT_ALL_BITS
519 + word_num * BITMAP_WORD_BITS
523 /* Store in bitmap TO the result of combining bitmap FROM1 and FROM2 using
524 a specific bit manipulation. Return true if TO changes. */
527 bitmap_operation (to, from1, from2, operation)
531 enum bitmap_bits operation;
533 #define HIGHEST_INDEX (unsigned int) ~0
535 bitmap_element *from1_ptr = from1->first;
536 bitmap_element *from2_ptr = from2->first;
537 unsigned int indx1 = (from1_ptr) ? from1_ptr->indx : HIGHEST_INDEX;
538 unsigned int indx2 = (from2_ptr) ? from2_ptr->indx : HIGHEST_INDEX;
539 bitmap_element *to_ptr = to->first;
540 bitmap_element *from1_tmp;
541 bitmap_element *from2_tmp;
542 bitmap_element *to_tmp;
546 #if BITMAP_ELEMENT_WORDS == 2
549 BITMAP_WORD t0, t1, f10, f11, f20, f21; \
550 f10 = from1_tmp->bits[0]; \
551 f20 = from2_tmp->bits[0]; \
553 changed |= (t0 != to_tmp->bits[0]); \
554 f11 = from1_tmp->bits[1]; \
555 f21 = from2_tmp->bits[1]; \
557 changed |= (t1 != to_tmp->bits[1]); \
558 to_tmp->bits[0] = t0; \
559 to_tmp->bits[1] = t1; \
564 BITMAP_WORD t, f1, f2; \
566 for (i = 0; i < BITMAP_ELEMENT_WORDS; ++i) \
568 f1 = from1_tmp->bits[i]; \
569 f2 = from2_tmp->bits[i]; \
571 changed |= (t != to_tmp->bits[i]); \
572 to_tmp->bits[i] = t; \
577 to->first = to->current = 0;
579 while (from1_ptr != 0 || from2_ptr != 0)
581 /* Figure out whether we need to substitute zero elements for
586 from1_tmp = from1_ptr;
587 from2_tmp = from2_ptr;
588 from1_ptr = from1_ptr->next;
589 indx1 = (from1_ptr) ? from1_ptr->indx : HIGHEST_INDEX;
590 from2_ptr = from2_ptr->next;
591 indx2 = (from2_ptr) ? from2_ptr->indx : HIGHEST_INDEX;
593 else if (indx1 < indx2)
596 from1_tmp = from1_ptr;
597 from2_tmp = &bitmap_zero_bits;
598 from1_ptr = from1_ptr->next;
599 indx1 = (from1_ptr) ? from1_ptr->indx : HIGHEST_INDEX;
604 from1_tmp = &bitmap_zero_bits;
605 from2_tmp = from2_ptr;
606 from2_ptr = from2_ptr->next;
607 indx2 = (from2_ptr) ? from2_ptr->indx : HIGHEST_INDEX;
610 /* Find the appropriate element from TO. Begin by discarding
611 elements that we've skipped. */
612 while (to_ptr && to_ptr->indx < indx)
616 to_ptr = to_ptr->next;
617 bitmap_elem_to_freelist (to, to_tmp);
619 if (to_ptr && to_ptr->indx == indx)
622 to_ptr = to_ptr->next;
625 to_tmp = bitmap_element_allocate (to);
627 /* Do the operation, and if any bits are set, link it into the
638 case BITMAP_AND_COMPL:
645 case BITMAP_IOR_COMPL:
653 if (! bitmap_element_zerop (to_tmp))
656 bitmap_element_link (to, to_tmp);
660 bitmap_elem_to_freelist (to, to_tmp);
664 /* If we have elements of TO left over, free the lot. */
668 for (to_tmp = to_ptr; to_tmp->next ; to_tmp = to_tmp->next)
670 if (to->using_obstack)
672 to_tmp->next = bitmap_free;
673 bitmap_free = to_ptr;
677 to_tmp->next = bitmap_ggc_free;
678 bitmap_ggc_free = to_ptr;
687 /* Return true if two bitmaps are identical. */
690 bitmap_equal_p (a, b)
697 memset (&c, 0, sizeof (c));
698 ret = ! bitmap_operation (&c, a, b, BITMAP_XOR);
704 /* Or into bitmap TO bitmap FROM1 and'ed with the complement of
708 bitmap_ior_and_compl (to, from1, from2)
715 tmp.first = tmp.current = 0;
716 tmp.using_obstack = 0;
718 bitmap_operation (&tmp, from1, from2, BITMAP_AND_COMPL);
719 bitmap_operation (to, to, &tmp, BITMAP_IOR);
724 bitmap_union_of_diff (dst, a, b, c)
733 tmp.first = tmp.current = 0;
734 tmp.using_obstack = 0;
736 bitmap_operation (&tmp, b, c, BITMAP_AND_COMPL);
737 changed = bitmap_operation (dst, &tmp, a, BITMAP_IOR);
743 /* Initialize a bitmap header. */
746 bitmap_initialize (head, using_obstack)
750 if (head == NULL && ! using_obstack)
751 head = ggc_alloc (sizeof (*head));
753 head->first = head->current = 0;
754 head->using_obstack = using_obstack;
759 /* Debugging function to print out the contents of a bitmap. */
762 debug_bitmap_file (file, head)
768 fprintf (file, "\nfirst = ");
769 fprintf (file, HOST_PTR_PRINTF, (PTR) head->first);
770 fprintf (file, " current = ");
771 fprintf (file, HOST_PTR_PRINTF, (PTR) head->current);
772 fprintf (file, " indx = %u\n", head->indx);
774 for (ptr = head->first; ptr; ptr = ptr->next)
776 unsigned int i, j, col = 26;
778 fprintf (file, "\t");
779 fprintf (file, HOST_PTR_PRINTF, (PTR) ptr);
780 fprintf (file, " next = ");
781 fprintf (file, HOST_PTR_PRINTF, (PTR) ptr->next);
782 fprintf (file, " prev = ");
783 fprintf (file, HOST_PTR_PRINTF, (PTR) ptr->prev);
784 fprintf (file, " indx = %u\n\t\tbits = {", ptr->indx);
786 for (i = 0; i < BITMAP_ELEMENT_WORDS; i++)
787 for (j = 0; j < BITMAP_WORD_BITS; j++)
788 if ((ptr->bits[i] >> j) & 1)
792 fprintf (file, "\n\t\t\t");
796 fprintf (file, " %u", (ptr->indx * BITMAP_ELEMENT_ALL_BITS
797 + i * BITMAP_WORD_BITS + j));
801 fprintf (file, " }\n");
805 /* Function to be called from the debugger to print the contents
812 debug_bitmap_file (stdout, head);
815 /* Function to print out the contents of a bitmap. Unlike debug_bitmap_file,
816 it does not print anything but the bits. */
819 bitmap_print (file, head, prefix, suffix)
825 const char *comma = "";
828 fputs (prefix, file);
829 EXECUTE_IF_SET_IN_BITMAP (head, 0, i,
831 fprintf (file, "%s%d", comma, i);
834 fputs (suffix, file);
837 #include "gt-bitmap.h"