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