CMake: add LLVM_INSTALL_TOOLCHAIN_ONLY option

[hans]

Summary

This variable allows for installing just the toolchain parts of LLVM.

[rnk]

As discussed in person, let's go for a single option called LLVM_INSTALL_DEV_FILES (or DEV_RESOURCES or any other spelling).

This would basically cover libs, headers, cmake files, tablegen, and anything that a *developer* would need to build code against this package, ie what would go in a Debian libfoo-dev package.

[hans]

Change option name to LLVM_INSTALL_DEV_FILES. Also move cmake files and llvm-lit under this flag.

(Not changing the code review title to hopefully keep this in the same email thread.)

[rnk]

LGTM Nice!

[hans]

Er, no?

OK, I've changed it.

So, first note that this changes users of 'make install' in addition to users of cpack.

Right. I think my patch description actually only mentioned the 'install' target, because I don't think a lot of folks use cpack. Anyway, I'll expand the commit message that it affects both.

There are two layers of this:

1. install development tools / resources useful for developing other *LLVM* projects (tblgen, etc)

2. install *anything* but executable binaries.

I think these should be different. I think #1 should be default-off and turned on for users of the stand-alone Clang cmake build. It should be called something about "development".

I think #2 should be default-on, because many many users of LLVM specifically want the core libraries. I think the best way is to negate the flag: make it INSTALL_TOOLCHAIN_BINARIES_ONLY or something, and when enabled, you only get the binaries used as part of a toolchain (llvm-{ar,nm,dwarfdump,...}, clang, clang-format, etc., but not opt or llc.

I don't think I'm following. You say #1 and #2 should be different. If #1 is development tools and resources (i.e. tablegen, headers and libraries), doesn't that overlap with #2 being anything but toolchain binaries?

I think my patch provides an good way to configure the install target. Currently, 'make install' installs everything. I don't want to change that default. My patch just adds the possibility to exclude the "dev stuff", i.e. the libraries and headers. Isn't that pretty intuitive?

[hans]

New patch revision demonstrating a three-state variable for controlling what to include in the 'install' target.

[hans]

After the discussion on the mailing list, go back to just having one option for this.

[hans]

With this patch, the Clang side patch from http://llvm-reviews.chandlerc.com/D1498 and a corresponding patch to lld, using this option will result in the following install dir:

./bin/clang++.exe
./bin/clang-check.exe
./bin/clang-cl.exe
./bin/clang-format.exe
./bin/clang.exe
./bin/git-clang-format
./bin/libclang.dll
./bin/lld.exe
./bin/llvm-ar.exe
./bin/llvm-objdump.exe
./include/clang-c/CXCompilationDatabase.h
./include/clang-c/CXString.h
./include/clang-c/Index.h
./include/clang-c/Platform.h
./lib/clang/3.4/include
./lib/clang/3.4/include/altivec.h
./lib/clang/3.4/include/ammintrin.h
./lib/clang/3.4/include/arm_neon.h
./lib/clang/3.4/include/avx2intrin.h
./lib/clang/3.4/include/avxintrin.h
./lib/clang/3.4/include/bmi2intrin.h
./lib/clang/3.4/include/bmiintrin.h
./lib/clang/3.4/include/cpuid.h
./lib/clang/3.4/include/emmintrin.h
./lib/clang/3.4/include/f16cintrin.h
./lib/clang/3.4/include/float.h
./lib/clang/3.4/include/fma4intrin.h
./lib/clang/3.4/include/fmaintrin.h
./lib/clang/3.4/include/immintrin.h
./lib/clang/3.4/include/iso646.h
./lib/clang/3.4/include/limits.h
./lib/clang/3.4/include/lzcntintrin.h
./lib/clang/3.4/include/mm3dnow.h
./lib/clang/3.4/include/mmintrin.h
./lib/clang/3.4/include/mm_malloc.h
./lib/clang/3.4/include/module.map
./lib/clang/3.4/include/nmmintrin.h
./lib/clang/3.4/include/pmmintrin.h
./lib/clang/3.4/include/popcntintrin.h
./lib/clang/3.4/include/prfchwintrin.h
./lib/clang/3.4/include/rdseedintrin.h
./lib/clang/3.4/include/rtmintrin.h
./lib/clang/3.4/include/smmintrin.h
./lib/clang/3.4/include/stdalign.h
./lib/clang/3.4/include/stdarg.h
./lib/clang/3.4/include/stdbool.h
./lib/clang/3.4/include/stddef.h
./lib/clang/3.4/include/stdint.h
./lib/clang/3.4/include/stdnoreturn.h
./lib/clang/3.4/include/tgmath.h
./lib/clang/3.4/include/tmmintrin.h
./lib/clang/3.4/include/unwind.h
./lib/clang/3.4/include/varargs.h
./lib/clang/3.4/include/wmmintrin.h
./lib/clang/3.4/include/x86intrin.h
./lib/clang/3.4/include/xmmintrin.h
./lib/clang/3.4/include/xopintrin.h
./lib/clang/3.4/include/__wmmintrin_aes.h
./lib/clang/3.4/include/__wmmintrin_pclmul.h
./lib/libclang.lib

