[profile][test] Add -fuse-ld=bfd to make instrprof-lto-pgogen.c robust

[MaskRay]

Summary

Otherwise if 'ld' is an older system LLD (FreeBSD; or if someone adds 'ld' to
point to an LLD from a different installation) which does not support the
current ModuleSummaryIndex::BitCodeSummaryVersion, the test will fail.

Add lit feature 'binutils_lto'. GNU ld is more common than GNU gold, so
we can just require 'is_binutils_lto_supported' to additionally support GNU ld.

[myhsu]

According your problem statement, I think the correct way to approach it is to fix the environment (i.e. use the correct version of LLD) because apparently the root of cause is outdated linkers. In other words, your original argument can be extrapolated to outdated GNU as, outdated objdump, or even outdated shell. But I don't think it's a good idea to put version constrains on every of these items, or say "because it's possible that users are using an old version of bash shell, so let's use sh shell"

Also, I'm not sure if this test will work on platform that doesn't have BFD linker at all (e.g. Mac OSX). Although my original patch was fixing a problem targeting BFD linkers, but the original test (i.e. the one without -fuse-ld=bfd) will run on platforms (MSVC will fail but it's not caused by not finding a proper linker) regardless of what the system linker is, because the driver will handle that. But I'm worry that if you explicitly assign the linker to use, platforms without BFD linker will unable to fulfill your linker requirement and fail at the very early stage.

[MaskRay]

In D84133#2162498, @myhsu wrote:

According your problem statement, I think the correct way to approach it is to fix the environment (i.e. use the correct version of LLD) because apparently the root of cause is outdated linkers.

I don't agree with your statement. If you look at various UNSUPPORTED: XFAIL: changes to compiler-rt/test/, many changes are due to reasonable environment differences. On FreeBSD, /usr/bin/ld is a system LLD of an older version.

In other words, your original argument can be extrapolated to outdated GNU as, outdated objdump, or even outdated shell. But I don't think it's a good idea to put version constrains on every of these items, or say "because it's possible that users are using an old version of bash shell, so let's use sh shell"

That is why we can't use objdump, GNU as, readelf, etc. Instead, we use llvm-objdump, llvm-mc and llvm-readelf. I picked -fuse-ld=bfd because I saw -fuse-ld=gold which is already used in a few tests.

Also, I'm not sure if this test will work on platform that doesn't have BFD linker at all (e.g. Mac OSX). Although my original patch was fixing a problem targeting BFD linkers, but the original test (i.e. the one without -fuse-ld=bfd) will run on platforms (MSVC will fail but it's not caused by not finding a proper linker) regardless of what the system linker is, because the driver will handle that. But I'm worry that if you explicitly assign the linker to use, platforms without BFD linker will unable to fulfill your linker requirement and fail at the very early stage.

That was actually my original complaint. The test should be restricted to a few platforms where it makes sense.

[MaskRay]

REQUIRES linux

[arichardson]

compiler-rt/test/profile/instrprof-lto-pgogen.c

1

I wonder if this should be using a new REQUIRES: ld.bfd feature instead of assuming Linux means fuse-ld=bfd will work?

[myhsu]

compiler-rt/test/profile/instrprof-lto-pgogen.c

1

I think that's a good idea, it can solve many debates we discussed here

[MaskRay]

Add binutils_lto

[myhsu]

compiler-rt/test/lit.common.cfg.py

447

I think this line is redundant (duplicate with line 461)

[MaskRay]

Delete config.available_features.add('lto')

[myhsu]

Thank you!
LGTM

[MaskRay]

Fix a typo

compiler-rt/cmake/config-ix.cmake

if (IS_DIRECTORY ${MSVC_DIA_SDK_DIR})
     set(CAN_SYMBOLIZE 1)
   else()
     set(CAN_SYMBOLIZE 0)
   endif()
 else()
   set(CAN_SYMBOLIZE 1)
 endif()
 
-find_program(GOLD_EXECUTABLE NAMES ${LLVM_DEFAULT_TARGET_TRIPLE}-ld.gold ld.gold ${LLVM_DEFAULT_TARGET_TRIPLE}-ld ld DOC "The gold linker")
+find_program(GNU_LD_EXECUTABLE NAMES ${LLVM_DEFAULT_TARGET_TRIPLE}-ld.bfd ld.bfd DOC "GNU ld")
+find_program(GOLD_EXECUTABLE NAMES ${LLVM_DEFAULT_TARGET_TRIPLE}-ld.gold ld.gold DOC "GNU gold")
 
 if(COMPILER_RT_SUPPORTED_ARCH)
   list(REMOVE_DUPLICATES COMPILER_RT_SUPPORTED_ARCH)
 endif()
 message(STATUS "Compiler-RT supported architectures: ${COMPILER_RT_SUPPORTED_ARCH}")
 
 set(ALL_SANITIZERS asan;dfsan;msan;hwasan;tsan;safestack;cfi;scudo;ubsan_minimal;gwp_asan)
 set(COMPILER_RT_SANITIZERS_TO_BUILD all CACHE STRING

compiler-rt/test/lit.common.cfg.py

 sancovcc_path = os.path.join(config.llvm_tools_dir, "sancov")
 if os.path.exists(sancovcc_path):
   config.available_features.add("has_sancovcc")
   config.substitutions.append( ("%sancovcc ", sancovcc_path) )
 
 def is_darwin_lto_supported():
   return os.path.exists(os.path.join(config.llvm_shlib_dir, 'libLTO.dylib'))
 
-def is_linux_lto_supported():
-  if config.use_lld:
-    return True
-
+def is_binutils_lto_supported():
   if not os.path.exists(os.path.join(config.llvm_shlib_dir, 'LLVMgold.so')):
     return False
 
-  ld_cmd = subprocess.Popen([config.gold_executable, '--help'], stdout = subprocess.PIPE, env={'LANG': 'C'})
+  # We require both ld.bfd and ld.gold exist and support plugins. They are in
+  # the same repository 'binutils-gdb' and usually built together.
+  for exe in (config.gnu_ld_executable, config.gold_executable):
+    ld_cmd = subprocess.Popen([exe, '--help'], stdout=subprocess.PIPE, env={'LANG': 'C'})
     ld_out = ld_cmd.stdout.read().decode()
     ld_cmd.wait()
-
     if not '-plugin' in ld_out:
       return False
 
   return True
 
 def is_windows_lto_supported():
   return os.path.exists(os.path.join(config.llvm_tools_dir, 'lld-link.exe'))
 
 if config.host_os == 'Darwin' and is_darwin_lto_supported():
   config.lto_supported = True
   config.lto_launch = ["env", "DYLD_LIBRARY_PATH=" + config.llvm_shlib_dir]
   config.lto_flags = []
-elif config.host_os in ['Linux', 'FreeBSD', 'NetBSD'] and is_linux_lto_supported():
+elif config.host_os in ['Linux', 'FreeBSD', 'NetBSD']:
+  config.lto_supported = False
+  if config.use_lld:
+    config.lto_supported = True
+  if is_binutils_lto_supported():
+    config.available_features.add('binutils_lto')
     config.lto_supported = True
+
+  if config.lto_supported:
     config.lto_launch = []
     if config.use_lld:
       config.lto_flags = ["-fuse-ld=lld"]
     else:
       config.lto_flags = ["-fuse-ld=gold"]
 elif config.host_os == 'Windows' and is_windows_lto_supported():
   config.lto_supported = True
   config.lto_launch = []
   config.lto_flags = ["-fuse-ld=lld"]
 else:
   config.lto_supported = False
 
 if config.lto_supported:

compiler-rt/test/lit.common.configured.in

 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("enable_per_target_runtime_dir", @LLVM_ENABLE_PER_TARGET_RUNTIME_DIR_PYBOOL@)
 set_default("llvm_tools_dir", "@LLVM_TOOLS_DIR@")
 set_default("llvm_shlib_dir", "@LLVM_LIBRARY_OUTPUT_INTDIR@")
+set_default("gnu_ld_executable", "@GNU_LD_EXECUTABLE@")
 set_default("gold_executable", "@GOLD_EXECUTABLE@")
 set_default("clang", "@COMPILER_RT_RESOLVED_TEST_COMPILER@")
 set_default("compiler_id", "@COMPILER_RT_TEST_COMPILER_ID@")
 set_default("python_executable", "@Python3_EXECUTABLE@")
 set_default("compiler_rt_debug", @COMPILER_RT_DEBUG_PYBOOL@)
 set_default("compiler_rt_intercept_libdispatch", @COMPILER_RT_INTERCEPT_LIBDISPATCH_PYBOOL@)
 set_default("compiler_rt_libdir", "@COMPILER_RT_RESOLVED_LIBRARY_OUTPUT_DIR@")
 set_default("emulator", "@COMPILER_RT_EMULATOR@")

compiler-rt/test/profile/instrprof-lto-pgogen.c

-// REQUIRES: lto
-// XFAIL: msvc
+// REQUIRES: binutils_lto
 
-// RUN: %clang_pgogen=%t.profraw -flto %s -o %t
+// RUN: %clang_pgogen=%t.profraw -fuse-ld=bfd -flto %s -o %t
 // RUN: %run %t
 // RUN: llvm-profdata merge %t.profraw -o %t.profdata
 // RUN: llvm-profdata show %t.profdata | FileCheck %s
 
-// Testing a bug that happens when trying to generate IR
-// profile with BFD linker + LTO plugin
+/// Test that we work around https://sourceware.org/bugzilla/show_bug.cgi?id=26262
+/// (as of GNU ld 2.35) which happens when trying to generate IR profile with
+/// BFD linker + LLVMgold.so
 
 // CHECK: Instrumentation level: IR
 int main() { return 0; }