Allow compiler-rt test targets to work with multi-config CMake generators

[gbedwell]

Summary

Allow compiler-rt test targets to work with multi-config CMake generators

Multi-config CMake generators need lit to be able to resolve paths of
artifacts from previous build steps at lit time, rather than expect them
to be fully resolved at CMake time as they may contain the build mode.

Previously check-asan, etc failed due to not being able to resolve
"$(Configuration)" in various paths.

https://reviews.llvm.org/D38470 is a pre-requisite.

[rnk]

lgtm

test/lit.common.configured.in

19

I see, this has the same treatment in LLVM.

[mgorny]

Could you give me a few minutes to test it before merging, please?

[mgorny]

Well, I think I did everything right, yet I still get:

CMake Error at cmake/Modules/AddCompilerRT.cmake:521 (set_llvm_build_mode):
  Unknown CMake command "set_llvm_build_mode".
Call Stack (most recent call first):
  unittests/CMakeLists.txt:1 (configure_compiler_rt_lit_site_cfg)

AFAICS AddLLVM is not included anywhere if building stand-alone (that is, outside LLVM sources).

[rnk]

In D38471#886281, @mgorny wrote:

Well, I think I did everything right, yet I still get:

CMake Error at cmake/Modules/AddCompilerRT.cmake:521 (set_llvm_build_mode):
  Unknown CMake command "set_llvm_build_mode".
Call Stack (most recent call first):
  unittests/CMakeLists.txt:1 (configure_compiler_rt_lit_site_cfg)

AFAICS AddLLVM is not included anywhere if building stand-alone (that is, outside LLVM sources).

Did you apply the LLVM side change and install it locally to test? I believe AddLLVM.cmake is shipped in the install step...

[mgorny]

Yes, I did apply it both to the installed CMake files and the external LLVM source tree used by compiler-rt. I can't see where else it could have gotten an old version from, and I don't grep any AddLLVM includes either.

[beanz]

test/CMakeLists.txt

2

You can't remove this. We only include AddLLVM in the test directory so that we can support building compiler-rt without LLVM, but we need this if you want to support running tests when building out of tree.

unittests/CMakeLists.txt

2

Same as my earlier comment. You can't remove this.

[gbedwell]

Ah. Thanks! I tested my patches against multiple platforms and generators, but didn't test an external build. D'oh!

Given that I've moved the usages of AddLLVM items into AddCompilerRT.cmake does it make sense to move the include there too? I'm happy either way. Thanks everyone for reviewing!

[beanz]

You can put the include inside the function body of configure_compiler_rt_lit_site_cfg, but you can't put it just inside the file. By design AddCompilerRT is mostly usable without AddLLVM.

[gbedwell]

Sorry for the delay on this. I got pulled onto something else for a bit. I've put the include(AddLLVM) statements back and tested a standalone compiler-rt build (on Linux) too. Thanks again for taking a look.

[beanz]

LGTM.

cmake/Modules/AddCompilerRT.cmake

if(APPLE)
     endif()
     add_custom_command(TARGET ${name} POST_BUILD
       COMMAND xcrun dsymutil $<TARGET_FILE:${name}>
       ${strip_command})
   else()
     message(FATAL_ERROR "COMPILER_RT_EXTERNALIZE_DEBUGINFO isn't implemented for non-darwin platforms!")
   endif()
 endfunction()
+
+
+# Configure lit configuration files, including compiler-rt specific variables.
+function(configure_compiler_rt_lit_site_cfg input output)
+  set_llvm_build_mode()
+
+  string(REPLACE ${CMAKE_CFG_INTDIR} ${LLVM_BUILD_MODE} COMPILER_RT_RESOLVED_TEST_COMPILER ${COMPILER_RT_TEST_COMPILER})
+  string(REPLACE ${CMAKE_CFG_INTDIR} ${LLVM_BUILD_MODE} COMPILER_RT_RESOLVED_LIBRARY_OUTPUT_DIR ${COMPILER_RT_LIBRARY_OUTPUT_DIR})
+
+  configure_lit_site_cfg(${input} ${output})
+endfunction()

test/CMakeLists.txt

