WIP: attempt to use CMake EXPORT

The CMake EXPORT feature seems like it's supposed to make target_compile_options etc. work nicely for both in-project builds and also projects that consume your project by installing it and finding it with find_package. Using EXPORT would make it easy to have similar behavior to Buck's exported_preprocessor_flags, for example.

Unfortunately, I am currently stalled here by XNNPACK's lack of use of EXPORT. I tried working around dependencies that don't use EXPORT by re-installing them with EXPORT ourselves, but XNNPACK has rather a lot so I'm sending this out to highlight the problem and ask if there's another way.

I found some similar issues in TFLite: tensorflow/tensorflow#57658 tensorflow/tensorflow#87172

ghstack-source-id: d71d97f
ghstack-comment-id: 2699501745
Pull Request resolved: #8954

Author: swolchok

.ci/scripts/test_llama.sh

@@ -150,6 +150,7 @@ cmake_install_executorch_libraries() {
     echo "Installing libexecutorch.a, libextension_module.so, libportable_ops_lib.a"
     rm -rf cmake-out
     retry cmake --preset llm \
+        -DBUILD_TESTING=OFF \
         -DCMAKE_INSTALL_PREFIX=cmake-out \
         -DCMAKE_BUILD_TYPE="$CMAKE_BUILD_TYPE" \
         -DEXECUTORCH_BUILD_QNN="$QNN" \

CMakeLists.txt

@@ -52,6 +52,7 @@ include(${PROJECT_SOURCE_DIR}/tools/cmake/common/preset.cmake)
 include(${PROJECT_SOURCE_DIR}/tools/cmake/Utils.cmake)
 include(CMakeDependentOption)
 include(ExternalProject)
+include(GNUInstallDirs)
 
 if(NOT CMAKE_CXX_STANDARD)
   set(CMAKE_CXX_STANDARD 17)
@@ -168,7 +169,6 @@ endif()
 add_subdirectory(third-party)
 
 if(NOT DEFINED FXDIV_SOURCE_DIR)
-  include(GNUInstallDirs)
   get_extra_cmake_args_for_external_project(FXDIV_EXTRA_CMAKE_ARGS)
   set(FXDIV_SOURCE_DIR
       "${CMAKE_CURRENT_LIST_DIR}/backends/xnnpack/third-party/FXdiv"
@@ -247,7 +247,6 @@ if(EXECUTORCH_BUILD_PTHREADPOOL)
   set(PTHREADPOOL_SOURCE_DIR
       "${CMAKE_CURRENT_LIST_DIR}/backends/xnnpack/third-party/pthreadpool"
   )
-  include(GNUInstallDirs)
   set(PTHREADPOOL_BINARY_DIR "${CMAKE_CURRENT_BINARY_DIR}/pthreadpool")
   set(PTHREADPOOL_INSTALL_DIR "${PTHREADPOOL_BINARY_DIR}/install")
   set(PTHREADPOOL_LIBRARY
@@ -309,9 +308,10 @@ if(NOT "${_repo_dir_name}" STREQUAL "executorch")
   )
 endif()
 set(_common_include_directories
-    ${CMAKE_CURRENT_SOURCE_DIR}/..
-    ${CMAKE_CURRENT_SOURCE_DIR}/runtime/core/portable_type/c10
-)
+  $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/..>
+  $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/runtime/core/portable_type/c10>
+  $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>
+  $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}/executorch/runtime/core/portable_type/c10>)
 
 #
 # The `_<target>_srcs` lists are defined by including ${EXECUTORCH_SRCS_FILE}.
