[BOLT][CMake] Redo the build and install targets

[phosek]

Summary

The existing BOLT install targets are broken on Windows because they
don't properly handle the output extension. We cannot use the existing
LLVM macros since those make assumptions that don't hold for BOLT. This
change instead implements custom macros following the approach used by
Clang and LLD.

[phosek]

Ping, our toolchain build on Windows is currently broken because of BOLT and I verified that this change resolves the issue so I'd appreciate a review.

[smeenai]

LGTM. Sorry for the delay, I was out for Memorial Day weekend.

[phosek]

I had to redo the patch after investigating the builder failure and better understanding the intention of the original code.

[phosek]

There's still an issue where only bolt is included in LLVM_DISTRIBUTION_COMPONENTS and not individual tools such as llvm-bolt because then the install targets won't be created because of https://github.com/llvm/llvm-project/blob/c7eb1b07470b9babfcd258f014df3661e5f84b30/llvm/cmake/modules/AddLLVM.cmake#L1348. Unfortunately this scenario where the name of the component is different from the tool itself is currently supported in the LLVM build.

[phosek]

@smeenai Do you have any thoughts on this? I don't actually know how to fix this. The intention seems to be allow the use of the bolt target/component as a grouping for other BOLT targets such as llvm-bolt or bolt_rt, so you can only include bolt in LLVM_DISTRIBUTION_COMPONENT. I understand why that may be desirable, but that breaks many of the assumptions that existing macros make and I don't know how to easily fix it.

[smeenai]

Hmm, could we extend the existing umbrella target support for things like llvm-libraries and clang-libraries to cover the BOLT case as well?

bolt/tools/driver/CMakeLists.txt

38

I assume this should be add_dependencies?

41

This should depend on the stripped target?

[phosek]

In D151595#4382652, @smeenai wrote:

Hmm, could we extend the existing umbrella target support for things like llvm-libraries and clang-libraries to cover the BOLT case as well?

I have opted for an approach that's similar to the one used by Clang and LLD, although the handling of components is different to preserve the existing behavior. This seems to be working in my local testing.

[smeenai]

Makes sense, though @Amir should also take a look.

bolt/CMakeLists.txt

122

Where is BOLT_DEPENDS being set now?

The CMake docs say DEPENDS should only be used for add_custom_command outputs in the same folder, and add_dependencies for everything else, so we want the latter here. I know this is just moving existing code, but we may as well fix that while we're here. I don't think it makes any difference for Ninja, but it might for other generators?

bolt/tools/heatmap/CMakeLists.txt

8

Why this change?

[phosek]

@Amir does this change look good to you?

bolt/tools/heatmap/CMakeLists.txt

8

This tool wasn't previously included in the bolt umbrella target so I assume that it doesn't need an install target, but I'd be helpful for @Amir to confirm.

[Amir]

In D151595#4385506, @phosek wrote:

@Amir does this change look good to you?

Looks good overall. Thanks for adding AddBolt cmake module. Testing the build internally, will reply shortly.

[Amir]

bolt/test/CMakeLists.txt

40

We have a number of dependencies on llvm-boltdiff and perf2bolt, e.g. in internal and upstream binary tests: https://github.com/rafaelauler/bolt-tests/blob/main/CMakeLists.txt#L22. Can we keep these targets somehow?

bolt/tools/heatmap/CMakeLists.txt

8

It wasn't included by omission. Let's include it into the umbrella target.

[phosek]

bolt/test/CMakeLists.txt

40

These symlinks are now always generated, see the ALWAYS_GENERATED option in add_bolt_tool_symlink so there's no need to specify those as targets here separately.

[Amir]

Thanks. Will update the dependencies, removing always-installed symlinks.

[Amir]

Merged the PR. Please reland

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 17)
 
+# Add path for custom modules.
+list(INSERT CMAKE_MODULE_PATH 0 "${BOLT_SOURCE_DIR}/cmake/modules")
+
 # Determine default set of targets to build -- the intersection of
 # those BOLT supports and those LLVM is targeting.
 set(BOLT_TARGETS_TO_BUILD_all "AArch64;X86")
 set(BOLT_TARGETS_TO_BUILD_default)
 foreach (tgt ${BOLT_TARGETS_TO_BUILD_all})
   if (tgt IN_LIST LLVM_TARGETS_TO_BUILD)
     list(APPEND BOLT_TARGETS_TO_BUILD_default ${tgt})
   endif()
install(CODE "execute_process\(COMMAND \${CMAKE_COMMAND} -DCMAKE_INSTALL_PREFIX=\${CMAKE_INSTALL_PREFIX} -P ${CMAKE_CURRENT_BINARY_DIR}/bolt_rt-bins/cmake_install.cmake \)"
     COMPONENT bolt)
   add_llvm_install_targets(install-bolt_rt
     DEPENDS bolt_rt bolt
     COMPONENT bolt)
 endif()
 
 find_program(GNU_LD_EXECUTABLE NAMES ${LLVM_DEFAULT_TARGET_TRIPLE}-ld.bfd ld.bfd DOC "GNU ld")
 
