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