[libc] Enable the 'stdlib' unit tests to be hermetic

[jhuber6]

Summary

This changes the stdlib tests to the new add_libc_test framework.
This applies to all but the exit tests.

Depends on D149691

[michaelrj]

libc/test/src/stdlib/CMakeLists.txt

111–112

why is this added?

[jhuber6]

libc/test/src/stdlib/CMakeLists.txt

111–112

Discussed with Siva in the discord, but otherwise it will emit a call to a compiler-rt function for __floatuntixf.

[michaelrj]

LGTM

[sivachandra]

Can you hold off on landing this. I do want to understand why we are still getting link errors even with https://reviews.llvm.org/D149683.

[sivachandra]

libc/test/UnitTest/RoundingModeUtils.cpp

40

This will be break when LLVM's libc is being used in the overlay mode and fenv comes from the system libc. I don't have a better suggestion though.

libc/test/src/CMakeLists.txt

37

Instead of creating another fp testing function, WDYT of https://reviews.llvm.org/D149728

libc/test/src/stdlib/CMakeLists.txt

111–112

ISTM that you did not apply https://reviews.llvm.org/D149683 when you were testing? I have landed it now, can you try again? I am not able to repro this problem after I have landed https://reviews.llvm.org/D149683.

264

Nit: Move this right under the name so that it catches the reader's eye.

[jhuber6]

Making suggested changes.

[sivachandra]

libc/test/src/CMakeLists.txt

22

FATAL_ERROR

37

Do we still need this?

[jhuber6]

libc/test/src/CMakeLists.txt

37

Nope.

[jhuber6]

Remove unused.

libc/test/UnitTest/RoundingModeUtils.cpp

 //===-- RoundingModeUtils.cpp ---------------------------------------------===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 
 #include "RoundingModeUtils.h"
 
-#include <fenv.h>
+#include "src/__support/FPUtil/FEnvImpl.h"
 
 namespace __llvm_libc {
 namespace fputil {
 namespace testing {
 
 int get_fe_rounding(RoundingMode mode) {
   switch (mode) {
   case RoundingMode::Upward:
case RoundingMode::Nearest:
     return FE_TONEAREST;
     break;
   default:
     __builtin_unreachable();
   }
 }
 
 ForceRoundingMode::ForceRoundingMode(RoundingMode mode) {
-  old_rounding_mode = fegetround();
+  old_rounding_mode = fputil::get_round();
   rounding_mode = get_fe_rounding(mode);
   if (old_rounding_mode != rounding_mode)
-    fesetround(rounding_mode);
+    fputil::set_round(rounding_mode);
 }
 
 ForceRoundingMode::~ForceRoundingMode() {
   if (old_rounding_mode != rounding_mode)
-    fesetround(old_rounding_mode);
+    fputil::set_round(old_rounding_mode);
 }
 
 } // namespace testing
 } // namespace fputil
 } // namespace __llvm_libc

libc/test/src/CMakeLists.txt

 function(add_fp_unittest name)
   cmake_parse_arguments(
     "MATH_UNITTEST"
-    "NEED_MPFR" # Optional arguments
+    "NEED_MPFR;HERMETIC_TEST_ONLY" # Optional arguments
     "" # Single value arguments
     "LINK_LIBRARIES" # Multi-value arguments
     ${ARGN}
   )
 
   if(MATH_UNITTEST_NEED_MPFR)
     if(NOT LIBC_TESTS_CAN_USE_MPFR)
       message("WARNING: Math test ${name} will be skipped as MPFR library is not available.")
       return()
     endif()
   endif()
 
+  if(MATH_UNITTEST_HERMETIC_TEST_ONLY)
+    set(test_type HERMETIC_TEST_ONLY)
+  endif()
   if(MATH_UNITTEST_NEED_MPFR)
+    if(MATH_UNITTEST_HERMETIC_TEST_ONLY)
+      message(FATAL "Hermetic math test cannot require MPFR.")
+    endif()
+    set(test_type UNIT_TEST_ONLY)
     list(APPEND MATH_UNITTEST_LINK_LIBRARIES libcMPFRWrapper libc_math_test_utils -lmpfr -lgmp)
   endif()
   list(APPEND MATH_UNITTEST_LINK_LIBRARIES LibcFPTestHelpers)
 
   add_libc_unittest(
     ${name}
+    ${test_type}
     LINK_LIBRARIES "${MATH_UNITTEST_LINK_LIBRARIES}"
     "${MATH_UNITTEST_UNPARSED_ARGUMENTS}"
   )
 endfunction(add_fp_unittest)
 
