WIP: Clean up custom ops usage of executorch-config.cmake

Author: dbort

build/executorch-config.cmake

@@ -20,8 +20,10 @@ set(_root "${CMAKE_CURRENT_LIST_DIR}/../..")
 add_library(executorch STATIC IMPORTED)
 find_library(
     EXECUTORCH_LIBRARY_PATH executorch
-    HINTS "${_root}"
-    CMAKE_FIND_ROOT_PATH_BOTH
+    PATHS "${_root}"
+    REQUIRED
+    # Look only under PATHS; do not search under other implicit roots.
+    NO_CMAKE_FIND_ROOT_PATH
 )
 set_target_properties(
     executorch PROPERTIES IMPORTED_LOCATION "${EXECUTORCH_LIBRARY_PATH}"
@@ -31,8 +33,10 @@ target_include_directories(executorch INTERFACE ${_root})
 add_library(portable_kernels STATIC IMPORTED)
 find_library(
     PORTABLE_KERNELS_PATH portable_kernels
-    HINTS "${_root}"
-    CMAKE_FIND_ROOT_PATH_BOTH
+    PATHS "${_root}"
+    REQUIRED
+    # Look only under PATHS; do not search under other implicit roots.
+    NO_CMAKE_FIND_ROOT_PATH
 )
 set_target_properties(
     portable_kernels PROPERTIES IMPORTED_LOCATION "${PORTABLE_KERNELS_PATH}"

examples/portable/custom_ops/CMakeLists.txt

@@ -42,10 +42,16 @@ set(_common_compile_options -Wno-deprecated-declarations -fPIC)
 # Let files say "include <executorch/path/to/header.h>".
 set(_common_include_directories ${EXECUTORCH_ROOT}/..)
 
-find_package(executorch CONFIG REQUIRED)
-find_package(
-  gflags REQUIRED PATHS ${CMAKE_CURRENT_BINARY_DIR}/../../../third-party
-)
+# The path to executorch/cmake-out. We assume that the top-level project has
+# already been built, and then installed directly under the same cmake-out.
+set(_root_binary_dir "${EXECUTORCH_ROOT}/cmake-out")
+if(NOT EXISTS "${_root_binary_dir}")
+  message(FATAL_ERROR "Root binary dir '${_root_binary_dir}' does not exist. "
+          "Please build and install the top-level project first.")
+endif()
+
+find_package(executorch CONFIG REQUIRED PATHS ${_root_binary_dir})
+find_package(gflags REQUIRED PATHS ${_root_binary_dir}/third-party)
 
 target_include_directories(executorch INTERFACE ${_common_include_directories})
 
@@ -63,10 +69,7 @@ option(
 #
 # The `_<target>_srcs` lists are defined by including ${EXECUTORCH_SRCS_FILE}.
 #
-set(
-  EXECUTORCH_SRCS_FILE
-  "${CMAKE_CURRENT_BINARY_DIR}/../../../executorch_srcs.cmake"
-)
+set(EXECUTORCH_SRCS_FILE "${_root_binary_dir}/executorch_srcs.cmake")
 
 extract_sources(${EXECUTORCH_SRCS_FILE})
 

examples/portable/custom_ops/test_custom_ops.sh

@@ -9,11 +9,16 @@
 # EXIR to capture and export a model file. Then use `executor_runner` demo C++
 # binary to run the model.
 
-set -e
+set -eu
+set -o pipefail
 
 # shellcheck source=/dev/null
 source "$(dirname "${BASH_SOURCE[0]}")/../../../.ci/scripts/utils.sh"
 
+# Allow overriding the number of build jobs. The `-` makes this safe to check
+# even if the variable isn't defined; it is not a negative value.
+readonly NUM_JOBS=${CMAKE_BUILD_PARALLEL_LEVEL:-9}
+
 test_buck2_custom_op_1() {
   local model_name='custom_ops_1'
   echo "Exporting ${model_name}.pte"
@@ -39,13 +44,12 @@ test_cmake_custom_op_1() {
   rm -rf ${build_dir}
   retry cmake \
         -DREGISTER_EXAMPLE_CUSTOM_OP=1 \
-        -DCMAKE_INSTALL_PREFIX=cmake-out \
         -DPYTHON_EXECUTABLE="$PYTHON_EXECUTABLE" \
         -B${build_dir} \
         ${example_dir}
 
   echo "Building ${example_dir}"
-  cmake --build ${build_dir} -j9 --config Release
+  cmake --build ${build_dir} -j${NUM_JOBS} --config Release
 
   echo 'Running custom_ops_executor_runner'
   ${build_dir}/custom_ops_executor_runner --model_path="./${model_name}.pte"
@@ -85,21 +89,27 @@ get_shared_lib_ext() {
 
 test_cmake_custom_op_2() {
   local model_name='custom_ops_2'
-  SITE_PACKAGES="$(${PYTHON_EXECUTABLE} -c 'from distutils.sysconfig import get_python_lib; print(get_python_lib())')"
-  CMAKE_PREFIX_PATH="$PWD/cmake-out/lib/cmake/ExecuTorch;${SITE_PACKAGES}/torch"
+  # Declare as local separately so it doesn't hide errors when executing the
+  # subcommand.
+  local site_packages
+  site_packages="$(${PYTHON_EXECUTABLE} -c \
+    'from distutils.sysconfig import get_python_lib; print(get_python_lib())')"
+  # executorch-config.cmake is installed under cmake-out. The torch config lives
+  # inside its installed pip package.
+  local cmake_prefix_path="$PWD/cmake-out;${site_packages}/torch"
 
   local example_dir=examples/portable/custom_ops
   local build_dir=cmake-out/${example_dir}
   rm -rf ${build_dir}
   retry cmake \
         -DREGISTER_EXAMPLE_CUSTOM_OP=2 \
-        -DCMAKE_PREFIX_PATH="$CMAKE_PREFIX_PATH" \
-        -DPYTHON_EXECUTABLE="$PYTHON_EXECUTABLE" \
+        -DCMAKE_PREFIX_PATH="${cmake_prefix_path}" \
+        -DPYTHON_EXECUTABLE="${PYTHON_EXECUTABLE}" \
         -B${build_dir} \
         ${example_dir}
 
   echo "Building ${example_dir}"
-  cmake --build ${build_dir} -j9 --config Release
+  cmake --build ${build_dir} -j${NUM_JOBS} --config Release
 
   EXT=$(get_shared_lib_ext)
   echo "Exporting ${model_name}.pte"
@@ -110,12 +120,12 @@ test_cmake_custom_op_2() {
   ${build_dir}/custom_ops_executor_runner --model_path="./${model_name}.pte"
 }
 
-if [[ -z $PYTHON_EXECUTABLE ]];
+if [[ -z ${PYTHON_EXECUTABLE:-} ]];
 then
   PYTHON_EXECUTABLE=python3
 fi
 
-if [[ -z $BUCK ]];
+if [[ -z ${BUCK:-} ]];
 then
   BUCK=buck2
 fi