[llvm-driver] Support single distributions

[abrachet]

Summary

LLVM_DISTRIBUTION_COMPONENTS now influences the llvm binary in the
normal cmake output directory when it is set. This allows for
distribution targets to only include tools they want in the llvm
binary. It must be done this way because only one target can be
associated with a specific output name.

[phosek]

Since distributions are used for selecting components that are distributed in the toolchain, and most vendors only have a single distribution, I'd prefer using the name llvm (rather than llvm-distribution) for the default distribution since that binary is going to be shipped in the toolchain (and "distribution" is an internal concept that users shouldn't be concerned with).

I wonder if we could use the following approach:

• If LLVM_DISTRIBUTION_COMPONENTS isn't set, then combine all supported tools into llvm driver.
• If LLVM_DISTRIBUTION_COMPONENTS is set, then combine all supported tools listed in LLVM_DISTRIBUTION_COMPONENTS into llvm driver and leave all other tools standalone.
• (In the future) If LLVM_DISTRIBUTIONS is set, then combine all supported tools listed in LLVM_<name>_DISTRIBUTION_COMPONENTS into llvm-<name> driver and leave all other tools standalone.

What do you think?

llvm/cmake/modules/AddLLVM.cmake

2068

Should this apply to ${dest} as well?

llvm/tools/llvm-driver/CMakeLists.txt

31 ↗

(On Diff #450465)

Nit: you can omit, variables in CMake don't need to be initialized.

[abrachet]

In D131310#3821479, @phosek wrote:

Since distributions are used for selecting components that are distributed in the toolchain, and most vendors only have a single distribution, I'd prefer using the name llvm (rather than llvm-distribution) for the default distribution since that binary is going to be shipped in the toolchain (and "distribution" is an internal concept that users shouldn't be concerned with).

I wonder if we could use the following approach:

• If LLVM_DISTRIBUTION_COMPONENTS isn't set, then combine all supported tools into llvm driver.
• If LLVM_DISTRIBUTION_COMPONENTS is set, then combine all supported tools listed in LLVM_DISTRIBUTION_COMPONENTS into llvm driver and leave all other tools standalone.
• (In the future) If LLVM_DISTRIBUTIONS is set, then combine all supported tools listed in LLVM_<name>_DISTRIBUTION_COMPONENTS into llvm-<name> driver and leave all other tools standalone.

What do you think?

Sounds good. 1 and 2 have been implemented and 3 has been saved for later

[phosek]

LGTM

clang/cmake/modules/AddClang.cmake

macro(add_clang_executable name)
   set_clang_windows_version_resource_properties(${name})
 endmacro(add_clang_executable)
 
 macro(add_clang_tool name)
   cmake_parse_arguments(ARG "DEPENDS;GENERATE_DRIVER" "" "" ${ARGN})
   if (NOT CLANG_BUILD_TOOLS)
     set(EXCLUDE_FROM_ALL ON)
   endif()
-  if(ARG_GENERATE_DRIVER AND LLVM_TOOL_LLVM_DRIVER_BUILD)
+  if(ARG_GENERATE_DRIVER
+     AND LLVM_TOOL_LLVM_DRIVER_BUILD
+     AND (NOT LLVM_DISTRIBUTION_COMPONENTS OR ${name} IN_LIST LLVM_DISTRIBUTION_COMPONENTS)
+    )
     set(get_obj_args ${ARGN})
     list(FILTER get_obj_args EXCLUDE REGEX "^SUPPORT_PLUGINS$")
     generate_llvm_objects(${name} ${get_obj_args})
     add_custom_target(${name} DEPENDS llvm-driver clang-resource-headers)
   else()
     add_clang_executable(${name} ${ARGN})
     add_dependencies(${name} clang-resource-headers)
 
if (CLANG_BUILD_TOOLS)
       endif()
       set_property(GLOBAL APPEND PROPERTY CLANG_EXPORTS ${name})
     endif()
   endif()
 endmacro()
 
 macro(add_clang_symlink name dest)
   get_property(LLVM_DRIVER_TOOLS GLOBAL PROPERTY LLVM_DRIVER_TOOLS)
