[libcxx-commits] [libcxx] Simplify flip() for std::bitset (PR #120807)

[Peng Liu via libcxx-commits]

https://github.com/winner245 updated https://github.com/llvm/llvm-project/pull/120807

>From 975084a82fa6e768942d86a445059daa5f764a5b Mon Sep 17 00:00:00 2001
From: Peng Liu <winner245 at hotmail.com>
Date: Fri, 20 Dec 2024 18:18:00 -0500
Subject: [PATCH 1/2] Simplify flip() for std::bit_set

---
 libcxx/include/bitset                         | 12 +++-------
 .../bitset.members/flip_all.pass.cpp          | 18 ++++++++-------
 .../template.bitset/bitset_test_cases.h       | 22 +++++++++++++++++++
 3 files changed, 35 insertions(+), 17 deletions(-)

diff --git a/libcxx/include/bitset b/libcxx/include/bitset
index a20842985b3d5..27689721c79e6 100644
--- a/libcxx/include/bitset
+++ b/libcxx/include/bitset
@@ -329,12 +329,8 @@ _LIBCPP_HIDE_FROM_ABI _LIBCPP_CONSTEXPR_SINCE_CXX23 void __bitset<_N_words, _Siz
   for (; __n >= __bits_per_word; ++__p, __n -= __bits_per_word)
     *__p = ~*__p;
   // do last partial word
-  if (__n > 0) {
-    __storage_type __m = ~__storage_type(0) >> (__bits_per_word - __n);
-    __storage_type __b = *__p & __m;
-    *__p &= ~__m;
-    *__p |= ~__b & __m;
-  }
+  if (__n > 0)
+    *__p ^= (__storage_type(1) << __n) - 1;
 }
 
 template <size_t _N_words, size_t _Size>
@@ -514,9 +510,7 @@ __bitset<1, _Size>::operator^=(const __bitset& __v) _NOEXCEPT {
 
 template <size_t _Size>
 inline _LIBCPP_HIDE_FROM_ABI _LIBCPP_CONSTEXPR_SINCE_CXX23 void __bitset<1, _Size>::flip() _NOEXCEPT {
-  __storage_type __m = ~__storage_type(0) >> (__bits_per_word - _Size);
-  __first_           = ~__first_;
-  __first_ &= __m;
+  __first_ ^= ~__storage_type(0) >> (__bits_per_word - _Size);
 }
 
 template <size_t _Size>
diff --git a/libcxx/test/std/utilities/template.bitset/bitset.members/flip_all.pass.cpp b/libcxx/test/std/utilities/template.bitset/bitset.members/flip_all.pass.cpp
index 79fa505e63cd3..55401367cd08f 100644
--- a/libcxx/test/std/utilities/template.bitset/bitset.members/flip_all.pass.cpp
+++ b/libcxx/test/std/utilities/template.bitset/bitset.members/flip_all.pass.cpp
@@ -18,19 +18,21 @@
 
 template <std::size_t N>
 TEST_CONSTEXPR_CXX23 void test_flip_all() {
-    std::vector<std::bitset<N> > const cases = get_test_cases<N>();
-    for (std::size_t c = 0; c != cases.size(); ++c) {
-        std::bitset<N> v1 = cases[c];
-        std::bitset<N> v2 = v1;
-        v2.flip();
-        for (std::size_t i = 0; i < v1.size(); ++i)
-            assert(v2[i] == ~v1[i]);
-    }
+  std::vector<std::bitset<N> > const cases = get_test_cases<N>();
+  for (std::size_t c = 0; c != cases.size(); ++c) {
+    std::bitset<N> v1 = cases[c];
+    std::bitset<N> v2 = v1;
+    v2.flip();
+    for (std::size_t i = 0; i < v1.size(); ++i)
+      assert(v2[i] == ~v1[i]);
+  }
 }
 
 TEST_CONSTEXPR_CXX23 bool test() {
   test_flip_all<0>();
   test_flip_all<1>();
+  test_flip_all<2>();
+  test_flip_all<5>();
   test_flip_all<31>();
   test_flip_all<32>();
   test_flip_all<33>();
diff --git a/libcxx/test/std/utilities/template.bitset/bitset_test_cases.h b/libcxx/test/std/utilities/template.bitset/bitset_test_cases.h
index b561b01ef19a9..1ca19ec469e2c 100644
--- a/libcxx/test/std/utilities/template.bitset/bitset_test_cases.h
+++ b/libcxx/test/std/utilities/template.bitset/bitset_test_cases.h
@@ -43,6 +43,28 @@ TEST_CONSTEXPR_CXX23 inline std::vector<std::bitset<2> > get_test_cases<2>() {
   return cases;
 }
 
+template <>
+TEST_CONSTEXPR_CXX23 inline std::vector<std::bitset<5> > get_test_cases<5>() {
+  std::vector<std::bitset<5> > cases;
+  cases.push_back(std::bitset<5>("00000"));
+  cases.push_back(std::bitset<5>("00001"));
+  cases.push_back(std::bitset<5>("10000"));
+  cases.push_back(std::bitset<5>("00010"));
+  cases.push_back(std::bitset<5>("01000"));
+  cases.push_back(std::bitset<5>("00011"));
+  cases.push_back(std::bitset<5>("11000"));
+  cases.push_back(std::bitset<5>("00100"));
+  cases.push_back(std::bitset<5>("11011"));
+  cases.push_back(std::bitset<5>("00101"));
+  cases.push_back(std::bitset<5>("10100"));
+  cases.push_back(std::bitset<5>("00110"));
+  cases.push_back(std::bitset<5>("01100"));
+  cases.push_back(std::bitset<5>("00111"));
+  cases.push_back(std::bitset<5>("11100"));
+  cases.push_back(std::bitset<5>("11111"));
+  return cases;
+}
+
 template <>
 TEST_CONSTEXPR_CXX23 inline std::vector<std::bitset<31> > get_test_cases<31>() {
   std::vector<std::bitset<31> > cases;

>From 853fe17e126fdb62545f3c11c2424357dc98e630 Mon Sep 17 00:00:00 2001
From: Peng Liu <winner245 at hotmail.com>
Date: Wed, 19 Feb 2025 18:19:00 -0500
Subject: [PATCH 2/2] Address philnik777's comment regarding ABI

---
 libcxx/include/bitset | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/libcxx/include/bitset b/libcxx/include/bitset
index 27689721c79e6..c63e47463b0a0 100644
--- a/libcxx/include/bitset
+++ b/libcxx/include/bitset
@@ -329,6 +329,8 @@ _LIBCPP_HIDE_FROM_ABI _LIBCPP_CONSTEXPR_SINCE_CXX23 void __bitset<_N_words, _Siz
   for (; __n >= __bits_per_word; ++__p, __n -= __bits_per_word)
     *__p = ~*__p;
   // do last partial word
+  // Ensure trailing padding bits are zeroed as part of the ABI for consistent hashing behavior. std::hash<bitset>
+  // assumes trailing bits are zeroed; otherwise, identical bitsets could hash differently.
   if (__n > 0)
     *__p ^= (__storage_type(1) << __n) - 1;
 }