Update

[ghstack-poisoned]

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

@@ -54,6 +54,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)
@@ -170,14 +171,29 @@ endif()
 add_subdirectory(third-party)
 
 if(NOT DEFINED FXDIV_SOURCE_DIR)
-  set(ORIGINAL_CMAKE_POSITION_INDEPENDENT_CODE_FLAG
-      ${CMAKE_POSITION_INDEPENDENT_CODE}
+  get_extra_cmake_args_for_external_project(FXDIV_EXTRA_CMAKE_ARGS)
+  set(FXDIV_SOURCE_DIR
+      "${CMAKE_CURRENT_LIST_DIR}/backends/xnnpack/third-party/FXdiv"
   )
-  set(FXDIV_SOURCE_DIR "backends/xnnpack/third-party/FXdiv")
-  add_subdirectory("${FXDIV_SOURCE_DIR}")
-  set(CMAKE_POSITION_INDEPENDENT_CODE
-      ${ORIGINAL_CMAKE_POSITION_INDEPENDENT_CODE_FLAG}
+  set(FXDIV_BINARY_DIR "${CMAKE_CURRENT_BINARY_DIR}/fxdiv")
+  set(FXDIV_INSTALL_DIR "${FXDIV_BINARY_DIR}/install")
+  set(FXDIV_HEADER "${FXDIV_INSTALL_DIR}/${CMAKE_INSTALL_INCLUDEDIR}/fxdiv.h")
+  ExternalProject_Add(
+    fxdivExternalProject
+    SOURCE_DIR "${FXDIV_SOURCE_DIR}"
+    BINARY_DIR "${FXDIV_BINARY_DIR}"
+    INSTALL_DIR "${FXDIV_INSTALL_DIR}"
+    BUILD_BYPRODUCTS "${FXDIV_HEADER}"
+    CMAKE_ARGS "${FXDIV_EXTRA_CMAKE_ARGS}"
+               -D
+               CMAKE_INSTALL_PREFIX=<INSTALL_DIR>
+               -D
+               FXDIV_BUILD_TESTS=OFF
+               -D
+               FXDIV_BUILD_BENCHMARKS=OFF
   )
+  add_library(fxdiv INTERFACE IMPORTED)
+  set_property(TARGET fxdiv PROPERTY IMPORTED_LOCATION "${FXDIV_HEADER}")
 endif()
 
 if(EXECUTORCH_BUILD_CPUINFO)
@@ -233,8 +249,6 @@ if(EXECUTORCH_BUILD_PTHREADPOOL)
   set(PTHREADPOOL_SOURCE_DIR
       "${CMAKE_CURRENT_LIST_DIR}/backends/xnnpack/third-party/pthreadpool"
   )
-  include(ExternalProject)
-  include(GNUInstallDirs)
   set(PTHREADPOOL_BINARY_DIR "${CMAKE_CURRENT_BINARY_DIR}/pthreadpool")
   set(PTHREADPOOL_INSTALL_DIR "${PTHREADPOOL_BINARY_DIR}/install")
   set(PTHREADPOOL_LIBRARY
@@ -298,8 +312,8 @@ endif()
 set(_common_include_directories
   $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/..>
   $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/runtime/core/portable_type/c10>
-  $<INSTALL_INTERFACE:include>
-  $<INSTALL_INTERFACE:include/executorch/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}.
@@ -473,43 +487,43 @@ 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"
 )
@@ -583,7 +597,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"
   )

backends/apple/coreml/CMakeLists.txt

@@ -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
@@ -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)

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}/")
@@ -66,8 +66,7 @@ find_library(MPS_GRAPH_FRAMEWORK MetalPerformanceShadersGraph)
 
 target_link_libraries(
   mpsdelegate
-  PRIVATE bundled_program
-          mps_schema
+  PRIVATE mps_schema
           executorch_core
           ${FOUNDATION_FRAMEWORK}
           ${METAL_FRAMEWORK}
@@ -80,7 +79,7 @@ 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

backends/mediatek/CMakeLists.txt

@@ -30,12 +30,12 @@ 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

devtools/CMakeLists.txt

@@ -5,7 +5,9 @@
 # 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
+    $<BUILD_INTERFACE:${CMAKE_BINARY_DIR}/devtools/include>
+)
 
 add_subdirectory(etdump)
 add_subdirectory(bundled_program)

devtools/bundled_program/CMakeLists.txt

@@ -4,18 +4,20 @@
 # This source code is licensed under the BSD-style license found in the
 # LICENSE file in the root directory of this source tree.
 
-set(
-  _schema_files
-  bundled_program_schema.fbs
-  scalar_type.fbs
-)
+set(_schema_files bundled_program_schema.fbs scalar_type.fbs)
 
 set(_schema_outputs)
 foreach(schema_file ${_schema_files})
-  list(APPEND _bundled_program_schema__srcs "${CMAKE_CURRENT_SOURCE_DIR}/schema/${schema_file}")
+  list(APPEND _bundled_program_schema__srcs
+       "${CMAKE_CURRENT_SOURCE_DIR}/schema/${schema_file}"
+  )
 
   string(REGEX REPLACE "[.]fbs$" "_generated.h" generated "${schema_file}")
