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