[libc] Add a convenience CMake function `add_unittest_framework_library`.

[sivachandra]

Summary

This function is used to add unit test and hermetic test framework libraries.
It avoids the duplicated code to add compile options to each every test
framework libraries.

[jhuber6]

I got the following error when trying to build locally

CMake Error at /home/jhuber/Documents/llvm/llvm-project/libc/test/UnitTest/CMakeLists.txt:10 (message):
  'add_unittest_framework_library' requires SRCS; for header only libraries,
  use 'add_header_library'
Call Stack (most recent call first):
  /home/jhuber/Documents/llvm/llvm-project/libc/test/UnitTest/CMakeLists.txt:78 (add_unittest_framework_library)

[sivachandra]

Fix the sources of LibcDeathTestExecutors library.

[sivachandra]

In D150727#4348169, @jhuber6 wrote:

I got the following error when trying to build locally

CMake Error at /home/jhuber/Documents/llvm/llvm-project/libc/test/UnitTest/CMakeLists.txt:10 (message):
  'add_unittest_framework_library' requires SRCS; for header only libraries,
  use 'add_header_library'
Call Stack (most recent call first):
  /home/jhuber/Documents/llvm/llvm-project/libc/test/UnitTest/CMakeLists.txt:78 (add_unittest_framework_library)

Thanks for trying. I messed up the sources of the`LibcDeathTestExecutors` library. It should be fixed now.

[jhuber6]

ld.lld: error: libc/test/UnitTest/libLibcHermeticTestSupport.hermetic.a(HermeticTestUtils.cpp.o) is incompatible with libc/startup/gpu/amdgpu/CMakeFiles/libc.startup.gpu.amdgpu.crt1.dir/start.cpp.o
clang++: error: ld.lld command failed with exit code 1 (use -v to see invocation)

I get this error now, it happens when the architectures don't line up. So that means HermeticTestUtils.cpp.o is no longer being compiled for the GPU via --target=

[sivachandra]

Add hermetic test compile options to all hermetic test framework libraries.

[sivachandra]

In D150727#4350004, @jhuber6 wrote:

So that means HermeticTestUtils.cpp.o is no longer being compiled for the GPU via --target=

Indeed! I the hermetic test compile options were only being added to the main test framework library and not to the other test framework libraries. Hopefully its fixed now.

[jhuber6]

Works for me now, thanks

libc/cmake/modules/LLVMLibCTestRules.cmake

if(NOT LIBC_UNITTEST_CXX_STANDARD)
     set(LIBC_UNITTEST_CXX_STANDARD ${CMAKE_CXX_STANDARD})
   endif()
   set_target_properties(
     ${fq_build_target_name}
     PROPERTIES
       CXX_STANDARD ${LIBC_UNITTEST_CXX_STANDARD}
   )
 
+  set(link_libraries ${link_object_files})
   # Test object files will depend on LINK_LIBRARIES passed down from `add_fp_unittest`
-  set(link_libraries ${link_object_files} ${LIBC_UNITTEST_LINK_LIBRARIES})
+  foreach(lib IN LISTS LIBC_UNITTEST_LINK_LIBRARIES)
+    if(TARGET ${lib}.unit)
+      list(APPEND link_libraries ${lib}.unit)
+    else()
+      list(APPEND link_libraries ${lib})
+    endif()
+  endforeach()
 
   set_target_properties(${fq_build_target_name}
     PROPERTIES RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR})
 
   add_dependencies(
     ${fq_build_target_name}
     ${fq_deps_list}
   )
 
   # LibcUnitTest should not depend on anything in LINK_LIBRARIES.
