WIP: start using install again

Author: dbort

CMakeLists.txt

@@ -45,6 +45,12 @@ project(executorch)
 include(build/Utils.cmake)
 include(CMakeDependentOption)
 
+# Set CMAKE_INSTALL_* vars to values recommended by the GNU Coding Standards.
+# It's important we do this here because many of the third-party projects also
+# include this, and it can change the values of CMAKE_INSTALL_* vars on some
+# systems (e.g., from `lib` to `lib64`).
+include(GNUInstallDirs)
+
 set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
 
 if(NOT CMAKE_CXX_STANDARD)
@@ -174,6 +180,11 @@ option(EXECUTORCH_BUILD_GTESTS
 option(EXECUTORCH_BUILD_EXTENSION_AOT_UTIL
        "Build the extension/aot_util directory" OFF)
 
+# Conventional installation location for CMake config files; see
+# https://stackoverflow.com/q/71725037.
+set(EXECUTORCH_INSTALL_CMAKEDIR "${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}"
+    CACHE STRING "Install path for ${PROJECT_NAME} CMake files")
+
 if(NOT BUCK2)
   set(BUCK2 buck2)
 endif()
@@ -185,7 +196,8 @@ endif()
 # TODO(dbort): Fix these warnings and remove this flag.
 set(_common_compile_options -Wno-deprecated-declarations -fPIC)
 
-# Let files say "include <executorch/path/to/header.h>".
+# Let files say "include <executorch/path/to/header.h>". Assumes that the repo
+# lives in a directory named "executorch".
 set(_common_include_directories ${CMAKE_CURRENT_SOURCE_DIR}/..)
 
 #
@@ -264,6 +276,13 @@ if(EXECUTORCH_BUILD_FLATC)
   set(FLATBUFFERS_BUILD_TESTS OFF CACHE BOOL "")
   set(FLATBUFFERS_INSTALL OFF CACHE BOOL "")
   add_subdirectory(third-party/flatbuffers)
+
+  # Install flatc ourselves, even though third-party/flatbuffers/CMakeLists.txt
+  # has an option for it. Setting FLATBUFFERS_INSTALL would also install its
+  # CMake config files, which we do not want to publish.
+  install(
+    TARGETS flatc
+    RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR})
 endif()
 if(NOT FLATC_EXECUTABLE)
   message(
@@ -301,6 +320,16 @@ if(MAX_KERNEL_NUM)
                              PRIVATE MAX_KERNEL_NUM=${MAX_KERNEL_NUM})
 endif()
 
+install(
+  TARGETS executorch
+  LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
+  INCLUDES DESTINATION ${CMAKE_INSTALL_INCLUDEDIR})
+
+# Install CMake config along with library files.
+install(
+  FILES build/executorch-config.cmake
+  DESTINATION ${EXECUTORCH_INSTALL_CMAKEDIR})
+
 #
 # portable_ops_lib: A library to register core ATen ops using portable kernels,
 # see kernels/portable/CMakeLists.txt.
@@ -322,15 +351,6 @@ if(EXECUTORCH_BUILD_GFLAGS)
   add_subdirectory(third-party/gflags)
 endif()
 
-# Install `executorch` library as well as `executorch-config.cmake` under
-# ${CMAKE_INSTALL_PREFIX}/
-install(
-  TARGETS executorch
-  LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
-  INCLUDES
-  DESTINATION ${_common_include_directories})
-install(FILES build/executorch-config.cmake DESTINATION share/cmake/executorch)
-
 #
 # executor_runner: Host tool that demonstrates program execution.
 #
@@ -454,22 +474,26 @@ if(EXECUTORCH_BUILD_PYBIND)
                PATHS "${TORCH_INSTALL_PREFIX}/lib")
 
   # compile options for pybind
-
   set(_pybind_compile_options -Wno-deprecated-declarations -fPIC -frtti
                               -fexceptions)