-# Needed for lit support
-include(AddLLVM)
-
-configure_lit_site_cfg(
+configure_compiler_rt_lit_site_cfg(
   ${CMAKE_CURRENT_SOURCE_DIR}/lit.common.configured.in
   ${CMAKE_CURRENT_BINARY_DIR}/lit.common.configured)
 
 # BlocksRuntime (and most of builtins) testsuites are not yet ported to lit.
 # add_subdirectory(BlocksRuntime)
 
 set(SANITIZER_COMMON_LIT_TEST_DEPS)
 

test/lit.common.cfg

else:
     # bash on Windows is usually very slow.
     execute_external = (not sys.platform in ['win32'])
 
 # Setup test format.
 config.test_format = lit.formats.ShTest(execute_external)
 if execute_external:
   config.available_features.add('shell')
 
-# Setup clang binary.
-compiler_path = getattr(config, 'clang', None)
-if (not compiler_path) or (not os.path.exists(compiler_path)):
-  lit_config.fatal("Can't find compiler on path %r" % compiler_path)
-
 compiler_id = getattr(config, 'compiler_id', None)
 if compiler_id == "Clang":
   if platform.system() != 'Windows':
     config.cxx_mode_flags = ["--driver-mode=g++"]
   else:
     config.cxx_mode_flags = []
   # We assume that sanitizers should provide good enough error
   # reports and stack traces even with minimal debug info.

test/lit.common.configured.in

 set_default("host_arch", "@HOST_ARCH@")
 set_default("target_arch", "@COMPILER_RT_DEFAULT_TARGET_ARCH@")
 set_default("host_os", "@HOST_OS@")
 set_default("llvm_build_mode", "@LLVM_BUILD_MODE@")
 set_default("llvm_src_root", "@LLVM_MAIN_SRC_DIR@")
 set_default("llvm_obj_root", "@LLVM_BINARY_DIR@")
 set_default("compiler_rt_src_root", "@COMPILER_RT_SOURCE_DIR@")
 set_default("compiler_rt_obj_root", "@COMPILER_RT_BINARY_DIR@")
-set_default("llvm_tools_dir", "@LLVM_TOOLS_BINARY_DIR@")
+set_default("llvm_tools_dir", "@LLVM_TOOLS_DIR@")
 set_default("llvm_shlib_dir", "@LLVM_LIBRARY_OUTPUT_INTDIR@")
 set_default("gold_executable", "@GOLD_EXECUTABLE@")
-set_default("clang", "@COMPILER_RT_TEST_COMPILER@")
+set_default("clang", "@COMPILER_RT_RESOLVED_TEST_COMPILER@")
 set_default("compiler_id", "@COMPILER_RT_TEST_COMPILER_ID@")
 set_default("python_executable", "@PYTHON_EXECUTABLE@")
 set_default("compiler_rt_debug", @COMPILER_RT_DEBUG_PYBOOL@)
-set_default("compiler_rt_libdir", "@COMPILER_RT_LIBRARY_OUTPUT_DIR@")
+set_default("compiler_rt_libdir", "@COMPILER_RT_RESOLVED_LIBRARY_OUTPUT_DIR@")
 set_default("emulator", "@COMPILER_RT_EMULATOR@")
 set_default("ios", False)
 set_default("iossim", False)
 set_default("sanitizer_can_use_cxxabi", @SANITIZER_CAN_USE_CXXABI_PYBOOL@)
 set_default("has_lld", @COMPILER_RT_HAS_LLD_PYBOOL@)
 set_default("can_symbolize", @CAN_SYMBOLIZE@)
 set_default("use_lld", False)
 set_default("use_thinlto", False)
 set_default("android", @ANDROID_PYBOOL@)
 config.available_features.add('target-is-%s' % config.target_arch)
 
 # LLVM tools dir can be passed in lit parameters, so try to
 # apply substitution.
 try:
   config.llvm_tools_dir = config.llvm_tools_dir % lit_config.params
+  config.clang = config.clang % lit_config.params
+  config.compiler_rt_libdir = config.compiler_rt_libdir % lit_config.params
 except KeyError as e:
   key, = e.args
   lit_config.fatal("unable to find %r parameter, use '--param=%s=VALUE'" % (key, key))
 
+if not os.path.exists(config.clang):
+  lit_config.fatal("Can't find compiler on path %r" % config.clang)
+
 # Setup attributes common for all compiler-rt projects.
 lit_config.load_config(config, "@COMPILER_RT_SOURCE_DIR@/test/lit.common.cfg")

unittests/CMakeLists.txt

-# Needed for lit support
-include(AddLLVM)
-
-configure_lit_site_cfg(
+configure_compiler_rt_lit_site_cfg(
   ${CMAKE_CURRENT_SOURCE_DIR}/lit.common.unit.configured.in
   ${CMAKE_CURRENT_BINARY_DIR}/lit.common.unit.configured)

unittests/lit.common.unit.configured.in

 @LIT_SITE_CFG_IN_HEADER@
 
 # Generic config options for all compiler-rt unit tests.
 config.target_triple = "@TARGET_TRIPLE@"
 config.llvm_src_root = "@LLVM_MAIN_SRC_DIR@"
 config.llvm_obj_root = "@LLVM_BINARY_DIR@"
-config.llvm_tools_dir = "@LLVM_TOOLS_BINARY_DIR@"
+config.llvm_tools_dir = "@LLVM_TOOLS_DIR@"
 config.compiler_rt_src_root = "@COMPILER_RT_SOURCE_DIR@"
-config.compiler_rt_libdir = "@COMPILER_RT_LIBRARY_OUTPUT_DIR@"
+config.compiler_rt_libdir = "@COMPILER_RT_RESOLVED_LIBRARY_OUTPUT_DIR@"
 config.llvm_build_mode = "@LLVM_BUILD_MODE@"
 config.host_arch = "@HOST_ARCH@"
 config.host_os = "@HOST_OS@"
 
 # LLVM tools dir and build mode can be passed in lit parameters,
 # so try to apply substitution.
 try:
   config.llvm_tools_dir = config.llvm_tools_dir % lit_config.params
+  config.compiler_rt_libdir = config.compiler_rt_libdir % lit_config.params
   config.llvm_build_mode = config.llvm_build_mode % lit_config.params
 except KeyError as e:
   key, = e.args
   lit_config.fatal("unable to find %r parameter, use '--param=%s=VALUE'" % (key, key))
 
 # Setup attributes common for all compiler-rt unit tests.
 lit_config.load_config(config, "@COMPILER_RT_SOURCE_DIR@/unittests/lit.common.unit.cfg")