OSDN Git Service

2010-04-28 Richard Guenther <rguenther@suse.de>
[pf3gnuchains/gcc-fork.git] / gcc / bitmap.h
index beb3f4a..bbc0e20 100644 (file)
@@ -1,12 +1,12 @@
 /* Functions to support general ended bitmaps.
-   Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004
-   Free Software Foundation, Inc.
+   Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
+   2006, 2007, 2008, 2009 Free Software Foundation, Inc.
 
 This file is part of GCC.
 
 GCC is free software; you can redistribute it and/or modify it under
 the terms of the GNU General Public License as published by the Free
-Software Foundation; either version 2, or (at your option) any later
+Software Foundation; either version 3, or (at your option) any later
 version.
 
 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
@@ -15,12 +15,14 @@ FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 for more details.
 
 You should have received a copy of the GNU General Public License
-along with GCC; see the file COPYING.  If not, write to the Free
-Software Foundation, 59 Temple Place - Suite 330, Boston, MA
-02111-1307, USA.  */
+along with GCC; see the file COPYING3.  If not see
+<http://www.gnu.org/licenses/>.  */
 
 #ifndef GCC_BITMAP_H
 #define GCC_BITMAP_H
+#include "hashtab.h"
+#include "statistics.h"
+#include "obstack.h"
 
 /* Fundamental storage type for bitmap.  */
 
@@ -40,8 +42,7 @@ typedef unsigned long BITMAP_WORD;
 #define BITMAP_ELEMENT_ALL_BITS (BITMAP_ELEMENT_WORDS * BITMAP_WORD_BITS)
 
 /* Obstack for allocating bitmaps and elements from.  */