+include(AddBOLT)
+
+option(BOLT_BUILD_TOOLS
+  "Build the BOLT tools. If OFF, just generate build targets." ON)
+
+add_custom_target(bolt)
+set_target_properties(bolt PROPERTIES FOLDER "BOLT")
+add_llvm_install_targets(install-bolt DEPENDS bolt COMPONENT bolt)
+
 include_directories(
   ${CMAKE_CURRENT_SOURCE_DIR}/include
   ${CMAKE_CURRENT_BINARY_DIR}/include
   )
 
 add_subdirectory(lib)
 add_subdirectory(tools)
 

bolt/cmake/modules/AddBOLT.cmake

+include(GNUInstallDirs)
+include(LLVMDistributionSupport)
+
+macro(add_bolt_executable name)
+  add_llvm_executable(${name} ${ARGN})
+  set_target_properties(${name} PROPERTIES FOLDER "BOLT")
+endmacro()
+
+macro(add_bolt_tool name)
+  if (NOT BOLT_BUILD_TOOLS)
+    set(EXCLUDE_FROM_ALL ON)
+  endif()
+
+  add_bolt_executable(${name} ${ARGN})
+
+  if (BOLT_BUILD_TOOLS)
+    get_target_export_arg(${name} BOLT export_to_bolttargets)
+    install(TARGETS ${name}
+      ${export_to_bolttargets}
+      RUNTIME DESTINATION "${CMAKE_INSTALL_BINDIR}"
+      COMPONENT bolt)
+
+    if(NOT LLVM_ENABLE_IDE)
+      add_llvm_install_targets(install-${name}
+                               DEPENDS ${name}
+                               COMPONENT bolt)
+    endif()
+    set_property(GLOBAL APPEND PROPERTY BOLT_EXPORTS ${name})
+  endif()
+endmacro()
+
+macro(add_bolt_tool_symlink name dest)
+  llvm_add_tool_symlink(BOLT ${name} ${dest} ALWAYS_GENERATE)
+  # Always generate install targets
+  llvm_install_symlink(BOLT ${name} ${dest} ALWAYS_GENERATE COMPONENT bolt)
+endmacro()