-  if(LLVM_TOOL_LLVM_DRIVER_BUILD AND ${dest} IN_LIST LLVM_DRIVER_TOOLS)
+  if(LLVM_TOOL_LLVM_DRIVER_BUILD
+     AND ${dest} IN_LIST LLVM_DRIVER_TOOLS
+     AND (NOT LLVM_DISTRIBUTION_COMPONENTS OR ${dest} IN_LIST LLVM_DISTRIBUTION_COMPONENTS)
+    )
     set_property(GLOBAL APPEND PROPERTY LLVM_DRIVER_TOOL_ALIASES_${dest} ${name})
   else()
     llvm_add_tool_symlink(CLANG ${name} ${dest} ALWAYS_GENERATE)
     # Always generate install targets
     llvm_install_symlink(CLANG ${name} ${dest} ALWAYS_GENERATE)
   endif()
 endmacro()
 

llvm/cmake/modules/AddLLVM.cmake

foreach(path ${CMAKE_MODULE_PATH})
           ${path}/llvm-driver-template.cpp.in
           ${CMAKE_CURRENT_BINARY_DIR}/${name}-driver.cpp)
         break()
       endif()
     endforeach()
 
     list(APPEND ALL_FILES ${CMAKE_CURRENT_BINARY_DIR}/${name}-driver.cpp)
 
-    if (LLVM_TOOL_LLVM_DRIVER_BUILD)
+    if (LLVM_TOOL_LLVM_DRIVER_BUILD
+        AND (NOT LLVM_DISTRIBUTION_COMPONENTS OR ${name} IN_LIST LLVM_DISTRIBUTION_COMPONENTS)
+       )
       set_property(GLOBAL APPEND PROPERTY LLVM_DRIVER_COMPONENTS ${LLVM_LINK_COMPONENTS})
       set_property(GLOBAL APPEND PROPERTY LLVM_DRIVER_DEPS ${ARG_DEPENDS} ${LLVM_COMMON_DEPENDS})
       set_property(GLOBAL APPEND PROPERTY LLVM_DRIVER_OBJLIBS "${obj_name}")
 
       set_property(GLOBAL APPEND PROPERTY LLVM_DRIVER_TOOLS ${name})
       set_property(GLOBAL APPEND PROPERTY LLVM_DRIVER_TOOL_ALIASES_${name} ${name})
       target_link_libraries(${obj_name} ${LLVM_PTHREAD_LIB})
       llvm_config(${obj_name} ${USE_SHARED} ${LLVM_LINK_COMPONENTS} )
set (LLVM_TOOLCHAIN_TOOLS
     )
 endif()
 
 macro(llvm_add_tool project name)
   cmake_parse_arguments(ARG "DEPENDS;GENERATE_DRIVER" "" "" ${ARGN})
   if( NOT LLVM_BUILD_TOOLS )
     set(EXCLUDE_FROM_ALL ON)
   endif()
-  if(ARG_GENERATE_DRIVER AND LLVM_TOOL_LLVM_DRIVER_BUILD)
+  if(ARG_GENERATE_DRIVER
+     AND LLVM_TOOL_LLVM_DRIVER_BUILD
+     AND (NOT LLVM_DISTRIBUTION_COMPONENTS OR ${name} IN_LIST LLVM_DISTRIBUTION_COMPONENTS)
+    )
     generate_llvm_objects(${name} ${ARGN})
     add_custom_target(${name} DEPENDS llvm-driver)
   else()
     add_llvm_executable(${name} ${ARGN})
 
     if ( ${name} IN_LIST LLVM_TOOLCHAIN_TOOLS OR NOT LLVM_INSTALL_TOOLCHAIN_ONLY)
       if( LLVM_BUILD_TOOLS )
         get_target_export_arg(${name} LLVM export_to_llvmexports)
function(llvm_install_library_symlink name dest type)
   install(SCRIPT ${INSTALL_SYMLINK}
           CODE "install_symlink(\"${full_name}\" \"${full_dest}\" \"${output_dir}\")"
           COMPONENT ${component})
 
 endfunction()
 
 function(llvm_install_symlink project name dest)
   get_property(LLVM_DRIVER_TOOLS GLOBAL PROPERTY LLVM_DRIVER_TOOLS)
