[libcxx-commits] [libcxx] [libc++][vector<bool>] Tests shrink_to_fit requirement. (PR #98009)

[Mark de Wever via libcxx-commits]

https://github.com/mordante updated https://github.com/llvm/llvm-project/pull/98009

>From facbd5822d5620d83267fcb002cfe7d1c7d3c49c Mon Sep 17 00:00:00 2001
From: Mark de Wever <koraq at xs4all.nl>
Date: Sat, 6 Jul 2024 14:58:20 +0200
Subject: [PATCH] [libc++][vector<bool>] Tests shrink_to_fit requirement.

vector<bool>'s shrink_to_fit implementation is using the
"swap-to-free-container-resources-trick" which only shrinks when the input
vector is empty. Since the request to shrink_to_fit is non-binding, this
is a valid implementation. It is not a high-quality implementation. Since
vector<bool> is not a very popular container the implementation has not
been changed and only a test to validate the non-growing property has been
added.

This was discovered while investigating https://github.com/llvm/llvm-project/issues/95161
---
 .../vector.bool/shrink_to_fit.pass.cpp        | 39 +++++++++++++++++++
 1 file changed, 39 insertions(+)

diff --git a/libcxx/test/std/containers/sequences/vector.bool/shrink_to_fit.pass.cpp b/libcxx/test/std/containers/sequences/vector.bool/shrink_to_fit.pass.cpp
index b39245cab7bf43..18661ad825c6b4 100644
--- a/libcxx/test/std/containers/sequences/vector.bool/shrink_to_fit.pass.cpp
+++ b/libcxx/test/std/containers/sequences/vector.bool/shrink_to_fit.pass.cpp
@@ -39,9 +39,48 @@ TEST_CONSTEXPR_CXX20 bool tests()
     return true;
 }
 
+#if TEST_STD_VER >= 23
+std::size_t min_bytes = 1000;
+
+template <typename T>
+struct increasing_allocator {
+  using value_type       = T;
+  increasing_allocator() = default;
+  template <typename U>
+  increasing_allocator(const increasing_allocator<U>&) noexcept {}
+  std::allocation_result<T*> allocate_at_least(std::size_t n) {
+    std::size_t allocation_amount = n * sizeof(T);
+    if (allocation_amount < min_bytes)
+      allocation_amount = min_bytes;
+    min_bytes += 1000;
+    return {static_cast<T*>(::operator new(allocation_amount)), allocation_amount / sizeof(T)};
+  }
+  T* allocate(std::size_t n) { return allocate_at_least(n).ptr; }
+  void deallocate(T* p, std::size_t) noexcept { ::operator delete(static_cast<void*>(p)); }
+};
+
+template <typename T, typename U>
+bool operator==(increasing_allocator<T>, increasing_allocator<U>) {
+  return true;
+}
+
+// https://github.com/llvm/llvm-project/issues/95161
+void test_increasing_allocator() {
+  std::vector<bool, increasing_allocator<bool>> v;
+  v.push_back(1);
+  std::size_t capacity = v.capacity();
+  v.shrink_to_fit();
+  assert(v.capacity() <= capacity);
+  assert(v.size() == 1);
+}
+#endif // TEST_STD_VER >= 23
+
 int main(int, char**)
 {
     tests();
+#if TEST_STD_VER >= 23
+    test_increasing_allocator();
+#endif // TEST_STD_VER >= 23
 #if TEST_STD_VER > 17
     static_assert(tests());
 #endif