Set up CMake build for extension/evalue_util (pytorch#12691)

It didn't have one. Now it does.

Author: swolchok

.ci/scripts/unittest-linux.sh

@@ -22,7 +22,7 @@ if [[ "$BUILD_TOOL" == "cmake" ]]; then
 
     # We need the runner to test the built library.
     PYTHON_EXECUTABLE=python \
-    CMAKE_ARGS="-DEXECUTORCH_BUILD_EXECUTOR_RUNNER=ON -DEXECUTORCH_BUILD_TESTS=ON" \
+    CMAKE_ARGS="-DEXECUTORCH_BUILD_EXTENSION_EVALUE_UTIL=ON -DEXECUTORCH_BUILD_EXTENSION_RUNNER_UTIL=ON -DEXECUTORCH_BUILD_EXECUTOR_RUNNER=ON -DEXECUTORCH_BUILD_TESTS=ON" \
     .ci/scripts/setup-linux.sh "$@"
 
     .ci/scripts/unittest-linux-cmake.sh

.ci/scripts/unittest-macos.sh

@@ -22,7 +22,7 @@ trap 'rm -rfv ${TMP_DIR}' EXIT
 # Setup MacOS dependencies as there is no Docker support on MacOS atm
 # We need the runner to test the built library.
 PYTHON_EXECUTABLE=python \
-CMAKE_ARGS="-DEXECUTORCH_BUILD_EXECUTOR_RUNNER=ON -DEXECUTORCH_BUILD_TESTS=ON" \
+CMAKE_ARGS="-DEXECUTORCH_BUILD_EXTENSION_EVALUE_UTIL=ON -DEXECUTORCH_BUILD_EXTENSION_RUNNER_UTIL=ON -DEXECUTORCH_BUILD_EXECUTOR_RUNNER=ON -DEXECUTORCH_BUILD_TESTS=ON" \
 ${CONDA_RUN} --no-capture-output \
 .ci/scripts/setup-macos.sh "$@"
 

CMakeLists.txt

@@ -548,6 +548,16 @@ if(EXECUTORCH_BUILD_EXTENSION_DATA_LOADER)
   add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/extension/data_loader)
 endif()
 
+if(EXECUTORCH_BUILD_EXTENSION_EVALUE_UTIL)
+  add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/extension/evalue_util)
+  install(
+    DIRECTORY extension/evalue_util/
+    DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/executorch/extension/evalue_util
+    FILES_MATCHING
+    PATTERN "*.h"
+  )
+endif()
+
 if(EXECUTORCH_BUILD_EXTENSION_FLAT_TENSOR)
   add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/extension/flat_tensor)
 endif()
@@ -576,6 +586,12 @@ endif()
 
 if(EXECUTORCH_BUILD_EXTENSION_RUNNER_UTIL)
   add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/extension/runner_util)
+  install(
+    DIRECTORY extension/runner_util/
+    DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/executorch/extension/runner_util
+    FILES_MATCHING
+    PATTERN "*.h"
+  )
 endif()
 
 if(EXECUTORCH_BUILD_EXTENSION_TENSOR)
