[runtimes] Detect changes to Tests.cmake

[phosek]

Summary

This ensures that Tests.cmake is tracked by Ninja and any changes to
this file from the subbuilds are correctly detected.

[phosek]

@ldionne would you be willing to accept this? This should address the issue reported in D121276.

[ldionne]

In D121647#3386791, @phosek wrote:

@ldionne would you be willing to accept this? This should address the issue reported in D121276.

I don't see something fundamentally wrong with it, but CI isn't passing on the Bootstrapping build, so it looks like something's off. Sorry, I was waiting for CI to be green before reviewing.

[ldionne]

llvm/runtimes/CMakeLists.txt

225

I'm a bit confused -- doesn't this mean that we're going to include an empty Tests.cmake file and hence all the LLVM_RUNTIMES_LIT_TESTSUITES & friends below will expand to nothing?

[phosek]

In D121647#3386971, @ldionne wrote:

In D121647#3386791, @phosek wrote:

@ldionne would you be willing to accept this? This should address the issue reported in D121276.

I don't see something fundamentally wrong with it, but CI isn't passing on the Bootstrapping build, so it looks like something's off. Sorry, I was waiting for CI to be green before reviewing.

I think I understand the issue, I'll upload a new version soon.

llvm/runtimes/CMakeLists.txt

225

Yes, this is just so we can include this file unconditionally below which is only necessary during the clean build. We could also use include(... OPTIONAL) but in my experience that didn't result in Tests.cmake being properly tracked by Ninja until you re-run CMake.

[phosek]

llvm/runtimes/CMakeLists.txt

225

Turned out this is no longer need with BYPRODUCTS.

[jdenny]

The version of this patch that landed did not fix the openmp problem caused by D121276. I backed it out (locally) and applied the version that I originally tested on 3/15, and all seems fine (that is, check-all includes openmp tests). I'm testing at 3edec279dfa7.

[jdenny]

In D121647#3396314, @jdenny wrote:

The version of this patch that landed did not fix the openmp problem caused by D121276. I backed it out (locally) and applied the version that I originally tested on 3/15, and all seems fine (that is, check-all includes openmp tests). I'm testing at 3edec279dfa7.

@phosek I'm concerned I wasn't clear here: things are still broken upstream. check-all still doesn't include openmp tests.

The May 15 version of this patch does fix it. Can you apply something more like it?

Thanks.

llvm/cmake/modules/LLVMExternalProjectUtils.cmake

 #   EXTRA_TARGETS targets...
 #     Extra targets in the subproject to generate targets for
 #   PASSTHROUGH_PREFIXES prefix...
 #     Extra variable prefixes (name is always included) to pass down
 #   STRIP_TOOL path
 #     Use provided strip tool instead of the default one.
 #   TARGET_TRIPLE triple
 #     Optional target triple to pass to the compiler
+#   BYPRODUCTS files...
+#     Files generated as a byproduct of this build.
 #   )
 function(llvm_ExternalProject_Add name source_dir)
   cmake_parse_arguments(ARG
     "USE_TOOLCHAIN;EXCLUDE_FROM_ALL;NO_INSTALL;ALWAYS_CLEAN"
     "SOURCE_DIR"
-    "CMAKE_ARGS;TOOLCHAIN_TOOLS;RUNTIME_LIBRARIES;DEPENDS;EXTRA_TARGETS;PASSTHROUGH_PREFIXES;STRIP_TOOL;TARGET_TRIPLE"
+    "CMAKE_ARGS;TOOLCHAIN_TOOLS;RUNTIME_LIBRARIES;DEPENDS;EXTRA_TARGETS;PASSTHROUGH_PREFIXES;STRIP_TOOL;TARGET_TRIPLE;BYPRODUCTS"
     ${ARGN})
   canonicalize_tool_name(${name} nameCanon)
 
   foreach(arg ${ARG_CMAKE_ARGS})
     if(arg MATCHES "^-DCMAKE_SYSTEM_NAME=")
       string(REGEX REPLACE "^-DCMAKE_SYSTEM_NAME=(.*)$" "\\1" _cmake_system_name "${arg}")
     endif()
   endforeach()
CMAKE_ARGS ${${nameCanon}_CMAKE_ARGS}
                -DCMAKE_C_COMPILER_LAUNCHER=${CMAKE_C_COMPILER_LAUNCHER}
                -DCMAKE_CXX_COMPILER_LAUNCHER=${CMAKE_CXX_COMPILER_LAUNCHER}
                -DCMAKE_EXPORT_COMPILE_COMMANDS=1
                ${cmake_args}
                ${PASSTHROUGH_VARIABLES}
     INSTALL_COMMAND ""
     STEP_TARGETS configure build
     BUILD_ALWAYS 1