-typedef struct bitmap_obstack GTY (())
-{
+typedef struct GTY (()) bitmap_obstack {
   struct bitmap_element_def *elements;
   struct bitmap_head_def *heads;
   struct obstack GTY ((skip)) obstack;
@@ -49,29 +50,39 @@ typedef struct bitmap_obstack GTY (())
 
 /* Bitmap set element.  We use a linked list to hold only the bits that
    are set.  This allows for use to grow the bitset dynamically without
-   having to realloc and copy a giant bit array.  The `prev' field is
-   undefined for an element on the free list.  */
+   having to realloc and copy a giant bit array.
 
-typedef struct bitmap_element_def GTY(())
-{
+   The free list is implemented as a list of lists.  There is one
+   outer list connected together by prev fields.  Each element of that
+   outer is an inner list (that may consist only of the outer list
+   element) that are connected by the next fields.  The prev pointer
+   is undefined for interior elements.  This allows
+   bitmap_elt_clear_from to be implemented in unit time rather than
+   linear in the number of elements to be freed.  */
+
+typedef struct GTY(()) bitmap_element_def {
   struct bitmap_element_def *next;             /* Next element.  */
   struct bitmap_element_def *prev;             /* Previous element.  */
   unsigned int indx;                   /* regno/BITMAP_ELEMENT_ALL_BITS.  */
   BITMAP_WORD bits[BITMAP_ELEMENT_WORDS]; /* Bits that are set.  */
 } bitmap_element;
 
-/* Head of bitmap linked list.  */
-typedef struct bitmap_head_def GTY(()) {
+struct bitmap_descriptor;
+/* Head of bitmap linked list.  gengtype ignores ifdefs, but for
+   statistics we need to add a bitmap descriptor pointer.  As it is
+   not collected, we can just GTY((skip)) it.   */
+
+typedef struct GTY(()) bitmap_head_def {
   bitmap_element *first;       /* First element in linked list.  */
   bitmap_element *current;     /* Last element looked at.  */
   unsigned int indx;           /* Index of last element looked at.  */
   bitmap_obstack *obstack;     /* Obstack to allocate elements from.
                                   If NULL, then use ggc_alloc.  */
+#ifdef GATHER_STATISTICS
+  struct bitmap_descriptor GTY((skip)) *desc;
+#endif
 } bitmap_head;
 
-
-typedef struct bitmap_head_def *bitmap;
-
 /* Global data */
 extern bitmap_element bitmap_zero_bits;        /* Zero bitmap element */
 extern bitmap_obstack bitmap_default_obstack;   /* Default bitmap obstack */
@@ -80,78 +91,102 @@ extern bitmap_obstack bitmap_default_obstack;   /* Default bitmap obstack */
 extern void bitmap_clear (bitmap);
 
 /* Copy a bitmap to another bitmap.  */
-extern void bitmap_copy (bitmap, bitmap);
+extern void bitmap_copy (bitmap, const_bitmap);
 
 /* True if two bitmaps are identical.  */
-extern bool bitmap_equal_p (bitmap, bitmap);
+extern bool bitmap_equal_p (const_bitmap, const_bitmap);
 
 /* True if the bitmaps intersect (their AND is non-empty).  */
-extern bool bitmap_intersect_p (bitmap, bitmap);
+extern bool bitmap_intersect_p (const_bitmap, const_bitmap);
 
 /* True if the complement of the second intersects the first (their
    AND_COMPL is non-empty).  */
-extern bool bitmap_intersect_compl_p (bitmap, bitmap);
+extern bool bitmap_intersect_compl_p (const_bitmap, const_bitmap);
 
 /* True if MAP is an empty bitmap.  */
 #define bitmap_empty_p(MAP) (!(MAP)->first)
 
+/* True if the bitmap has only a single bit set.  */
+extern bool bitmap_single_bit_set_p (const_bitmap);
+
+/* Count the number of bits set in the bitmap.  */
+extern unsigned long bitmap_count_bits (const_bitmap);
+
 /* Boolean operations on bitmaps.  The _into variants are two operand
    versions that modify the first source operand.  The other variants
    are three operand versions that to not destroy the source bitmaps.
    The operations supported are &, & ~, |, ^.  */
-extern void bitmap_and (bitmap, bitmap, bitmap);
-extern void bitmap_and_into (bitmap, bitmap);
-extern void bitmap_and_compl (bitmap, bitmap, bitmap);
-extern bool bitmap_and_compl_into (bitmap, bitmap);
-extern bool bitmap_ior (bitmap, bitmap, bitmap);
-extern bool bitmap_ior_into (bitmap, bitmap);
-extern void bitmap_xor (bitmap, bitmap, bitmap);
-extern void bitmap_xor_into (bitmap, bitmap);
-
+extern void bitmap_and (bitmap, const_bitmap, const_bitmap);
+extern void bitmap_and_into (bitmap, const_bitmap);
+extern bool bitmap_and_compl (bitmap, const_bitmap, const_bitmap);
+extern bool bitmap_and_compl_into (bitmap, const_bitmap);
+#define bitmap_compl_and(DST, A, B) bitmap_and_compl (DST, B, A)
+extern void bitmap_compl_and_into (bitmap, const_bitmap);
+extern void bitmap_clear_range (bitmap, unsigned int, unsigned int);
+extern void bitmap_set_range (bitmap, unsigned int, unsigned int);
+extern bool bitmap_ior (bitmap, const_bitmap, const_bitmap);
+extern bool bitmap_ior_into (bitmap, const_bitmap);
+extern void bitmap_xor (bitmap, const_bitmap, const_bitmap);
+extern void bitmap_xor_into (bitmap, const_bitmap);
+
+/* DST = A | (B & C).  Return true if DST changes.  */
+extern bool bitmap_ior_and_into (bitmap DST, const_bitmap B, const_bitmap C);
 /* DST = A | (B & ~C).  Return true if DST changes.  */
-extern bool bitmap_ior_and_compl (bitmap DST, bitmap A, bitmap B, bitmap C);
+extern bool bitmap_ior_and_compl (bitmap DST, const_bitmap A, const_bitmap B, const_bitmap C);
 /* A |= (B & ~C).  Return true if A changes.  */
-extern bool bitmap_ior_and_compl_into (bitmap DST, bitmap B, bitmap C);
+extern bool bitmap_ior_and_compl_into (bitmap DST, const_bitmap B, const_bitmap C);
 
-/* Clear a single register in a register set.  */
-extern void bitmap_clear_bit (bitmap, int);
+/* Clear a single bit in a bitmap.  Return true if the bit changed.  */
+extern bool bitmap_clear_bit (bitmap, int);
 
-/* Set a single register in a register set.  */
-extern void bitmap_set_bit (bitmap, int);
+/* Set a single bit in a bitmap.  Return true if the bit changed.  */
+extern bool bitmap_set_bit (bitmap, int);
 
 /* Return true if a register is set in a register set.  */
 extern int bitmap_bit_p (bitmap, int);
 
 /* Debug functions to print a bitmap linked list.  */
-extern void debug_bitmap (bitmap);
-extern void debug_bitmap_file (FILE *, bitmap);
+extern void debug_bitmap (const_bitmap);
+extern void debug_bitmap_file (FILE *, const_bitmap);
 
 /* Print a bitmap.  */
-extern void bitmap_print (FILE *, bitmap, const char *, const char *);
+extern void bitmap_print (FILE *, const_bitmap, const char *, const char *);
 
-/* Initialize and releas a bitmap obstack.  */
+/* Initialize and release a bitmap obstack.  */
 extern void bitmap_obstack_initialize (bitmap_obstack *);
 extern void bitmap_obstack_release (bitmap_obstack *);
+extern void bitmap_register (bitmap MEM_STAT_DECL);
+extern void dump_bitmap_statistics (void);
 
 /* Initialize a bitmap header.  OBSTACK indicates the bitmap obstack
    to allocate from, NULL for GC'd bitmap.  */
 
 static inline void
-bitmap_initialize (bitmap head, bitmap_obstack *obstack)
+bitmap_initialize_stat (bitmap head, bitmap_obstack *obstack MEM_STAT_DECL)
 {
   head->first = head->current = NULL;
   head->obstack = obstack;
+#ifdef GATHER_STATISTICS
+  bitmap_register (head PASS_MEM_STAT);
+#endif
 }
+#define bitmap_initialize(h,o) bitmap_initialize_stat (h,o MEM_STAT_INFO)
 
 /* Allocate and free bitmaps from obstack, malloc and gc'd memory.  */
-extern bitmap bitmap_obstack_alloc (bitmap_obstack *obstack);
-extern bitmap bitmap_gc_alloc (void);
+extern bitmap bitmap_obstack_alloc_stat (bitmap_obstack *obstack MEM_STAT_DECL);
+#define bitmap_obstack_alloc(t) bitmap_obstack_alloc_stat (t MEM_STAT_INFO)
+extern bitmap bitmap_gc_alloc_stat (ALONE_MEM_STAT_DECL);
+#define bitmap_gc_alloc() bitmap_gc_alloc_stat (ALONE_MEM_STAT_INFO)
 extern void bitmap_obstack_free (bitmap);
 
 /* A few compatibility/functions macros for compatibility with sbitmaps */
 #define dump_bitmap(file, bitmap) bitmap_print (file, bitmap, "", "\n")
 #define bitmap_zero(a) bitmap_clear (a)
-extern unsigned bitmap_first_set_bit (bitmap);
+extern unsigned bitmap_first_set_bit (const_bitmap);
+extern unsigned bitmap_last_set_bit (const_bitmap);
+
+/* Compute bitmap hash (for purposes of hashing etc.)  */
+extern hashval_t bitmap_hash(const_bitmap);
 
 /* Allocate a bitmap from a bit obstack.  */
 #define BITMAP_ALLOC(OBSTACK) bitmap_obstack_alloc (OBSTACK)
@@ -159,15 +194,9 @@ extern unsigned bitmap_first_set_bit (bitmap);
 /* Allocate a gc'd bitmap.  */
 #define BITMAP_GGC_ALLOC() bitmap_gc_alloc ()
 
-/* Allocate a bitmap with xmalloc.  */
-#define BITMAP_XMALLOC() BITMAP_ALLOC (NULL)
-
 /* Do any cleanup needed on a bitmap when it is no longer used.  */
-#define BITMAP_FREE(BITMAP)                    \
-       ((void)(bitmap_obstack_free (BITMAP), (BITMAP) = NULL))
-
-/* Do any cleanup needed on an xmalloced bitmap when it is no longer used.  */
-#define BITMAP_XFREE(BITMAP) BITMAP_FREE (BITMAP)
+#define BITMAP_FREE(BITMAP) \
+       ((void) (bitmap_obstack_free ((bitmap) BITMAP), (BITMAP) = (bitmap) NULL))
 
 /* Iterator for bitmaps.  */
 
@@ -175,13 +204,13 @@ typedef struct
 {
   /* Pointer to the current bitmap element.  */
   bitmap_element *elt1;
-  
+
   /* Pointer to 2nd bitmap element when two are involved.  */
   bitmap_element *elt2;
 
   /* Word within the current element.  */
   unsigned word_no;
-  
+
   /* Contents of the actually processed word.  When finding next bit
      it is shifted right, so that the actual bit is always the least
      significant bit of ACTUAL.  */
@@ -192,7 +221,7 @@ typedef struct
    iterate from.  */
 
 static inline void
-bmp_iter_set_init (bitmap_iterator *bi, bitmap map,
+bmp_iter_set_init (bitmap_iterator *bi, const_bitmap map,
                   unsigned start_bit, unsigned *bit_no)
 {
   bi->elt1 = map->first;
@@ -206,7 +235,7 @@ bmp_iter_set_init (bitmap_iterator *bi, bitmap map,
          bi->elt1 = &bitmap_zero_bits;
          break;
        }
-      
+
       if (bi->elt1->indx >= start_bit / BITMAP_ELEMENT_ALL_BITS)
        break;
       bi->elt1 = bi->elt1->next;
@@ -215,7 +244,7 @@ bmp_iter_set_init (bitmap_iterator *bi, bitmap map,
   /* We might have gone past the start bit, so reinitialize it.  */
   if (bi->elt1->indx != start_bit / BITMAP_ELEMENT_ALL_BITS)
     start_bit = bi->elt1->indx * BITMAP_ELEMENT_ALL_BITS;
-  
+
   /* Initialize for what is now start_bit.  */
   bi->word_no = start_bit / BITMAP_WORD_BITS % BITMAP_ELEMENT_WORDS;
   bi->bits = bi->elt1->bits[bi->word_no];
@@ -226,7 +255,7 @@ bmp_iter_set_init (bitmap_iterator *bi, bitmap map,
      will fail.  It won't matter if this increment moves us into the
      next word.  */
   start_bit += !bi->bits;
-  
+
   *bit_no = start_bit;
 }
 
@@ -234,7 +263,7 @@ bmp_iter_set_init (bitmap_iterator *bi, bitmap map,
    bitmaps.  START_BIT is the bit to commence from.  */
 
 static inline void
-bmp_iter_and_init (bitmap_iterator *bi, bitmap map1, bitmap map2,
+bmp_iter_and_init (bitmap_iterator *bi, const_bitmap map1, const_bitmap map2,
                   unsigned start_bit, unsigned *bit_no)
 {
   bi->elt1 = map1->first;
@@ -249,12 +278,12 @@ bmp_iter_and_init (bitmap_iterator *bi, bitmap map1, bitmap map2,
          bi->elt2 = NULL;
          break;
        }
-      
+
       if (bi->elt1->indx >= start_bit / BITMAP_ELEMENT_ALL_BITS)
        break;
       bi->elt1 = bi->elt1->next;
     }
-  
+
   /* Advance elt2 until it is not before elt1.  */
   while (1)
     {
@@ -263,7 +292,7 @@ bmp_iter_and_init (bitmap_iterator *bi, bitmap map1, bitmap map2,
          bi->elt1 = bi->elt2 = &bitmap_zero_bits;
          break;
        }
-      
+
       if (bi->elt2->indx >= bi->elt1->indx)
        break;
       bi->elt2 = bi->elt2->next;
@@ -273,10 +302,10 @@ bmp_iter_and_init (bitmap_iterator *bi, bitmap map1, bitmap map2,
   if (bi->elt1->indx == bi->elt2->indx)
     {
       /* We might have advanced beyond the start_bit, so reinitialize
-        for that.  */
+        for that.  */
       if (bi->elt1->indx != start_bit / BITMAP_ELEMENT_ALL_BITS)
        start_bit = bi->elt1->indx * BITMAP_ELEMENT_ALL_BITS;
-      
+
       bi->word_no = start_bit / BITMAP_WORD_BITS % BITMAP_ELEMENT_WORDS;
       bi->bits = bi->elt1->bits[bi->word_no] & bi->elt2->bits[bi->word_no];
       bi->bits >>= start_bit % BITMAP_WORD_BITS;
@@ -288,13 +317,13 @@ bmp_iter_and_init (bitmap_iterator *bi, bitmap map1, bitmap map2,
       bi->word_no = BITMAP_ELEMENT_WORDS - 1;
       bi->bits = 0;
     }
-  
+
   /* If this word is zero, we must make sure we're not pointing at the
      first bit, otherwise our incrementing to the next word boundary
      will fail.  It won't matter if this increment moves us into the
      next word.  */
   start_bit += !bi->bits;
-  
+
   *bit_no = start_bit;
 }
 
@@ -302,7 +331,7 @@ bmp_iter_and_init (bitmap_iterator *bi, bitmap map1, bitmap map2,
    */
 
 static inline void
-bmp_iter_and_compl_init (bitmap_iterator *bi, bitmap map1, bitmap map2,
+bmp_iter_and_compl_init (bitmap_iterator *bi, const_bitmap map1, const_bitmap map2,
                         unsigned start_bit, unsigned *bit_no)
 {
   bi->elt1 = map1->first;
@@ -316,7 +345,7 @@ bmp_iter_and_compl_init (bitmap_iterator *bi, bitmap map1, bitmap map2,
          bi->elt1 = &bitmap_zero_bits;
          break;
        }
-      
+
       if (bi->elt1->indx >= start_bit / BITMAP_ELEMENT_ALL_BITS)
        break;
       bi->elt1 = bi->elt1->next;
@@ -330,19 +359,19 @@ bmp_iter_and_compl_init (bitmap_iterator *bi, bitmap map1, bitmap map2,
      that.  */
   if (bi->elt1->indx != start_bit / BITMAP_ELEMENT_ALL_BITS)
     start_bit = bi->elt1->indx * BITMAP_ELEMENT_ALL_BITS;
-  
+
   bi->word_no = start_bit / BITMAP_WORD_BITS % BITMAP_ELEMENT_WORDS;
   bi->bits = bi->elt1->bits[bi->word_no];
   if (bi->elt2 && bi->elt1->indx == bi->elt2->indx)
     bi->bits &= ~bi->elt2->bits[bi->word_no];
   bi->bits >>= start_bit % BITMAP_WORD_BITS;
-  
+
   /* If this word is zero, we must make sure we're not pointing at the
      first bit, otherwise our incrementing to the next word boundary
      will fail.  It won't matter if this increment moves us into the
      next word.  */
   start_bit += !bi->bits;
-  
+
   *bit_no = start_bit;
 }
 
@@ -393,7 +422,7 @@ bmp_iter_set (bitmap_iterator *bi, unsigned *bit_no)
          *bit_no += BITMAP_WORD_BITS;
          bi->word_no++;
        }
-  
+
       /* Advance to the next element.  */
       bi->elt1 = bi->elt1->next;
       if (!bi->elt1)
@@ -428,7 +457,7 @@ bmp_iter_and (bitmap_iterator *bi, unsigned *bit_no)
   *bit_no = ((*bit_no + BITMAP_WORD_BITS - 1)
             / BITMAP_WORD_BITS * BITMAP_WORD_BITS);
   bi->word_no++;
-  
+
   while (1)
     {
       /* Find the next nonzero word in this elt.  */
@@ -440,7 +469,7 @@ bmp_iter_and (bitmap_iterator *bi, unsigned *bit_no)
          *bit_no += BITMAP_WORD_BITS;
          bi->word_no++;
        }
-  
+
       /* Advance to the next identical element.  */
       do
        {
@@ -453,7 +482,7 @@ bmp_iter_and (bitmap_iterator *bi, unsigned *bit_no)
                return false;
            }
          while (bi->elt1->indx < bi->elt2->indx);
-       
+
          /* Advance elt2 to be no less than elt1.  This might not
             advance.  */
          while (bi->elt2->indx < bi->elt1->indx)
@@ -464,7 +493,7 @@ bmp_iter_and (bitmap_iterator *bi, unsigned *bit_no)
            }
        }
       while (bi->elt1->indx != bi->elt2->indx);
-  
+
       *bit_no = bi->elt1->indx * BITMAP_ELEMENT_ALL_BITS;
       bi->word_no = 0;
     }
@@ -509,7 +538,7 @@ bmp_iter_and_compl (bitmap_iterator *bi, unsigned *bit_no)
          *bit_no += BITMAP_WORD_BITS;
          bi->word_no++;
        }
-  
+
       /* Advance to the next element of elt1.  */
       bi->elt1 = bi->elt1->next;
       if (!bi->elt1)
@@ -518,7 +547,7 @@ bmp_iter_and_compl (bitmap_iterator *bi, unsigned *bit_no)
       /* Advance elt2 until it is no less than elt1.  */
       while (bi->elt2 && bi->elt2->indx < bi->elt1->indx)
        bi->elt2 = bi->elt2->next;
-      
+
       *bit_no = bi->elt1->indx * BITMAP_ELEMENT_ALL_BITS;
       bi->word_no = 0;
     }
@@ -540,7 +569,7 @@ bmp_iter_and_compl (bitmap_iterator *bi, unsigned *bit_no)
    loop state.  */
 
 #define EXECUTE_IF_AND_IN_BITMAP(BITMAP1, BITMAP2, MIN, BITNUM, ITER)  \
-  for (bmp_iter_and_init (&(ITER), (BITMAP1), (BITMAP2), (MIN),        \
+  for (bmp_iter_and_init (&(ITER), (BITMAP1), (BITMAP2), (MIN),                \
                          &(BITNUM));                                   \
        bmp_iter_and (&(ITER), &(BITNUM));                              \
        bmp_iter_next (&(ITER), &(BITNUM)))
@@ -552,7 +581,7 @@ bmp_iter_and_compl (bitmap_iterator *bi, unsigned *bit_no)
 
 #define EXECUTE_IF_AND_COMPL_IN_BITMAP(BITMAP1, BITMAP2, MIN, BITNUM, ITER) \
   for (bmp_iter_and_compl_init (&(ITER), (BITMAP1), (BITMAP2), (MIN),  \
-                               &(BITNUM));                             \
+                               &(BITNUM));                             \
        bmp_iter_and_compl (&(ITER), &(BITNUM));                                \
        bmp_iter_next (&(ITER), &(BITNUM)))