-  list(APPEND _schema_outputs "${DEVTOOLS_INCLUDE_DIR}/executorch/devtools/bundled_program/schema/${generated}")
+  list(
+    APPEND
+    _schema_outputs
+    "${DEVTOOLS_INCLUDE_DIR}/executorch/devtools/bundled_program/schema/${generated}"
+  )
 endforeach()
 
 file(MAKE_DIRECTORY ${DEVTOOLS_INCLUDE_DIR}/executorch/devtools/bundled_program)
@@ -32,24 +34,20 @@ add_custom_command(
 )
 
 add_library(
-  bundled_program
-  ${_schema_outputs}
-  ${CMAKE_CURRENT_SOURCE_DIR}/bundled_program.cpp
-)
-target_link_libraries(
-  bundled_program
-  PUBLIC
-    executorch
+  bundled_program ${_schema_outputs}
+                  ${CMAKE_CURRENT_SOURCE_DIR}/bundled_program.cpp
 )
+target_link_libraries(bundled_program PUBLIC executorch)
 target_include_directories(
   bundled_program
   PUBLIC
     ${DEVTOOLS_INCLUDE_DIR}
-    ${PROJECT_SOURCE_DIR}/third-party/flatbuffers/include
+    $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/third-party/flatbuffers/include>
 )
 
 install(
   TARGETS bundled_program
+  EXPORT ExecuTorchTargets
   DESTINATION ${CMAKE_BINARY_DIR}/lib
   INCLUDES
   DESTINATION ${_common_include_directories}

examples/models/llama/runner/CMakeLists.txt

@@ -23,55 +23,44 @@ endif()
 include(${EXECUTORCH_ROOT}/tools/cmake/Utils.cmake)
 include(${EXECUTORCH_ROOT}/tools/cmake/Codegen.cmake)
 
-#
-# The `_<target>_srcs` lists are defined by including ${EXECUTORCH_SRCS_FILE}.
-#
-set(EXECUTORCH_SRCS_FILE
-    "${CMAKE_CURRENT_BINARY_DIR}/../../../../executorch_srcs.cmake"
-)
-
-extract_sources(${EXECUTORCH_SRCS_FILE})
-
-include(${EXECUTORCH_SRCS_FILE})
-
-# build llama_runner library
-list(TRANSFORM _llama_runner__srcs PREPEND "${EXECUTORCH_ROOT}/")
-
-target_include_directories(
-  extension_module INTERFACE ${_common_include_directories}
-)
+# The buck-based executorch_srcs.cmake setup was crossing package
+# boundaries and trying to build stuff from
+# executorch/extension/llm/runner and tokenizers. Just set up sources
+# manually.
+set(llama_runner_srcs
+  runner.cpp
+  ../tokenizer/llama_tiktoken.cpp)
 
 if(CMAKE_TOOLCHAIN_IOS
    OR ANDROID
    OR APPLE
 )
   # Building a share library on iOS requires code signing On Android we see
   # duplicated registration when using shared lib
-  add_library(llama_runner STATIC ${_llama_runner__srcs})
+  add_library(llama_runner STATIC ${llama_runner_srcs})
 else()
-  add_library(llama_runner SHARED ${_llama_runner__srcs})
+  add_library(llama_runner SHARED ${llama_runner_srcs})
 endif()
 
 # For extension_llm_runner
 if(NOT TARGET extension_llm_runner)
-  add_subdirectory(
-    ${EXECUTORCH_ROOT}/extension/llm/runner
-    ${CMAKE_CURRENT_BINARY_DIR}/../../../../extension/llm/runner
+  message(
+    FATAL_ERROR
+      "ExecuTorch must be installed with EXECUTORCH_BUILD_EXTENSION_LLM_RUNNER enabled."
   )
 endif()
 
-set(llama_runner_deps executorch_core extension_data_loader extension_module
-                      extension_tensor extension_flat_tensor extension_llm_runner
+set(llama_runner_deps
+    executorch_core extension_data_loader extension_module extension_tensor
+    extension_flat_tensor extension_llm_runner
 )
 
 target_link_libraries(llama_runner PUBLIC ${llama_runner_deps})
-
-target_link_libraries(
-  llama_runner PUBLIC tokenizers
-)
+# XXX: this fixing anything means we are defining an unnamespaced tokenizers target that needs building somehow
+target_link_libraries(llama_runner PUBLIC tokenizers::tokenizers)
 
 target_include_directories(
-  llama_runner
-  PUBLIC ${EXECUTORCH_ROOT}/extension/llm/tokenizers/include
+  llama_runner PUBLIC ${EXECUTORCH_ROOT}/extension/llm/tokenizers/include
+  ${EXECUTORCH_ROOT}/..
 )
 target_compile_options(llama_runner PUBLIC ${_preprocessor_flag})

extension/llm/custom_ops/CMakeLists.txt

@@ -37,7 +37,7 @@ include(${EXECUTORCH_SRCS_FILE})
 
 set(_common_include_directories
     $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/..,${CMAKE_CURRENT_SOURCE_DIR}/runtime/core/portable_type/c10>
-    $<INSTALL_INTERFACE:include,include/executorch/runtime/core/portable_type/c10>
+    $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR},${CMAKE_INSTALL_INCLUDEDIR}/executorch/runtime/core/portable_type/c10>
 )
 # REVIEW: are we installing AO? will this mess up EXPORT?
 list(APPEND _common_include_directories $<BUILD_INTERFACE:${EXECUTORCH_ROOT}/third-party/ao>)