nsz Git - libfirm/blob - ir/adt/bitset.h

   1 /*
   2  * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
   3  *
   4  * This file is part of libFirm.
   5  *
   6  * This file may be distributed and/or modified under the terms of the
   7  * GNU General Public License version 2 as published by the Free Software
   8  * Foundation and appearing in the file LICENSE.GPL included in the
   9  * packaging of this file.
  10  *
  11  * Licensees holding valid libFirm Professional Edition licenses may use
  12  * this file in accordance with the libFirm Commercial License.
  13  * Agreement provided with the Software.
  14  *
  15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
  16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE.
  18  */
  19
  20 /**
  21  * @file
  22  * @date   15.10.2004
  23  * @author Sebastian Hack
  24  * @brief  A bitset implementation.
  25  */
  26 #ifndef FIRM_ADT_BITSET_H
  27 #define FIRM_ADT_BITSET_H
  28
  29 #include "firm_config.h"
  30
  31 #include <stdlib.h>
  32 #include <stdio.h>
  33 #include <assert.h>
  34 #include <string.h>
  35
  36 #include "xmalloc.h"
  37 #include "bitfiddle.h"
  38
  39 typedef unsigned int bitset_pos_t;
  40
  41 #include "bitset_std.h"
  42
  43 /*
  44 #if defined(__GNUC__) && defined(__i386__)
  45 #include "bitset_ia32.h"
  46 #endif
  47 */
  48
  49 typedef struct _bitset_t {
  50         bitset_pos_t units;
  51         bitset_pos_t size;
  52         bitset_unit_t *data;
  53 } bitset_t;
  54
  55 #define BS_UNIT_SIZE sizeof(bitset_unit_t)
  56 #define BS_UNIT_SIZE_BITS (BS_UNIT_SIZE * 8)
  57 #define BS_UNIT_MASK (BS_UNIT_SIZE_BITS - 1)
  58
  59 /**
  60  * Initialize a bitset.
  61  * This functions should not be called.
  62  *
  63  * Note that this function needs three macros which must be provided by the
  64  * bitfield implementor:
  65  * - _bitset_overall_size(size) The overall size that must be
  66  *   allocated for the bitfield in bytes.
  67  * - _bitset_units(size) The number of units that will be
  68  *   present in the bitfield for a given highest bit.
  69  * - _bitset_data_ptr(data, size) This produces as pointer to the
  70  *   first unit in the allocated memory area. The main reason for this
  71  *   macro is, that some bitset implementors want control over memory
  72  *   alignment.
  73  *
  74  * @param area A pointer to memory reserved for the bitset.
  75  * @param size The size of the bitset in bits.
  76  * @return A pointer to the initialized bitset.
  77  */
  78 static INLINE bitset_t *_bitset_prepare(void *area, bitset_pos_t size)
  79 {
  80         bitset_t *ptr = area;
  81         memset(area, 0, _bitset_overall_size(sizeof(bitset_t), size));
  82         ptr->units = _bitset_units(size);
  83         ptr->size = size;
  84         ptr->data = _bitset_data_ptr(area, sizeof(bitset_t), size);
  85         return ptr;
  86 }
  87
  88 /**
  89  * Mask out all bits, which are only there, because the number
  90  * of bits in the set didn't match a unit size boundary.
  91  * @param bs The bitset.
  92  * @return The masked bitset.
  93  */
  94 static INLINE bitset_t *_bitset_mask_highest(bitset_t *bs)
  95 {
  96         bitset_pos_t rest = bs->size & BS_UNIT_MASK;
  97         if (rest)
  98                 bs->data[bs->units - 1] &= (1 << rest) - 1;
  99         return bs;
 100 }
 101
 102 /**
 103  * Get the capacity of the bitset in bits.
 104  * @param bs The bitset.
 105  * @return The capacity in bits of the bitset.
 106  */
 107 #define bitset_capacity(bs) ((bs)->units * BS_UNIT_SIZE_BITS)
 108
 109 /**
 110  * Get the size of the bitset in bits.
 111  * @note Note the difference between capacity and size.
 112  * @param bs The bitset.
 113  * @return The highest bit which can be set or cleared plus 1.
 114  */
 115 #define bitset_size(bs)  ((bs)->size)
 116
 117 /**
 118  * Allocate a bitset on an obstack.
 119  * @param obst The obstack.
 120  * @param size The greatest bit that shall be stored in the set.
 121  * @return A pointer to an empty initialized bitset.
 122  */
 123 #define bitset_obstack_alloc(obst,size) \
 124         _bitset_prepare(obstack_alloc(obst, _bitset_overall_size(sizeof(bitset_t), size)), size)
 125
 126 /**
 127  * Allocate a bitset via malloc.
 128  * @param size The greatest bit that shall be stored in the set.
 129  * @return A pointer to an empty initialized bitset.
 130  */
 131 #define bitset_malloc(size) \
 132         _bitset_prepare(xmalloc(_bitset_overall_size(sizeof(bitset_t), size)), size)
 133
 134 /**
 135  * Free a bitset allocated with bitset_malloc().
 136  * @param bs The bitset.
 137  */
 138 #define bitset_free(bs) free(bs)
 139
 140 /**
 141  * Allocate a bitset on the stack via alloca.
 142  * @param size The greatest bit that shall be stored in the set.
 143  * @return A pointer to an empty initialized bitset.
 144  */
 145 #define bitset_alloca(size) \
 146         _bitset_prepare(alloca(_bitset_overall_size(sizeof(bitset_t), size)), size)
 147
 148
 149 /**
 150  * Get the unit which contains a specific bit.
 151  * This function is internal.
 152  * @param bs The bitset.
 153  * @param bit The bit.
 154  * @return A pointer to the unit containing the bit.
 155  */
 156 static INLINE bitset_unit_t *_bitset_get_unit(const bitset_t *bs, bitset_pos_t bit)
 157 {
 158         /* assert(bit < bs->units * BS_UNIT_SIZE_BITS && "Bit too large"); */
 159         assert(bit <= bs->size && "Bit to large");
 160         return bs->data + bit / BS_UNIT_SIZE_BITS;
 161 }
 162
 163 /**
 164  * Set a bit in the bitset.
 165  * @param bs The bitset.
 166  * @param bit The bit to set.
 167  */
 168 static INLINE void bitset_set(bitset_t *bs, bitset_pos_t bit)
 169 {
 170         bitset_unit_t *unit = _bitset_get_unit(bs, bit);
 171         _bitset_inside_set(unit, bit & BS_UNIT_MASK);
 172 }
 173
 174 /**
 175  * Clear a bit in the bitset.
 176  * @param bs The bitset.
 177  * @param bit The bit to clear.
 178  */
 179 static INLINE void bitset_clear(bitset_t *bs, bitset_pos_t bit)
 180 {
 181         bitset_unit_t *unit = _bitset_get_unit(bs, bit);
 182         _bitset_inside_clear(unit, bit & BS_UNIT_MASK);
 183 }
 184
 185 /**
 186  * Check, if a bit is set.
 187  * @param bs The bitset.
 188  * @param bit The bit to check for.
 189  * @return 1, if the bit was set, 0 if not.
 190  */
 191 static INLINE int bitset_is_set(const bitset_t *bs, bitset_pos_t bit)
 192 {
 193         bitset_unit_t *unit = _bitset_get_unit(bs, bit);
 194         return _bitset_inside_is_set(unit, bit & BS_UNIT_MASK);
 195 }
 196
 197 /**
 198  * Flip a bit in a bitset.
 199  * @param bs The bitset.
 200  * @param bit The bit to flip.
 201  */
 202 static INLINE void bitset_flip(bitset_t *bs, bitset_pos_t bit)
 203 {
 204         bitset_unit_t *unit = _bitset_get_unit(bs, bit);
 205         _bitset_inside_flip(unit, bit & BS_UNIT_MASK);
 206 }
 207
 208 /**
 209  * Flip the whole bitset.
 210  * @param bs The bitset.
 211  */
 212 static INLINE void bitset_flip_all(bitset_t *bs)
 213 {
 214         bitset_pos_t i;
 215         for(i = 0; i < bs->units; i++)
 216                 _bitset_inside_flip_unit(&bs->data[i]);
 217         _bitset_mask_highest(bs);
 218 }
 219
 220 /**
 221  * Copy a bitset to another.
 222  * @param tgt The target bitset.
 223  * @param src The source bitset.
 224  * @return The target bitset.
 225  */
 226 static INLINE bitset_t *bitset_copy(bitset_t *tgt, const bitset_t *src)
 227 {
 228         bitset_pos_t tu = tgt->units;
 229         bitset_pos_t su = src->units;
 230         bitset_pos_t min_units = tu < su ? tu : su;
 231         memcpy(tgt->data, src->data, min_units * BS_UNIT_SIZE);
 232         if(tu > min_units)
 233                 memset(tgt->data + min_units, 0, BS_UNIT_SIZE * (tu - min_units));
 234         return _bitset_mask_highest(tgt);
 235 }
 236
 237 /**
 238  * Find the smallest bit set in the bitset.
 239  * @param bs The bitset.
 240  * @return The smallest bit set in the bitset.
 241  */
 242 static INLINE bitset_pos_t bitset_min(const bitset_t *bs)
 243 {
 244         bitset_pos_t i, ofs = 0;
 245
 246         for(i = 0; i < bs->units; ++i) {
 247                 bitset_unit_t *unit = &bs->data[i];
 248                 bitset_pos_t pos = _bitset_inside_ntz(unit);
 249                 if(pos > 0)
 250                         return ofs + pos;
 251                 ofs += BS_UNIT_SIZE_BITS;
 252         }
 253
 254         return 0;
 255 }
 256
 257 /**
 258  * Find the greatest bit set in the bitset.
 259  * @param bs The bitset.
 260  * @return The greatest bit set in the bitset.
 261  */
 262 static INLINE bitset_pos_t bitset_max(const bitset_t *bs)
 263 {
 264         bitset_pos_t i, max = 0, ofs = 0;
 265
 266         for(i = 0; i < bs->units; ++i) {
 267                 bitset_unit_t *unit = &bs->data[i];
 268                 bitset_pos_t pos = _bitset_inside_nlz(unit);
 269                 if(pos > 0)
 270                         max = ofs + pos;
 271                 ofs += BS_UNIT_SIZE_BITS;
 272         }
 273
 274         return max;
 275 }
 276
 277 /**
 278  * Find the next set bit from a given bit.
 279  * @note Note that if pos is set, pos is returned.
 280  * @param bs The bitset.
 281  * @param pos The bit from which to search for the next set bit.
 282  * @return The next set bit from pos on, or -1, if no set bit was found
 283  * after pos.
 284  */
 285 static INLINE bitset_pos_t _bitset_next(const bitset_t *bs,
 286                 bitset_pos_t pos, int set)
 287 {
 288         bitset_pos_t unit_number = pos / BS_UNIT_SIZE_BITS;
 289         bitset_pos_t res;
 290
 291         if(pos >= bs->size)
 292                 return -1;
 293
 294         {
 295                 bitset_pos_t bit_in_unit = pos & BS_UNIT_MASK;
 296                 bitset_pos_t in_unit_mask = (1 << bit_in_unit) - 1;
 297
 298                 /*
 299                  * Mask out the bits smaller than pos in the current unit.
 300                  * We are only interested in bits set higher than pos.
 301                  */
 302                 bitset_unit_t curr_unit = bs->data[unit_number];
 303
 304                 /*
 305                  * Find the next bit set in the unit.
 306                  * Mind that this function returns 0, if the unit is -1 and
 307                  * counts the bits from 1 on.
 308                  */
 309                 bitset_pos_t next_in_this_unit =
 310                         _bitset_inside_ntz_value((set ? curr_unit : ~curr_unit) & ~in_unit_mask);
 311
 312                 /* If there is a bit set in the current unit, exit. */
 313                 if (next_in_this_unit < BS_UNIT_SIZE_BITS) {
 314                         res = next_in_this_unit + unit_number * BS_UNIT_SIZE_BITS;
 315                         return res < bs->size ? res : -1;
 316                 }
 317
 318                 /* Else search for set bits in the next units. */
 319                 else {
 320                         bitset_pos_t i;
 321                         for(i = unit_number + 1; i < bs->units; ++i) {
 322                                 bitset_unit_t data = bs->data[i];
 323                                 bitset_pos_t first_set =
 324                                         _bitset_inside_ntz_value(set ? data : ~data);
 325
 326                                 if (first_set < BS_UNIT_SIZE_BITS) {
 327                                         res = first_set + i * BS_UNIT_SIZE_BITS;
 328                                         return res < bs->size ? res : -1;
 329                                 }
 330                         }
 331                 }
 332         }
 333
 334         return -1;
 335 }
 336
 337 #define bitset_next_clear(bs,pos) _bitset_next((bs), (pos), 0)
 338 #define bitset_next_set(bs,pos) _bitset_next((bs), (pos), 1)
 339
 340 /**
 341  * Convenience macro for bitset iteration.
 342  * @param bitset The bitset.
 343  * @param elm A unsigned long variable.
 344  */
 345 #define bitset_foreach(bitset,elm) \
 346         for(elm = bitset_next_set(bitset,0); elm != -1; elm = bitset_next_set(bitset,elm+1))
 347
 348
 349 #define bitset_foreach_clear(bitset,elm) \
 350         for(elm = bitset_next_clear(bitset,0); elm != -1; elm = bitset_next_clear(bitset,elm+1))
 351
 352 /**
 353  * Count the bits set.
 354  * This can also be seen as the cardinality of the set.
 355  * @param bs The bitset.
 356  * @return The number of bits set in the bitset.
 357  */
 358 static INLINE bitset_pos_t bitset_popcnt(const bitset_t *bs)
 359 {
 360         bitset_pos_t i, pop = 0;
 361         bitset_unit_t *unit;
 362
 363         for(i = 0, unit = bs->data; i < bs->units; ++i, ++unit)
 364                 pop += _bitset_inside_pop(unit);
 365
 366         return pop;
 367 }
 368
 369 /**
 370  * Clear the bitset.
 371  * This sets all bits to zero.
 372  * @param bs The bitset.
 373  */
 374 static INLINE bitset_t *bitset_clear_all(bitset_t *bs)
 375 {
 376         memset(bs->data, 0, BS_UNIT_SIZE * bs->units);
 377         return bs;
 378 }
 379
 380 /**
 381  * Set the bitset.
 382  * This sets all bits to one.
 383  * @param bs The bitset.
 384  */
 385 static INLINE bitset_t *bitset_set_all(bitset_t *bs)
 386 {
 387         memset(bs->data, -1, bs->units * BS_UNIT_SIZE);
 388         return _bitset_mask_highest(bs);
 389 }
 390
 391 /**
 392  * Check, if one bitset is contained by another.
 393  * That is, each bit set in lhs is also set in rhs.
 394  * @param lhs A bitset.
 395  * @param rhs Another bitset.
 396  * @return 1, if all bits in lhs are also set in rhs, 0 otherwise.
 397  */
 398 static INLINE int bitset_contains(const bitset_t *lhs, const bitset_t *rhs)
 399 {
 400         bitset_pos_t n = lhs->units < rhs->units ? lhs->units : rhs->units;
 401         bitset_pos_t i;
 402
 403         for(i = 0; i < n; ++i) {
 404                 bitset_unit_t lu = lhs->data[i];
 405                 bitset_unit_t ru = rhs->data[i];
 406
 407                 if((lu | ru) & ~ru)
 408                         return 0;
 409         }
 410
 411         /*
 412          * If the left hand sinde is a larger bitset than rhs,
 413          * we have to check, that all extra bits in lhs are 0
 414          */
 415         if(lhs->units > n) {
 416                 for(i = n; i < lhs->units; ++i) {
 417                         if(lhs->data[i] != 0)
 418                                 return 0;
 419                 }
 420         }
 421
 422         return 1;
 423 }
 424
 425 /**
 426  * Treat the bitset as a number and subtract 1.
 427  * @param bs The bitset.
 428  * @return The same bitset.
 429  */
 430 static INLINE void bitset_minus1(bitset_t *bs)
 431 {
 432 #define _SH (sizeof(bitset_unit_t) * 8 - 1)
 433
 434         bitset_pos_t i;
 435
 436         for(i = 0; i < bs->units; ++i) {
 437                 bitset_unit_t unit = bs->data[i];
 438                 bitset_unit_t um1  = unit - 1;
 439
 440                 bs->data[i] = um1;
 441
 442                 if(((unit >> _SH) ^ (um1 >> _SH)) == 0)
 443                         break;
 444         }
 445 #undef _SH
 446 }
 447
 448 /**
 449  * Print a bitset to a stream.
 450  * The bitset is printed as a comma separated list of bits set.
 451  * @param file The stream.
 452  * @param bs The bitset.
 453  */
 454 static INLINE void bitset_fprint(FILE *file, const bitset_t *bs)
 455 {
 456         const char *prefix = "";
 457         int i;
 458
 459         putc('{', file);
 460         for(i = bitset_next_set(bs, 0); i != -1; i = bitset_next_set(bs, i + 1)) {
 461                 fprintf(file, "%s%u", prefix, i);
 462                 prefix = ",";
 463         }
 464         putc('}', file);
 465 }
 466
 467 static INLINE void bitset_debug_fprint(FILE *file, const bitset_t *bs)
 468 {
 469         bitset_pos_t i;
 470
 471         fprintf(file, "%u:", bs->units);
 472         for(i = 0; i < bs->units; ++i)
 473                 fprintf(file, " " BITSET_UNIT_FMT, bs->data[i]);
 474 }
 475
 476 /*
 477  * Here, the binary operations follow.
 478  * And, Or, And Not, Xor are available.
 479  */
 480 #define BINARY_OP(op) \
 481 static INLINE bitset_t *bitset_ ## op(bitset_t *tgt, const bitset_t *src) \
 482 { \
 483         bitset_pos_t i; \
 484         bitset_pos_t n = tgt->units > src->units ? src->units : tgt->units; \
 485         for(i = 0; i < n; i += _BITSET_BINOP_UNITS_INC) \
 486                 _bitset_inside_binop_ ## op(&tgt->data[i], &src->data[i]); \
 487         if(n < tgt->units) \
 488                 _bitset_clear_rest(&tgt->data[i], tgt->units - i); \
 489         return _bitset_mask_highest(tgt); \
 490 }
 491
 492 /*
 493  * Define the clear rest macro for the and, since it is the only case,
 494  * were non existed (treated as 0) units in the src must be handled.
 495  * For all other operations holds: x Op 0 = x for Op in { Andnot, Or, Xor }
 496  *
 497  * For and, each bitset implementer has to provide the macro
 498  * _bitset_clear_units(data, n), which clears n units from the pointer
 499  * data on.
 500  */
 501 #define _bitset_clear_rest(data,n) _bitset_inside_clear_units(data, n)
 502 BINARY_OP(and)
 503 #undef _bitset_clear_rest
 504 #define _bitset_clear_rest(data,n)
 505
 506 BINARY_OP(andnot)
 507 BINARY_OP(or)
 508 BINARY_OP(xor)
 509
 510 #endif