[chandlerc]

LGTM! Thanks for all of the iterations here.

Also, I'm trusting that libLTO.so is still installed here. as long as that's true, ship it!

[hans]

Also, I'm trusting that libLTO.so is still installed here. as long as that's true, ship it!

It wasn't (we don't build it on Windows, so I didn't notice), but I'll fix this when committing.

[hans]

Closed by commit rL189155 (authored by @hans).

llvm/trunk/CMakeLists.txt

set(CMAKE_MODULE_PATH
   "${CMAKE_CURRENT_SOURCE_DIR}/cmake/modules"
   )
 
 set(LLVM_VERSION_MAJOR 3)
 set(LLVM_VERSION_MINOR 4)
 
 set(PACKAGE_VERSION "${LLVM_VERSION_MAJOR}.${LLVM_VERSION_MINOR}svn")
 
+option(LLVM_INSTALL_TOOLCHAIN_ONLY "Only include toolchain files in the 'install' target." OFF)
+
 option(LLVM_USE_FOLDERS "Enable solution folders in Visual Studio. Disable for Express versions." ON)
 if ( LLVM_USE_FOLDERS )
   set_property(GLOBAL PROPERTY USE_FOLDERS ON)
 endif()
 
 include(VersionFromVCS)
 
 option(LLVM_APPEND_VC_REV
add_lit_target(check-all
     PARAMS ${LLVM_LIT_PARAMS}
     DEPENDS ${LLVM_LIT_DEPENDS}
     ARGS ${LLVM_LIT_EXTRA_ARGS}
     )
 endif()
 
 add_subdirectory(cmake/modules)
 
+if (NOT LLVM_INSTALL_TOOLCHAIN_ONLY)
   install(DIRECTORY include/
     DESTINATION include
     FILES_MATCHING
     PATTERN "*.def"
     PATTERN "*.h"
     PATTERN "*.td"
     PATTERN "*.inc"
     PATTERN "LICENSE.TXT"
     PATTERN ".svn" EXCLUDE
     )
 
   install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/include/
     DESTINATION include
     FILES_MATCHING
     PATTERN "*.def"
     PATTERN "*.h"
     PATTERN "*.gen"
     PATTERN "*.inc"
     # Exclude include/llvm/CMakeFiles/intrinsics_gen.dir, matched by "*.def"
     PATTERN "CMakeFiles" EXCLUDE
     PATTERN ".svn" EXCLUDE
     )
+endif()
+
+if( NOT WIN32 )
+  install(FILES include/llvm-c/lto.h DESTINATION include/llvm-c)
+endif()
+
 
 # TODO: make and install documentation.
 
 set(CPACK_PACKAGE_VENDOR "LLVM")
 set(CPACK_PACKAGE_VERSION_MAJOR ${LLVM_VERSION_MAJOR})
 set(CPACK_PACKAGE_VERSION_MINOR ${LLVM_VERSION_MINOR})
 if( LLVM_APPEND_VC_REV )
   add_version_info_from_vcs(CPACK_PACKAGE_VERSION_PATCH)

llvm/trunk/cmake/modules/AddLLVM.cmake

macro(add_llvm_library name)
 
   # Ensure that the system libraries always comes last on the
   # list. Without this, linking the unit tests on MinGW fails.
   link_system_libs( ${name} )
 
   if( EXCLUDE_FROM_ALL )
     set_target_properties( ${name} PROPERTIES EXCLUDE_FROM_ALL ON)
   else()
+    if (NOT LLVM_INSTALL_TOOLCHAIN_ONLY OR ${name} STREQUAL "LTO")
       install(TARGETS ${name}
         LIBRARY DESTINATION lib${LLVM_LIBDIR_SUFFIX}
         ARCHIVE DESTINATION lib${LLVM_LIBDIR_SUFFIX})
     endif()