-  # util lib
+
+  # Utilities needed by the pybindings extension.
   add_library(
-    util
+    extension_pybindings_util
     ${CMAKE_CURRENT_SOURCE_DIR}/extension/evalue_util/print_evalue.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/extension/aten_util/aten_bridge.cpp
-    ${CMAKE_CURRENT_SOURCE_DIR}/util/read_file.cpp
-  )
-  target_include_directories(util PUBLIC ${_common_include_directories}
-                                         ${TORCH_INCLUDE_DIRS})
-  target_compile_options(util PUBLIC ${_pybind_compile_options})
-  target_link_libraries(util PRIVATE torch c10 executorch)
-
-  # pybind portable_lib
+    ${CMAKE_CURRENT_SOURCE_DIR}/util/read_file.cpp)
+  target_include_directories(
+    extension_pybindings_util
+    PUBLIC
+      ${_common_include_directories}
+      ${TORCH_INCLUDE_DIRS})
+  target_compile_options(extension_pybindings_util
+                         PUBLIC ${_pybind_compile_options})
+  target_link_libraries(extension_pybindings_util PRIVATE torch c10 executorch)
+
+  # Pybindings extension for the executorch.extension.pybindings.portable_lib
+  # module.
   pybind11_add_module(portable_lib extension/pybindings/pybindings.cpp)
   target_compile_definitions(portable_lib
                              PUBLIC EXECUTORCH_PYTHON_MODULE_NAME=portable_lib)
@@ -482,8 +506,8 @@ if(EXECUTORCH_BUILD_PYBIND)
       etdump
       executorch
       extension_data_loader
+      extension_pybindings_util
       portable_ops_lib
-      util
       torch
       ${PYBIND_LINK_COREML}
       ${PYBIND_LINK_MPS}

build/executorch-config.cmake

@@ -12,7 +12,11 @@
 
 cmake_minimum_required(VERSION 3.19)
 
+# This file (which lives in CMAKE_CURRENT_LIST_DIR) should have been installed
+# in "${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}". Get the path to
+# CMAKE_INSTALL_LIBDIR, which should contain all static and dynamic libraries.
 set(_root "${CMAKE_CURRENT_LIST_DIR}/../..")
+
 add_library(executorch STATIC IMPORTED)
 find_library(
     EXECUTORCH_LIBRARY_PATH executorch
@@ -36,13 +40,13 @@ set_target_properties(
 target_include_directories(portable_kernels INTERFACE ${_root})
 
 if(CMAKE_BUILD_TYPE MATCHES "Debug")
-    set(FLATCC_LIB flatcc_d)
+    set(FLATCCRT_LIB flatccrt_d)
 else()
-    set(FLATCC_LIB flatcc)
+    set(FLATCCRT_LIB flatccrt)
 endif()
 
 set(lib_list
-    etdump bundled_program extension_data_loader ${FLATCC_LIB} mpsdelegate
+    etdump bundled_program extension_data_loader ${FLATCCRT_LIB} mpsdelegate
     qnn_executorch_backend portable_ops_lib extension_module xnnpack_backend
     XNNPACK cpuinfo pthreadpool
 )
@@ -57,7 +61,7 @@ foreach(lib ${lib_list})
         if("${lib}" STREQUAL "extension_module" AND (NOT CMAKE_TOOLCHAIN_IOS))
             add_library(${lib} SHARED IMPORTED)
         else()
-            # Building a share library on iOS requires code signing, so it's
+            # Building a shared library on iOS requires code signing, so it's
             # easier to keep all libs as static when CMAKE_TOOLCHAIN_IOS is
             # used
             add_library(${lib} STATIC IMPORTED)

sdk/CMakeLists.txt

@@ -174,5 +174,4 @@ target_include_directories(
 install(
   TARGETS bundled_program etdump flatccrt
   DESTINATION ${CMAKE_INSTALL_LIBDIR}
-  INCLUDES
-  DESTINATION ${_common_include_directories})
+  INCLUDES DESTINATION ${CMAKE_INSTALL_INCLUDEDIR})

setup.py

@@ -338,6 +338,27 @@ def run(self):
         # Build the system.
         self.spawn(["cmake", "--build", cmake_cache_dir, *build_args])
 
+        # Install some files to a common spot under cmake-out. This will make
+        # them available install via BuiltExtension with a source under
+        # `_installed/`.
+        # TODO(dbort): Add --strip for release builds.
+        cmake_install_dir = os.path.join(cmake_cache_dir, "_installed")
+        self.spawn(
+            [
+                "cmake",
+                "--install",
+                cmake_cache_dir,
+                "--prefix",
+                cmake_install_dir,
+            ]
+        )
+
+        # Copy all installed files into the package, under data/. If names or
+        # locations need to change, handle that in the CMake config instead of
+        # adding a mapping here.
+        data_root = os.path.join(self.build_lib, "executorch", "data")
+        self.copy_tree(cmake_install_dir, data_root)
+
         # Finally, run the underlying subcommands like build_py, build_ext.
         build.run(self)