@@ -485,50 +485,51 @@ add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/configurations)
 # ${CMAKE_INSTALL_PREFIX}/
 install(
   DIRECTORY runtime/core/
-  DESTINATION include/executorch/runtime/core
+  DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/executorch/runtime/core
   FILES_MATCHING
   PATTERN "*.h"
 )
 install(
   DIRECTORY runtime/executor/
-  DESTINATION include/executorch/runtime/executor
+  DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/executorch/runtime/executor
   FILES_MATCHING
   PATTERN "*.h"
 )
 install(
   DIRECTORY runtime/kernel/
-  DESTINATION include/executorch/runtime/kernel
+  DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/executorch/runtime/kernel
   FILES_MATCHING
   PATTERN "*.h"
 )
 install(
   DIRECTORY runtime/platform/
-  DESTINATION include/executorch/runtime/platform
+  DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/executorch/runtime/platform
   FILES_MATCHING
   PATTERN "*.h"
 )
 install(
   DIRECTORY extension/kernel_util/
-  DESTINATION include/executorch/extension/kernel_util
+  DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/executorch/extension/kernel_util
   FILES_MATCHING
   PATTERN "*.h"
 )
 install(
   DIRECTORY extension/tensor/
-  DESTINATION include/executorch/extension/tensor
+  DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/executorch/extension/tensor
   FILES_MATCHING
   PATTERN "*.h"
 )
 install(
   DIRECTORY extension/threadpool/
-  DESTINATION include/executorch/extension/threadpool
+  DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/executorch/extension/threadpool
   FILES_MATCHING
   PATTERN "*.h"
 )
 install(
   TARGETS executorch executorch_core
+  EXPORT ExecuTorchTargets
   INCLUDES
-  DESTINATION ${_common_include_directories}
+  DESTINATION include
 )
 install(FILES tools/cmake/Utils.cmake tools/cmake/executorch-config.cmake
         DESTINATION lib/cmake/ExecuTorch
@@ -594,7 +595,7 @@ if(EXECUTORCH_BUILD_EXTENSION_MODULE)
   add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/extension/module)
   install(
     DIRECTORY extension/module/
-    DESTINATION include/executorch/extension/module
+    DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/executorch/extension/module
     FILES_MATCHING
     PATTERN "*.h"
   )
@@ -709,6 +710,7 @@ if(EXECUTORCH_BUILD_PYBIND)
   target_link_libraries(portable_lib PRIVATE ${_dep_libs})
 
   install(TARGETS portable_lib
+          EXPORT ExecuTorchTargets
           LIBRARY DESTINATION executorch/extension/pybindings
   )
 endif()
@@ -792,5 +794,9 @@ endif()
 
 include(Test.cmake)
 
+install(EXPORT ExecuTorchTargets
+  FILE ExecuTorchTargets.cmake
+  DESTINATION lib/cmake/ExecuTorch)
+
 # Print all the configs that were called with announce_configured_options.
 print_configured_options()

backends/apple/coreml/CMakeLists.txt

@@ -105,7 +105,7 @@ endif()
 
 add_library(coreml_util ${UTIL_SOURCES})
 target_include_directories(
-  coreml_util PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/runtime/util
+  coreml_util PUBLIC $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/runtime/util> $<INSTALL_INTERFACE:include/executorch/backends/apple/coreml/runtime/util>
 )
 if(APPLE)
   target_link_libraries(coreml_util PRIVATE ${FOUNDATION_FRAMEWORK})
@@ -115,8 +115,13 @@ target_compile_options(coreml_util PUBLIC -fPIC)
 install(
   TARGETS coreml_util
   DESTINATION lib
-  INCLUDES
-  DESTINATION ${_common_include_directories}
+)
+
+install(
+  DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/runtime/util
+  DESTINATION include/executorch/backends/apple/coreml/runtime/util
+  FILES_MATCHING
+  PATTERN "*.h"
 )
 
 # CoreML inmemoryfs
