Build xnn_executor_runner with cmake (#153)

Summary:
So that the binary can be used in the same way as buck2

Pull Request resolved: #153

Reviewed By: kirklandsign

Differential Revision: D48727218

Pulled By: huydhn

fbshipit-source-id: a06c3316e4b6c4c8edbbd309115a2b7283bf8359

Author: huydhn

.ci/scripts/setup-macos.sh

@@ -57,9 +57,9 @@ install_buck() {
   fi
 }
 
-if [[ "${BUILD_TOOL}" == "buck2" ]]; then
-  install_buck
-fi
+# NB: we need buck2 in all cases because cmake build also depends on calling
+# buck2 atm
+install_buck
 install_conda
 install_pip_dependencies
 install_executorch

.ci/scripts/test.sh

@@ -65,8 +65,7 @@ test_model_with_xnnpack() {
   if [[ "${BUILD_TOOL}" == "buck2" ]]; then
     buck2 run //examples/backend:xnn_executor_runner -- --model_path "${OUTPUT_MODEL_PATH}"
   elif [[ "${BUILD_TOOL}" == "cmake" ]]; then
-    # TODO: Add cmake support for xnn_executor_runner
-    echo "XNNPACK doesn't support cmake yet, skipping..."
+    ./${CMAKE_OUTPUT_DIR}/backends/xnnpack/xnn_executor_runner --model_path "${OUTPUT_MODEL_PATH}"
   else
     echo "Invalid build tool ${BUILD_TOOL}. Only buck2 and cmake are supported atm"
     exit 1

.gitignore

@@ -8,6 +8,9 @@ build/lib/
 exir/serialize/scalar_type.fbs
 exir/serialize/program.fbs
 
+# Any exported models
+*.pte
+
 # Editor temporaries
 *.swa
 *.swb

CMakeLists.txt

@@ -171,5 +171,7 @@ if(NOT CMAKE_TOOLCHAIN_FILE MATCHES ".*ios\.toolchain\.cmake$")
   target_compile_options(executor_runner PUBLIC ${_common_compile_options})
 endif()
 
+add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/backends/xnnpack)
+
 # Print all summary
 executorch_print_configuration_summary()

backends/xnnpack/CMakeLists.txt

@@ -0,0 +1,95 @@
+# 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 --first-comment-is-literal=True CMakeLists.txt
+# ~~~
+
+cmake_minimum_required(VERSION 3.19)
+
+set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
+if(NOT CMAKE_CXX_STANDARD)
+  set(CMAKE_CXX_STANDARD 17)
+endif()
+
+if(NOT PYTHON_EXECUTABLE)
+  set(PYTHON_EXECUTABLE python3)
+endif()
+# Source root directory for executorch.
+if(NOT EXECUTORCH_ROOT)
+  set(EXECUTORCH_ROOT ${CMAKE_CURRENT_SOURCE_DIR}/../..)
+endif()
+
+include(${EXECUTORCH_ROOT}/build/Utils.cmake)
+
+set(_common_include_directories ${EXECUTORCH_ROOT}/..)
+set(_common_compile_options -Wno-deprecated-declarations)
+
+set(_xnnpack_schema__include_dir "${CMAKE_BINARY_DIR}/schema/include")
+# Paths to headers generated from the .fbs files.
+set(_xnnpack_schema__outputs)
+foreach(fbs_file ${_xnnpack_schema__srcs})
+  string(REGEX REPLACE "serialization/([^/]+)[.]fbs$" "\\1_generated.h"
+                       generated "${fbs_file}")
+  list(APPEND _xnnpack_schema__outputs
+       "${_xnnpack_schema__include_dir}/executorch/${generated}")
+endforeach()
+
+# Generate the headers from the .fbs files.
+add_custom_command(
+  OUTPUT ${_xnnpack_schema__outputs}
+  COMMAND
+    flatc --cpp --cpp-std c++11 --scoped-enums -o
+    "${_xnnpack_schema__include_dir}/executorch/backends/xnnpack"
+    ${_xnnpack_schema__srcs}
+  WORKING_DIRECTORY ${EXECUTORCH_ROOT}
+  COMMENT "Generating xnnpack_schema headers"
+  VERBATIM)
+
+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)
+
+set(xnn_executor_runner_libs ${_libs} xnnpack_schema)
+
+list(TRANSFORM _dynamic_quant_utils__srcs PREPEND "${EXECUTORCH_ROOT}/")
+add_library(dynamic_quant_utils ${_dynamic_quant_utils__srcs})
+set_target_properties(dynamic_quant_utils PROPERTIES LINKER_LANGUAGE CXX)
+target_include_directories(dynamic_quant_utils
+                           PUBLIC ${_common_include_directories})
+target_compile_options(dynamic_quant_utils PUBLIC ${_common_compile_options})
+
+if(ENABLE_DYNAMIC_QUANTIZATION)
+  list(APPEND xnn_executor_runner_libs dynamic_quant_utils)
+endif()
+
+include(cmake/Dependencies.cmake)
+
+list(TRANSFORM _xnnpack_backend__srcs PREPEND "${EXECUTORCH_ROOT}/")
+add_library(xnnpack_backend ${_xnnpack_backend__srcs})
+target_link_libraries(xnnpack_backend PRIVATE ${xnn_executor_runner_libs})
+target_include_directories(xnnpack_backend
+                           PUBLIC ${_common_include_directories})
+target_include_directories(xnnpack_backend PUBLIC ${XNNPACK_INCLUDE_DIR})
+target_compile_options(xnnpack_backend PUBLIC ${_common_compile_options})
+target_link_options_shared_lib(xnnpack_backend)
+
+list(APPEND xnn_executor_runner_libs xnnpack_backend)
+
+# ios can only build library but not binary
+if(NOT CMAKE_TOOLCHAIN_FILE MATCHES ".*ios\.toolchain\.cmake$")
+  #
+  # xnn_executor_runner: Like executor_runner but with XNNPACK, the binary will
+  # be at ${CMAKE_BINARY_DIR}/backends/xnnpack
+  #
+  list(TRANSFORM _xnn_executor_runner__srcs PREPEND "${EXECUTORCH_ROOT}/")
+  add_executable(xnn_executor_runner ${_xnn_executor_runner__srcs})
+  target_link_libraries(xnn_executor_runner ${xnn_executor_runner_libs})
+  target_compile_options(xnn_executor_runner PUBLIC ${_common_compile_options})
+endif()

