Add CMake option not to build BOLT tests

[Amir]

Can you please elaborate the goal? BOLT tests are disabled if LLVM tests are disabled (LLVM_INCLUDE_TESTS=OFF), or if prerequisites are not met (clang/lld are not built or not specified via BOLT_{CLANG,LLD}_EXE). Likewise, they are enabled if LLVM_INCLUDE_TESTS is on.
If the goal is to control BOLT tests independent from LLVM tests, can you please confirm by specifying LLVM_INCLUDE_TESTS=ON and BOLT_INCLUDE_TESTS=OFF and vice versa.

[kongyi]

In D120808#3355123, @Amir wrote:

Can you please elaborate the goal? BOLT tests are disabled if LLVM tests are disabled (LLVM_INCLUDE_TESTS=OFF), or if prerequisites are not met (clang/lld are not built or not specified via BOLT_{CLANG,LLD}_EXE). Likewise, they are enabled if LLVM_INCLUDE_TESTS is on.
If the goal is to control BOLT tests independent from LLVM tests, can you please confirm by specifying LLVM_INCLUDE_TESTS=ON and BOLT_INCLUDE_TESTS=OFF and vice versa.

BOLT_INCLUDE_TESTS also controls whether merge-fdata gets built with relocation. My goal is to build LLVM with tests but without relocation for merge-fdata.

[Amir]

In D120808#3355222, @kongyi wrote:

In D120808#3355123, @Amir wrote:

Can you please elaborate the goal? BOLT tests are disabled if LLVM tests are disabled (LLVM_INCLUDE_TESTS=OFF), or if prerequisites are not met (clang/lld are not built or not specified via BOLT_{CLANG,LLD}_EXE). Likewise, they are enabled if LLVM_INCLUDE_TESTS is on.
If the goal is to control BOLT tests independent from LLVM tests, can you please confirm by specifying LLVM_INCLUDE_TESTS=ON and BOLT_INCLUDE_TESTS=OFF and vice versa.

BOLT_INCLUDE_TESTS also controls whether merge-fdata gets built with relocation. My goal is to build LLVM with tests but without relocation for merge-fdata.