@@ -651,8 +667,7 @@ if(EXECUTORCH_BUILD_PYBIND)
 
   # util lib
   add_library(
-    util ${CMAKE_CURRENT_SOURCE_DIR}/extension/evalue_util/print_evalue.cpp
-         ${CMAKE_CURRENT_SOURCE_DIR}/extension/aten_util/aten_bridge.cpp
+    util ${CMAKE_CURRENT_SOURCE_DIR}/extension/aten_util/aten_bridge.cpp
   )
   target_include_directories(
     util PUBLIC ${_common_include_directories} ${TORCH_INCLUDE_DIRS}
@@ -702,7 +717,9 @@ endif()
 
 if(EXECUTORCH_BUILD_EXECUTOR_RUNNER)
   # Baseline libraries that executor_runner will link against.
-  set(_executor_runner_libs executorch gflags)
+  set(_executor_runner_libs executorch extension_evalue_util
+                            extension_runner_util gflags
+  )
 
   if(EXECUTORCH_BUILD_KERNELS_OPTIMIZED)
     list(APPEND _executor_runner_libs optimized_native_cpu_ops_lib)

examples/apple/mps/CMakeLists.txt

@@ -105,6 +105,8 @@ if(NOT CMAKE_TOOLCHAIN_FILE MATCHES ".*(iOS|ios\.toolchain)\.cmake$")
     mps_executor_runner
     bundled_program
     executorch
+    extension_evalue_util
+    extension_runner_util
     gflags
     etdump
     flatccrt

examples/apple/mps/test_mps.sh

@@ -19,6 +19,8 @@ cmake_install_executorch_devtools_lib() {
           -DCMAKE_INSTALL_PREFIX=cmake-out \
           -DCMAKE_BUILD_TYPE=Release \
           -DEXECUTORCH_BUILD_DEVTOOLS=ON \
+          -DEXECUTORCH_BUILD_EXTENSION_EVALUE_UTIL=ON \
+          -DEXECUTORCH_BUILD_EXTENSION_RUNNER_UTIL=ON \
           -DEXECUTORCH_BUILD_MPS=ON \
           -DEXECUTORCH_ENABLE_EVENT_TRACER=ON \
           -DPYTHON_EXECUTABLE="$PYTHON_EXECUTABLE" \

examples/portable/custom_ops/CMakeLists.txt

@@ -123,7 +123,8 @@ list(TRANSFORM _executor_runner__srcs PREPEND "${EXECUTORCH_ROOT}/")
 
 add_executable(custom_ops_executor_runner ${_executor_runner__srcs})
 target_link_libraries(
-  custom_ops_executor_runner custom_ops_lib executorch gflags
+  custom_ops_executor_runner custom_ops_lib executorch extension_evalue_util
+  extension_runner_util gflags
 )
 target_compile_options(
   custom_ops_executor_runner PUBLIC ${_common_compile_options}

examples/qualcomm/executor_runner/CMakeLists.txt

@@ -19,8 +19,14 @@ target_include_directories(
   qnn_executor_runner PUBLIC ${_common_include_directories}
 )
 target_link_libraries(
-  qnn_executor_runner qnn_executorch_backend full_portable_ops_lib etdump
-  flatccrt gflags
+  qnn_executor_runner
+  qnn_executorch_backend
+  extension_evalue_util
+  extension_runner_util
+  full_portable_ops_lib
+  etdump
+  flatccrt
+  gflags
 )
 set_target_properties(
   qnn_executor_runner PROPERTIES LINK_FLAGS "-Wl,-rpath='$ORIGIN'"

examples/selective_build/CMakeLists.txt

@@ -33,7 +33,9 @@ if(NOT CMAKE_CXX_STANDARD)
   # Can't set to 11 due to executor_runner.cpp make_unique
 endif()
 
-set(_common_compile_options -Wno-deprecated-declarations -fPIC -ffunction-sections -fdata-sections)
+set(_common_compile_options -Wno-deprecated-declarations -fPIC
+                            -ffunction-sections -fdata-sections
+)
 
 # Let files say "include <executorch/path/to/header.h>".
 set(_common_include_directories ${EXECUTORCH_ROOT}/..)
@@ -43,7 +45,9 @@ find_package(
   gflags REQUIRED PATHS ${CMAKE_CURRENT_BINARY_DIR}/../../third-party
 )
 
-target_include_directories(executorch_core INTERFACE ${_common_include_directories})
+target_include_directories(
+  executorch_core INTERFACE ${_common_include_directories}
+)
 
 # ------------------------------ OPTIONS BEGIN -------------------------------
 
@@ -63,12 +67,13 @@ option(EXECUTORCH_SELECT_ALL_OPS
 )
 
 # Option to enable parsing ops and dtypes directly from model pte file
-option(EXECUTORCH_SELECT_OPS_FROM_MODEL "Enable op selection from pte during build." OFF
+option(EXECUTORCH_SELECT_OPS_FROM_MODEL
+       "Enable op selection from pte during build." OFF
 )
 
-# Option to enable dtype selective build. Note: must be using selective build model API.
-option(EXECUTORCH_DTYPE_SELECTIVE_BUILD "Enable dtype selective build." OFF
-)
+# Option to enable dtype selective build. Note: must be using selective build
+# model API.
+option(EXECUTORCH_DTYPE_SELECTIVE_BUILD "Enable dtype selective build." OFF)
 # ------------------------------- OPTIONS END --------------------------------
 
 #
@@ -155,7 +160,8 @@ if(NOT CMAKE_BUILD_TYPE STREQUAL "Debug")
   target_link_options_gc_sections(selective_build_test)
 endif()
 target_link_libraries(
-  selective_build_test PRIVATE executorch_core gflags select_build_lib
+  selective_build_test PRIVATE executorch_core extension_evalue_util
+                               extension_runner_util gflags select_build_lib
 )
 executorch_target_link_options_shared_lib(select_build_lib)
 target_compile_options(selective_build_test PUBLIC ${_common_compile_options})

extension/evalue_util/CMakeLists.txt

@@ -0,0 +1,29 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+# All rights reserved.
+#
+# This source code is licensed under the BSD-style license found in the
+# LICENSE file in the root directory of this source tree.
+
+# Please this file formatted by running:
+# ~~~
+# cmake-format -i CMakeLists.txt
+# ~~~
+# Source root directory for executorch.
+if(NOT EXECUTORCH_ROOT)
+  set(EXECUTORCH_ROOT ${CMAKE_CURRENT_SOURCE_DIR}/../..)
+endif()
+list(TRANSFORM _extension_evalue_util__srcs PREPEND "${EXECUTORCH_ROOT}/")
+add_library(extension_evalue_util ${_extension_evalue_util__srcs})
+target_link_libraries(extension_evalue_util executorch_core)
+target_include_directories(
+  extension_evalue_util PUBLIC ${_common_include_directories}
+)
+target_compile_options(extension_evalue_util PUBLIC ${_common_compile_options})
+
+# Install libraries
+install(
+  TARGETS extension_evalue_util
+  DESTINATION ${CMAKE_BINARY_DIR}/lib
+  INCLUDES
+  DESTINATION ${_common_include_directories}
+)

extension/evalue_util/print_evalue.cpp

@@ -39,8 +39,8 @@ int get_edge_items_xalloc() {
 
 /// Returns the number of "edge items" to print at the beginning and end of
 /// lists when using the provided stream.
-long get_stream_edge_items(std::ostream& os) {
-  long edge_items = os.iword(get_edge_items_xalloc());
+size_t get_stream_edge_items(std::ostream& os) {
+  size_t edge_items = os.iword(get_edge_items_xalloc());
   return edge_items <= 0 ? kDefaultEdgeItems : edge_items;
 }
 
@@ -78,21 +78,20 @@ void print_scalar_list(
     executorch::aten::ArrayRef<T> list,
     bool print_length = true,
     bool elide_inner_items = true) {
-  long edge_items = elide_inner_items ? get_stream_edge_items(os)
-                                      : std::numeric_limits<long>::max();
+  size_t edge_items = elide_inner_items ? get_stream_edge_items(os)
+                                        : std::numeric_limits<long>::max();
   if (print_length) {
     os << "(len=" << list.size() << ")";
   }
 
   // See if we'll be printing enough elements to cause us to wrap.
   bool wrapping = false;
   {
-    long num_printed_items;
+    size_t num_printed_items;
     if (elide_inner_items) {
-      num_printed_items =
-          std::min(static_cast<long>(list.size()), edge_items * 2);
+      num_printed_items = std::min(list.size(), edge_items * 2);
     } else {
-      num_printed_items = static_cast<long>(list.size());
+      num_printed_items = list.size();
     }
     wrapping = num_printed_items > kItemsPerLine;
   }