+function(add_fp_test name)
+  cmake_parse_arguments(
+    "MATH_TEST"
+    "" # Optional arguments
+    "" # Single value arguments
+    "LINK_LIBRARIES" # Multi-value arguments
+    ${ARGN}
+  )
+
+  list(APPEND MATH_TEST_LINK_LIBRARIES LibcFPTestHelpers)
+  add_libc_test(
+    ${name}
+    LINK_LIBRARIES "${MATH_TEST_LINK_LIBRARIES}"
+    "${MATH_TEST_UNPARSED_ARGUMENTS}"
+  )
+endfunction(add_fp_test)
+
 add_subdirectory(__support)
 add_subdirectory(ctype)
 add_subdirectory(errno)
 add_subdirectory(fenv)
 add_subdirectory(math)
 add_subdirectory(string)
 add_subdirectory(stdlib)
 add_subdirectory(inttypes)

libc/test/src/stdlib/CMakeLists.txt

-add_custom_target(libc_stdlib_unittests)
+add_custom_target(libc-stdlib-tests)
 
-add_libc_unittest(
+add_libc_test(
   atof_test
   SUITE
-    libc_stdlib_unittests
+    libc-stdlib-tests
   SRCS
     atof_test.cpp
   DEPENDS
     libc.src.errno.errno
     libc.src.stdlib.atof
 )
 
 add_header_library(
   atoi_test_support
   HDRS
     AtoiTest.h
   DEPENDS
     libc.src.errno.errno
     libc.src.__support.CPP.type_traits
 )
 
-add_libc_unittest(
+add_libc_test(
   atoi_test
   SUITE
-    libc_stdlib_unittests
+    libc-stdlib-tests
   SRCS
     atoi_test.cpp
   DEPENDS
     .atoi_test_support
     libc.src.stdlib.atoi
 )
 
-add_libc_unittest(
+add_libc_test(
   atol_test
   SUITE
-    libc_stdlib_unittests
+    libc-stdlib-tests
   SRCS
     atol_test.cpp
   DEPENDS
     .atoi_test_support
     libc.src.stdlib.atol
 )
 
-add_libc_unittest(
+add_libc_test(
   atoll_test
   SUITE
-    libc_stdlib_unittests
+    libc-stdlib-tests
   SRCS
     atoll_test.cpp
   DEPENDS
     .atoi_test_support
     libc.src.stdlib.atoll
 )
 
 add_fp_unittest(
   strtod_test
   SUITE
-    libc_stdlib_unittests
+    libc-stdlib-tests
   SRCS
     strtod_test.cpp
   DEPENDS
     libc.src.errno.errno
     libc.src.stdlib.strtod
+    libc.src.__support.FPUtil.fenv_impl
 )
 
 add_fp_unittest(
   strtof_test
   SUITE
-    libc_stdlib_unittests
+    libc-stdlib-tests
   SRCS
     strtof_test.cpp
   DEPENDS
     libc.src.errno.errno
     libc.src.stdlib.strtof
+    libc.src.__support.FPUtil.fenv_impl
 )
 
 add_header_library(
   strtol_test_support
   HDRS
     StrtolTest.h
   DEPENDS
     libc.src.__support.CPP.limits
     libc.src.__support.CPP.type_traits
     libc.src.errno.errno
 )
 
-add_libc_unittest(
+add_libc_test(
   strtol_test
   SUITE
-    libc_stdlib_unittests
+    libc-stdlib-tests
   SRCS
     strtol_test.cpp
   DEPENDS
     libc.src.stdlib.strtol
     .strtol_test_support
 )
 
-add_libc_unittest(
+add_libc_test(
   strtold_test
   SUITE
-    libc_stdlib_unittests
+    libc-stdlib-tests
   SRCS
     strtold_test.cpp
   DEPENDS
     libc.src.errno.errno
     libc.src.__support.uint128
     libc.src.stdlib.strtold
 )
 
-add_libc_unittest(
+add_libc_test(
   strtoll_test
   SUITE
-    libc_stdlib_unittests
+    libc-stdlib-tests
   SRCS
     strtoll_test.cpp
   DEPENDS
     libc.src.stdlib.strtoll
     .strtol_test_support
 )
 
-add_libc_unittest(
+add_libc_test(
   strtoul_test
   SUITE
-    libc_stdlib_unittests
+    libc-stdlib-tests
   SRCS
     strtoul_test.cpp
   DEPENDS
     libc.src.stdlib.strtoul
     .strtol_test_support
 )
 
-add_libc_unittest(
+add_libc_test(
   strtoull_test
   SUITE
-    libc_stdlib_unittests
+    libc-stdlib-tests
   SRCS
     strtoull_test.cpp
   DEPENDS
     libc.src.stdlib.strtoull
     .strtol_test_support
 )
 
-add_libc_unittest(
+add_libc_test(
   abs_test
   SUITE
-    libc_stdlib_unittests
+    libc-stdlib-tests
   SRCS
     abs_test.cpp
   DEPENDS
     libc.src.stdlib.abs
 )
 
-add_libc_unittest(
+add_libc_test(
   labs_test
   SUITE
-    libc_stdlib_unittests
+    libc-stdlib-tests
   SRCS
     labs_test.cpp
   DEPENDS
     libc.src.stdlib.labs
 )
 
-add_libc_unittest(
+add_libc_test(
   llabs_test
   SUITE
-    libc_stdlib_unittests
+    libc-stdlib-tests
   SRCS
     llabs_test.cpp
   DEPENDS
     libc.src.stdlib.llabs
 )
 
-add_libc_unittest(
+add_libc_test(
   div_test
   SUITE
-    libc_stdlib_unittests
+    libc-stdlib-tests
   SRCS
     div_test.cpp
   HDRS
     DivTest.h
   DEPENDS
     libc.include.stdlib
     libc.src.stdlib.div
 )
 
-add_libc_unittest(
+add_libc_test(
   ldiv_test
   SUITE
-    libc_stdlib_unittests
+    libc-stdlib-tests
   SRCS
     ldiv_test.cpp
   HDRS
     DivTest.h
   DEPENDS
     libc.include.stdlib
     libc.src.stdlib.ldiv
 )
 
-add_libc_unittest(
+add_libc_test(
   lldiv_test
   SUITE
-    libc_stdlib_unittests
+    libc-stdlib-tests
   SRCS
     lldiv_test.cpp
   HDRS
     DivTest.h
   DEPENDS
     libc.include.stdlib
     libc.src.stdlib.lldiv
 )
 
-add_libc_unittest(
+add_libc_test(
   bsearch_test
   SUITE
-    libc_stdlib_unittests
+    libc-stdlib-tests
   SRCS
     bsearch_test.cpp
   DEPENDS
     libc.include.stdlib
     libc.src.stdlib.bsearch
 )
 
-add_libc_unittest(
+add_libc_test(
   qsort_test
   SUITE
-    libc_stdlib_unittests
+    libc-stdlib-tests
   SRCS
     qsort_test.cpp
   DEPENDS
     libc.include.stdlib
     libc.src.stdlib.qsort
 )
 
-add_libc_unittest(
+add_libc_test(
   rand_test
   SUITE
-    libc_stdlib_unittests
+    libc-stdlib-tests
   SRCS
     rand_test.cpp
   DEPENDS
     libc.include.stdlib
     libc.src.stdlib.rand
     libc.src.stdlib.srand
 )
 
 if(LLVM_LIBC_FULL_BUILD)
 
-  add_libc_unittest(
+  add_libc_test(
     _Exit_test
+    # The EXPECT_EXITS test is only availible for unit tests.
+    UNIT_TEST_ONLY
     SUITE
-      libc_stdlib_unittests
+      libc-stdlib-tests
     SRCS
       _Exit_test.cpp
     DEPENDS
       libc.include.stdlib
       libc.src.stdlib._Exit
       libc.src.stdlib.exit
   )
 
-  add_libc_unittest(
+  add_libc_test(
     atexit_test
+    # The EXPECT_EXITS test is only availible for unit tests.
+    UNIT_TEST_ONLY
     SUITE
-      libc_stdlib_unittests
+      libc-stdlib-tests
     SRCS
       atexit_test.cpp
     DEPENDS
       libc.include.stdlib
       libc.src.stdlib._Exit
       libc.src.stdlib.exit
       libc.src.stdlib.atexit
       libc.src.__support.CPP.array
       libc.src.__support.CPP.utility
   )
 
-  add_libc_unittest(
+  add_libc_test(
     abort_test
+    # The EXPECT_DEATH test is only availible for unit tests.
+    UNIT_TEST_ONLY
     SUITE
-      libc_stdlib_unittests
+      libc-stdlib-tests
     SRCS
       abort_test.cpp
     DEPENDS
       libc.include.stdlib
       libc.include.signal
       libc.src.stdlib.abort
       libc.src.stdlib._Exit
       libc.src.signal.raise
   )
 
 endif()