backends/xnnpack/cmake/Dependencies.cmake

@@ -0,0 +1,39 @@
+# 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.
+
+# The logic is copied from https://github.com/pytorch/pytorch/blob/main/cmake/Dependencies.cmake
+set(THIRD_PARTY_ROOT "${CMAKE_CURRENT_SOURCE_DIR}/third-party")
+
+# --- cpuinfo
+set(CPUINFO_SOURCE_DIR "${THIRD_PARTY_ROOT}/cpuinfo")
+set(CPUINFO_BUILD_TOOLS OFF CACHE BOOL "")
+set(CPUINFO_BUILD_UNIT_TESTS OFF CACHE BOOL "")
+set(CPUINFO_BUILD_MOCK_TESTS OFF CACHE BOOL "")
+set(CPUINFO_BUILD_BENCHMARKS OFF CACHE BOOL "")
+set(CPUINFO_LIBRARY_TYPE "static" CACHE STRING "")
+set(CPUINFO_LOG_LEVEL "error" CACHE STRING "")
+set(CLOG_SOURCE_DIR "${CPUINFO_SOURCE_DIR}/deps/clog")
+add_subdirectory("${CPUINFO_SOURCE_DIR}")
+list(APPEND xnn_executor_runner_libs cpuinfo)
+
+# --- pthreadpool
+set(PTHREADPOOL_SOURCE_DIR "${THIRD_PARTY_ROOT}/pthreadpool")
+set(PTHREADPOOL_BUILD_TESTS OFF CACHE BOOL "")
+set(PTHREADPOOL_BUILD_BENCHMARKS OFF CACHE BOOL "")
+set(PTHREADPOOL_LIBRARY_TYPE "static" CACHE STRING "")
+set(PTHREADPOOL_ALLOW_DEPRECATED_API ON CACHE BOOL "")
+add_subdirectory("${PTHREADPOOL_SOURCE_DIR}")
+list(APPEND xnn_executor_runner_libs pthreadpool)
+
+# --- XNNPACK
+set(XNNPACK_SOURCE_DIR "${THIRD_PARTY_ROOT}/XNNPACK")
+set(XNNPACK_INCLUDE_DIR "${XNNPACK_SOURCE_DIR}/include")
+set(XNNPACK_LIBRARY_TYPE "static" CACHE STRING "")
+set(XNNPACK_BUILD_BENCHMARKS OFF CACHE BOOL "")
+set(XNNPACK_BUILD_TESTS OFF CACHE BOOL "")
+add_subdirectory("${XNNPACK_SOURCE_DIR}")
+include_directories(SYSTEM ${XNNPACK_INCLUDE_DIR})
+list(APPEND xnn_executor_runner_libs XNNPACK)