+    BUILD_BYPRODUCTS ${ARG_BYPRODUCTS}
     USES_TERMINAL_CONFIGURE 1
     USES_TERMINAL_BUILD 1
     USES_TERMINAL_INSTALL 1
     LIST_SEPARATOR |
     )
 
   if(ARG_USE_TOOLCHAIN)
     set(force_deps DEPENDS ${TOOLCHAIN_BINS})

llvm/runtimes/CMakeLists.txt

function(runtime_default_target)
   endforeach()
   foreach(component ${LLVM_RUNTIME_DISTRIBUTION_COMPONENTS})
     if(NOT ${component} IN_LIST SUB_COMPONENTS)
       list(APPEND extra_targets ${component} install-${component} install-${component}-stripped)
     endif()
   endforeach()
 
   if(LLVM_INCLUDE_TESTS)
-    include(${LLVM_BINARY_DIR}/runtimes/Tests.cmake OPTIONAL RESULT_VARIABLE have_tests)
-    set_property(DIRECTORY APPEND PROPERTY CMAKE_CONFIGURE_DEPENDS ${LLVM_BINARY_DIR}/runtimes/Tests.cmake)
-    if(have_tests)
-      set_property(GLOBAL APPEND PROPERTY LLVM_LIT_TESTSUITES ${RUNTIMES_LIT_TESTSUITES})
-      set_property(GLOBAL APPEND PROPERTY LLVM_LIT_PARAMS ${RUNTIMES_LIT_PARAMS})
-      set_property(GLOBAL APPEND PROPERTY LLVM_LIT_EXTRA_ARGS ${RUNTIMES_LIT_EXTRA_ARGS})
+    if (NOT EXISTS ${LLVM_BINARY_DIR}/runtimes/Tests.cmake)
+      # This file will be later replaced by the runtimes subbuild.
+      file(TOUCH ${LLVM_BINARY_DIR}/runtimes/Tests.cmake)
     endif()
+    include(${LLVM_BINARY_DIR}/runtimes/Tests.cmake)
+    set_property(DIRECTORY APPEND PROPERTY CMAKE_CONFIGURE_DEPENDS ${LLVM_BINARY_DIR}/runtimes/Tests.cmake)
+    set_property(GLOBAL APPEND PROPERTY LLVM_LIT_TESTSUITES ${LLVM_RUNTIMES_LIT_TESTSUITES})
+    set_property(GLOBAL APPEND PROPERTY LLVM_LIT_PARAMS ${LLVM_RUNTIMES_LIT_PARAMS})
+    set_property(GLOBAL APPEND PROPERTY LLVM_LIT_EXTRA_ARGS ${LLVM_RUNTIMES_LIT_EXTRA_ARGS})
     list(APPEND test_targets runtimes-test-depends check-runtimes)
   endif()
 
   set(LLVM_ENABLE_PER_TARGET_RUNTIME_DIR_default ON)
   # AIX should fold 32-bit & 64-bit arch libraries into a single archive.
   if (LLVM_TARGET_TRIPLE MATCHES "aix")
     set(LLVM_ENABLE_PER_TARGET_RUNTIME_DIR_default OFF)
   endif()
llvm_ExternalProject_Add(runtimes
                                                 ${ARG_PREFIXES}
                            EXTRA_TARGETS ${extra_targets}
                                          ${test_targets}
                                          ${SUB_COMPONENTS}
                                          ${SUB_CHECK_TARGETS}
                                          ${SUB_INSTALL_TARGETS}
                            USE_TOOLCHAIN
                            TARGET_TRIPLE ${LLVM_TARGET_TRIPLE}
+                           BYPRODUCTS ${LLVM_BINARY_DIR}/runtimes/Tests.cmake
                            ${EXTRA_ARGS})
 endfunction()
 
 # runtime_register_target(target)
 #   Utility function to register external runtime target.
 function(runtime_register_target name target)
   cmake_parse_arguments(ARG "" "" "DEPENDS;CMAKE_ARGS" ${ARGN})
   include(${LLVM_BINARY_DIR}/runtimes/${name}/Components.cmake OPTIONAL)