+  endif()
   set_target_properties(${name} PROPERTIES FOLDER "Libraries")
 
   # Add the explicit dependency information for this library.
   #
   # It would be nice to verify that we have the dependencies for this library
   # name, but using get_property(... SET) doesn't suffice to determine if a
   # property has been set to an empty value.
   get_property(lib_deps GLOBAL PROPERTY LLVMBUILD_LIB_DEPS_${name})
if (APPLE)
       # Darwin-specific linker flags for loadable modules.
       set_target_properties(${name} PROPERTIES
         LINK_FLAGS "-Wl,-flat_namespace -Wl,-undefined -Wl,suppress")
     endif()
 
     if( EXCLUDE_FROM_ALL )
       set_target_properties( ${name} PROPERTIES EXCLUDE_FROM_ALL ON)
     else()
+      if (NOT LLVM_INSTALL_TOOLCHAIN_ONLY)
         install(TARGETS ${name}
           LIBRARY DESTINATION lib${LLVM_LIBDIR_SUFFIX}
           ARCHIVE DESTINATION lib${LLVM_LIBDIR_SUFFIX})
       endif()
     endif()
+  endif()
 
   set_target_properties(${name} PROPERTIES FOLDER "Loadable modules")
 endmacro(add_llvm_loadable_module name)
 
 
 macro(add_llvm_executable name)
   llvm_process_sources( ALL_FILES ${ARGN} )
   if( EXCLUDE_FROM_ALL )
     add_executable(${name} EXCLUDE_FROM_ALL ${ALL_FILES})
   else()
     add_executable(${name} ${ALL_FILES})
   endif()
   set(EXCLUDE_FROM_ALL OFF)
   llvm_config( ${name} ${LLVM_LINK_COMPONENTS} )
   if( LLVM_COMMON_DEPENDS )
     add_dependencies( ${name} ${LLVM_COMMON_DEPENDS} )
   endif( LLVM_COMMON_DEPENDS )
   link_system_libs( ${name} )
 endmacro(add_llvm_executable name)
 
 
+set (LLVM_TOOLCHAIN_TOOLS
+  llvm-ar
+  llvm-objdump
+  )
+
 macro(add_llvm_tool name)
   set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${LLVM_TOOLS_BINARY_DIR})
   if( NOT LLVM_BUILD_TOOLS )
     set(EXCLUDE_FROM_ALL ON)
   endif()
   add_llvm_executable(${name} ${ARGN})
+
+  list(FIND LLVM_TOOLCHAIN_TOOLS ${name} LLVM_IS_${name}_TOOLCHAIN_TOOL)
+  if (LLVM_IS_${name}_TOOLCHAIN_TOOL GREATER -1 OR NOT LLVM_INSTALL_TOOLCHAIN_ONLY)
     if( LLVM_BUILD_TOOLS )
       install(TARGETS ${name} RUNTIME DESTINATION bin)
     endif()
+  endif()
   set_target_properties(${name} PROPERTIES FOLDER "Tools")
 endmacro(add_llvm_tool name)
 
 
 macro(add_llvm_example name)
 #  set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${LLVM_EXAMPLES_BINARY_DIR})
   if( NOT LLVM_BUILD_EXAMPLES )
     set(EXCLUDE_FROM_ALL ON)

llvm/trunk/cmake/modules/CMakeLists.txt

configure_file(
   ${llvm_cmake_builddir}/LLVMConfig.cmake
   @ONLY)
 
 configure_file(
   LLVMConfigVersion.cmake.in
   ${llvm_cmake_builddir}/LLVMConfigVersion.cmake
   @ONLY)
 
+if (NOT LLVM_INSTALL_TOOLCHAIN_ONLY)
   install(FILES
     ${llvm_cmake_builddir}/LLVMConfig.cmake
     ${llvm_cmake_builddir}/LLVMConfigVersion.cmake
     LLVM-Config.cmake
     DESTINATION share/llvm/cmake)
 
   install(DIRECTORY .
     DESTINATION share/llvm/cmake
     FILES_MATCHING PATTERN *.cmake
     PATTERN .svn EXCLUDE
     PATTERN LLVMConfig.cmake EXCLUDE
     PATTERN LLVMConfigVersion.cmake EXCLUDE
     PATTERN LLVM-Config.cmake EXCLUDE
     PATTERN GetHostTriple.cmake EXCLUDE
     PATTERN VersionFromVCS.cmake EXCLUDE
     PATTERN CheckAtomic.cmake EXCLUDE)
+endif()