-  list(APPEND link_libraries LibcUnitTest)
+  list(APPEND link_libraries LibcDeathTestExecutors.unit LibcTest.unit)
 
   target_link_libraries(${fq_build_target_name} PRIVATE ${link_libraries})
 
   if(NOT LIBC_UNITTEST_NO_RUN_POSTBUILD)
     add_custom_target(
       ${fq_target_name}
       COMMAND ${fq_build_target_name}
       COMMENT "Running unit test ${fq_target_name}"
target_include_directories(
     PRIVATE
       ${LIBC_SOURCE_DIR}
       ${LIBC_BUILD_DIR}
       ${LIBC_BUILD_DIR}/include
   )
   target_compile_options(${fq_build_target_name}
       PRIVATE ${LIBC_HERMETIC_TEST_COMPILE_OPTIONS} ${HERMETIC_TEST_COMPILE_OPTIONS})
 
+  set(link_libraries "")
+  foreach(lib IN LISTS HERMETIC_TEST_LINK_LIBRARIES)
+    if(TARGET ${lib}.hermetic)
+      list(APPEND link_libraries ${lib}.hermetic)
+    else()
+      list(APPEND link_libraries ${lib})
+    endif()
+  endforeach()
+
   if(LIBC_TARGET_ARCHITECTURE_IS_GPU)
     target_link_options(${fq_build_target_name} PRIVATE -nostdlib -static)
   else()
     target_link_options(${fq_build_target_name} PRIVATE -nolibc -nostartfiles -nostdlib++ -static)
   endif()
   target_link_libraries(
     ${fq_build_target_name}
     PRIVATE
-      ${HERMETIC_TEST_LINK_LIBRARIES}
       libc.startup.${LIBC_TARGET_OS}.crt1
-      LibcHermeticTest
+      ${link_libraries}
+      LibcTest.hermetic
+      LibcHermeticTestSupport.hermetic
       # The NVIDIA 'nvlink' linker does not currently support static libraries.
       $<$<NOT:$<BOOL:${LIBC_GPU_TARGET_ARCHITECTURE_IS_NVPTX}>>:${fq_target_name}.__libc__>)
   add_dependencies(${fq_build_target_name}
-                   LibcHermeticTest
+                   LibcTest.hermetic
                    ${fq_deps_list})
 
   # Tests on the GPU require an external loader utility to launch the kernel.
   if(TARGET libc.utils.gpu.loader)
     add_dependencies(${fq_build_target_name} libc.utils.gpu.loader)
     get_target_property(gpu_loader_exe libc.utils.gpu.loader "EXECUTABLE")
   endif()
 

libc/test/UnitTest/CMakeLists.txt

-set(libc_test_srcs_common
-  CmakeFilePath.cpp
-  LibcTest.cpp
-  LibcTestMain.cpp
-  TestLogger.cpp
-  LibcTest.h
-  Test.h
-  TestLogger.h
-)
-
-set(libc_death_test_srcs ExecuteFunction.h)
-if(${LIBC_TARGET_OS} STREQUAL "linux")
-  list(APPEND libc_death_test_srcs 
-       LibcDeathTestExecutors.cpp ExecuteFunctionUnix.cpp)
+function(add_unittest_framework_library name)
+  cmake_parse_arguments(
+    "TEST_LIB"
+    "" # No optional arguments
+    "" # No single value arguments
+    "SRCS;HDRS;DEPENDS" # Multi value arguments
+    ${ARGN}
+  )
+  if(NOT TEST_LIB_SRCS)
+    message(FATAL_ERROR "'add_unittest_framework_library' requires SRCS; for "
+                        "header only libraries, use 'add_header_library'")
   endif()
 
   # The Nvidia 'nvlink' linker does not support static libraries.
   if(LIBC_GPU_TARGET_ARCHITECTURE_IS_NVPTX)
     set(library_type OBJECT)
   else()
     set(library_type STATIC)
   endif()
 
+  foreach(lib IN ITEMS ${name}.unit ${name}.hermetic)
     add_library(
-  LibcUnitTest
-  ${library_type}
-  EXCLUDE_FROM_ALL
-  ${libc_test_srcs_common}
-  ${libc_death_test_srcs}
-)
-
-add_library(
-  LibcHermeticTest
+      ${lib}
       ${library_type}
       EXCLUDE_FROM_ALL
-  ${libc_test_srcs_common}
-  HermeticTestUtils.cpp
+      ${TEST_LIB_SRCS}
+      ${TEST_LIB_HDRS}
     )
-
-foreach(lib LibcUnitTest LibcHermeticTest)
     target_include_directories(${lib} PUBLIC ${LIBC_SOURCE_DIR})
     target_compile_options(${lib} PRIVATE -fno-exceptions -fno-rtti)
-  add_dependencies(${lib}
+  endforeach()
+  target_include_directories(${name}.hermetic PRIVATE ${LIBC_BUILD_DIR}/include)
+  target_compile_options(${name}.hermetic
+      PRIVATE ${LIBC_HERMETIC_TEST_COMPILE_OPTIONS} -ffreestanding -nostdinc++)
+
+  if(TEST_LIB_DEPENDS)
+    foreach(dep IN LISTS ${TEST_LIB_DEPENDS})
+      if(TARGET ${dep}.unit)
+        add_dependencies(${name}.unit ${dep}.unit)
+      else()
+        add_dependencies(${name}.unit ${dep})
+      endif()
+      if(TARGET ${dep}.hermetic)
+        add_dependencies(${name}.hermetic ${dep}.hermetic)
+      else()
+        add_dependencies(${name}.hermetic ${dep})
+      endif()
+    endforeach()
+  endif()
+endfunction()
+
+add_unittest_framework_library(
+  LibcTest
+  SRCS
+    CmakeFilePath.cpp
+    LibcTest.cpp
+    LibcTestMain.cpp
+    TestLogger.cpp
+  HDRS
+    LibcTest.h
+    Test.h
+    TestLogger.h
+  DEPENDS
     libc.src.__support.c_string
     libc.src.__support.CPP.string
     libc.src.__support.CPP.string_view
     libc.src.__support.CPP.type_traits
     libc.src.__support.OSUtil.osutil
     libc.src.__support.uint128
-  )
-endforeach()
 
-target_include_directories(LibcHermeticTest PRIVATE ${LIBC_BUILD_DIR}/include)
-target_compile_options(LibcHermeticTest
-    PRIVATE ${LIBC_HERMETIC_TEST_COMPILE_OPTIONS} -ffreestanding -nostdlib -nostdlib++)
+set(libc_death_test_srcs LibcDeathTestExecutors.cpp)
+if(${LIBC_TARGET_OS} STREQUAL "linux")
+  list(APPEND libc_death_test_srcs ExecuteFunctionUnix.cpp)
+endif()
+
+add_unittest_framework_library(
+  LibcDeathTestExecutors
+  SRCS
+    ${libc_death_test_srcs}
+  HDRS
+    ExecuteFunction.h
+)
+
+add_unittest_framework_library(
+  LibcHermeticTestSupport
+  SRCS
+    HermeticTestUtils.cpp
+)
 
 add_header_library(
   string_utils
   HDRS
     StringUtils.h
   DEPENDS
     libc.src.__support.CPP.string
     libc.src.__support.CPP.type_traits
 )
 
-add_library(
+add_unittest_framework_library(
   LibcFPTestHelpers
-  FPMatcher.h
+  SRCS
     RoundingModeUtils.cpp
+  HDRS
+    FPMatcher.h
     RoundingModeUtils.h
-)
-add_dependencies(
-  LibcFPTestHelpers
-  LibcUnitTest
+  DEPENDS
+    LibcTest
     libc.test.UnitTest.string_utils
     libc.src.__support.FPUtil.fp_bits
     libc.src.__support.FPUtil.fenv_impl
     libc.test.UnitTest.string_utils
 )
-add_library(
+
+add_unittest_framework_library(
   LibcFPExceptionHelpers
+  SRCS
     FPExceptMatcher.cpp
+  HDRS
     FPExceptMatcher.h
-)
-add_dependencies(
-  LibcFPExceptionHelpers
-  LibcUnitTest
+  DEPENDS
+    LibcTest
     libc.src.__support.FPUtil.fp_bits
     libc.src.__support.FPUtil.fenv_impl
 )
 
-add_library(
+add_unittest_framework_library(
   LibcMemoryHelpers
-  ${library_type}
-  MemoryMatcher.h
+  SRCS
     MemoryMatcher.cpp
-)
-add_dependencies(
-  LibcMemoryHelpers
-  LibcUnitTest
+  HDRS
+    MemoryMatcher.h
+  DEPENDS
+    LibcTest
     libc.src.__support.CPP.span
 )
 
-add_library(
+add_unittest_framework_library(
   LibcPrintfHelpers
-  PrintfMatcher.h
+  SRCS
     PrintfMatcher.cpp
-)
-add_dependencies(
-  LibcPrintfHelpers
-  LibcUnitTest
+  HDRS
+    PrintfMatcher.h
+  DEPENDS
+    LibcTest
     libc.src.__support.FPUtil.fp_bits
     libc.src.stdio.printf_core.core_structs
     libc.test.UnitTest.string_utils
 )
 
-add_library(
+add_unittest_framework_library(
   LibcScanfHelpers
-  ScanfMatcher.h
+  SRCS
     ScanfMatcher.cpp
-)
-add_dependencies(
-  LibcScanfHelpers
-  LibcUnitTest
+  HDRS
+    ScanfMatcher.h
+  DEPENDS
+    LibcTest
     libc.src.__support.FPUtil.fp_bits
     libc.src.stdio.scanf_core.core_structs
     libc.test.UnitTest.string_utils
 )
-
-foreach(lib LibcFPTestHelpers LibcFPExceptionHelpers LibcMemoryHelpers 
-            LibcPrintfHelpers LibcScanfHelpers)
-  target_include_directories(${lib} PUBLIC ${LIBC_SOURCE_DIR})
-  target_compile_options(${lib} PRIVATE -fno-exceptions -fno-rtti)
-  target_link_libraries(${lib} LibcUnitTest)
-endforeach()
-
-# The GPU needs these flags applied to override the system triple.
-if(LIBC_TARGET_ARCHITECTURE_IS_GPU)
-  foreach(lib LibcMemoryHelpers)
-    target_include_directories(${lib} PRIVATE ${LIBC_BUILD_DIR}/include)
-    target_compile_options(${lib}
-        PRIVATE ${LIBC_HERMETIC_TEST_COMPILE_OPTIONS} -ffreestanding -nostdlib -nostdlib++)
-  endforeach()
-endif()

libc/utils/MPFRWrapper/CMakeLists.txt

 if(LIBC_TESTS_CAN_USE_MPFR)
   add_library(libcMPFRWrapper
     MPFRUtils.cpp
     MPFRUtils.h
   )
   add_compile_options(
     -O3
   )
   add_dependencies(
     libcMPFRWrapper 
     libc.src.__support.CPP.string_view 
     libc.src.__support.CPP.type_traits 
     libc.src.__support.FPUtil.fp_bits
     libc.src.__support.FPUtil.platform_defs
-    LibcUnitTest
+    LibcTest.unit
   )
   if(EXISTS ${LLVM_LIBC_MPFR_INSTALL_PATH})
     target_include_directories(libcMPFRWrapper PUBLIC ${LLVM_LIBC_MPFR_INSTALL_PATH}/include)
     target_link_directories(libcMPFRWrapper PUBLIC ${LLVM_LIBC_MPFR_INSTALL_PATH}/lib)
   endif()
-  target_link_libraries(libcMPFRWrapper LibcFPTestHelpers LibcUnitTest mpfr gmp)
+  target_link_libraries(libcMPFRWrapper LibcFPTestHelpers.unit LibcTest.unit mpfr gmp)
 elseif(NOT LIBC_TARGET_ARCHITECTURE_IS_GPU)
   message(WARNING "Math tests using MPFR will be skipped.")
 endif()