nsz Git - libfirm/blob - include/libfirm/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  * @brief   A bitset implementation.
  23  * @author  Sebastian Hack
  24  * @date    15.10.2004
  25  * @version $Id$
  26  */
  27 #ifndef FIRM_ADT_BITSET_H
  28 #define FIRM_ADT_BITSET_H
  29
  30 #include "firm_config.h"
  31
  32 #include <stdlib.h>
  33 #include <stdio.h>
  34 #include <assert.h>
  35 #include <string.h>
  36
  37 #include "xmalloc.h"
  38 #include "bitfiddle.h"
  39
  40 typedef unsigned int bitset_pos_t;
  41
  42 #include "bitset_std.h"
  43
  44 #if defined(__GNUC__) && defined(__i386__)
  45 #include "bitset_ia32.h"
  46 #endif
  47
  48 typedef struct _bitset_t {
  49         bitset_pos_t units;
  50         bitset_pos_t size;
  51 } bitset_t;
  52
  53 #define BS_UNIT_SIZE         sizeof(bitset_unit_t)
  54 #define BS_UNIT_SIZE_BITS    (BS_UNIT_SIZE * 8)
  55 #define BS_UNIT_MASK         (BS_UNIT_SIZE_BITS - 1)
  56
  57 #define BS_DATA(bs)          ((bitset_unit_t *) ((char *) (bs) + sizeof(bitset_t)))
  58 #define BS_UNITS(bits)       (round_up2(bits, BS_UNIT_SIZE_BITS) / BS_UNIT_SIZE_BITS)
  59 #define BS_TOTAL_SIZE(bits)  (sizeof(bitset_t) + BS_UNITS(bits) * BS_UNIT_SIZE)
  60
  61 /**
  62  * Initialize a bitset.
  63  * This functions should not be called.
  64  *
  65  * Note that this function needs three macros which must be provided by the
  66  * bitfield implementor:
  67  * - _bitset_overall_size(size) The overall size that must be
  68  *   allocated for the bitfield in bytes.
  69  * - _bitset_units(size) The number of units that will be
  70  *   present in the bitfield for a given highest bit.
  71  * - _bitset_data_ptr(data, size) This produces as pointer to the
  72  *   first unit in the allocated memory area. The main reason for this
  73  *   macro is, that some bitset implementors want control over memory
  74  *   alignment.
  75  *
  76  * @param area A pointer to memory reserved for the bitset.
  77  * @param size The size of the bitset in bits.
  78  * @return A pointer to the initialized bitset.
  79  */
  80 static INLINE bitset_t *_bitset_prepare(void *area, bitset_pos_t size)
  81 {
  82         bitset_t *ptr = area;
  83         memset(area, 0, BS_TOTAL_SIZE(size));
  84         ptr->units = BS_UNITS(size);
  85         ptr->size  = size;
  86         return ptr;
  87 }
  88
  89 /**
  90  * Mask out all bits, which are only there, because the number
  91  * of bits in the set didn't match a unit size boundary.
  92  * @param bs The bitset.
  93  * @return The masked bitset.
  94  */
  95 static INLINE bitset_t *_bitset_mask_highest(bitset_t *bs)
  96 {
  97         bitset_pos_t rest = bs->size & BS_UNIT_MASK;
  98         if (rest)
  99                 BS_DATA(bs)[bs->units - 1] &= (1 << rest) - 1;
 100         return bs;
 101 }
 102
 103 /**
 104  * Get the capacity of the bitset in bits.
 105  * @param bs The bitset.
 106  * @return The capacity in bits of the bitset.
 107  */
 108 #define bitset_capacity(bs) ((bs)->units * BS_UNIT_SIZE_BITS)
 109
 110 /**
 111  * Get the size of the bitset in bits.
 112  * @note Note the difference between capacity and size.
 113  * @param bs The bitset.
 114  * @return The highest bit which can be set or cleared plus 1.
 115  */
 116 #define bitset_size(bs)  ((bs)->size)
 117
 118 /**
 119  * Allocate a bitset on an obstack.
 120  * @param obst The obstack.
 121  * @param size The greatest bit that shall be stored in the set.
 122  * @return A pointer to an empty initialized bitset.
 123  */
 124 #define bitset_obstack_alloc(obst,size) \
 125         _bitset_prepare(obstack_alloc(obst, BS_TOTAL_SIZE(size)), size)
 126
 127 /**
 128  * Allocate a bitset via malloc.
 129  * @param size The greatest bit that shall be stored in the set.
 130  * @return A pointer to an empty initialized bitset.
 131  */
 132 #define bitset_malloc(size) \
 133         _bitset_prepare(xmalloc(BS_TOTAL_SIZE(size)), size)
 134
 135 /**
 136  * Free a bitset allocated with bitset_malloc().
 137  * @param bs The bitset.
 138  */
 139 #define bitset_free(bs) free(bs)
 140
 141 /**
 142  * Allocate a bitset on the stack via alloca.
 143  * @param size The greatest bit that shall be stored in the set.
 144  * @return A pointer to an empty initialized bitset.
 145  */
 146 #define bitset_alloca(size) \
 147         _bitset_prepare(alloca(BS_TOTAL_SIZE(size)), size)
 148
 149
 150 /**
 151  * Get the unit which contains a specific bit.
 152  * This function is internal.
 153  * @param bs The bitset.
 154  * @param bit The bit.
 155  * @return A pointer to the unit containing the bit.
 156  */
 157 static INLINE bitset_unit_t *_bitset_get_unit(const bitset_t *bs, bitset_pos_t bit)
 158 {
 159         assert(bit <= bs->size && "Bit to large");
 160         return BS_DATA(bs) + 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(bs)[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(BS_DATA(tgt), BS_DATA(src), min_units * BS_UNIT_SIZE);
 232         if(tu > min_units)
 233                 memset(BS_DATA(tgt) + 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(bs)[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(bs)[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(bs)[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(bs)[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 unsigned bitset_popcnt(const bitset_t *bs)
 359 {
 360         bitset_pos_t  i;
 361         bitset_unit_t *unit;
 362         unsigned      pop = 0;
 363
 364         for (i = 0, unit = BS_DATA(bs); i < bs->units; ++i, ++unit)
 365                 pop += _bitset_inside_pop(unit);
 366
 367         return pop;
 368 }
 369
 370 /**
 371  * Clear the bitset.
 372  * This sets all bits to zero.
 373  * @param bs The bitset.
 374  */
 375 static INLINE bitset_t *bitset_clear_all(bitset_t *bs)
 376 {
 377         memset(BS_DATA(bs), 0, BS_UNIT_SIZE * bs->units);
 378         return bs;
 379 }
 380
 381 /**
 382  * Set the bitset.
 383  * This sets all bits to one.
 384  * @param bs The bitset.
 385  */
 386 static INLINE bitset_t *bitset_set_all(bitset_t *bs)
 387 {
 388         memset(BS_DATA(bs), -1, bs->units * BS_UNIT_SIZE);
 389         return _bitset_mask_highest(bs);
 390 }
 391
 392 /**
 393  * Check, if one bitset is contained by another.
 394  * That is, each bit set in lhs is also set in rhs.
 395  * @param lhs A bitset.
 396  * @param rhs Another bitset.
 397  * @return 1, if all bits in lhs are also set in rhs, 0 otherwise.
 398  */
 399 static INLINE int bitset_contains(const bitset_t *lhs, const bitset_t *rhs)
 400 {
 401         bitset_pos_t n = lhs->units < rhs->units ? lhs->units : rhs->units;
 402         bitset_pos_t i;
 403
 404         for(i = 0; i < n; ++i) {
 405                 bitset_unit_t lu = BS_DATA(lhs)[i];
 406                 bitset_unit_t ru = BS_DATA(rhs)[i];
 407
 408                 if((lu | ru) & ~ru)
 409                         return 0;
 410         }
 411
 412         /*
 413          * If the left hand sinde is a larger bitset than rhs,
 414          * we have to check, that all extra bits in lhs are 0
 415          */
 416         if(lhs->units > n) {
 417                 for(i = n; i < lhs->units; ++i) {
 418                         if(BS_DATA(lhs)[i] != 0)
 419                                 return 0;
 420                 }
 421         }
 422
 423         return 1;
 424 }
 425
 426 /**
 427  * Treat the bitset as a number and subtract 1.
 428  * @param bs The bitset.
 429  * @return The same bitset.
 430  */
 431 static INLINE void bitset_minus1(bitset_t *bs)
 432 {
 433 #define _SH (sizeof(bitset_unit_t) * 8 - 1)
 434
 435         bitset_pos_t i;
 436
 437         for(i = 0; i < bs->units; ++i) {
 438                 bitset_unit_t unit = BS_DATA(bs)[i];
 439                 bitset_unit_t um1  = unit - 1;
 440
 441                 BS_DATA(bs)[i] = um1;
 442
 443                 if(((unit >> _SH) ^ (um1 >> _SH)) == 0)
 444                         break;
 445         }
 446 #undef _SH
 447 }
 448
 449 /**
 450  * Check if two bitsets intersect.
 451  * @param a The first bitset.
 452  * @param b The second bitset.
 453  * @return 1 if they have a bit in common, 0 if not.
 454  */
 455 static INLINE int bitset_intersect(const bitset_t *a, const bitset_t *b)
 456 {
 457         bitset_pos_t n = a->units < b->units ? a->units : b->units;
 458         bitset_pos_t i;
 459
 460         for (i = 0; i < n; ++i)
 461                 if (BS_DATA(a)[i] & BS_DATA(b)[i])
 462                         return 1;
 463
 464         return 0;
 465 }
 466
 467 /**
 468  * Check, if a bitset is empty.
 469  * @param a The bitset.
 470  * @return 1, if the bitset is empty, 0 if not.
 471  */
 472 static INLINE int bitset_is_empty(const bitset_t *a)
 473 {
 474         bitset_pos_t i;
 475         for (i = 0; i < a->units; ++i)
 476                 if (BS_DATA(a)[i] != 0)
 477                         return 0;
 478         return 1;
 479 }
 480
 481 /**
 482  * Print a bitset to a stream.
 483  * The bitset is printed as a comma separated list of bits set.
 484  * @param file The stream.
 485  * @param bs The bitset.
 486  */
 487 static INLINE void bitset_fprint(FILE *file, const bitset_t *bs)
 488 {
 489         const char *prefix = "";
 490         int i;
 491
 492         putc('{', file);
 493         for(i = bitset_next_set(bs, 0); i != -1; i = bitset_next_set(bs, i + 1)) {
 494                 fprintf(file, "%s%u", prefix, i);
 495                 prefix = ",";
 496         }
 497         putc('}', file);
 498 }
 499
 500 static INLINE void bitset_debug_fprint(FILE *file, const bitset_t *bs)
 501 {
 502         bitset_pos_t i;
 503
 504         fprintf(file, "%u:", bs->units);
 505         for(i = 0; i < bs->units; ++i)
 506                 fprintf(file, " " BITSET_UNIT_FMT, BS_DATA(bs)[i]);
 507 }
 508
 509 /**
 510  * Perform tgt = tgt \ src operation.
 511  * @param tgt  The target bitset.
 512  * @param src  The source bitset.
 513  * @return the tgt set.
 514  */
 515 static INLINE bitset_t *bitset_andnot(bitset_t *tgt, const bitset_t *src);
 516
 517 /**
 518  * Perform Union, tgt = tgt u src operation.
 519  * @param tgt  The target bitset.
 520  * @param src  The source bitset.
 521  * @return the tgt set.
 522  */
 523 static INLINE bitset_t *bitset_or(bitset_t *tgt, const bitset_t *src);
 524
 525 /**
 526  * Perform tgt = tgt ^ ~src operation.
 527  * @param tgt  The target bitset.
 528  * @param src  The source bitset.
 529  * @return the tgt set.
 530  */
 531 static INLINE bitset_t *bitset_xor(bitset_t *tgt, const bitset_t *src);
 532
 533 /*
 534  * Here, the binary operations follow.
 535  * And, Or, And Not, Xor are available.
 536  */
 537 #define BINARY_OP(op) \
 538 static INLINE bitset_t *bitset_ ## op(bitset_t *tgt, const bitset_t *src) \
 539 { \
 540         bitset_pos_t i; \
 541         bitset_pos_t n = tgt->units > src->units ? src->units : tgt->units; \
 542         for(i = 0; i < n; i += _BITSET_BINOP_UNITS_INC) \
 543                 _bitset_inside_binop_ ## op(&BS_DATA(tgt)[i], &BS_DATA(src)[i]); \
 544         if(n < tgt->units) \
 545                 _bitset_clear_rest(&BS_DATA(tgt)[i], tgt->units - i); \
 546         return _bitset_mask_highest(tgt); \
 547 }
 548
 549 /*
 550  * Define the clear rest macro for the and, since it is the only case,
 551  * were non existed (treated as 0) units in the src must be handled.
 552  * For all other operations holds: x Op 0 = x for Op in { Andnot, Or, Xor }
 553  *
 554  * For and, each bitset implementer has to provide the macro
 555  * _bitset_clear_units(data, n), which clears n units from the pointer
 556  * data on.
 557  */
 558 #define _bitset_clear_rest(data,n) _bitset_inside_clear_units(data, n)
 559 BINARY_OP(and)
 560 #undef _bitset_clear_rest
 561 #define _bitset_clear_rest(data,n)
 562
 563 BINARY_OP(andnot)
 564 BINARY_OP(or)
 565 BINARY_OP(xor)
 566
 567 #endif