backends/xnnpack/runtime/XNNCompiler.cpp

@@ -7,8 +7,8 @@
  */
 
 #include <executorch/backends/xnnpack/runtime/XNNCompiler.h>
+#include <executorch/backends/xnnpack/schema_generated.h>
 #include <executorch/backends/xnnpack/threadpool/threadpool.h>
-#include <executorch/backends/xnnpack/xnnpack_schema_generated.h>
 #include <executorch/runtime/core/exec_aten/util/scalar_type_util.h>
 #include <unordered_map>
 

backends/xnnpack/targets.bzl

@@ -28,7 +28,7 @@ def define_common_targets():
         # file. Use `outs` so that `${OUT}` is expanded as the containing
         # directory instead of the file itself.
         outs = {
-            "xnnpack_schema_generated.h": ["schema_generated.h"],
+            "schema_generated.h": ["schema_generated.h"],
         },
         cmd = " ".join([
             "$(exe {})".format(runtime.external_dep_location("flatc")),
@@ -45,7 +45,7 @@ def define_common_targets():
         name = "xnnpack_schema",
         srcs = [],
         exported_headers = {
-            "xnnpack_schema_generated.h": ":gen_xnnpack_schema[xnnpack_schema_generated.h]",
+            "schema_generated.h": ":gen_xnnpack_schema[schema_generated.h]",
         },
         exported_external_deps = ["flatbuffers-api"],
     )

build/cmake_deps.toml

@@ -62,3 +62,42 @@ deps = [
   "executorch",
   "portable_kernels",
 ]
+
+[targets.xnnpack_schema]
+buck_targets = [
+  "//backends/xnnpack:xnnpack_schema"
+]
+filters = [
+  ".fbs$",
+]
+
+[targets.dynamic_quant_utils]
+buck_targets = [
+  "//backends/xnnpack:dynamic_quant_utils"
+]
+filters = [
+  ".cpp$",
+]
+
+[targets.xnnpack_backend]
+buck_targets = [
+  "//backends/xnnpack:xnnpack_backend"
+]
+filters = [
+  ".cpp$",
+]
+
+[targets.xnn_executor_runner]
+buck_targets = [
+  "//examples/backend:xnn_executor_runner",
+]
+filters = [
+  ".cpp$",
+]
+excludes = [
+  "^codegen",
+]
+deps = [
+  "xnnpack_backend",
+  "portable_kernels",
+]

examples/backend/xnnpack_examples.py

@@ -59,7 +59,7 @@
             "T161880157: Quantization-only without delegation is not supported yet"
         )
 
-    if args.model_name not in MODEL_NAME_TO_OPTIONS:
+    if args.model_name not in MODEL_NAME_TO_OPTIONS and args.quantize:
         raise RuntimeError(
             f"Model {args.model_name} is not a valid name. or not quantizable right now, "
             "please contact executorch team if you want to learn why or how to support "