-  if(LLVM_TOOL_LLVM_DRIVER_BUILD AND ${dest} IN_LIST LLVM_DRIVER_TOOLS)
+  if(LLVM_TOOL_LLVM_DRIVER_BUILD
+     AND ${dest} IN_LIST LLVM_DRIVER_TOOLS
+     AND (NOT LLVM_DISTRIBUTION_COMPONENTS OR ${dest} IN_LIST LLVM_DISTRIBUTION_COMPONENTS)
+    )
     return()
   endif()
   cmake_parse_arguments(ARG "ALWAYS_GENERATE" "COMPONENT" "" ${ARGN})
   foreach(path ${CMAKE_MODULE_PATH})
     if(EXISTS ${path}/LLVMInstallSymlink.cmake)
       set(INSTALL_SYMLINK ${path}/LLVMInstallSymlink.cmake)
       break()
     endif()
   endforeach()
 
   if(ARG_COMPONENT)
     set(component ${ARG_COMPONENT})
   else()
     if(ARG_ALWAYS_GENERATE)
       set(component ${dest})
     else()
       set(component ${name})
     endif()
   endif()
 
   set(full_name ${name}${CMAKE_EXECUTABLE_SUFFIX})
   set(full_dest ${dest}${CMAKE_EXECUTABLE_SUFFIX})
   if (${dest} STREQUAL "llvm-driver")
     set(full_dest llvm${CMAKE_EXECUTABLE_SUFFIX})
   endif()
 
   set(output_dir "${${project}_TOOLS_INSTALL_DIR}")
 
   install(SCRIPT ${INSTALL_SYMLINK}
           CODE "install_symlink(\"${full_name}\" \"${full_dest}\" \"${output_dir}\")"
           COMPONENT ${component})
 
   if (NOT LLVM_ENABLE_IDE AND NOT ARG_ALWAYS_GENERATE)

llvm/cmake/modules/LLVMDistributionSupport.cmake

function(llvm_distribution_add_targets)
   if(NOT distributions)
     # CMake seemingly doesn't distinguish between an empty list and a list
     # containing one element which is the empty string, so just use a special
     # marker to denote the default (unnamed) distribution and fix it in the
     # loop.
     set(distributions "<DEFAULT>")
   endif()
 
+  get_property(LLVM_DRIVER_TOOL_SYMLINKS GLOBAL PROPERTY LLVM_DRIVER_TOOL_SYMLINKS)
+
   foreach(distribution ${distributions})
     if(distribution STREQUAL "<DEFAULT>")
       set(distribution_target distribution)
       # Preserve legacy behavior for LLVM_DISTRIBUTION_COMPONENTS.
       set(distribution_components ${LLVM_DISTRIBUTION_COMPONENTS} ${LLVM_RUNTIME_DISTRIBUTION_COMPONENTS})
     else()
       string(TOLOWER "${distribution}" distribution_lower)
       set(distribution_target ${distribution_lower}-distribution)
       set(distribution_components ${LLVM_${distribution}_DISTRIBUTION_COMPONENTS})
     endif()
 
     add_custom_target(${distribution_target})
     add_custom_target(install-${distribution_target})
     add_custom_target(install-${distribution_target}-stripped)
 
     foreach(target ${distribution_components})
       # Note that some distribution components may not have an actual target, but only an install-FOO target.
       # This happens for example if a target is an INTERFACE target.
       if(TARGET ${target})
         add_dependencies(${distribution_target} ${target})
       endif()
 
       if(TARGET install-${target})
         add_dependencies(install-${distribution_target} install-${target})
+      elseif(TARGET install-llvm-driver AND ${target} IN_LIST LLVM_DRIVER_TOOL_SYMLINKS)
+        add_dependencies(install-${distribution_target} install-llvm-driver)
       else()
         message(SEND_ERROR "Specified distribution component '${target}' doesn't have an install target")
       endif()
 
       if(TARGET install-${target}-stripped)
         add_dependencies(install-${distribution_target}-stripped install-${target}-stripped)
+      elseif(TARGET install-llvm-driver-stripped AND ${target} IN_LIST LLVM_DRIVER_TOOL_SYMLINKS)
+        add_dependencies(install-${distribution_target}-stripped install-llvm-driver-stripped)
       else()
         message(SEND_ERROR
                 "Specified distribution component '${target}' doesn't have an install-stripped target."
                 " Its installation target creation should be changed to use add_llvm_install_targets,"
                 " or you should manually create the 'install-${target}-stripped' target.")
       endif()
     endforeach()
   endforeach()
 endfunction()