gcc/sbitmap.h

   1 /* Simple bitmaps.
   2    Copyright (C) 1999, 2000, 2002, 2003, 2004, 2006, 2007
   3    Free Software Foundation, Inc.
   4
   5 This file is part of GCC.
   6
   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
  10 version.
  11
  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
  15 for more details.
  16
  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
  20 02110-1301, USA.  */
  21
  22 #ifndef GCC_SBITMAP_H
  23 #define GCC_SBITMAP_H
  24
  25 /* It's not clear yet whether using bitmap.[ch] will be a win.
  26    It should be straightforward to convert so for now we keep things simple
  27    while more important issues are dealt with.  */
  28
  29 #define SBITMAP_ELT_BITS ((unsigned) HOST_BITS_PER_WIDEST_FAST_INT)
  30 #define SBITMAP_ELT_TYPE unsigned HOST_WIDEST_FAST_INT
  31
  32 /* Can't use SBITMAP_ELT_BITS in this macro because it contains a
  33    cast.  There is no perfect macro in GCC to test against.  This
  34    suffices for roughly 99% of the hosts we run on, and the rest
  35    don't have 256 bit integers.  */
  36 #if HOST_BITS_PER_WIDEST_FAST_INT > 255
  37 #error Need to increase size of datatype used for popcount
  38 #endif
  39
  40 typedef struct simple_bitmap_def
  41 {
  42   unsigned char *popcount;      /* Population count.  */
  43   unsigned int n_bits;          /* Number of bits.  */
  44   unsigned int size;            /* Size in elements.  */
  45   SBITMAP_ELT_TYPE elms[1];     /* The elements.  */
  46 } *sbitmap;
  47 typedef const struct simple_bitmap_def *const_sbitmap;
  48
  49 typedef SBITMAP_ELT_TYPE *sbitmap_ptr;
  50 typedef const SBITMAP_ELT_TYPE *const_sbitmap_ptr;
  51
  52 /* Return the set size needed for N elements.  */
  53 #define SBITMAP_SET_SIZE(N) (((N) + SBITMAP_ELT_BITS - 1) / SBITMAP_ELT_BITS)
  54 #define SBITMAP_SIZE_BYTES(BITMAP) ((BITMAP)->size * sizeof (SBITMAP_ELT_TYPE))
  55
  56 /* Test if bit number bitno in the bitmap is set.  */
  57 #define TEST_BIT(BITMAP, BITNO) \
  58 ((BITMAP)->elms [(BITNO) / SBITMAP_ELT_BITS] >> (BITNO) % SBITMAP_ELT_BITS & 1)
  59
  60 /* Set bit number BITNO in the sbitmap MAP.  Updates population count
  61    if this bitmap has one.  */
  62
  63 static inline void
  64 SET_BIT (sbitmap map, unsigned int bitno)
  65 {
  66   if (map->popcount)
  67     {
  68       bool oldbit;
  69       oldbit = TEST_BIT (map, bitno);
  70       if (!oldbit)
  71         map->popcount[bitno / SBITMAP_ELT_BITS]++;
  72     }
  73   map->elms[bitno / SBITMAP_ELT_BITS]
  74     |= (SBITMAP_ELT_TYPE) 1 << (bitno) % SBITMAP_ELT_BITS;
  75 }
  76
  77
  78
  79 /* Reset bit number BITNO in the sbitmap MAP.  Updates population
  80    count if this bitmap has one.  */
  81
  82 static inline void
  83 RESET_BIT (sbitmap map,  unsigned int bitno)
  84 {
  85   if (map->popcount)
  86     {
  87       bool oldbit;
  88       oldbit = TEST_BIT (map, bitno);
  89       if (oldbit)
  90         map->popcount[bitno / SBITMAP_ELT_BITS]--;
  91     }
  92   map->elms[bitno / SBITMAP_ELT_BITS]
  93     &= ~((SBITMAP_ELT_TYPE) 1 << (bitno) % SBITMAP_ELT_BITS);
  94 }
  95
  96 /* The iterator for sbitmap.  */
  97 typedef struct {
  98   /* The pointer to the first word of the bitmap.  */
  99   const SBITMAP_ELT_TYPE *ptr;
 100
 101   /* The size of the bitmap.  */
 102   unsigned int size;
 103
 104   /* The current word index.  */
 105   unsigned int word_num;
 106
 107   /* The current bit index (not modulo SBITMAP_ELT_BITS).  */
 108   unsigned int bit_num;
 109
 110   /* The words currently visited.  */
 111   SBITMAP_ELT_TYPE word;
 112 } sbitmap_iterator;
 113
 114 /* Initialize the iterator I with sbitmap BMP and the initial index
 115    MIN.  */
 116
 117 static inline void
 118 sbitmap_iter_init (sbitmap_iterator *i, const_sbitmap bmp, unsigned int min)
 119 {
 120   i->word_num = min / (unsigned int) SBITMAP_ELT_BITS;
 121   i->bit_num = min;
 122   i->size = bmp->size;
 123   i->ptr = bmp->elms;
 124
 125   if (i->word_num >= i->size)
 126     i->word = 0;
 127   else
 128     i->word = (i->ptr[i->word_num]
 129                >> (i->bit_num % (unsigned int) SBITMAP_ELT_BITS));
 130 }
 131
 132 /* Return true if we have more bits to visit, in which case *N is set
 133    to the index of the bit to be visited.  Otherwise, return
 134    false.  */
 135
 136 static inline bool
 137 sbitmap_iter_cond (sbitmap_iterator *i, unsigned int *n)
 138 {
 139   /* Skip words that are zeros.  */
 140   for (; i->word == 0; i->word = i->ptr[i->word_num])
 141     {
 142       i->word_num++;
 143
 144       /* If we have reached the end, break.  */
 145       if (i->word_num >= i->size)
 146         return false;
 147
 148       i->bit_num = i->word_num * SBITMAP_ELT_BITS;
 149     }
 150
 151   /* Skip bits that are zero.  */
 152   for (; (i->word & 1) == 0; i->word >>= 1)
 153     i->bit_num++;
 154
 155   *n = i->bit_num;
 156
 157   return true;
 158 }
 159
 160 /* Advance to the next bit.  */
 161
 162 static inline void
 163 sbitmap_iter_next (sbitmap_iterator *i)
 164 {
 165   i->word >>= 1;
 166   i->bit_num++;
 167 }
 168
 169 /* Loop over all elements of SBITMAP, starting with MIN.  In each
 170    iteration, N is set to the index of the bit being visited.  ITER is
 171    an instance of sbitmap_iterator used to iterate the bitmap.  */
 172
 173 #define EXECUTE_IF_SET_IN_SBITMAP(SBITMAP, MIN, N, ITER)        \
 174   for (sbitmap_iter_init (&(ITER), (SBITMAP), (MIN));           \
 175        sbitmap_iter_cond (&(ITER), &(N));                       \
 176        sbitmap_iter_next (&(ITER)))
 177
 178 #define EXECUTE_IF_SET_IN_SBITMAP_REV(SBITMAP, N, CODE)                 \
 179 do {                                                                    \
 180   unsigned int word_num_;                                               \
 181   unsigned int bit_num_;                                                \
 182   unsigned int size_ = (SBITMAP)->size;                                 \
 183   SBITMAP_ELT_TYPE *ptr_ = (SBITMAP)->elms;                             \
 184                                                                         \
 185   for (word_num_ = size_; word_num_ > 0; word_num_--)                   \
 186     {                                                                   \
 187       SBITMAP_ELT_TYPE word_ = ptr_[word_num_ - 1];                     \
 188                                                                         \
 189       if (word_ != 0)                                                   \
 190         for (bit_num_ = SBITMAP_ELT_BITS; bit_num_ > 0; bit_num_--)     \
 191           {                                                             \
 192             SBITMAP_ELT_TYPE _mask = (SBITMAP_ELT_TYPE)1 << (bit_num_ - 1);\
 193                                                                         \
 194             if ((word_ & _mask) != 0)                                   \
 195               {                                                         \
 196                 word_ &= ~ _mask;                                       \
 197                 (N) = (word_num_ - 1) * SBITMAP_ELT_BITS + bit_num_ - 1;\
 198                 CODE;                                                   \
 199                 if (word_ == 0)                                         \
 200                   break;                                                \
 201               }                                                         \
 202           }                                                             \
 203     }                                                                   \
 204 } while (0)
 205
 206 #define sbitmap_free(MAP)               (free((MAP)->popcount), free((MAP)))
 207 #define sbitmap_vector_free(VEC)        free(VEC)
 208
 209 struct int_list;
 210
 211 extern void dump_sbitmap (FILE *, const_sbitmap);
 212 extern void dump_sbitmap_file (FILE *, const_sbitmap);
 213 extern void dump_sbitmap_vector (FILE *, const char *, const char *, sbitmap *,
 214                                  int);
 215 extern sbitmap sbitmap_alloc (unsigned int);
 216 extern sbitmap sbitmap_alloc_with_popcount (unsigned int);
 217 extern sbitmap *sbitmap_vector_alloc (unsigned int, unsigned int);
 218 extern sbitmap sbitmap_resize (sbitmap, unsigned int, int);
 219 extern void sbitmap_copy (sbitmap, const_sbitmap);
 220 extern void sbitmap_copy_n (sbitmap, const_sbitmap, unsigned int);
 221 extern int sbitmap_equal (const_sbitmap, const_sbitmap);
 222 extern bool sbitmap_empty_p (const_sbitmap);
 223 extern void sbitmap_zero (sbitmap);
 224 extern void sbitmap_ones (sbitmap);
 225 extern void sbitmap_vector_zero (sbitmap *, unsigned int);
 226 extern void sbitmap_vector_ones (sbitmap *, unsigned int);
 227
 228 extern void sbitmap_union_of_diff (sbitmap, const_sbitmap, const_sbitmap, const_sbitmap);
 229 extern bool sbitmap_union_of_diff_cg (sbitmap, const_sbitmap, const_sbitmap, const_sbitmap);
 230 extern void sbitmap_difference (sbitmap, const_sbitmap, const_sbitmap);
 231 extern void sbitmap_not (sbitmap, const_sbitmap);
 232 extern void sbitmap_a_or_b_and_c (sbitmap, const_sbitmap, const_sbitmap, const_sbitmap);
 233 extern bool sbitmap_a_or_b_and_c_cg (sbitmap, const_sbitmap, const_sbitmap, const_sbitmap);
 234 extern void sbitmap_a_and_b_or_c (sbitmap, const_sbitmap, const_sbitmap, const_sbitmap);
 235 extern bool sbitmap_a_and_b_or_c_cg (sbitmap, const_sbitmap, const_sbitmap, const_sbitmap);
 236 extern bool sbitmap_any_common_bits (const_sbitmap, const_sbitmap);
 237 extern void sbitmap_a_and_b (sbitmap, const_sbitmap, const_sbitmap);
 238 extern bool sbitmap_a_and_b_cg (sbitmap, const_sbitmap, const_sbitmap);
 239 extern void sbitmap_a_or_b (sbitmap, const_sbitmap, const_sbitmap);
 240 extern bool sbitmap_a_or_b_cg (sbitmap, const_sbitmap, const_sbitmap);
 241 extern void sbitmap_a_xor_b (sbitmap, const_sbitmap, const_sbitmap);
 242 extern bool sbitmap_a_xor_b_cg (sbitmap, const_sbitmap, const_sbitmap);
 243 extern bool sbitmap_a_subset_b_p (const_sbitmap, const_sbitmap);
 244
 245 extern int sbitmap_first_set_bit (const_sbitmap);
 246 extern int sbitmap_last_set_bit (const_sbitmap);
 247
 248 extern void sbitmap_intersect_of_predsucc (sbitmap, sbitmap *, int,
 249                                            struct int_list **);
 250 #define sbitmap_intersect_of_predecessors  sbitmap_intersect_of_predsucc
 251 #define sbitmap_intersect_of_successors    sbitmap_intersect_of_predsucc
 252
 253 extern void sbitmap_union_of_predsucc (sbitmap, sbitmap *, int,
 254                                        struct int_list **);
 255 #define sbitmap_union_of_predecessors  sbitmap_union_of_predsucc
 256 #define sbitmap_union_of_successors    sbitmap_union_of_predsucc
 257
 258 /* Intersection and Union of preds/succs using the new flow graph
 259    structure instead of the pred/succ arrays.  */
 260
 261 extern void sbitmap_intersection_of_succs (sbitmap, sbitmap *, int);
 262 extern void sbitmap_intersection_of_preds (sbitmap, sbitmap *, int);
 263 extern void sbitmap_union_of_succs (sbitmap, sbitmap *, int);
 264 extern void sbitmap_union_of_preds (sbitmap, sbitmap *, int);
 265
 266 extern void debug_sbitmap (const_sbitmap);
 267 extern sbitmap sbitmap_realloc (sbitmap, unsigned int);
 268 extern unsigned long sbitmap_popcount(const_sbitmap, unsigned long);
 269 extern void sbitmap_verify_popcount (const_sbitmap);
 270 #endif /* ! GCC_SBITMAP_H */