[llvm] [ADT] BitVector: give `subsetOf(RHS)` name to `!test(RHS)` (NFC) (PR #170875)
Anatoly Trosinenko via llvm-commits
llvm-commits at lists.llvm.org
Mon Dec 8 08:03:32 PST 2025
https://github.com/atrosinenko updated https://github.com/llvm/llvm-project/pull/170875
>From c8af3b78350d79f3148876efb4c8a6063fac4015 Mon Sep 17 00:00:00 2001
From: Anatoly Trosinenko <atrosinenko at accesssoftek.com>
Date: Fri, 5 Dec 2025 13:36:07 +0300
Subject: [PATCH 1/4] [ADT] BitVector: give `subsetOf(RHS)` name to
`!test(RHS)` (NFC)
Define `LHS.subsetOf(RHS)` as a more descriptive name for `!LHS.test(RHS)`
and update the existing callers to use that name.
---
bolt/lib/Passes/PAuthGadgetScanner.cpp | 2 +-
llvm/include/llvm/ADT/BitVector.h | 5 ++++-
llvm/include/llvm/ADT/SmallBitVector.h | 6 +++++-
llvm/lib/Analysis/StackLifetime.cpp | 4 ++--
llvm/lib/CodeGen/AsmPrinter/DwarfExpression.cpp | 2 +-
llvm/lib/CodeGen/StackColoring.cpp | 4 ++--
llvm/lib/Target/Hexagon/HexagonBitSimplify.cpp | 3 +--
llvm/lib/Target/Hexagon/HexagonGenInsert.cpp | 3 +--
8 files changed, 17 insertions(+), 12 deletions(-)
diff --git a/bolt/lib/Passes/PAuthGadgetScanner.cpp b/bolt/lib/Passes/PAuthGadgetScanner.cpp
index 01b350b2f11fe..d38a7fadb0767 100644
--- a/bolt/lib/Passes/PAuthGadgetScanner.cpp
+++ b/bolt/lib/Passes/PAuthGadgetScanner.cpp
@@ -547,7 +547,7 @@ class SrcSafetyAnalysis {
// Being trusted is a strictly stronger property than being
// safe-to-dereference.
- assert(!Next.TrustedRegs.test(Next.SafeToDerefRegs) &&
+ assert(Next.TrustedRegs.subsetOf(Next.SafeToDerefRegs) &&
"SafeToDerefRegs should contain all TrustedRegs");
return Next;
diff --git a/llvm/include/llvm/ADT/BitVector.h b/llvm/include/llvm/ADT/BitVector.h
index cc3f3a9226395..f4645c18a93f0 100644
--- a/llvm/include/llvm/ADT/BitVector.h
+++ b/llvm/include/llvm/ADT/BitVector.h
@@ -550,7 +550,7 @@ class BitVector {
return *this;
}
- /// test - Check if (This - RHS) is zero.
+ /// test - Check if (This - RHS) is non-zero.
/// This is the same as reset(RHS) and any().
bool test(const BitVector &RHS) const {
unsigned ThisWords = Bits.size();
@@ -567,6 +567,9 @@ class BitVector {
return false;
}
+ /// subsetOf - Check if This is a subset of RHS.
+ bool subsetOf(const BitVector &RHS) const { return !test(RHS); }
+
template <class F, class... ArgTys>
static BitVector &apply(F &&f, BitVector &Out, BitVector const &Arg,
ArgTys const &...Args) {
diff --git a/llvm/include/llvm/ADT/SmallBitVector.h b/llvm/include/llvm/ADT/SmallBitVector.h
index 5b2a5221b791f..978dc3f073031 100644
--- a/llvm/include/llvm/ADT/SmallBitVector.h
+++ b/llvm/include/llvm/ADT/SmallBitVector.h
@@ -552,7 +552,8 @@ class SmallBitVector {
return *this;
}
- /// Check if (This - RHS) is zero. This is the same as reset(RHS) and any().
+ /// Check if (This - RHS) is non-zero.
+ /// This is the same as reset(RHS) and any().
bool test(const SmallBitVector &RHS) const {
if (isSmall() && RHS.isSmall())
return (getSmallBits() & ~RHS.getSmallBits()) != 0;
@@ -571,6 +572,9 @@ class SmallBitVector {
return false;
}
+ /// Check if This is a subset of RHS.
+ bool subsetOf(const SmallBitVector &RHS) const { return !test(RHS); }
+
SmallBitVector &operator|=(const SmallBitVector &RHS) {
resize(std::max(size(), RHS.size()));
if (isSmall() && RHS.isSmall())
diff --git a/llvm/lib/Analysis/StackLifetime.cpp b/llvm/lib/Analysis/StackLifetime.cpp
index 1e20fca965ace..30e0316b882cc 100644
--- a/llvm/lib/Analysis/StackLifetime.cpp
+++ b/llvm/lib/Analysis/StackLifetime.cpp
@@ -173,7 +173,7 @@ void StackLifetime::calculateLocalLiveness() {
BitsIn.resize(NumAllocas, true);
// Update block LiveIn set, noting whether it has changed.
- if (BitsIn.test(BlockInfo.LiveIn)) {
+ if (!BitsIn.subsetOf(BlockInfo.LiveIn)) {
BlockInfo.LiveIn |= BitsIn;
}
@@ -198,7 +198,7 @@ void StackLifetime::calculateLocalLiveness() {
}
// Update block LiveOut set, noting whether it has changed.
- if (BitsIn.test(BlockInfo.LiveOut)) {
+ if (!BitsIn.subsetOf(BlockInfo.LiveOut)) {
Changed = true;
BlockInfo.LiveOut |= BitsIn;
}
diff --git a/llvm/lib/CodeGen/AsmPrinter/DwarfExpression.cpp b/llvm/lib/CodeGen/AsmPrinter/DwarfExpression.cpp
index c7d45897c403b..d6b06b83207c7 100644
--- a/llvm/lib/CodeGen/AsmPrinter/DwarfExpression.cpp
+++ b/llvm/lib/CodeGen/AsmPrinter/DwarfExpression.cpp
@@ -164,7 +164,7 @@ bool DwarfExpression::addMachineReg(const TargetRegisterInfo &TRI,
// If this sub-register has a DWARF number and we haven't covered
// its range, and its range covers the value, emit a DWARF piece for it.
- if (Offset < MaxSize && CurSubReg.test(Coverage)) {
+ if (Offset < MaxSize && !CurSubReg.subsetOf(Coverage)) {
// Emit a piece for any gap in the coverage.
if (Offset > CurPos)
DwarfRegs.push_back(Register::createSubRegister(
diff --git a/llvm/lib/CodeGen/StackColoring.cpp b/llvm/lib/CodeGen/StackColoring.cpp
index f7862641d94b9..4ec8b8b3646c1 100644
--- a/llvm/lib/CodeGen/StackColoring.cpp
+++ b/llvm/lib/CodeGen/StackColoring.cpp
@@ -815,13 +815,13 @@ void StackColoring::calculateLocalLiveness() {
LocalLiveOut |= BlockInfo.Begin;
// Update block LiveIn set, noting whether it has changed.
- if (LocalLiveIn.test(BlockInfo.LiveIn)) {
+ if (!LocalLiveIn.subsetOf(BlockInfo.LiveIn)) {
changed = true;
BlockInfo.LiveIn |= LocalLiveIn;
}
// Update block LiveOut set, noting whether it has changed.
- if (LocalLiveOut.test(BlockInfo.LiveOut)) {
+ if (!LocalLiveOut.subsetOf(BlockInfo.LiveOut)) {
changed = true;
BlockInfo.LiveOut |= LocalLiveOut;
}
diff --git a/llvm/lib/Target/Hexagon/HexagonBitSimplify.cpp b/llvm/lib/Target/Hexagon/HexagonBitSimplify.cpp
index 557a0a3f27819..848337457c997 100644
--- a/llvm/lib/Target/Hexagon/HexagonBitSimplify.cpp
+++ b/llvm/lib/Target/Hexagon/HexagonBitSimplify.cpp
@@ -137,8 +137,7 @@ namespace {
return !Bits.any();
}
bool includes(const RegisterSet &Rs) const {
- // A.test(B) <=> A-B != {}
- return !Rs.Bits.test(Bits);
+ return Rs.Bits.subsetOf(Bits);
}
bool intersects(const RegisterSet &Rs) const {
return Bits.anyCommon(Rs.Bits);
diff --git a/llvm/lib/Target/Hexagon/HexagonGenInsert.cpp b/llvm/lib/Target/Hexagon/HexagonGenInsert.cpp
index ff876f6595350..18fcd6a4873fb 100644
--- a/llvm/lib/Target/Hexagon/HexagonGenInsert.cpp
+++ b/llvm/lib/Target/Hexagon/HexagonGenInsert.cpp
@@ -153,8 +153,7 @@ namespace {
return !BitVector::any();
}
bool includes(const RegisterSet &Rs) const {
- // A.BitVector::test(B) <=> A-B != {}
- return !Rs.BitVector::test(*this);
+ return Rs.BitVector::subsetOf(*this);
}
bool intersects(const RegisterSet &Rs) const {
return BitVector::anyCommon(Rs);
>From 7c35ff5afc3828302218457a9dd036e7cf968fbd Mon Sep 17 00:00:00 2001
From: Anatoly Trosinenko <atrosinenko at accesssoftek.com>
Date: Mon, 8 Dec 2025 14:59:23 +0300
Subject: [PATCH 2/4] Add unit tests
---
llvm/unittests/ADT/BitVectorTest.cpp | 92 ++++++++++++++++++++++++++++
1 file changed, 92 insertions(+)
diff --git a/llvm/unittests/ADT/BitVectorTest.cpp b/llvm/unittests/ADT/BitVectorTest.cpp
index e13523b8e10c3..51fa10e7fb665 100644
--- a/llvm/unittests/ADT/BitVectorTest.cpp
+++ b/llvm/unittests/ADT/BitVectorTest.cpp
@@ -835,19 +835,27 @@ TYPED_TEST(BitVectorTest, BinOps) {
A.resize(65);
EXPECT_FALSE(A.anyCommon(B));
EXPECT_FALSE(B.anyCommon(B));
+ EXPECT_TRUE(A.subsetOf(B));
+ EXPECT_TRUE(B.subsetOf(A));
B.resize(64);
A.set(64);
EXPECT_FALSE(A.anyCommon(B));
EXPECT_FALSE(B.anyCommon(A));
+ EXPECT_FALSE(A.subsetOf(B));
+ EXPECT_TRUE(B.subsetOf(A));
B.set(63);
EXPECT_FALSE(A.anyCommon(B));
EXPECT_FALSE(B.anyCommon(A));
+ EXPECT_FALSE(A.subsetOf(B));
+ EXPECT_FALSE(B.subsetOf(A));
A.set(63);
EXPECT_TRUE(A.anyCommon(B));
EXPECT_TRUE(B.anyCommon(A));
+ EXPECT_FALSE(A.subsetOf(B));
+ EXPECT_TRUE(B.subsetOf(A));
B.resize(70);
B.set(64);
@@ -855,6 +863,90 @@ TYPED_TEST(BitVectorTest, BinOps) {
A.resize(64);
EXPECT_FALSE(A.anyCommon(B));
EXPECT_FALSE(B.anyCommon(A));
+ EXPECT_FALSE(A.subsetOf(B));
+ EXPECT_FALSE(B.subsetOf(A));
+
+ B.set(63);
+ B.reset(64);
+ EXPECT_TRUE(A.anyCommon(B));
+ EXPECT_TRUE(B.anyCommon(A));
+ EXPECT_TRUE(A.subsetOf(B));
+ EXPECT_TRUE(B.subsetOf(A));
+}
+
+template <typename VecType>
+static inline VecType createBitVectorFromBits(uint32_t Size,
+ const std::vector<int> &SetBits) {
+ VecType V;
+ V.resize(Size);
+ for (auto &BitIndex : SetBits)
+ V.set(BitIndex);
+ return V;
+}
+
+TYPED_TEST(BitVectorTest, BinOpsLiteral) {
+ // More tests of binary operations with more focus on the semantics and
+ // less focus on mutability.
+
+ auto AnyCommon = [](uint32_t SizeLHS, const std::vector<int> &SetBitsLHS,
+ uint32_t SizeRHS, const std::vector<int> &SetBitsRHS) {
+ auto LHS = createBitVectorFromBits<TypeParam>(SizeLHS, SetBitsLHS);
+ auto RHS = createBitVectorFromBits<TypeParam>(SizeRHS, SetBitsRHS);
+ return LHS.anyCommon(RHS);
+ };
+ auto SubsetOf = [](uint32_t SizeLHS, const std::vector<int> &SetBitsLHS,
+ uint32_t SizeRHS, const std::vector<int> &SetBitsRHS) {
+ auto LHS = createBitVectorFromBits<TypeParam>(SizeLHS, SetBitsLHS);
+ auto RHS = createBitVectorFromBits<TypeParam>(SizeRHS, SetBitsRHS);
+ return LHS.subsetOf(RHS);
+ };
+
+ // clang-format off
+
+ // Test small-sized vectors.
+
+ EXPECT_TRUE (AnyCommon(10, {1, 2, 3}, 10, {3, 4, 5}));
+ EXPECT_FALSE(AnyCommon(10, {1, 2, 3}, 10, {4, 5}));
+
+ EXPECT_FALSE(SubsetOf(10, {1, 2, 3}, 10, {2, 3, 4}));
+ EXPECT_TRUE (SubsetOf(10, {2, 3}, 10, {2, 3, 4}));
+ EXPECT_FALSE(SubsetOf(10, {1, 2, 3}, 10, {2, 3}));
+ EXPECT_TRUE (SubsetOf(10, {1, 2, 3}, 10, {1, 2, 3}));
+
+ // Test representations of empty sets of various sizes.
+
+ EXPECT_FALSE(AnyCommon(10, {}, 10, {}));
+ EXPECT_FALSE(AnyCommon(10, {}, 123, {}));
+ EXPECT_FALSE(AnyCommon(123, {}, 10, {}));
+ EXPECT_FALSE(AnyCommon(123, {}, 123, {}));
+ EXPECT_TRUE(SubsetOf(10, {}, 10, {}));
+ EXPECT_TRUE(SubsetOf(10, {}, 123, {}));
+ EXPECT_TRUE(SubsetOf(123, {}, 10, {}));
+ EXPECT_TRUE(SubsetOf(123, {}, 123, {}));
+
+ // Test handling of the remainder words.
+
+ EXPECT_FALSE(AnyCommon(10, {1, 2}, 123, {5, 70}));
+ EXPECT_TRUE (AnyCommon(10, {1, 2}, 123, {1, 70}));
+ EXPECT_FALSE(AnyCommon(123, {5, 70}, 10, {1, 2}));
+ EXPECT_TRUE (AnyCommon(123, {1, 70}, 10, {1, 2}));
+
+ EXPECT_FALSE(AnyCommon(10, {1, 2}, 123, {5}));
+ EXPECT_TRUE (AnyCommon(10, {1, 2}, 123, {1}));
+ EXPECT_FALSE(AnyCommon(123, {5}, 10, {1, 2}));
+ EXPECT_TRUE (AnyCommon(123, {1}, 10, {1, 2}));
+
+ EXPECT_FALSE(SubsetOf(10, {1, 2}, 123, {2, 70}));
+ EXPECT_TRUE (SubsetOf(10, {1, 2}, 123, {1, 2, 70}));
+ EXPECT_FALSE(SubsetOf(123, {2, 70}, 10, {1, 2}));
+ EXPECT_FALSE(SubsetOf(123, {1, 2, 70}, 10, {1, 2}));
+
+ EXPECT_FALSE(SubsetOf(10, {1, 2}, 123, {2}));
+ EXPECT_TRUE (SubsetOf(10, {1, 2}, 123, {1, 2}));
+ EXPECT_TRUE (SubsetOf(123, {2}, 10, {1, 2}));
+ EXPECT_TRUE (SubsetOf(123, {1, 2}, 10, {1, 2}));
+
+ // clang-format on
}
using RangeList = std::vector<std::pair<int, int>>;
>From e86dd121f882303f16b3fe1b355ec0e39dfe76b2 Mon Sep 17 00:00:00 2001
From: Anatoly Trosinenko <atrosinenko at accesssoftek.com>
Date: Mon, 8 Dec 2025 18:18:31 +0300
Subject: [PATCH 3/4] Address comments
---
llvm/unittests/ADT/BitVectorTest.cpp | 15 ++++++++-------
1 file changed, 8 insertions(+), 7 deletions(-)
diff --git a/llvm/unittests/ADT/BitVectorTest.cpp b/llvm/unittests/ADT/BitVectorTest.cpp
index 51fa10e7fb665..40fc7bffd6eaf 100644
--- a/llvm/unittests/ADT/BitVectorTest.cpp
+++ b/llvm/unittests/ADT/BitVectorTest.cpp
@@ -11,6 +11,7 @@
#include "llvm/ADT/STLExtras.h"
#include "llvm/ADT/SmallBitVector.h"
#include "gtest/gtest.h"
+#include <initializer_list>
using namespace llvm;
@@ -875,11 +876,11 @@ TYPED_TEST(BitVectorTest, BinOps) {
}
template <typename VecType>
-static inline VecType createBitVectorFromBits(uint32_t Size,
- const std::vector<int> &SetBits) {
+static inline VecType
+createBitVectorFromBits(uint32_t Size, std::initializer_list<int> SetBits) {
VecType V;
V.resize(Size);
- for (auto &BitIndex : SetBits)
+ for (int BitIndex : SetBits)
V.set(BitIndex);
return V;
}
@@ -888,14 +889,14 @@ TYPED_TEST(BitVectorTest, BinOpsLiteral) {
// More tests of binary operations with more focus on the semantics and
// less focus on mutability.
- auto AnyCommon = [](uint32_t SizeLHS, const std::vector<int> &SetBitsLHS,
- uint32_t SizeRHS, const std::vector<int> &SetBitsRHS) {
+ auto AnyCommon = [](uint32_t SizeLHS, std::initializer_list<int> SetBitsLHS,
+ uint32_t SizeRHS, std::initializer_list<int> SetBitsRHS) {
auto LHS = createBitVectorFromBits<TypeParam>(SizeLHS, SetBitsLHS);
auto RHS = createBitVectorFromBits<TypeParam>(SizeRHS, SetBitsRHS);
return LHS.anyCommon(RHS);
};
- auto SubsetOf = [](uint32_t SizeLHS, const std::vector<int> &SetBitsLHS,
- uint32_t SizeRHS, const std::vector<int> &SetBitsRHS) {
+ auto SubsetOf = [](uint32_t SizeLHS, std::initializer_list<int> SetBitsLHS,
+ uint32_t SizeRHS, std::initializer_list<int> SetBitsRHS) {
auto LHS = createBitVectorFromBits<TypeParam>(SizeLHS, SetBitsLHS);
auto RHS = createBitVectorFromBits<TypeParam>(SizeRHS, SetBitsRHS);
return LHS.subsetOf(RHS);
>From 4e8a185f65d09d74d22a7625612fbd73dca2eec3 Mon Sep 17 00:00:00 2001
From: Anatoly Trosinenko <atrosinenko at accesssoftek.com>
Date: Mon, 8 Dec 2025 19:03:22 +0300
Subject: [PATCH 4/4] Apply suggestions from code review
Co-authored-by: Jakub Kuderski <jakub at nod-labs.com>
---
llvm/unittests/ADT/BitVectorTest.cpp | 3 ---
1 file changed, 3 deletions(-)
diff --git a/llvm/unittests/ADT/BitVectorTest.cpp b/llvm/unittests/ADT/BitVectorTest.cpp
index 40fc7bffd6eaf..d3200b7722ee3 100644
--- a/llvm/unittests/ADT/BitVectorTest.cpp
+++ b/llvm/unittests/ADT/BitVectorTest.cpp
@@ -905,7 +905,6 @@ TYPED_TEST(BitVectorTest, BinOpsLiteral) {
// clang-format off
// Test small-sized vectors.
-
EXPECT_TRUE (AnyCommon(10, {1, 2, 3}, 10, {3, 4, 5}));
EXPECT_FALSE(AnyCommon(10, {1, 2, 3}, 10, {4, 5}));
@@ -915,7 +914,6 @@ TYPED_TEST(BitVectorTest, BinOpsLiteral) {
EXPECT_TRUE (SubsetOf(10, {1, 2, 3}, 10, {1, 2, 3}));
// Test representations of empty sets of various sizes.
-
EXPECT_FALSE(AnyCommon(10, {}, 10, {}));
EXPECT_FALSE(AnyCommon(10, {}, 123, {}));
EXPECT_FALSE(AnyCommon(123, {}, 10, {}));
@@ -926,7 +924,6 @@ TYPED_TEST(BitVectorTest, BinOpsLiteral) {
EXPECT_TRUE(SubsetOf(123, {}, 123, {}));
// Test handling of the remainder words.
-
EXPECT_FALSE(AnyCommon(10, {1, 2}, 123, {5, 70}));
EXPECT_TRUE (AnyCommon(10, {1, 2}, 123, {1, 70}));
EXPECT_FALSE(AnyCommon(123, {5, 70}, 10, {1, 2}));
More information about the llvm-commits
mailing list