@@ -134,7 +139,7 @@ endif()
 
 add_library(coreml_inmemoryfs ${INMEMORYFS_SOURCES})
 target_include_directories(
-  coreml_inmemoryfs PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/runtime/inmemoryfs
+  coreml_inmemoryfs PUBLIC $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/runtime/inmemoryfs> $<INSTALL_INTERFACE:include/executorch/backends/apple/coreml/runtime/inmemoryfs>
 )
 if(APPLE)
   target_link_libraries(
@@ -150,6 +155,13 @@ install(
   DESTINATION ${_common_include_directories}
 )
 
+install(
+  DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/runtime/inmemoryfs
+  DESTINATION include/executorch/backends/apple/coreml/runtime/inmemoryfs
+  FILES_MATCHING
+  PATTERN "*.h"
+)
+
 # executorchcoreml
 
 if(EXECUTORCH_BUILD_PYBIND)
@@ -232,9 +244,10 @@ if(APPLE)
   endif()
 
   install(
-    TARGETS coremldelegate
+    TARGETS coremldelegate coreml_util coreml_inmemoryfs
+    EXPORT ExecuTorchTargets
     DESTINATION lib
     INCLUDES
-    DESTINATION ${_common_include_directories}
+    DESTINATION include
   )
 endif()

backends/apple/mps/CMakeLists.txt

@@ -19,7 +19,6 @@ endif()
 include(${EXECUTORCH_ROOT}/tools/cmake/Utils.cmake)
 
 set(_common_compile_options -Wno-deprecated-declarations)
-set(_common_include_directories ${EXECUTORCH_ROOT}/..)
 
 set(_mps_schema__include_dir "${CMAKE_BINARY_DIR}/schema/include")
 
@@ -51,9 +50,10 @@ add_library(mps_schema INTERFACE ${_mps_schema__outputs})
 set_target_properties(mps_schema PROPERTIES LINKER_LANGUAGE CXX)
 target_include_directories(
   mps_schema
-  INTERFACE ${_mps_schema__include_dir}
-            ${EXECUTORCH_ROOT}/third-party/flatbuffers/include
-            ${_common_include_directories}
+  INTERFACE
+    $<BUILD_INTERFACE:${_mps_schema__include_dir}>
+    $<BUILD_INTERFACE:${EXECUTORCH_ROOT}/third-party/flatbuffers/include>
+    ${_common_include_directories}
 )
 
 list(TRANSFORM _mps_backend__srcs PREPEND "${EXECUTORCH_ROOT}/")
@@ -79,7 +79,8 @@ target_compile_options(mpsdelegate PUBLIC ${_common_compile_options})
 target_compile_options(mpsdelegate PRIVATE "-fno-objc-arc")
 
 install(
-  TARGETS mpsdelegate
+  TARGETS mpsdelegate mps_schema
+  EXPORT ExecuTorchTargets
   DESTINATION lib
   INCLUDES
   DESTINATION ${_common_include_directories}

backends/mediatek/CMakeLists.txt

@@ -30,16 +30,20 @@ target_link_libraries(
 )
 target_sources(
   neuron_backend
-  INTERFACE ${CMAKE_CURRENT_LIST_DIR}/runtime/include/NeuronBackend.h
-            ${CMAKE_CURRENT_LIST_DIR}/runtime/include/NeuronBufferAllocator.h
-            ${CMAKE_CURRENT_LIST_DIR}/runtime/include/NeuronExecutor.h
-            ${CMAKE_CURRENT_LIST_DIR}/runtime/include/NeuronLog.h
-            ${CMAKE_CURRENT_LIST_DIR}/runtime/include/api/APUWareUtilsLib.h
-            ${CMAKE_CURRENT_LIST_DIR}/runtime/include/api/NeuronAdapterShim.h
+  INTERFACE $<BUILD_INTERFACE:${CMAKE_CURRENT_LIST_DIR}/runtime/include/NeuronBackend.h>
+            $<BUILD_INTERFACE:${CMAKE_CURRENT_LIST_DIR}/runtime/include/NeuronBufferAllocator.h>
+            $<BUILD_INTERFACE:${CMAKE_CURRENT_LIST_DIR}/runtime/include/NeuronExecutor.h>
+            $<BUILD_INTERFACE:${CMAKE_CURRENT_LIST_DIR}/runtime/include/NeuronLog.h>
+            $<BUILD_INTERFACE:${CMAKE_CURRENT_LIST_DIR}/runtime/include/api/APUWareUtilsLib.h>
+            $<BUILD_INTERFACE:${CMAKE_CURRENT_LIST_DIR}/runtime/include/api/NeuronAdapterShim.h>
   PRIVATE ${CMAKE_CURRENT_LIST_DIR}/runtime/NeuronBackend.cpp
           ${CMAKE_CURRENT_LIST_DIR}/runtime/NeuronExecutor.cpp
           ${CMAKE_CURRENT_LIST_DIR}/runtime/NeuronBufferAllocator.cpp
 )
 target_link_options_shared_lib(neuron_backend)
 
-install(TARGETS neuron_backend DESTINATION lib)
+install(
+  TARGETS neuron_backend
+  EXPORT ExecuTorchTargets
+  DESTINATION lib
+)

backends/qualcomm/CMakeLists.txt

@@ -229,7 +229,11 @@ add_subdirectory(
   ${QNN_EXECUTORCH_ROOT_DIR}/aot/ir
   ${CMAKE_CURRENT_BINARY_DIR}/qnn_executorch/ir
 )
-install(TARGETS qnn_executorch_backend DESTINATION lib)
+install(
+  TARGETS qnn_executorch_backend
+  EXPORT ExecuTorchTargets
+  DESTINATION lib
+)
 
 # QNN pybind
 if(${CMAKE_SYSTEM_PROCESSOR} MATCHES "x86_64")

backends/vulkan/CMakeLists.txt

@@ -135,6 +135,7 @@ endif()
 
 install(
   TARGETS vulkan_backend
+  EXPORT ExecuTorchTargets
   DESTINATION lib
   INCLUDES
   DESTINATION ${COMMON_INCLUDES}

backends/xnnpack/CMakeLists.txt

@@ -35,7 +35,6 @@ if(EXECUTORCH_XNNPACK_ENABLE_KLEIDI)
   add_definitions(-DENABLE_XNNPACK_KLEIDI)
 endif()
 
-set(_common_include_directories ${EXECUTORCH_ROOT}/..)
 set(_common_compile_options -Wno-deprecated-declarations -fPIC)
 
 set(_xnnpack_schema__include_dir "${CMAKE_BINARY_DIR}/schema/include")
@@ -88,8 +87,10 @@ unset(MV_COMMAND)
 add_library(xnnpack_schema INTERFACE ${_xnnpack_schema__outputs})
 set_target_properties(xnnpack_schema PROPERTIES LINKER_LANGUAGE CXX)
 target_include_directories(
-  xnnpack_schema INTERFACE ${_xnnpack_schema__include_dir}
-                           ${EXECUTORCH_ROOT}/third-party/flatbuffers/include
+  xnnpack_schema
+  INTERFACE
+    $<BUILD_INTERFACE:${_xnnpack_schema__include_dir}>
+    $<BUILD_INTERFACE:${EXECUTORCH_ROOT}/third-party/flatbuffers/include>
 )
 
 include(cmake/Dependencies.cmake)
@@ -101,24 +102,25 @@ target_link_libraries(
   xnnpack_backend PUBLIC ${xnnpack_third_party} executorch_core xnnpack_schema
                          extension_threadpool
 )
-
 target_include_directories(
   xnnpack_backend PUBLIC ${_common_include_directories}
 )
-target_include_directories(xnnpack_backend PUBLIC ${XNNPACK_INCLUDE_DIR})
+target_include_directories(xnnpack_backend PRIVATE ${XNNPACK_INCLUDE_DIR})
 target_include_directories(
   xnnpack_backend
-  PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/third-party/pthreadpool/include
+  PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/third-party/pthreadpool/include
 )
 target_include_directories(
   xnnpack_backend
-  PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/third-party/cpuinfo/include
+  PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/third-party/cpuinfo/include
 )
 target_compile_options(xnnpack_backend PUBLIC ${_common_compile_options})
 target_link_options_shared_lib(xnnpack_backend)
 
 install(
-  TARGETS xnnpack_backend
+  TARGETS xnnpack_backend xnnpack_schema
+  EXPORT ExecuTorchTargets
+  DESTINATION lib
   INCLUDES
   DESTINATION ${_common_include_directories}
 )

configurations/CMakeLists.txt

@@ -60,5 +60,9 @@ if(EXECUTORCH_BUILD_KERNELS_OPTIMIZED)
     executorch_core
   )
 
-  install(TARGETS optimized_native_cpu_ops_lib DESTINATION lib)
+  install(
+    TARGETS optimized_native_cpu_ops_lib
+    EXPORT ExecuTorchTargets
+    DESTINATION lib
+  )
 endif()

devtools/CMakeLists.txt

@@ -5,7 +5,10 @@
 # LICENSE file in the root directory of this source tree.
 
 # The include directory that will contain the generated schema headers.
-set(DEVTOOLS_INCLUDE_DIR "${CMAKE_BINARY_DIR}/devtools/include")
+set(DEVTOOLS_INCLUDE_DIR_NO_BUILD_INTERFACE ${CMAKE_BINARY_DIR}/devtools/include)
+set(DEVTOOLS_INCLUDE_DIR
+    $<BUILD_INTERFACE:${DEVTOOLS_INCLUDE_DIR_NO_BUILD_INTERFACE}>
+)
 
 add_subdirectory(etdump)
 add_subdirectory(bundled_program)