[Polly][Cmake] Generate a PollyConfig.cmake

[philip.pfaffe]

Summary

Generate a PollyConfig.cmake for use with Cmake's find_package in out-of-tree projects.

This patch is based on Meinersbur's template, including some fixes and most importantly the appropriate ISL target.

[Meinersbur]

Thank you for picking up and continue my PollyConfig patch. I stopped when I discovered that I could generate the IMPORTED libraries using the [[ https://cmake.org/cmake/help/v3.7/command/export.html | export ]] command and couldn't decide whether it was better. You seem to have decided against using it. Can you share why?

cmake/CMakeLists.txt

47

This shouldn't overwrite ISL_INCLUDE_DIRS, even if it is changed just in this CMakeLists.txt. Just add it to POLLY_CONFIG_INCLUDE_DIRS.

cmake/PollyConfig.cmake.in

5

I tried a standalone build where POLLY_CONFIG_LLVM_CMAKE_DIR turned out to be /root/install/polly/release/lib/cmake/llvm, but should be /root/install/llvm/release/lib/cmake/llvm (${LLVM_INSTALL_ROOT}/${LLVM_INSTALL_PACKAGE_DIR})
(-DCMAKE_INSTALL_PREFIX=/root/install/llvm/release for llvm w/o Polly and
-DCMAKE_INSTALL_PREFIX=/root/install/polly/release for Polly).

llvm_cmake_builddir might need to be set to something else in that case. I think I copied that part from clang, they might have it wrong too.

10

Who is setting POLLY_CONFIG_INCLUDE_DIRS? Its plural name indicates it's a list, so shouldn't be surrounded by quotes.

11

In standalone (not built together with LLVM) builds, the LIBRARY_DIRS of Polly will be different from that of LLVM.

12

PollyPPCG should depend on POLLY_ENABLE_GPGPU_CODEGEN

13

Terminating @ missing?

20–23

Existence of this target should also depend on POLLY_ENABLE_GPGPU_CODEGEN.

[philip.pfaffe]

In D30495#690821, @Meinersbur wrote:

You seem to have decided against using it. Can you share why?

I didn't go with export() because it solves only half the problem. The exported targets are only valid for the build tree. The equivalent for the install tree would be install(EXPORT) together with the appropriate per-target install options. I don't think the second path is feasible for Polly, because it requires invasive changes to LLVM's cmake setup. Thus, I'd have to manually export the targets for the install tree anyways. I still could've used export() for the build tree, but I prefer the symmetry of my solution.

Updates wrt. to the inline comments coming soon.

[Meinersbur]

OK, thanks for explaining.

[philip.pfaffe]

Addressed inline comments and a couple of extra issues I found, specifically the missing IMPORTED_LOCATION settings.

[Meinersbur]

Thanks for this update. Here are some more comments.

cmake/CMakeLists.txt

14

Did you mean

list(APPEND POLLY_CONFIG_EXPORTED_TARGETS PollyPPCG)

?

45

Clang uses

set(clang_cmake_builddir "${CMAKE_BINARY_DIR}/${CLANG_INSTALL_PACKAGE_DIR}")

(CMAKE_BINARY_DIR instead of POLLY_BINARY_DIR). The effect is that the PollyConfig.cmake lands in <build dir>/lib/polly/PollyConfig.cmake, not in <build dir>/tools/polly/lib/cmake/PollyConfig.cmake as done currently. I think we should do the same. I think the idea is that all the *Config.cmake for the build dir can be found at a central place. We should do the same.

46

Did you mean

set(POLLY_CONFIG_INCLUDE_DIRS ${ISL_INCLUDE_DIRS})

?

66–68

On Windows, this generates several errors:

CMake Error at tools/polly/cmake/CMakeLists.txt:63 (file):
  Error evaluating generator expression:

    $<TARGET_FILE:LLVMPolly>

  Target "LLVMPolly" is not an executable or library.

(same for line 109)
Because LLVMPolly is only a dummy target on Windows.

For the other targets these errors show up:

CMake Error in tools/polly/cmake/CMakeLists.txt:
  Evaluation file to be written multiple times for different configurations
  or languages with different content:

    C:/Users/Meinersbur/build/llvm/vc14/tools/polly/lib/cmake/polly/PollyExports.cmake

with multi-configuration generators such as Visual Studio.

I don't really care about having this generated on Windows, but there shouldn't be errors. Can you just skip this in these cases? I suggest:

if (NOT CMAKE_CONFIGURATION_TYPES AND NOT MSVC)
  add_subdirectory(cmake)
endif ()

(this also excludes XCode)

[philip.pfaffe]

Addressed inline comments.

This patch now generates one Exports file per Configuration and should now also work on Windows.

[Meinersbur]

Thanks for making it work under Windows. Could you just remove the debugging line if it is one (or let me do it), then I'll commit.

cmake/CMakeLists.txt

57

Is this a leftover from debugging?

[philip.pfaffe]

Removed the Debug output. My bad!

[Meinersbur]

Thanks for all the effort!

CMakeLists.txt

 
 add_subdirectory(docs)
 add_subdirectory(lib)
 add_subdirectory(test)
 if (POLLY_GTEST_AVAIL)
   add_subdirectory(unittests)
 endif ()
 add_subdirectory(tools)
+add_subdirectory(cmake)
 # TODO: docs.
 
 
 configure_file( ${CMAKE_CURRENT_SOURCE_DIR}/include/polly/Config/config.h.cmake
                 ${POLLY_BINARY_DIR}/include/polly/Config/config.h )
 
 # Add target to check formatting of polly files
 file( GLOB_RECURSE files *.h lib/*.cpp lib/*.c tools/*.cpp tools/*.c tools/*.h unittests/*.cpp)

cmake/CMakeLists.txt

+# Keep this in sync with llvm/cmake/CMakeLists.txt!
+if (LLVM_INSTALL_ROOT)
+  # this simplifies things down the road, by not requiring to distinguish
+  # between in-tree and out of tree builds
+  set(LLVM_BINARY_DIR ${LLVM_INSTALL_ROOT})
+endif()
+
+set(LLVM_INSTALL_PACKAGE_DIR "lib${LLVM_LIBDIR_SUFFIX}/cmake/llvm")
+set(POLLY_INSTALL_PACKAGE_DIR "lib${LLVM_LIBDIR_SUFFIX}/cmake/polly")
+if (CMAKE_CONFIGURATION_TYPES)
+  set(POLLY_EXPORTS_FILE_NAME "PollyExports-$<LOWER_CASE:$<CONFIG>>.cmake")
+else()
+  # avoid conflicts in the build-tree when changing configuration
+  set(POLLY_EXPORTS_FILE_NAME "PollyExports-all.cmake")
+endif()
+
+set(POLLY_CONFIG_EXPORTED_TARGETS Polly ${ISL_TARGET})
+if (NOT MSVC)
+  # LLVMPolly is a dummy target on Win
+  list(APPEND POLLY_CONFIG_EXPORTED_TARGETS LLVMPolly)
+endif()
+if (POLLY_ENABLE_GPGPU_CODEGEN)
+  list(APPEND POLLY_CONFIG_EXPORTED_TARGETS PollyPPCG)
+endif()
+
+# Get the target type for every exported target
+foreach(tgt IN LISTS POLLY_CONFIG_EXPORTED_TARGETS)
+  get_target_property(tgt_type ${tgt} TYPE)
+  string(REPLACE "_LIBRARY" "" tgt_type ${tgt_type})
+  set(POLLY_CONFIG_TARGET_${tgt}_TYPE ${tgt_type})
+endforeach()
+
+set(llvm_cmake_builddir "${LLVM_BINARY_DIR}/${LLVM_INSTALL_PACKAGE_DIR}")
+set(POLLY_CONFIG_LLVM_CMAKE_DIR "${llvm_cmake_builddir}")
+
+# generate the import code for bundled/undbundled libisl versions
+if (NOT POLLY_BUNDLED_ISL)
+  get_property(incl TARGET ISL PROPERTY INTERFACE_INCLUDE_DIRECTORIES)
+  get_property(lib TARGET ISL PROPERTY INTERFACE_LINK_LIBRARIES)
+  get_property(opt TARGET ISL PROPERTY INTERFACE_COMPILE_OPTIONS)
+  set(ISL_CONFIG_CODE "
+add_library(ISL INTERFACE IMPORTED)
+set_property(TARGET ISL APPEND PROPERTY INTERFACE_INCLUDE_DIRECTORIES ${incl})
+set_property(TARGET ISL APPEND PROPERTY INTERFACE_LINK_LIBRARIES ${lib})
+set_property(TARGET ISL APPEND PROPERTY INTERFACE_COMPILE_OPTIONS ${opt})")
+else()
+  set(ISL_CONFIG_CODE "
+if (NOT TARGET PollyISL)
+  add_library(PollyISL ${POLLY_CONFIG_TARGET_PollyISL_TYPE} IMPORTED)
+endif()")
+endif()
+
+# Generate PollyConfig.cmake for the build tree.
+set(POLLY_CONFIG_CMAKE_DIR "${CMAKE_BINARY_DIR}/${POLLY_INSTALL_PACKAGE_DIR}")
+set(POLLY_CONFIG_INCLUDE_DIRS ${ISL_INCLUDE_DIRS})
+set(POLLY_CONFIG_LIBRARY_DIRS "${POLLY_BINARY_DIR}/lib")
+
+# set locations for imported targets
+foreach(tgt IN LISTS POLLY_CONFIG_EXPORTED_TARGETS)
+  get_target_property(tgt_type ${tgt} TYPE)
+  if (NOT tgt_type STREQUAL "INTERFACE_LIBRARY")
+    set(POLLY_EXPORTS
+      "set_target_properties(${tgt} PROPERTIES
+              IMPORTED_LOCATION_$<UPPER_CASE:$<CONFIG>> $<TARGET_FILE:${tgt}>)
+${POLLY_EXPORTS}")
+  endif()
+endforeach(tgt)
+
+# PollyConfig holds the target definitions and general settings, PollyExports
+# the imported locations
+configure_file(
+  ${CMAKE_CURRENT_SOURCE_DIR}/PollyConfig.cmake.in
+  ${POLLY_CONFIG_CMAKE_DIR}/PollyConfig.cmake
+  @ONLY)
+
+file(GENERATE
+  OUTPUT ${POLLY_CONFIG_CMAKE_DIR}/${POLLY_EXPORTS_FILE_NAME}
+  CONTENT "${POLLY_EXPORTS}")
+
+
+# Generate PollyConfig.cmake for the install tree.
+unset(POLLY_EXPORTS)
+set(POLLY_INSTALL_PREFIX "${CMAKE_INSTALL_PREFIX}")
+set(POLLY_CONFIG_LLVM_CMAKE_DIR "${LLVM_BINARY_DIR}/${LLVM_INSTALL_PACKAGE_DIR}")
+set(POLLY_CONFIG_CMAKE_DIR "${POLLY_INSTALL_PREFIX}/${POLLY_INSTALL_PACKAGE_DIR}")
+set(POLLY_CONFIG_LIBRARY_DIRS "${POLLY_INSTALL_PREFIX}/lib${LLVM_LIBDIR_SUFFIX}")
+if (POLLY_BUNDLED_ISL)
+  set(POLLY_CONFIG_INCLUDE_DIRS "${POLLY_INSTALL_PREFIX}/include/polly")
+else()
+  set(POLLY_CONFIG_INCLUDE_DIRS ${ISL_INCLUDE_DIRS})
+endif()
+
+# set locations for imported targets. The path is constructed to be relative to
+# the config file
+foreach(tgt IN LISTS POLLY_CONFIG_EXPORTED_TARGETS)
+  get_target_property(tgt_type ${tgt} TYPE)
+  if (tgt_type STREQUAL "EXECUTABLE")
+    set(tgt_prefix "bin/")
+  else()
+    set(tgt_prefix "lib/")
+  endif()
+
+  set(tgt_path "${CMAKE_INSTALL_PREFIX}/${tgt_prefix}$<TARGET_FILE_NAME:${tgt}>")
+  file(RELATIVE_PATH tgt_path ${POLLY_CONFIG_CMAKE_DIR} ${tgt_path})
+
+  if (NOT tgt_type STREQUAL "INTERFACE_LIBRARY")
+    set(POLLY_EXPORTS
+"set_target_properties(${tgt} PROPERTIES
+        IMPORTED_LOCATION_$<UPPER_CASE:$<CONFIG>> \${CMAKE_CURRENT_LIST_DIR}/${tgt_path})
+${POLLY_EXPORTS}")
+  endif()
+endforeach(tgt)
+
+configure_file(
+  ${CMAKE_CURRENT_SOURCE_DIR}/PollyConfig.cmake.in
+  ${CMAKE_CURRENT_BINARY_DIR}/CMakeFiles/PollyConfig.cmake
+  @ONLY)
+file(GENERATE OUTPUT
+  ${CMAKE_CURRENT_BINARY_DIR}/CMakeFiles/${POLLY_EXPORTS_FILE_NAME}
+  CONTENT "${POLLY_EXPORTS}")
+
+if (NOT LLVM_INSTALL_TOOLCHAIN_ONLY)
+  install(
+    FILES
+    "${CMAKE_CURRENT_BINARY_DIR}/CMakeFiles/PollyConfig.cmake"
+    "${CMAKE_CURRENT_BINARY_DIR}/CMakeFiles/${POLLY_EXPORTS_FILE_NAME}"
+    DESTINATION "${POLLY_INSTALL_PACKAGE_DIR}")
+endif ()

cmake/PollyConfig.cmake.in

+# This file allows users to call find_package(Polly) and pick up our targets.
+
+find_package(LLVM REQUIRED CONFIG
+             HINTS "@POLLY_CONFIG_LLVM_CMAKE_DIR@")
+
+set(Polly_CMAKE_DIR ${CMAKE_CURRENT_LIST_DIR})
+set(Polly_BUNDLED_ISL @POLLY_BUNDLED_ISL@)
+set(Polly_ENABLE_GPGPU_CODEGEN @POLLY_ENABLE_GPGPU_CODEGEN@)
+
+set(Polly_DEFINITIONS ${LLVM_DEFINITIONS})
+set(Polly_INCLUDE_DIRS @POLLY_CONFIG_INCLUDE_DIRS@ ${LLVM_INCLUDE_DIRS})
+set(Polly_LIBRARY_DIRS @POLLY_CONFIG_LIBRARY_DIRS@)
+set(Polly_EXPORTED_TARGETS @POLLY_CONFIG_EXPORTED_TARGETS@)
+set(Polly_LIBRARIES ${LLVM_LIBRARIES} ${Polly_EXPORTED_TARGETS})
+
+# Imported Targets:
+@ISL_CONFIG_CODE@
+
+if (Polly_ENABLE_GPGPU_CODEGEN AND NOT TARGET PollyPPCG)
+  add_library(PollyPPCG @POLLY_CONFIG_TARGET_TARGET_PollyPPCG_TYPE@ IMPORTED)
+  set_target_property(TARGET PollyPPCG PROPERTY INTERFACE_LINK_LIBRARIES @ISL_TARGET@)
+endif()
+
+if (NOT TARGET Polly)
+  add_library(Polly @POLLY_CONFIG_TARGET_Polly_TYPE@ IMPORTED)
+  set_property(TARGET Polly PROPERTY INTERFACE_LINK_LIBRARIES @ISL_TARGET@)
+  if (Polly_ENABLE_GPGPU_CODEGEN)
+    set_property(TARGET Polly APPEND PROPERTY INTERFACE_LINK_LIBRARIES PollyPPCG)
+  endif()
+endif()
+
+if (NOT TARGET LLVMPolly)
+  add_library(LLVMPolly @POLLY_CONFIG_TARGET_LLVMPolly_TYPE@ IMPORTED)
+  set_property(TARGET LLVMPolly PROPERTY INTERFACE_LINK_LIBRARIES Polly)
+endif()
+
+# Exported locations:
+file(GLOB CONFIG_FILES "${Polly_CMAKE_DIR}/PollyExports-*.cmake")
+foreach(f ${CONFIG_FILES})
+  include(${f})
+endforeach()