[libc++] Allow running the test suite with optimizations (#68753)

This patch adds a configuration of the libc++ test suite that enables
optimizations when building the tests. It also adds a new CI
configuration to exercise this on a regular basis. This is added in the
context of [1], which requires building with optimizations in order to
hit the bug.

[1]: #68552

Author: ldionne

.github/workflows/libcxx-build-and-test.yaml

@@ -161,6 +161,7 @@ jobs:
           'generic-no-unicode',
           'generic-no-wide-characters',
           'generic-no-rtti',
+          'generic-optimized-speed',
           'generic-static',
           'generic-with_llvm_unwinder',
           # TODO Find a better place for the benchmark and bootstrapping builds to live. They're either very expensive

libcxx/cmake/caches/Generic-optimized-speed.cmake

@@ -0,0 +1,4 @@
+set(CMAKE_BUILD_TYPE RelWithDebInfo CACHE STRING "")
+set(LIBCXX_TEST_PARAMS "optimization=speed" CACHE STRING "")
+set(LIBCXXABI_TEST_PARAMS "${LIBCXX_TEST_PARAMS}" CACHE STRING "")
+set(LIBUNWIND_TEST_PARAMS "${LIBCXX_TEST_PARAMS}" CACHE STRING "")

libcxx/test/libcxx/depr/depr.default.allocator/allocator.members/allocate.cxx2a.pass.cpp

@@ -60,7 +60,7 @@ void test_aligned() {
   {
     globalMemCounter.last_new_size = 0;
     globalMemCounter.last_new_align = 0;
-    T* volatile ap2 = a.allocate(11, (const void*)5);
+    T* ap2 = a.allocate(11, (const void*)5);
     DoNotOptimize(ap2);
     assert(globalMemCounter.checkOutstandingNewEq(1));
     assert(globalMemCounter.checkNewCalledEq(1));

libcxx/test/libcxx/language.support/support.dynamic/libcpp_deallocate.sh.cpp

@@ -187,13 +187,13 @@ void test_allocator_and_new_match() {
   stats.reset();
 #if defined(NO_SIZE) && defined(NO_ALIGN)
   {
-    int* x = new int(42);
+    int* x = DoNotOptimize(new int(42));
     delete x;
     assert(stats.expect_plain());
   }
   stats.reset();
   {
-    AlignedType* a = new AlignedType();
+    AlignedType* a = DoNotOptimize(new AlignedType());
     delete a;
     assert(stats.expect_plain());
   }
@@ -202,42 +202,42 @@ void test_allocator_and_new_match() {
   stats.reset();
 #if TEST_STD_VER >= 11
   {
-    int* x = new int(42);
+    int* x = DoNotOptimize(new int(42));
     delete x;
     assert(stats.expect_plain());
   }
 #endif
   stats.reset();
   {
-    AlignedType* a = new AlignedType();
+    AlignedType* a = DoNotOptimize(new AlignedType());
     delete a;
     assert(stats.expect_align(TEST_ALIGNOF(AlignedType)));
   }
   stats.reset();
 #elif defined(NO_ALIGN)
   stats.reset();
   {
-    int* x = new int(42);
+    int* x = DoNotOptimize(new int(42));
     delete x;
     assert(stats.expect_size(sizeof(int)));
   }
   stats.reset();
   {
-    AlignedType* a = new AlignedType();
+    AlignedType* a = DoNotOptimize(new AlignedType());
     delete a;
     assert(stats.expect_size(sizeof(AlignedType)));
   }
   stats.reset();
 #else
   stats.reset();
   {
-    int* x = new int(42);
+    int* x = DoNotOptimize(new int(42));
     delete x;
     assert(stats.expect_size(sizeof(int)));
   }
   stats.reset();
   {
-    AlignedType* a = new AlignedType();
+    AlignedType* a = DoNotOptimize(new AlignedType());
     delete a;
     assert(stats.expect_size_align(sizeof(AlignedType),
                                    TEST_ALIGNOF(AlignedType)));

libcxx/test/std/experimental/simd/simd.class/simd_ctor_conversion.pass.cpp

@@ -9,6 +9,10 @@
 // UNSUPPORTED: c++03, c++11, c++14
 // XFAIL: target=powerpc{{.*}}le-unknown-linux-gnu
 
+// TODO: This test makes incorrect assumptions about floating point conversions.
+//       See https://github.com/llvm/llvm-project/issues/74327.
+// XFAIL: optimization=speed
+
 // <experimental/simd>
 //
 // [simd.class]

libcxx/test/std/input.output/filesystems/class.path/path.member/path.assign/move.pass.cpp

@@ -31,7 +31,7 @@ int main(int, char**) {
   const std::string s("we really really really really really really really "
                       "really really long string so that we allocate");
   ASSERT_WITH_LIBRARY_INTERNAL_ALLOCATIONS(
-      globalMemCounter.checkOutstandingNewEq(1));
+      globalMemCounter.checkOutstandingNewLessThanOrEqual(1));
   const fs::path::string_type ps(s.begin(), s.end());
   path p(s);
   {

libcxx/test/std/input.output/filesystems/class.path/path.member/path.construct/move.pass.cpp

@@ -31,7 +31,7 @@ int main(int, char**) {
   const std::string s("we really really really really really really really "
                       "really really long string so that we allocate");
   ASSERT_WITH_LIBRARY_INTERNAL_ALLOCATIONS(
-      globalMemCounter.checkOutstandingNewEq(1));
+      globalMemCounter.checkOutstandingNewLessThanOrEqual(1));
   const fs::path::string_type ps(s.begin(), s.end());
   path p(s);
   {

libcxx/test/std/language.support/support.dynamic/new.delete/new.delete.array/new.size.replace.indirect.pass.cpp

@@ -42,7 +42,7 @@ void operator delete(void* p) TEST_NOEXCEPT {
 
 int main(int, char**) {
     new_called = delete_called = 0;
-    int* x = new int[3];
+    int* x = DoNotOptimize(new int[3]);
     assert(x != nullptr);
     ASSERT_WITH_OPERATOR_NEW_FALLBACKS(new_called == 1);
 

libcxx/test/std/language.support/support.dynamic/new.delete/new.delete.array/new.size.replace.pass.cpp

@@ -40,7 +40,7 @@ void operator delete[](void* p) TEST_NOEXCEPT {
 
 int main(int, char**) {
     new_called = delete_called = 0;
-    int* x = new int[3];
+    int* x = DoNotOptimize(new int[3]);
     assert(x != nullptr);
     ASSERT_WITH_OPERATOR_NEW_FALLBACKS(new_called == 1);
 

libcxx/test/std/language.support/support.dynamic/new.delete/new.delete.array/new.size_align.replace.indirect.pass.cpp

@@ -51,7 +51,7 @@ int main(int, char**) {
     // Test with an overaligned type
     {
         new_called = delete_called = 0;
-        OverAligned* x = new OverAligned[3];
+        OverAligned* x = DoNotOptimize(new OverAligned[3]);
         ASSERT_WITH_OPERATOR_NEW_FALLBACKS(static_cast<void*>(x) == DummyData);
         ASSERT_WITH_OPERATOR_NEW_FALLBACKS(new_called == 1);
 
@@ -62,7 +62,7 @@ int main(int, char**) {
     // Test with a type that is right on the verge of being overaligned
     {
         new_called = delete_called = 0;
-        MaxAligned* x = new MaxAligned[3];
+        MaxAligned* x = DoNotOptimize(new MaxAligned[3]);
         assert(x != nullptr);
         assert(new_called == 0);
 
@@ -73,7 +73,7 @@ int main(int, char**) {
     // Test with a type that is clearly not overaligned
     {
         new_called = delete_called = 0;
-        int* x = new int[3];
+        int* x = DoNotOptimize(new int[3]);
         assert(x != nullptr);
         assert(new_called == 0);
 

libcxx/test/std/language.support/support.dynamic/new.delete/new.delete.array/new.size_align_nothrow.replace.indirect.pass.cpp

@@ -51,7 +51,7 @@ int main(int, char**) {
     // Test with an overaligned type
     {
         new_called = delete_called = 0;
-        OverAligned* x = new (std::nothrow) OverAligned[3];
+        OverAligned* x = DoNotOptimize(new (std::nothrow) OverAligned[3]);
         ASSERT_WITH_OPERATOR_NEW_FALLBACKS(static_cast<void*>(x) == DummyData);
         ASSERT_WITH_OPERATOR_NEW_FALLBACKS(new_called == 1);
 
@@ -62,7 +62,7 @@ int main(int, char**) {
     // Test with a type that is right on the verge of being overaligned
     {
         new_called = delete_called = 0;
-        MaxAligned* x = new (std::nothrow) MaxAligned[3];
+        MaxAligned* x = DoNotOptimize(new (std::nothrow) MaxAligned[3]);
         assert(x != nullptr);
         assert(new_called == 0);
 
@@ -73,7 +73,7 @@ int main(int, char**) {
     // Test with a type that is clearly not overaligned
     {
         new_called = delete_called = 0;
-        int* x = new (std::nothrow) int[3];
+        int* x = DoNotOptimize(new (std::nothrow) int[3]);
         assert(x != nullptr);
         assert(new_called == 0);
 

libcxx/test/std/language.support/support.dynamic/new.delete/new.delete.array/new.size_align_nothrow.replace.pass.cpp

@@ -48,7 +48,7 @@ int main(int, char**) {
     // Test with an overaligned type
     {
         new_nothrow_called = delete_called = 0;
-        OverAligned* x = new (std::nothrow) OverAligned[3];
+        OverAligned* x = DoNotOptimize(new (std::nothrow) OverAligned[3]);
         assert(static_cast<void*>(x) == DummyData);
         ASSERT_WITH_OPERATOR_NEW_FALLBACKS(new_nothrow_called == 1);
 
@@ -59,7 +59,7 @@ int main(int, char**) {
     // Test with a type that is right on the verge of being overaligned
     {
         new_nothrow_called = delete_called = 0;
-        MaxAligned* x = new (std::nothrow) MaxAligned[3];
+        MaxAligned* x = DoNotOptimize(new (std::nothrow) MaxAligned[3]);
         assert(x != nullptr);
         assert(new_nothrow_called == 0);
 
@@ -70,7 +70,7 @@ int main(int, char**) {
     // Test with a type that is clearly not overaligned
     {
         new_nothrow_called = delete_called = 0;
-        int* x = new (std::nothrow) int[3];
+        int* x = DoNotOptimize(new (std::nothrow) int[3]);
         assert(x != nullptr);
         assert(new_nothrow_called == 0);
 

libcxx/test/std/language.support/support.dynamic/new.delete/new.delete.array/new.size_nothrow.replace.indirect.pass.cpp

@@ -46,7 +46,7 @@ void operator delete(void* p) TEST_NOEXCEPT {
 
 int main(int, char**) {
     new_called = delete_called = 0;
-    int* x = new (std::nothrow) int[3];
+    int* x = DoNotOptimize(new (std::nothrow) int[3]);
     assert(x != nullptr);
     ASSERT_WITH_OPERATOR_NEW_FALLBACKS(new_called == 1);
 

libcxx/test/std/language.support/support.dynamic/new.delete/new.delete.array/new.size_nothrow.replace.pass.cpp

@@ -35,7 +35,7 @@ void operator delete[](void* p) TEST_NOEXCEPT {
 
 int main(int, char**) {
     new_nothrow_called = delete_called = 0;
-    int* x = new (std::nothrow) int[3];
+    int* x = DoNotOptimize(new (std::nothrow) int[3]);
     assert(x != nullptr);
     ASSERT_WITH_OPERATOR_NEW_FALLBACKS(new_nothrow_called == 1);
 

libcxx/test/std/language.support/support.dynamic/new.delete/new.delete.single/new.size.replace.pass.cpp

@@ -38,7 +38,7 @@ void operator delete(void* p) TEST_NOEXCEPT {
 
 int main(int, char**) {
     new_called = delete_called = 0;
-    int* x = new int(3);
+    int* x = DoNotOptimize(new int(3));
     assert(x != nullptr);
     ASSERT_WITH_OPERATOR_NEW_FALLBACKS(new_called == 1);
 

libcxx/test/std/language.support/support.dynamic/new.delete/new.delete.single/new.size_align_nothrow.replace.indirect.pass.cpp

@@ -50,7 +50,7 @@ int main(int, char**) {
     // Test with an overaligned type
     {
         new_called = delete_called = 0;
-        OverAligned* x = new (std::nothrow) OverAligned;
+        OverAligned* x = DoNotOptimize(new (std::nothrow) OverAligned);
         ASSERT_WITH_OPERATOR_NEW_FALLBACKS(static_cast<void*>(x) == DummyData);
         ASSERT_WITH_OPERATOR_NEW_FALLBACKS(new_called == 1);
 
@@ -61,7 +61,7 @@ int main(int, char**) {
     // Test with a type that is right on the verge of being overaligned
     {
         new_called = delete_called = 0;
-        MaxAligned* x = new (std::nothrow) MaxAligned;
+        MaxAligned* x = DoNotOptimize(new (std::nothrow) MaxAligned);
         assert(x != nullptr);
         assert(new_called == 0);
 
@@ -72,7 +72,7 @@ int main(int, char**) {
     // Test with a type that is clearly not overaligned
     {
         new_called = delete_called = 0;
-        int* x = new (std::nothrow) int;
+        int* x = DoNotOptimize(new (std::nothrow) int);
         assert(x != nullptr);
         assert(new_called == 0);
 

libcxx/test/std/language.support/support.dynamic/new.delete/new.delete.single/new.size_nothrow.replace.indirect.pass.cpp

@@ -41,7 +41,7 @@ void operator delete(void* p) TEST_NOEXCEPT {
 
 int main(int, char**) {
     new_called = delete_called = 0;
-    int* x = new (std::nothrow) int(3);
+    int* x = DoNotOptimize(new (std::nothrow) int(3));
     assert(x != nullptr);
     ASSERT_WITH_OPERATOR_NEW_FALLBACKS(new_called == 1);
 

libcxx/test/std/utilities/function.objects/func.wrap/func.wrap.func/func.wrap.func.alg/swap.pass.cpp

@@ -69,12 +69,12 @@ int main(int, char**)
     static_assert(noexcept(swap(f1, f2)), "" );
 #endif
     assert(A::count == 2);
-    assert(globalMemCounter.checkOutstandingNewEq(2));
+    assert(globalMemCounter.checkOutstandingNewLessThanOrEqual(2));
     RTTI_ASSERT(f1.target<A>()->id() == 1);
     RTTI_ASSERT(f2.target<A>()->id() == 2);
     swap(f1, f2);
     assert(A::count == 2);
-    assert(globalMemCounter.checkOutstandingNewEq(2));
+    assert(globalMemCounter.checkOutstandingNewLessThanOrEqual(2));
     RTTI_ASSERT(f1.target<A>()->id() == 2);
     RTTI_ASSERT(f2.target<A>()->id() == 1);
     }
@@ -87,12 +87,12 @@ int main(int, char**)
     static_assert(noexcept(swap(f1, f2)), "" );
 #endif
     assert(A::count == 1);
-    assert(globalMemCounter.checkOutstandingNewEq(1));
+    assert(globalMemCounter.checkOutstandingNewLessThanOrEqual(1));
     RTTI_ASSERT(f1.target<A>()->id() == 1);
     RTTI_ASSERT(*f2.target<int(*)(int)>() == g);
     swap(f1, f2);
     assert(A::count == 1);
-    assert(globalMemCounter.checkOutstandingNewEq(1));
+    assert(globalMemCounter.checkOutstandingNewLessThanOrEqual(1));
     RTTI_ASSERT(*f1.target<int(*)(int)>() == g);
     RTTI_ASSERT(f2.target<A>()->id() == 1);
     }
@@ -105,12 +105,12 @@ int main(int, char**)
     static_assert(noexcept(swap(f1, f2)), "" );
 #endif
     assert(A::count == 1);
-    assert(globalMemCounter.checkOutstandingNewEq(1));
+    assert(globalMemCounter.checkOutstandingNewLessThanOrEqual(1));
     RTTI_ASSERT(*f1.target<int(*)(int)>() == g);
     RTTI_ASSERT(f2.target<A>()->id() == 1);
     swap(f1, f2);
     assert(A::count == 1);
-    assert(globalMemCounter.checkOutstandingNewEq(1));
+    assert(globalMemCounter.checkOutstandingNewLessThanOrEqual(1));
     RTTI_ASSERT(f1.target<A>()->id() == 1);
     RTTI_ASSERT(*f2.target<int(*)(int)>() == g);
     }
@@ -123,12 +123,12 @@ int main(int, char**)
     static_assert(noexcept(swap(f1, f2)), "" );
 #endif
     assert(A::count == 0);
-    assert(globalMemCounter.checkOutstandingNewEq(0));
+    assert(globalMemCounter.checkOutstandingNewLessThanOrEqual(0));
     RTTI_ASSERT(*f1.target<int(*)(int)>() == g);
     RTTI_ASSERT(*f2.target<int(*)(int)>() == h);
     swap(f1, f2);
     assert(A::count == 0);
-    assert(globalMemCounter.checkOutstandingNewEq(0));
+    assert(globalMemCounter.checkOutstandingNewLessThanOrEqual(0));
     RTTI_ASSERT(*f1.target<int(*)(int)>() == h);
     RTTI_ASSERT(*f2.target<int(*)(int)>() == g);
     }

libcxx/test/std/utilities/function.objects/func.wrap/func.wrap.func/func.wrap.func.con/F.pass.cpp

@@ -69,7 +69,7 @@ int main(int, char**)
     {
     std::function<int(int)> f = A();
     assert(A::count == 1);
-    assert(globalMemCounter.checkOutstandingNewEq(1));
+    assert(globalMemCounter.checkOutstandingNewLessThanOrEqual(1));
     RTTI_ASSERT(f.target<A>());
     RTTI_ASSERT(f.target<int(*)(int)>() == 0);
     }

libcxx/test/std/utilities/function.objects/func.wrap/func.wrap.func/func.wrap.func.con/copy_assign.pass.cpp

@@ -57,13 +57,13 @@ int main(int, char**) {
   {
     std::function<int(int)> f = A();
     assert(A::count == 1);
-    assert(globalMemCounter.checkOutstandingNewEq(1));
+    assert(globalMemCounter.checkOutstandingNewLessThanOrEqual(1));
     RTTI_ASSERT(f.target<A>());
     RTTI_ASSERT(f.target<int (*)(int)>() == 0);
     std::function<int(int)> f2;
     f2 = f;
     assert(A::count == 2);
-    assert(globalMemCounter.checkOutstandingNewEq(2));
+    assert(globalMemCounter.checkOutstandingNewLessThanOrEqual(2));
     RTTI_ASSERT(f2.target<A>());
     RTTI_ASSERT(f2.target<int (*)(int)>() == 0);
   }
@@ -125,13 +125,13 @@ int main(int, char**) {
   {
     std::function<int(int)> f = A();
     assert(A::count == 1);
-    assert(globalMemCounter.checkOutstandingNewEq(1));
+    assert(globalMemCounter.checkOutstandingNewLessThanOrEqual(1));
     RTTI_ASSERT(f.target<A>());
     RTTI_ASSERT(f.target<int (*)(int)>() == 0);
     std::function<int(int)> f2;
     f2 = std::move(f);
     assert(A::count == 1);
-    assert(globalMemCounter.checkOutstandingNewEq(1));
+    assert(globalMemCounter.checkOutstandingNewLessThanOrEqual(1));
     RTTI_ASSERT(f2.target<A>());
     RTTI_ASSERT(f2.target<int (*)(int)>() == 0);
     RTTI_ASSERT(f.target<A>() == 0);