Makes sense. Although why is building with relocs a problem? (It might be a problem with gold linker that doesn't accept -emit-relocs together with -icf or -gc-sections)

bolt/CMakeLists.txt

17

Should this definition also be changed to set a cache entry?

29

Add FORCE to override a cache entry in case prerequisites are not met

[kongyi]

In D120808#3355730, @Amir wrote:

In D120808#3355222, @kongyi wrote:

In D120808#3355123, @Amir wrote:

Can you please elaborate the goal? BOLT tests are disabled if LLVM tests are disabled (LLVM_INCLUDE_TESTS=OFF), or if prerequisites are not met (clang/lld are not built or not specified via BOLT_{CLANG,LLD}_EXE). Likewise, they are enabled if LLVM_INCLUDE_TESTS is on.
If the goal is to control BOLT tests independent from LLVM tests, can you please confirm by specifying LLVM_INCLUDE_TESTS=ON and BOLT_INCLUDE_TESTS=OFF and vice versa.

BOLT_INCLUDE_TESTS also controls whether merge-fdata gets built with relocation. My goal is to build LLVM with tests but without relocation for merge-fdata.

Makes sense. Although why is building with relocs a problem? (It might be a problem with gold linker that doesn't accept -emit-relocs together with -icf or -gc-sections)

Due to some Darwin specific issues, we can only --strip-debug on the final library instead of --strip-all, and this causes error (symbol named in a relocation).

[Amir]

Please address the feedback, but otherwise LGTM. The proper way to solve the problem you're running into would be to disable relocs for merge-fdata and meta merge-fdata test on Darwin host, but it's orthogonal to disabling BOLT tests separate from the rest of LLVM tests. I'll take care of it.

In D120808#3356175, @kongyi wrote:

In D120808#3355730, @Amir wrote:

In D120808#3355222, @kongyi wrote:

In D120808#3355123, @Amir wrote:

Can you please elaborate the goal? BOLT tests are disabled if LLVM tests are disabled (LLVM_INCLUDE_TESTS=OFF), or if prerequisites are not met (clang/lld are not built or not specified via BOLT_{CLANG,LLD}_EXE). Likewise, they are enabled if LLVM_INCLUDE_TESTS is on.
If the goal is to control BOLT tests independent from LLVM tests, can you please confirm by specifying LLVM_INCLUDE_TESTS=ON and BOLT_INCLUDE_TESTS=OFF and vice versa.

BOLT_INCLUDE_TESTS also controls whether merge-fdata gets built with relocation. My goal is to build LLVM with tests but without relocation for merge-fdata.

Makes sense. Although why is building with relocs a problem? (It might be a problem with gold linker that doesn't accept -emit-relocs together with -icf or -gc-sections)

Due to some Darwin specific issues, we can only --strip-debug on the final library instead of --strip-all, and this causes error (symbol named in a relocation).

[Amir]

@kongyi

I've double checked the test and I'm not sure why you're running into issues with it:

• emit-relocs shouldn't be set for Darwin (https://github.com/llvm/llvm-project/blob/main/bolt/tools/merge-fdata/CMakeLists.txt#L11)

# Emit relocations for BOLT meta test (bolt/test/runtime/meta-merge-fdata.test)
if (BOLT_INCLUDE_TESTS AND UNIX AND NOT APPLE)
  target_link_options(merge-fdata PRIVATE LINKER:--emit-relocs)
endif()

• meta-merge-fdata.test should only be enabled on linux: (https://github.com/llvm/llvm-project/blob/main/bolt/test/runtime/meta-merge-fdata.test#L4)

REQUIRES: x86_64-linux

bolt/CMakeLists.txt

 include(ExternalProject)
 
 set(BOLT_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR})
 set(BOLT_BINARY_DIR ${CMAKE_CURRENT_BINARY_DIR})
 set(CMAKE_CXX_STANDARD 14)
 
 set(BOLT_ENABLE_RUNTIME OFF)
 if (CMAKE_HOST_SYSTEM_PROCESSOR MATCHES "x86_64")
   set(BOLT_ENABLE_RUNTIME ON)
 endif()
 
 set(BOLT_CLANG_EXE "" CACHE FILEPATH "Path to clang executable for the target \
 architecture for use in BOLT tests")
 set(BOLT_LLD_EXE "" CACHE FILEPATH "Path to lld executable for the target \
 architecture for use in BOLT tests")
 
 set(BOLT_INCLUDE_TESTS OFF)
 if (LLVM_INCLUDE_TESTS)
   if ("clang" IN_LIST LLVM_ENABLE_PROJECTS OR BOLT_CLANG_EXE)
     if ("clang" IN_LIST LLVM_ENABLE_PROJECTS AND BOLT_CLANG_EXE)
       message(WARNING "BOLT_CLANG_EXE is set and clang project is enabled. \
             BOLT_CLANG_EXE will be used for BOLT tests.")
     endif()
     if ("lld" IN_LIST LLVM_ENABLE_PROJECTS OR BOLT_LLD_EXE)
       if ("lld" IN_LIST LLVM_ENABLE_PROJECTS AND BOLT_LLD_EXE)
         message(WARNING "BOLT_LLD_EXE is set and lld project is enabled. \
               BOLT_LLD_EXE will be used for BOLT tests.")
       endif()
-      set(BOLT_INCLUDE_TESTS ON)
+      set(BOLT_INCLUDE_TESTS ON CACHE BOOL "Build BOLT tests")
     else()
       message(WARNING "Not including BOLT tests since lld is disabled. \
             Enable lld in LLVM_ENABLE_PROJECTS or provide a path to lld binary \
             in BOLT_LLD_EXE.")
     endif()
   else()
     message(WARNING "Not including BOLT tests since clang is disabled. \
           Enable clang in LLVM_ENABLE_PROJECTS or provide a path to clang \