function(runtime_register_target name target)
   foreach(component ${LLVM_RUNTIME_DISTRIBUTION_COMPONENTS})
     set(${component}-${name} ${component})
     set(install-${component}-${name} install-${component})
     set(install-${component}-${name}-stripped install-${component}-stripped)
     list(APPEND ${name}_extra_targets ${component}-${name} install-${component}-${name} install-${component}-${name}-stripped)
   endforeach()
 
   if(LLVM_INCLUDE_TESTS)
-    include(${LLVM_BINARY_DIR}/runtimes/${name}/Tests.cmake OPTIONAL RESULT_VARIABLE have_tests)
-    set_property(DIRECTORY APPEND PROPERTY CMAKE_CONFIGURE_DEPENDS ${LLVM_BINARY_DIR}/runtimes/${name}/Tests.cmake)
-    if(have_tests)
-      set_property(GLOBAL APPEND PROPERTY LLVM_LIT_TESTSUITES ${RUNTIMES_LIT_TESTSUITES})
-      set_property(GLOBAL APPEND PROPERTY LLVM_LIT_PARAMS ${RUNTIMES_LIT_PARAMS})
-      set_property(GLOBAL APPEND PROPERTY LLVM_LIT_EXTRA_ARGS ${RUNTIMES_LIT_EXTRA_ARGS})
+    if (NOT EXISTS ${LLVM_BINARY_DIR}/runtimes/${name}/Tests.cmake)
+      # This file will be later replaced by the runtimes subbuild.
+      file(TOUCH ${LLVM_BINARY_DIR}/runtimes/${name}/Tests.cmake)
     endif()
+    include(${LLVM_BINARY_DIR}/runtimes/${name}/Tests.cmake)
+    set_property(DIRECTORY APPEND PROPERTY CMAKE_CONFIGURE_DEPENDS ${LLVM_BINARY_DIR}/runtimes/${name}/Tests.cmake)
+    set_property(GLOBAL APPEND PROPERTY LLVM_LIT_TESTSUITES ${LLVM_RUNTIMES_LIT_TESTSUITES})
+    set_property(GLOBAL APPEND PROPERTY LLVM_LIT_PARAMS ${LLVM_RUNTIMES_LIT_PARAMS})
+    set_property(GLOBAL APPEND PROPERTY LLVM_LIT_EXTRA_ARGS ${LLVM_RUNTIMES_LIT_EXTRA_ARGS})
     set(runtimes-test-depends-${name} runtimes-test-depends)
     set(check-runtimes-${name} check-runtimes)
     list(APPEND ${name}_test_targets runtimes-test-depends-${name} check-runtimes-${name})
     list(APPEND test_targets ${${name}_test_targets})
     foreach(target_name IN LISTS SUB_CHECK_TARGETS)
       set(${target_name}-${name} ${target_name})
       list(APPEND ${name}_test_targets ${target_name}-${name})
       list(APPEND test_targets ${target_name}-${name})
llvm_ExternalProject_Add(runtimes-${name}
                                       -DLLVM_RUNTIMES_TARGET=${name}
                                       ${COMMON_CMAKE_ARGS}
                                       ${${name}_extra_args}
                            PASSTHROUGH_PREFIXES LLVM_USE_LINKER
                            EXTRA_TARGETS ${${name}_extra_targets}
                                          ${${name}_test_targets}
                            USE_TOOLCHAIN
                            TARGET_TRIPLE ${target}
+                           BYPRODUCTS ${LLVM_BINARY_DIR}/runtimes/${name}/Tests.cmake
                            ${EXTRA_ARGS})
 endfunction()
 
 if(runtimes)
   # Create a runtimes target that uses this file as its top-level CMake file.
   # The runtimes target is a configuration of all the runtime libraries
   # together in a single CMake invocaiton.
   set(extra_deps "")

runtimes/Tests.cmake.in

-set(RUNTIMES_LIT_TESTSUITES @RUNTIMES_LIT_TESTSUITES@)
-set(RUNTIMES_LIT_PARAMS @RUNTIMES_LIT_PARAMS@)
-set(RUNTIMES_LIT_EXTRA_ARGS @RUNTIMES_LIT_EXTRA_ARGS@)
+set(LLVM_RUNTIMES_LIT_TESTSUITES @RUNTIMES_LIT_TESTSUITES@)
+set(LLVM_RUNTIMES_LIT_PARAMS @RUNTIMES_LIT_PARAMS@)
+set(LLVM_RUNTIMES_LIT_EXTRA_ARGS @RUNTIMES_LIT_EXTRA_ARGS@)