[lit] Only set DYLD_LIBRARY_PATH for shared builds

[JDevlieghere]

Summary

In r370135 I committed a temporary workaround for the sanitized bot to not set (DY)LD_LIBRARY_PATH when (DY)LD_INSERT_LIBRARIES was set. Setting (DY)LD_LIBRARY_PATH is only necessary for (standalone) shared-library builds, so a better solution is to only set the environment variable when necessary.

[friss]

This looks good to me with one small provision:

lldb/lit/CMakeLists.txt

72

The other booleans have names that match boolean values (_DISABLE_, _ENABLE_, _IS_). Should we rename this to something like LLVM_IS_SHARED_BUILD? I'm terrible at names.

lldb/lit/CMakeLists.txt

 if(TARGET lld)
   list(APPEND LLDB_TEST_DEPS lld)
 endif()
 
 # the value is not canonicalized within LLVM
 llvm_canonicalize_cmake_booleans(
   LLDB_DISABLE_PYTHON
   LLVM_ENABLE_ZLIB
+  LLVM_SHARED_LIBS
   LLDB_IS_64_BITS)
 
 configure_lit_site_cfg(
   ${CMAKE_CURRENT_SOURCE_DIR}/lit.site.cfg.py.in
   ${CMAKE_CURRENT_BINARY_DIR}/lit.site.cfg.py
   MAIN_CONFIG
   ${CMAKE_CURRENT_SOURCE_DIR}/lit.cfg.py)
 configure_lit_site_cfg(

lldb/lit/Suite/lit.cfg

 def find_shlibpath_var():
   if platform.system() in ['Linux', 'FreeBSD', 'NetBSD', 'SunOS']:
     yield 'LD_LIBRARY_PATH'
   elif platform.system() == 'Darwin':
     yield 'DYLD_LIBRARY_PATH'
   elif platform.system() == 'Windows':
     yield 'PATH'
 
-if not 'DYLD_INSERT_LIBRARIES' in config.environment:
-  # Shared library build of LLVM may require LD_LIBRARY_PATH or equivalent.
-  # This clashes with DYLD_INSERT_LIBRARIES which is needed on Darwin.
+if config.shared_libs:
   for shlibpath_var in find_shlibpath_var():
     # In stand-alone build llvm_shlib_dir specifies LLDB's lib directory while
     # llvm_libs_dir specifies LLVM's lib directory.
     shlibpath = os.path.pathsep.join(
-      (config.llvm_shlib_dir,
-      config.llvm_libs_dir,
+        (config.llvm_shlib_dir, config.llvm_libs_dir,
          config.environment.get(shlibpath_var, '')))
     config.environment[shlibpath_var] = shlibpath
-    break
   else:
-    lit_config.warning("unable to inject shared library path on '{}'"
-                      .format(platform.system()))
+    lit_config.warning("unable to inject shared library path on '{}'".format(
+        platform.system()))
 
 # Build dotest command.
 dotest_cmd = [config.dotest_path]
 dotest_cmd.extend(config.dotest_args_str.split(';'))
 
 # We don't want to force users passing arguments to lit to use `;` as a
 # separator. We use Python's simple lexical analyzer to turn the args into a
 # list.

lldb/lit/Suite/lit.site.cfg.in

 @LIT_SITE_CFG_IN_HEADER@
 
 config.test_exec_root = "@LLDB_BINARY_DIR@"
 config.llvm_src_root = "@LLVM_SOURCE_DIR@"
 config.llvm_obj_root = "@LLVM_BINARY_DIR@"
 config.llvm_tools_dir = "@LLVM_TOOLS_DIR@"
 config.llvm_libs_dir = "@LLVM_LIBS_DIR@"
 config.llvm_shlib_dir = "@SHLIBDIR@"
 config.llvm_build_mode = "@LLVM_BUILD_MODE@"
 config.lit_tools_dir = "@LLVM_LIT_TOOLS_DIR@"
 config.lldb_obj_root = "@LLDB_BINARY_DIR@"
 config.lldb_src_root = "@LLDB_SOURCE_DIR@"
 config.cmake_cxx_compiler = "@CMAKE_CXX_COMPILER@"
 config.host_os = "@HOST_OS@"
 config.host_triple = "@LLVM_HOST_TRIPLE@"
+config.shared_libs = "@LLVM_SHARED_LIBS@"
 config.llvm_use_sanitizer = "@LLVM_USE_SANITIZER@"
 config.target_triple = "@TARGET_TRIPLE@"
 config.lldb_build_directory = "@LLDB_TEST_BUILD_DIRECTORY@"
 config.lldb_module_cache = "@LLDB_TEST_MODULE_CACHE_LLDB@"
 config.clang_module_cache = "@LLDB_TEST_MODULE_CACHE_CLANG@"
 config.python_executable = "@PYTHON_EXECUTABLE@"
 config.dotest_path = "@LLDB_SOURCE_DIR@/test/dotest.py"
 config.dotest_args_str = "@LLDB_DOTEST_ARGS@"

llvm/cmake/modules/LLVMConfig.cmake.in

 
 set(LLVM_DEFINITIONS "@LLVM_DEFINITIONS@")
 set(LLVM_CMAKE_DIR "@LLVM_CONFIG_CMAKE_DIR@")
 set(LLVM_BINARY_DIR "@LLVM_CONFIG_BINARY_DIR@")
 set(LLVM_TOOLS_BINARY_DIR "@LLVM_CONFIG_TOOLS_BINARY_DIR@")
 set(LLVM_TOOLS_INSTALL_DIR "@LLVM_TOOLS_INSTALL_DIR@")
 set(LLVM_HAVE_OPT_VIEWER_MODULES @LLVM_HAVE_OPT_VIEWER_MODULES@)
 set(LLVM_CONFIGURATION_TYPES @CMAKE_CONFIGURATION_TYPES@)
+set(LLVM_SHARED_LIBS @BUILD_SHARED_LIBS@)
 
 if(NOT TARGET LLVMSupport)
   set(LLVM_EXPORTED_TARGETS "@LLVM_CONFIG_EXPORTS@")
   include("@LLVM_CONFIG_EXPORTS_FILE@")
   @llvm_config_include_buildtree_only_exports@
 endif()
 
 # By creating intrinsics_gen here, subprojects that depend on LLVM's
 # tablegen-generated headers can always depend on this target whether building
 # in-tree with LLVM or not.
 if(NOT TARGET intrinsics_gen)
   add_custom_target(intrinsics_gen)
 endif()
 
 set_property(GLOBAL PROPERTY LLVM_TARGETS_CONFIGURED On)
 include(${LLVM_CMAKE_DIR}/LLVM-Config.cmake)