bolt/test/CMakeLists.txt

 list(APPEND BOLT_TEST_DEPS
   clang
   count
   FileCheck
   llc
   lld
   llvm-config
   llvm-bolt
-  llvm-boltdiff
   llvm-bolt-heatmap
   llvm-bat-dump
   llvm-dwarfdump
   llvm-dwp
   llvm-mc
   llvm-nm
   llvm-objdump
   llvm-readelf
   llvm-readobj
   llvm-strings
   llvm-strip
   llvm-objcopy
   merge-fdata
   not
-  perf2bolt
   split-file
   yaml2obj
   )
 
 add_custom_target(bolt-test-depends DEPENDS ${BOLT_TEST_DEPS})
 set_target_properties(bolt-test-depends PROPERTIES FOLDER "BOLT")
 
 add_lit_testsuite(check-bolt "Running the BOLT regression tests"

bolt/tools/CMakeLists.txt

 set(BOLT_TOOLS_INSTALL_DIR "${CMAKE_INSTALL_BINDIR}" CACHE PATH
     "Path for binary subdirectory (defaults to '${CMAKE_INSTALL_BINDIR}')")
 mark_as_advanced(BOLT_TOOLS_INSTALL_DIR)
 
-# Move these macros to AddBolt if such a CMake module is ever created.
-
-macro(add_bolt_tool name)
-  llvm_add_tool(BOLT ${ARGV})
-endmacro()
-
-macro(add_bolt_tool_symlink name)
-  llvm_add_tool_symlink(BOLT ${ARGV})
-endmacro()
-
 add_subdirectory(driver)
 add_subdirectory(llvm-bolt-fuzzer)
 add_subdirectory(bat-dump)
 add_subdirectory(merge-fdata)
 add_subdirectory(heatmap)

bolt/tools/bat-dump/CMakeLists.txt

 set(LLVM_LINK_COMPONENTS
   Object
   Support
   )
 
-add_llvm_tool(llvm-bat-dump
+add_bolt_executable(llvm-bat-dump
   bat-dump.cpp
 
   DISABLE_LLVM_LINK_LLVM_DYLIB
   )
 
 target_link_libraries(llvm-bat-dump
   PRIVATE
   LLVMBOLTProfile
   )
-
-set_target_properties(llvm-bat-dump PROPERTIES FOLDER "BOLT")

bolt/tools/driver/CMakeLists.txt

target_link_libraries(llvm-bolt
   LLVMBOLTProfile
   LLVMBOLTRewrite
   LLVMBOLTUtils
   )
 
 add_bolt_tool_symlink(perf2bolt llvm-bolt)
 add_bolt_tool_symlink(llvm-boltdiff llvm-bolt)
 
-set(BOLT_DEPENDS
-  llvm-bolt
-  perf2bolt
-  llvm-boltdiff
-  )
-
-add_custom_target(bolt DEPENDS ${BOLT_DEPENDS})
-install(PROGRAMS
-  ${CMAKE_BINARY_DIR}/bin/llvm-bolt
-  ${CMAKE_BINARY_DIR}/bin/perf2bolt
-  ${CMAKE_BINARY_DIR}/bin/llvm-boltdiff
-  DESTINATION ${CMAKE_INSTALL_BINDIR}
-  COMPONENT bolt
-  )
-add_llvm_install_targets(install-bolt DEPENDS bolt COMPONENT bolt)
-set_target_properties(bolt PROPERTIES FOLDER "BOLT")
-set_target_properties(install-bolt PROPERTIES FOLDER "BOLT")
+add_dependencies(bolt llvm-bolt)
 
-include_directories( ${BOLT_SOURCE_DIR}/lib )
+include_directories(${BOLT_SOURCE_DIR}/lib)

bolt/tools/heatmap/CMakeLists.txt

 set(LLVM_LINK_COMPONENTS
   ${LLVM_TARGETS_TO_BUILD}
   MC
   Object
   Support
   )
 
 add_bolt_tool(llvm-bolt-heatmap
   heatmap.cpp
   DISABLE_LLVM_LINK_LLVM_DYLIB
   )
 
 target_link_libraries(llvm-bolt-heatmap
   PRIVATE
   LLVMBOLTProfile
   LLVMBOLTRewrite
   LLVMBOLTUtils
   )
 
-set_target_properties(llvm-bolt-heatmap PROPERTIES FOLDER "BOLT")
+add_dependencies(bolt llvm-bolt-heatmap)

bolt/tools/merge-fdata/CMakeLists.txt

 set(LLVM_LINK_COMPONENTS Support)
 
 add_bolt_tool(merge-fdata
   merge-fdata.cpp
 
   DISABLE_LLVM_LINK_LLVM_DYLIB
 
   DEPENDS
   intrinsics_gen
 )
-set_target_properties(merge-fdata PROPERTIES FOLDER "BOLT")
 
 add_dependencies(bolt merge-fdata)
-install(PROGRAMS
-  ${CMAKE_BINARY_DIR}/bin/merge-fdata
-  DESTINATION ${CMAKE_INSTALL_BINDIR}
-  COMPONENT bolt
-  )
 
 # 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()

clang/cmake/caches/Fuchsia-stage2.cmake

 # This file sets up a CMakeCache for the second stage of a Fuchsia toolchain build.
 
 option(FUCHSIA_ENABLE_LLDB "Enable LLDB")
 
 set(LLVM_TARGETS_TO_BUILD X86;ARM;AArch64;RISCV CACHE STRING "")
 
 set(PACKAGE_VENDOR Fuchsia CACHE STRING "")
 
-set(_FUCHSIA_ENABLE_PROJECTS "clang;clang-tools-extra;lld;llvm;polly")
+set(_FUCHSIA_ENABLE_PROJECTS "bolt;clang;clang-tools-extra;lld;llvm;polly")
 set(LLVM_ENABLE_RUNTIMES "compiler-rt;libcxx;libcxxabi;libunwind" CACHE STRING "")
 
 set(LLVM_ENABLE_BACKTRACES OFF CACHE BOOL "")
 set(LLVM_ENABLE_DIA_SDK OFF CACHE BOOL "")
 set(LLVM_ENABLE_LIBCXX ON CACHE BOOL "")
 set(LLVM_ENABLE_LIBEDIT OFF CACHE BOOL "")
 set(LLVM_ENABLE_LLD ON CACHE BOOL "")
 set(LLVM_ENABLE_LTO ON CACHE BOOL "")
set(LLVM_TOOLCHAIN_TOOLS
   llvm-symbolizer
   llvm-undname
   llvm-xray
   sancov
   scan-build-py
   CACHE STRING "")
 
 set(LLVM_Toolchain_DISTRIBUTION_COMPONENTS
+  bolt
   clang
   lld
   clang-apply-replacements
   clang-doc
   clang-format
   clang-resource-headers
   clang-include-fixer
   clang-refactor

llvm/cmake/modules/AddLLVM.cmake

function(llvm_install_symlink project name dest)
 
   install(SCRIPT ${INSTALL_SYMLINK}
           CODE "install_symlink(\"${full_name}\" \"${full_dest}\" \"${output_dir}\" \"${LLVM_LINK_OR_COPY}\")"
           COMPONENT ${component})
 
   if (NOT LLVM_ENABLE_IDE AND NOT ARG_ALWAYS_GENERATE)
     add_llvm_install_targets(install-${name}
                              DEPENDS ${name} ${dest}
-                             COMPONENT ${name}
+                             COMPONENT ${component}
                              SYMLINK ${dest})
   endif()
 endfunction()
 
 function(llvm_add_tool_symlink project link_name target)
   cmake_parse_arguments(ARG "ALWAYS_GENERATE" "OUTPUT_DIR" "" ${ARGN})
 
   get_property(LLVM_DRIVER_TOOLS GLOBAL PROPERTY LLVM_DRIVER_TOOLS)