include/llvm/ADT/SmallBitVector.h

   1 //===- llvm/ADT/SmallBitVector.h - 'Normally small' bit vectors -*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements the SmallBitVector class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_ADT_SMALLBITVECTOR_H
  15 #define LLVM_ADT_SMALLBITVECTOR_H
  16
  17 #include "llvm/ADT/BitVector.h"
  18 #include "llvm/Support/Compiler.h"
  19 #include "llvm/Support/MathExtras.h"
  20 #include <cassert>
  21
  22 namespace llvm {
  23
  24 /// SmallBitVector - This is a 'bitvector' (really, a variable-sized bit array),
  25 /// optimized for the case when the array is small.  It contains one
  26 /// pointer-sized field, which is directly used as a plain collection of bits
  27 /// when possible, or as a pointer to a larger heap-allocated array when
  28 /// necessary.  This allows normal "small" cases to be fast without losing
  29 /// generality for large inputs.
  30 ///
  31 class SmallBitVector {
  32   // TODO: In "large" mode, a pointer to a BitVector is used, leading to an
  33   // unnecessary level of indirection. It would be more efficient to use a
  34   // pointer to memory containing size, allocation size, and the array of bits.
  35   uintptr_t X;
  36
  37   enum {
  38     // The number of bits in this class.
  39     NumBaseBits = sizeof(uintptr_t) * CHAR_BIT,
  40
  41     // One bit is used to discriminate between small and large mode. The
  42     // remaining bits are used for the small-mode representation.
  43     SmallNumRawBits = NumBaseBits - 1,
  44
  45     // A few more bits are used to store the size of the bit set in small mode.
  46     // Theoretically this is a ceil-log2. These bits are encoded in the most
  47     // significant bits of the raw bits.
  48     SmallNumSizeBits = (NumBaseBits == 32 ? 5 :
  49                         NumBaseBits == 64 ? 6 :
  50                         SmallNumRawBits),
  51
  52     // The remaining bits are used to store the actual set in small mode.
  53     SmallNumDataBits = SmallNumRawBits - SmallNumSizeBits
  54   };
  55
  56   static_assert(NumBaseBits == 64 || NumBaseBits == 32,
  57                 "Unsupported word size");
  58
  59 public:
  60   typedef unsigned size_type;
  61   // Encapsulation of a single bit.
  62   class reference {
  63     SmallBitVector &TheVector;
  64     unsigned BitPos;
  65
  66   public:
  67     reference(SmallBitVector &b, unsigned Idx) : TheVector(b), BitPos(Idx) {}
  68
  69     reference& operator=(reference t) {
  70       *this = bool(t);
  71       return *this;
  72     }
  73
  74     reference& operator=(bool t) {
  75       if (t)
  76         TheVector.set(BitPos);
  77       else
  78         TheVector.reset(BitPos);
  79       return *this;
  80     }
  81
  82     operator bool() const {
  83       return const_cast<const SmallBitVector &>(TheVector).operator[](BitPos);
  84     }
  85   };
  86
  87 private:
  88   bool isSmall() const {
  89     return X & uintptr_t(1);
  90   }
  91
  92   BitVector *getPointer() const {
  93     assert(!isSmall());
  94     return reinterpret_cast<BitVector *>(X);
  95   }
  96
  97   void switchToSmall(uintptr_t NewSmallBits, size_t NewSize) {
  98     X = 1;
  99     setSmallSize(NewSize);
 100     setSmallBits(NewSmallBits);
 101   }
 102
 103   void switchToLarge(BitVector *BV) {
 104     X = reinterpret_cast<uintptr_t>(BV);
 105     assert(!isSmall() && "Tried to use an unaligned pointer");
 106   }
 107
 108   // Return all the bits used for the "small" representation; this includes
 109   // bits for the size as well as the element bits.
 110   uintptr_t getSmallRawBits() const {
 111     assert(isSmall());
 112     return X >> 1;
 113   }
 114
 115   void setSmallRawBits(uintptr_t NewRawBits) {
 116     assert(isSmall());
 117     X = (NewRawBits << 1) | uintptr_t(1);
 118   }
 119
 120   // Return the size.
 121   size_t getSmallSize() const {
 122     return getSmallRawBits() >> SmallNumDataBits;
 123   }
 124
 125   void setSmallSize(size_t Size) {
 126     setSmallRawBits(getSmallBits() | (Size << SmallNumDataBits));
 127   }
 128
 129   // Return the element bits.
 130   uintptr_t getSmallBits() const {
 131     return getSmallRawBits() & ~(~uintptr_t(0) << getSmallSize());
 132   }
 133
 134   void setSmallBits(uintptr_t NewBits) {
 135     setSmallRawBits((NewBits & ~(~uintptr_t(0) << getSmallSize())) |
 136                     (getSmallSize() << SmallNumDataBits));
 137   }
 138
 139 public:
 140   /// SmallBitVector default ctor - Creates an empty bitvector.
 141   SmallBitVector() : X(1) {}
 142
 143   /// SmallBitVector ctor - Creates a bitvector of specified number of bits. All
 144   /// bits are initialized to the specified value.
 145   explicit SmallBitVector(unsigned s, bool t = false) {
 146     if (s <= SmallNumDataBits)
 147       switchToSmall(t ? ~uintptr_t(0) : 0, s);
 148     else
 149       switchToLarge(new BitVector(s, t));
 150   }
 151
 152   /// SmallBitVector copy ctor.
 153   SmallBitVector(const SmallBitVector &RHS) {
 154     if (RHS.isSmall())
 155       X = RHS.X;
 156     else
 157       switchToLarge(new BitVector(*RHS.getPointer()));
 158   }
 159
 160   SmallBitVector(SmallBitVector &&RHS) : X(RHS.X) {
 161     RHS.X = 1;
 162   }
 163
 164   ~SmallBitVector() {
 165     if (!isSmall())
 166       delete getPointer();
 167   }
 168
 169   /// empty - Tests whether there are no bits in this bitvector.
 170   bool empty() const {
 171     return isSmall() ? getSmallSize() == 0 : getPointer()->empty();
 172   }
 173
 174   /// size - Returns the number of bits in this bitvector.
 175   size_t size() const {
 176     return isSmall() ? getSmallSize() : getPointer()->size();
 177   }
 178
 179   /// count - Returns the number of bits which are set.
 180   size_type count() const {
 181     if (isSmall()) {
 182       uintptr_t Bits = getSmallBits();
 183       if (NumBaseBits == 32)
 184         return CountPopulation_32(Bits);
 185       if (NumBaseBits == 64)
 186         return CountPopulation_64(Bits);
 187       llvm_unreachable("Unsupported!");
 188     }
 189     return getPointer()->count();
 190   }
 191
 192   /// any - Returns true if any bit is set.
 193   bool any() const {
 194     if (isSmall())
 195       return getSmallBits() != 0;
 196     return getPointer()->any();
 197   }
 198
 199   /// all - Returns true if all bits are set.
 200   bool all() const {
 201     if (isSmall())
 202       return getSmallBits() == (uintptr_t(1) << getSmallSize()) - 1;
 203     return getPointer()->all();
 204   }
 205
 206   /// none - Returns true if none of the bits are set.
 207   bool none() const {
 208     if (isSmall())
 209       return getSmallBits() == 0;
 210     return getPointer()->none();
 211   }
 212
 213   /// find_first - Returns the index of the first set bit, -1 if none
 214   /// of the bits are set.
 215   int find_first() const {
 216     if (isSmall()) {
 217       uintptr_t Bits = getSmallBits();
 218       if (Bits == 0)
 219         return -1;
 220       return countTrailingZeros(Bits);
 221     }
 222     return getPointer()->find_first();
 223   }
 224
 225   /// find_next - Returns the index of the next set bit following the
 226   /// "Prev" bit. Returns -1 if the next set bit is not found.
 227   int find_next(unsigned Prev) const {
 228     if (isSmall()) {
 229       uintptr_t Bits = getSmallBits();
 230       // Mask off previous bits.
 231       Bits &= ~uintptr_t(0) << (Prev + 1);
 232       if (Bits == 0 || Prev + 1 >= getSmallSize())
 233         return -1;
 234       return countTrailingZeros(Bits);
 235     }
 236     return getPointer()->find_next(Prev);
 237   }
 238
 239   /// clear - Clear all bits.
 240   void clear() {
 241     if (!isSmall())
 242       delete getPointer();
 243     switchToSmall(0, 0);
 244   }
 245
 246   /// resize - Grow or shrink the bitvector.
 247   void resize(unsigned N, bool t = false) {
 248     if (!isSmall()) {
 249       getPointer()->resize(N, t);
 250     } else if (SmallNumDataBits >= N) {
 251       uintptr_t NewBits = t ? ~uintptr_t(0) << getSmallSize() : 0;
 252       setSmallSize(N);
 253       setSmallBits(NewBits | getSmallBits());
 254     } else {
 255       BitVector *BV = new BitVector(N, t);
 256       uintptr_t OldBits = getSmallBits();
 257       for (size_t i = 0, e = getSmallSize(); i != e; ++i)
 258         (*BV)[i] = (OldBits >> i) & 1;
 259       switchToLarge(BV);
 260     }
 261   }
 262
 263   void reserve(unsigned N) {
 264     if (isSmall()) {
 265       if (N > SmallNumDataBits) {
 266         uintptr_t OldBits = getSmallRawBits();
 267         size_t SmallSize = getSmallSize();
 268         BitVector *BV = new BitVector(SmallSize);
 269         for (size_t i = 0; i < SmallSize; ++i)
 270           if ((OldBits >> i) & 1)
 271             BV->set(i);
 272         BV->reserve(N);
 273         switchToLarge(BV);
 274       }
 275     } else {
 276       getPointer()->reserve(N);
 277     }
 278   }
 279
 280   // Set, reset, flip
 281   SmallBitVector &set() {
 282     if (isSmall())
 283       setSmallBits(~uintptr_t(0));
 284     else
 285       getPointer()->set();
 286     return *this;
 287   }
 288
 289   SmallBitVector &set(unsigned Idx) {
 290     if (isSmall()) {
 291       assert(Idx <= static_cast<unsigned>(
 292                         std::numeric_limits<uintptr_t>::digits) &&
 293              "undefined behavior");
 294       setSmallBits(getSmallBits() | (uintptr_t(1) << Idx));
 295     }
 296     else
 297       getPointer()->set(Idx);
 298     return *this;
 299   }
 300
 301   /// set - Efficiently set a range of bits in [I, E)
 302   SmallBitVector &set(unsigned I, unsigned E) {
 303     assert(I <= E && "Attempted to set backwards range!");
 304     assert(E <= size() && "Attempted to set out-of-bounds range!");
 305     if (I == E) return *this;
 306     if (isSmall()) {
 307       uintptr_t EMask = ((uintptr_t)1) << E;
 308       uintptr_t IMask = ((uintptr_t)1) << I;
 309       uintptr_t Mask = EMask - IMask;
 310       setSmallBits(getSmallBits() | Mask);
 311     } else
 312       getPointer()->set(I, E);
 313     return *this;
 314   }
 315
 316   SmallBitVector &reset() {
 317     if (isSmall())
 318       setSmallBits(0);
 319     else
 320       getPointer()->reset();
 321     return *this;
 322   }
 323
 324   SmallBitVector &reset(unsigned Idx) {
 325     if (isSmall())
 326       setSmallBits(getSmallBits() & ~(uintptr_t(1) << Idx));
 327     else
 328       getPointer()->reset(Idx);
 329     return *this;
 330   }
 331
 332   /// reset - Efficiently reset a range of bits in [I, E)
 333   SmallBitVector &reset(unsigned I, unsigned E) {
 334     assert(I <= E && "Attempted to reset backwards range!");
 335     assert(E <= size() && "Attempted to reset out-of-bounds range!");
 336     if (I == E) return *this;
 337     if (isSmall()) {
 338       uintptr_t EMask = ((uintptr_t)1) << E;
 339       uintptr_t IMask = ((uintptr_t)1) << I;
 340       uintptr_t Mask = EMask - IMask;
 341       setSmallBits(getSmallBits() & ~Mask);
 342     } else
 343       getPointer()->reset(I, E);
 344     return *this;
 345   }
 346
 347   SmallBitVector &flip() {
 348     if (isSmall())
 349       setSmallBits(~getSmallBits());
 350     else
 351       getPointer()->flip();
 352     return *this;
 353   }
 354
 355   SmallBitVector &flip(unsigned Idx) {
 356     if (isSmall())
 357       setSmallBits(getSmallBits() ^ (uintptr_t(1) << Idx));
 358     else
 359       getPointer()->flip(Idx);
 360     return *this;
 361   }
 362
 363   // No argument flip.
 364   SmallBitVector operator~() const {
 365     return SmallBitVector(*this).flip();
 366   }
 367
 368   // Indexing.
 369   reference operator[](unsigned Idx) {
 370     assert(Idx < size() && "Out-of-bounds Bit access.");
 371     return reference(*this, Idx);
 372   }
 373
 374   bool operator[](unsigned Idx) const {
 375     assert(Idx < size() && "Out-of-bounds Bit access.");
 376     if (isSmall())
 377       return ((getSmallBits() >> Idx) & 1) != 0;
 378     return getPointer()->operator[](Idx);
 379   }
 380
 381   bool test(unsigned Idx) const {
 382     return (*this)[Idx];
 383   }
 384
 385   /// Test if any common bits are set.
 386   bool anyCommon(const SmallBitVector &RHS) const {
 387     if (isSmall() && RHS.isSmall())
 388       return (getSmallBits() & RHS.getSmallBits()) != 0;
 389     if (!isSmall() && !RHS.isSmall())
 390       return getPointer()->anyCommon(*RHS.getPointer());
 391
 392     for (unsigned i = 0, e = std::min(size(), RHS.size()); i != e; ++i)
 393       if (test(i) && RHS.test(i))
 394         return true;
 395     return false;
 396   }
 397
 398   // Comparison operators.
 399   bool operator==(const SmallBitVector &RHS) const {
 400     if (size() != RHS.size())
 401       return false;
 402     if (isSmall())
 403       return getSmallBits() == RHS.getSmallBits();
 404     else
 405       return *getPointer() == *RHS.getPointer();
 406   }
 407
 408   bool operator!=(const SmallBitVector &RHS) const {
 409     return !(*this == RHS);
 410   }
 411
 412   // Intersection, union, disjoint union.
 413   SmallBitVector &operator&=(const SmallBitVector &RHS) {
 414     resize(std::max(size(), RHS.size()));
 415     if (isSmall())
 416       setSmallBits(getSmallBits() & RHS.getSmallBits());
 417     else if (!RHS.isSmall())
 418       getPointer()->operator&=(*RHS.getPointer());
 419     else {
 420       SmallBitVector Copy = RHS;
 421       Copy.resize(size());
 422       getPointer()->operator&=(*Copy.getPointer());
 423     }
 424     return *this;
 425   }
 426
 427   /// reset - Reset bits that are set in RHS. Same as *this &= ~RHS.
 428   SmallBitVector &reset(const SmallBitVector &RHS) {
 429     if (isSmall() && RHS.isSmall())
 430       setSmallBits(getSmallBits() & ~RHS.getSmallBits());
 431     else if (!isSmall() && !RHS.isSmall())
 432       getPointer()->reset(*RHS.getPointer());
 433     else
 434       for (unsigned i = 0, e = std::min(size(), RHS.size()); i != e; ++i)
 435         if (RHS.test(i))
 436           reset(i);
 437
 438     return *this;
 439   }
 440
 441   /// test - Check if (This - RHS) is zero.
 442   /// This is the same as reset(RHS) and any().
 443   bool test(const SmallBitVector &RHS) const {
 444     if (isSmall() && RHS.isSmall())
 445       return (getSmallBits() & ~RHS.getSmallBits()) != 0;
 446     if (!isSmall() && !RHS.isSmall())
 447       return getPointer()->test(*RHS.getPointer());
 448
 449     unsigned i, e;
 450     for (i = 0, e = std::min(size(), RHS.size()); i != e; ++i)
 451       if (test(i) && !RHS.test(i))
 452         return true;
 453
 454     for (e = size(); i != e; ++i)
 455       if (test(i))
 456         return true;
 457
 458     return false;
 459   }
 460
 461   SmallBitVector &operator|=(const SmallBitVector &RHS) {
 462     resize(std::max(size(), RHS.size()));
 463     if (isSmall())
 464       setSmallBits(getSmallBits() | RHS.getSmallBits());
 465     else if (!RHS.isSmall())
 466       getPointer()->operator|=(*RHS.getPointer());
 467     else {
 468       SmallBitVector Copy = RHS;
 469       Copy.resize(size());
 470       getPointer()->operator|=(*Copy.getPointer());
 471     }
 472     return *this;
 473   }
 474
 475   SmallBitVector &operator^=(const SmallBitVector &RHS) {
 476     resize(std::max(size(), RHS.size()));
 477     if (isSmall())
 478       setSmallBits(getSmallBits() ^ RHS.getSmallBits());
 479     else if (!RHS.isSmall())
 480       getPointer()->operator^=(*RHS.getPointer());
 481     else {
 482       SmallBitVector Copy = RHS;
 483       Copy.resize(size());
 484       getPointer()->operator^=(*Copy.getPointer());
 485     }
 486     return *this;
 487   }
 488
 489   // Assignment operator.
 490   const SmallBitVector &operator=(const SmallBitVector &RHS) {
 491     if (isSmall()) {
 492       if (RHS.isSmall())
 493         X = RHS.X;
 494       else
 495         switchToLarge(new BitVector(*RHS.getPointer()));
 496     } else {
 497       if (!RHS.isSmall())
 498         *getPointer() = *RHS.getPointer();
 499       else {
 500         delete getPointer();
 501         X = RHS.X;
 502       }
 503     }
 504     return *this;
 505   }
 506
 507   const SmallBitVector &operator=(SmallBitVector &&RHS) {
 508     if (this != &RHS) {
 509       clear();
 510       swap(RHS);
 511     }
 512     return *this;
 513   }
 514
 515   void swap(SmallBitVector &RHS) {
 516     std::swap(X, RHS.X);
 517   }
 518
 519   /// setBitsInMask - Add '1' bits from Mask to this vector. Don't resize.
 520   /// This computes "*this |= Mask".
 521   void setBitsInMask(const uint32_t *Mask, unsigned MaskWords = ~0u) {
 522     if (isSmall())
 523       applyMask<true, false>(Mask, MaskWords);
 524     else
 525       getPointer()->setBitsInMask(Mask, MaskWords);
 526   }
 527
 528   /// clearBitsInMask - Clear any bits in this vector that are set in Mask.
 529   /// Don't resize. This computes "*this &= ~Mask".
 530   void clearBitsInMask(const uint32_t *Mask, unsigned MaskWords = ~0u) {
 531     if (isSmall())
 532       applyMask<false, false>(Mask, MaskWords);
 533     else
 534       getPointer()->clearBitsInMask(Mask, MaskWords);
 535   }
 536
 537   /// setBitsNotInMask - Add a bit to this vector for every '0' bit in Mask.
 538   /// Don't resize.  This computes "*this |= ~Mask".
 539   void setBitsNotInMask(const uint32_t *Mask, unsigned MaskWords = ~0u) {
 540     if (isSmall())
 541       applyMask<true, true>(Mask, MaskWords);
 542     else
 543       getPointer()->setBitsNotInMask(Mask, MaskWords);
 544   }
 545
 546   /// clearBitsNotInMask - Clear a bit in this vector for every '0' bit in Mask.
 547   /// Don't resize.  This computes "*this &= Mask".
 548   void clearBitsNotInMask(const uint32_t *Mask, unsigned MaskWords = ~0u) {
 549     if (isSmall())
 550       applyMask<false, true>(Mask, MaskWords);
 551     else
 552       getPointer()->clearBitsNotInMask(Mask, MaskWords);
 553   }
 554
 555 private:
 556   template<bool AddBits, bool InvertMask>
 557   void applyMask(const uint32_t *Mask, unsigned MaskWords) {
 558     if (NumBaseBits == 64 && MaskWords >= 2) {
 559       uint64_t M = Mask[0] | (uint64_t(Mask[1]) << 32);
 560       if (InvertMask) M = ~M;
 561       if (AddBits) setSmallBits(getSmallBits() | M);
 562       else         setSmallBits(getSmallBits() & ~M);
 563     } else {
 564       uint32_t M = Mask[0];
 565       if (InvertMask) M = ~M;
 566       if (AddBits) setSmallBits(getSmallBits() | M);
 567       else         setSmallBits(getSmallBits() & ~M);
 568     }
 569   }
 570 };
 571
 572 inline SmallBitVector
 573 operator&(const SmallBitVector &LHS, const SmallBitVector &RHS) {
 574   SmallBitVector Result(LHS);
 575   Result &= RHS;
 576   return Result;
 577 }
 578
 579 inline SmallBitVector
 580 operator|(const SmallBitVector &LHS, const SmallBitVector &RHS) {
 581   SmallBitVector Result(LHS);
 582   Result |= RHS;
 583   return Result;
 584 }
 585
 586 inline SmallBitVector
 587 operator^(const SmallBitVector &LHS, const SmallBitVector &RHS) {
 588   SmallBitVector Result(LHS);
 589   Result ^= RHS;
 590   return Result;
 591 }
 592
 593 } // End llvm namespace
 594
 595 namespace std {
 596   /// Implement std::swap in terms of BitVector swap.
 597   inline void
 598   swap(llvm::SmallBitVector &LHS, llvm::SmallBitVector &RHS) {
 599     LHS.swap(RHS);
 600   }
 601 }
 602
 603 #endif