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
23 #include "coretypes.h"
31 /* Obstack to allocate bitmap elements from. */
32 static struct obstack bitmap_obstack;
33 static int bitmap_obstack_init = FALSE;
39 #define INLINE __inline__
44 bitmap_element bitmap_zero_bits; /* An element of all zero bits. */
45 static bitmap_element *bitmap_free; /* Freelist of bitmap elements. */
46 static GTY((deletable (""))) bitmap_element *bitmap_ggc_free;
48 static void bitmap_elem_to_freelist PARAMS ((bitmap, bitmap_element *));
49 static void bitmap_element_free PARAMS ((bitmap, bitmap_element *));
50 static bitmap_element *bitmap_element_allocate PARAMS ((bitmap));
51 static int bitmap_element_zerop PARAMS ((bitmap_element *));
52 static void bitmap_element_link PARAMS ((bitmap, bitmap_element *));
53 static bitmap_element *bitmap_find_bit PARAMS ((bitmap, unsigned int));
55 /* Add ELEM to the appropriate freelist. */
57 bitmap_elem_to_freelist (head, elt)
61 if (head->using_obstack)
63 elt->next = bitmap_free;
68 elt->next = bitmap_ggc_free;
69 bitmap_ggc_free = elt;
73 /* Free a bitmap element. Since these are allocated off the
74 bitmap_obstack, "free" actually means "put onto the freelist". */
77 bitmap_element_free (head, elt)
81 bitmap_element *next = elt->next;
82 bitmap_element *prev = elt->prev;
90 if (head->first == elt)
93 /* Since the first thing we try is to insert before current,
94 make current the next entry in preference to the previous. */
95 if (head->current == elt)
97 head->current = next != 0 ? next : prev;
99 head->indx = head->current->indx;
101 bitmap_elem_to_freelist (head, elt);
104 /* Allocate a bitmap element. The bits are cleared, but nothing else is. */
106 static INLINE bitmap_element *
107 bitmap_element_allocate (head)
110 bitmap_element *element;
112 if (head->using_obstack)
114 if (bitmap_free != 0)
116 element = bitmap_free;
117 bitmap_free = element->next;
121 /* We can't use gcc_obstack_init to initialize the obstack since
122 print-rtl.c now calls bitmap functions, and bitmap is linked
123 into the gen* functions. */
124 if (!bitmap_obstack_init)
126 bitmap_obstack_init = TRUE;
128 /* Let particular systems override the size of a chunk. */
129 #ifndef OBSTACK_CHUNK_SIZE
130 #define OBSTACK_CHUNK_SIZE 0
132 /* Let them override the alloc and free routines too. */
133 #ifndef OBSTACK_CHUNK_ALLOC
134 #define OBSTACK_CHUNK_ALLOC xmalloc
136 #ifndef OBSTACK_CHUNK_FREE
137 #define OBSTACK_CHUNK_FREE free
140 #if !defined(__GNUC__) || (__GNUC__ < 2)
141 #define __alignof__(type) 0
144 obstack_specify_allocation (&bitmap_obstack, OBSTACK_CHUNK_SIZE,
145 __alignof__ (bitmap_element),
146 (void *(*) PARAMS ((long))) OBSTACK_CHUNK_ALLOC,
147 (void (*) PARAMS ((void *))) OBSTACK_CHUNK_FREE);
150 element = (bitmap_element *) obstack_alloc (&bitmap_obstack,
151 sizeof (bitmap_element));
156 if (bitmap_ggc_free != NULL)
158 element = bitmap_ggc_free;
159 bitmap_ggc_free = element->next;
162 element = ggc_alloc (sizeof (bitmap_element));
165 memset (element->bits, 0, sizeof (element->bits));
170 /* Release any memory allocated by bitmaps. */
173 bitmap_release_memory ()
176 if (bitmap_obstack_init)
178 bitmap_obstack_init = FALSE;
179 obstack_free (&bitmap_obstack, NULL);
183 /* Return nonzero if all bits in an element are zero. */
186 bitmap_element_zerop (element)
187 bitmap_element *element;
189 #if BITMAP_ELEMENT_WORDS == 2
190 return (element->bits[0] | element->bits[1]) == 0;
194 for (i = 0; i < BITMAP_ELEMENT_WORDS; i++)
195 if (element->bits[i] != 0)
202 /* Link the bitmap element into the current bitmap linked list. */
205 bitmap_element_link (head, element)
207 bitmap_element *element;
209 unsigned int indx = element->indx;
212 /* If this is the first and only element, set it in. */
213 if (head->first == 0)
215 element->next = element->prev = 0;
216 head->first = element;
219 /* If this index is less than that of the current element, it goes someplace
220 before the current element. */
221 else if (indx < head->indx)
223 for (ptr = head->current;
224 ptr->prev != 0 && ptr->prev->indx > indx;
229 ptr->prev->next = element;
231 head->first = element;
233 element->prev = ptr->prev;
238 /* Otherwise, it must go someplace after the current element. */
241 for (ptr = head->current;
242 ptr->next != 0 && ptr->next->indx < indx;
247 ptr->next->prev = element;
249 element->next = ptr->next;
254 /* Set up so this is the first element searched. */
255 head->current = element;
259 /* Clear a bitmap by freeing the linked list. */
265 bitmap_element *element, *next;
267 for (element = head->first; element != 0; element = next)
269 next = element->next;
270 bitmap_elem_to_freelist (head, element);
273 head->first = head->current = 0;
276 /* Copy a bitmap to another bitmap. */
279 bitmap_copy (to, from)
283 bitmap_element *from_ptr, *to_ptr = 0;
284 #if BITMAP_ELEMENT_WORDS != 2
290 /* Copy elements in forward direction one at a time */
291 for (from_ptr = from->first; from_ptr; from_ptr = from_ptr->next)
293 bitmap_element *to_elt = bitmap_element_allocate (to);
295 to_elt->indx = from_ptr->indx;
297 #if BITMAP_ELEMENT_WORDS == 2
298 to_elt->bits[0] = from_ptr->bits[0];
299 to_elt->bits[1] = from_ptr->bits[1];
301 for (i = 0; i < BITMAP_ELEMENT_WORDS; i++)
302 to_elt->bits[i] = from_ptr->bits[i];
305 /* Here we have a special case of bitmap_element_link, for the case
306 where we know the links are being entered in sequence. */
309 to->first = to->current = to_elt;
310 to->indx = from_ptr->indx;
311 to_elt->next = to_elt->prev = 0;
315 to_elt->prev = to_ptr;
317 to_ptr->next = to_elt;
324 /* Find a bitmap element that would hold a bitmap's bit.
325 Update the `current' field even if we can't find an element that
326 would hold the bitmap's bit to make eventual allocation
329 static INLINE bitmap_element *
330 bitmap_find_bit (head, bit)
334 bitmap_element *element;
335 unsigned HOST_WIDE_INT indx = bit / BITMAP_ELEMENT_ALL_BITS;
337 if (head->current == 0
338 || head->indx == indx)
339 return head->current;
341 if (head->indx > indx)
342 for (element = head->current;
343 element->prev != 0 && element->indx > indx;
344 element = element->prev)
348 for (element = head->current;
349 element->next != 0 && element->indx < indx;
350 element = element->next)
353 /* `element' is the nearest to the one we want. If it's not the one we
354 want, the one we want doesn't exist. */
355 head->current = element;
356 head->indx = element->indx;
357 if (element != 0 && element->indx != indx)
363 /* Clear a single bit in a bitmap. */
366 bitmap_clear_bit (head, bit)
370 bitmap_element *ptr = bitmap_find_bit (head, bit);
374 unsigned bit_num = bit % (unsigned) HOST_BITS_PER_WIDE_INT;
375 unsigned word_num = ((bit / (unsigned) HOST_BITS_PER_WIDE_INT)
376 % BITMAP_ELEMENT_WORDS);
377 ptr->bits[word_num] &= ~ (((unsigned HOST_WIDE_INT) 1) << bit_num);
379 /* If we cleared the entire word, free up the element */
380 if (bitmap_element_zerop (ptr))
381 bitmap_element_free (head, ptr);
385 /* Set a single bit in a bitmap. */
388 bitmap_set_bit (head, bit)
392 bitmap_element *ptr = bitmap_find_bit (head, bit);
394 = ((bit / (unsigned) HOST_BITS_PER_WIDE_INT) % BITMAP_ELEMENT_WORDS);
395 unsigned bit_num = bit % (unsigned) HOST_BITS_PER_WIDE_INT;
396 unsigned HOST_WIDE_INT bit_val = ((unsigned HOST_WIDE_INT) 1) << bit_num;
400 ptr = bitmap_element_allocate (head);
401 ptr->indx = bit / BITMAP_ELEMENT_ALL_BITS;
402 ptr->bits[word_num] = bit_val;
403 bitmap_element_link (head, ptr);
406 ptr->bits[word_num] |= bit_val;
409 /* Return whether a bit is set within a bitmap. */
412 bitmap_bit_p (head, bit)
420 ptr = bitmap_find_bit (head, bit);
424 bit_num = bit % (unsigned) HOST_BITS_PER_WIDE_INT;
426 = ((bit / (unsigned) HOST_BITS_PER_WIDE_INT) % BITMAP_ELEMENT_WORDS);
428 return (ptr->bits[word_num] >> bit_num) & 1;
431 /* Return the bit number of the first set bit in the bitmap, or -1
432 if the bitmap is empty. */
435 bitmap_first_set_bit (a)
438 bitmap_element *ptr = a->first;
439 unsigned HOST_WIDE_INT word;
440 unsigned word_num, bit_num;
445 #if BITMAP_ELEMENT_WORDS == 2
446 word_num = 0, word = ptr->bits[0];
448 word_num = 1, word = ptr->bits[1];
450 for (word_num = 0; word_num < BITMAP_ELEMENT_WORDS; ++word_num)
451 if ((word = ptr->bits[word_num]) != 0)
455 /* Binary search for the first set bit. */
456 /* ??? It'd be nice to know if ffs or ffsl was available. */
461 #if HOST_BITS_PER_WIDE_INT > 64
462 #error "Fill out the table."
464 #if HOST_BITS_PER_WIDE_INT > 32
465 if ((word & 0xffffffff) == 0)
466 word >>= 32, bit_num += 32;
468 if ((word & 0xffff) == 0)
469 word >>= 16, bit_num += 16;
470 if ((word & 0xff) == 0)
471 word >>= 8, bit_num += 8;
479 return (ptr->indx * BITMAP_ELEMENT_ALL_BITS
480 + word_num * HOST_BITS_PER_WIDE_INT
484 /* Return the bit number of the last set bit in the bitmap, or -1
485 if the bitmap is empty. */
488 bitmap_last_set_bit (a)
491 bitmap_element *ptr = a->first;
492 unsigned HOST_WIDE_INT word;
493 unsigned word_num, bit_num;
498 while (ptr->next != NULL)
501 #if BITMAP_ELEMENT_WORDS == 2
502 word_num = 1, word = ptr->bits[1];
504 word_num = 0, word = ptr->bits[0];
506 for (word_num = BITMAP_ELEMENT_WORDS; word_num-- > 0; )
507 if ((word = ptr->bits[word_num]) != 0)
511 /* Binary search for the last set bit. */
514 #if HOST_BITS_PER_WIDE_INT > 64
515 #error "Fill out the table."
517 #if HOST_BITS_PER_WIDE_INT > 32
518 if (word & ~ (unsigned HOST_WIDE_INT) 0xffffffff)
519 word >>= 32, bit_num += 32;
521 if (word & 0xffff0000)
522 word >>= 16, bit_num += 16;
524 word >>= 8, bit_num += 8;
526 word >>= 4, bit_num += 4;
528 word >>= 2, bit_num += 2;
532 return (ptr->indx * BITMAP_ELEMENT_ALL_BITS
533 + word_num * HOST_BITS_PER_WIDE_INT
537 /* Store in bitmap TO the result of combining bitmap FROM1 and FROM2 using
538 a specific bit manipulation. Return true if TO changes. */
541 bitmap_operation (to, from1, from2, operation)
545 enum bitmap_bits operation;
547 #define HIGHEST_INDEX (unsigned int) ~0
549 bitmap_element *from1_ptr = from1->first;
550 bitmap_element *from2_ptr = from2->first;
551 unsigned int indx1 = (from1_ptr) ? from1_ptr->indx : HIGHEST_INDEX;
552 unsigned int indx2 = (from2_ptr) ? from2_ptr->indx : HIGHEST_INDEX;
553 bitmap_element *to_ptr = to->first;
554 bitmap_element *from1_tmp;
555 bitmap_element *from2_tmp;
556 bitmap_element *to_tmp;
560 #if BITMAP_ELEMENT_WORDS == 2
563 unsigned HOST_WIDE_INT t0, t1, f10, f11, f20, f21; \
564 f10 = from1_tmp->bits[0]; \
565 f20 = from2_tmp->bits[0]; \
567 changed |= (t0 != to_tmp->bits[0]); \
568 f11 = from1_tmp->bits[1]; \
569 f21 = from2_tmp->bits[1]; \
571 changed |= (t1 != to_tmp->bits[1]); \
572 to_tmp->bits[0] = t0; \
573 to_tmp->bits[1] = t1; \
578 unsigned HOST_WIDE_INT t, f1, f2; \
580 for (i = 0; i < BITMAP_ELEMENT_WORDS; ++i) \
582 f1 = from1_tmp->bits[i]; \
583 f2 = from2_tmp->bits[i]; \
585 changed |= (t != to_tmp->bits[i]); \
586 to_tmp->bits[i] = t; \
591 to->first = to->current = 0;
593 while (from1_ptr != 0 || from2_ptr != 0)
595 /* Figure out whether we need to substitute zero elements for
600 from1_tmp = from1_ptr;
601 from2_tmp = from2_ptr;
602 from1_ptr = from1_ptr->next;
603 indx1 = (from1_ptr) ? from1_ptr->indx : HIGHEST_INDEX;
604 from2_ptr = from2_ptr->next;
605 indx2 = (from2_ptr) ? from2_ptr->indx : HIGHEST_INDEX;
607 else if (indx1 < indx2)
610 from1_tmp = from1_ptr;
611 from2_tmp = &bitmap_zero_bits;
612 from1_ptr = from1_ptr->next;
613 indx1 = (from1_ptr) ? from1_ptr->indx : HIGHEST_INDEX;
618 from1_tmp = &bitmap_zero_bits;
619 from2_tmp = from2_ptr;
620 from2_ptr = from2_ptr->next;
621 indx2 = (from2_ptr) ? from2_ptr->indx : HIGHEST_INDEX;
624 /* Find the appropriate element from TO. Begin by discarding
625 elements that we've skipped. */
626 while (to_ptr && to_ptr->indx < indx)
630 to_ptr = to_ptr->next;
631 bitmap_elem_to_freelist (to, to_tmp);
633 if (to_ptr && to_ptr->indx == indx)
636 to_ptr = to_ptr->next;
639 to_tmp = bitmap_element_allocate (to);
641 /* Do the operation, and if any bits are set, link it into the
652 case BITMAP_AND_COMPL:
659 case BITMAP_IOR_COMPL:
667 if (! bitmap_element_zerop (to_tmp))
670 bitmap_element_link (to, to_tmp);
674 bitmap_elem_to_freelist (to, to_tmp);
678 /* If we have elements of TO left over, free the lot. */
682 for (to_tmp = to_ptr; to_tmp->next ; to_tmp = to_tmp->next)
684 if (to->using_obstack)
686 to_tmp->next = bitmap_free;
687 bitmap_free = to_ptr;
691 to_tmp->next = bitmap_ggc_free;
692 bitmap_ggc_free = to_ptr;
701 /* Return true if two bitmaps are identical. */
704 bitmap_equal_p (a, b)
711 memset (&c, 0, sizeof (c));
712 ret = ! bitmap_operation (&c, a, b, BITMAP_XOR);
718 /* Or into bitmap TO bitmap FROM1 and'ed with the complement of
722 bitmap_ior_and_compl (to, from1, from2)
729 tmp.first = tmp.current = 0;
730 tmp.using_obstack = 0;
732 bitmap_operation (&tmp, from1, from2, BITMAP_AND_COMPL);
733 bitmap_operation (to, to, &tmp, BITMAP_IOR);
738 bitmap_union_of_diff (dst, a, b, c)
747 tmp.first = tmp.current = 0;
748 tmp.using_obstack = 0;
750 bitmap_operation (&tmp, b, c, BITMAP_AND_COMPL);
751 changed = bitmap_operation (dst, &tmp, a, BITMAP_IOR);
757 /* Initialize a bitmap header. */
760 bitmap_initialize (head, using_obstack)
764 if (head == NULL && ! using_obstack)
765 head = ggc_alloc (sizeof (*head));
767 head->first = head->current = 0;
768 head->using_obstack = using_obstack;
773 /* Debugging function to print out the contents of a bitmap. */
776 debug_bitmap_file (file, head)
782 fprintf (file, "\nfirst = ");
783 fprintf (file, HOST_PTR_PRINTF, (PTR) head->first);
784 fprintf (file, " current = ");
785 fprintf (file, HOST_PTR_PRINTF, (PTR) head->current);
786 fprintf (file, " indx = %u\n", head->indx);
788 for (ptr = head->first; ptr; ptr = ptr->next)
792 fprintf (file, "\t");
793 fprintf (file, HOST_PTR_PRINTF, (PTR) ptr);
794 fprintf (file, " next = ");
795 fprintf (file, HOST_PTR_PRINTF, (PTR) ptr->next);
796 fprintf (file, " prev = ");
797 fprintf (file, HOST_PTR_PRINTF, (PTR) ptr->prev);
798 fprintf (file, " indx = %u\n\t\tbits = {", ptr->indx);
800 for (i = 0; i < BITMAP_ELEMENT_WORDS; i++)
801 for (j = 0; j < HOST_BITS_PER_WIDE_INT; j++)
802 if ((ptr->bits[i] >> j) & 1)
806 fprintf (file, "\n\t\t\t");
810 fprintf (file, " %u", (ptr->indx * BITMAP_ELEMENT_ALL_BITS
811 + i * HOST_BITS_PER_WIDE_INT + j));
815 fprintf (file, " }\n");
819 /* Function to be called from the debugger to print the contents
826 debug_bitmap_file (stdout, head);
829 /* Function to print out the contents of a bitmap. Unlike debug_bitmap_file,
830 it does not print anything but the bits. */
833 bitmap_print (file, head, prefix, suffix)
839 const char *comma = "";
842 fputs (prefix, file);
843 EXECUTE_IF_SET_IN_BITMAP (head, 0, i,
845 fprintf (file, "%s%d", comma, i);
848 fputs (suffix, file);
851 #include "gt-bitmap.h"