Merge branch 'main' into ops

Author: zingo

.ci/docker/build.sh

@@ -48,6 +48,7 @@ case "${IMAGE_NAME}" in
   executorch-ubuntu-22.04-mediatek-sdk)
     MEDIATEK_SDK=yes
     CLANG_VERSION=12
+    ANDROID_NDK_VERSION=r27b
     ;;
   executorch-ubuntu-22.04-clang12-android)
     LINTRUNNER=""

.ci/scripts/build_llama_android.sh

@@ -60,6 +60,5 @@ build_llama_runner() {
 
     cmake --build cmake-android-out/examples/models/llama -j4 --config Release
 }
-install_flatc_from_source
 install_executorch_and_backend_lib
 build_llama_runner

build/test_ios_ci.sh renamed to .ci/scripts/test_ios_ci.sh

@@ -209,9 +209,14 @@ test_model_with_qnn() {
   EXPORTED_MODEL=$(find "./${EXPORT_SCRIPT}" -type f -name "${MODEL_NAME}*.pte" -print -quit)
 }
 
+# Run CoreML tests.
+#
+# @param should_test If true, build and test the model using the coreml_executor_runner.
 test_model_with_coreml() {
-  if [[ "${BUILD_TOOL}" == "buck2" ]]; then
-    echo "coreml doesn't support buck2."
+  local should_test="$1"
+
+  if [[ "${BUILD_TOOL}" != "cmake" ]]; then
+    echo "coreml only supports cmake."
     exit 1
   fi
 
@@ -229,6 +234,14 @@ test_model_with_coreml() {
     echo "No .pte file found"
     exit 1
   fi
+
+  # Run the model
+  if [ "${should_test}" = true ]; then
+    echo "Testing exported model with coreml_executor_runner..."
+    local out_dir=$(mktemp -d)
+    COREML_EXECUTOR_RUNNER_OUT_DIR="${out_dir}" examples/apple/coreml/scripts/build_executor_runner.sh
+    "${out_dir}/coreml_executor_runner" --model_path "${EXPORTED_MODEL}"
+  fi
 }
 
 test_model_with_mps() {
@@ -247,7 +260,11 @@ elif [[ "${BACKEND}" == *"qnn"* ]]; then
   fi
 elif [[ "${BACKEND}" == *"coreml"* ]]; then
   echo "Testing ${MODEL_NAME} with coreml..."
-  test_model_with_coreml
+  should_test_coreml=false
+  if [[ "${BACKEND}" == *"test"* ]]; then
+    should_test_coreml=true
+  fi
+  test_model_with_coreml "${should_test_coreml}"
   if [[ $? -eq 0 ]]; then
     prepare_artifacts_upload
   fi

.ci/scripts/test_model.sh

@@ -80,25 +80,6 @@ install_pytorch_and_domains() {
   sccache --show-stats || true
 }
 
-install_flatc_from_source() {
-  # NB: This function could be used to install flatbuffer from source
-  pushd third-party/flatbuffers || return
-
-  cmake -G "Unix Makefiles" -DCMAKE_BUILD_TYPE=Release
-  if [ "$(uname)" == "Darwin" ]; then
-    CMAKE_JOBS=$(( $(sysctl -n hw.ncpu) - 1 ))
-  else
-    CMAKE_JOBS=$(( $(nproc) - 1 ))
-  fi
-  cmake --build . -j "${CMAKE_JOBS}"
-
-  # Copy the flatc binary to conda path
-  EXEC_PATH=$(dirname "$(which python)")
-  cp flatc "${EXEC_PATH}"
-
-  popd || return
-}
-
 build_executorch_runner_buck2() {
   # Build executorch runtime with retry as this step is flaky on macos CI
   retry buck2 build //examples/portable/executor_runner:executor_runner
@@ -111,9 +92,14 @@ build_executorch_runner_cmake() {
   mkdir "${CMAKE_OUTPUT_DIR}"
 
   pushd "${CMAKE_OUTPUT_DIR}" || return
+  if [[ $1 == "Debug" ]]; then
+      CXXFLAGS="-fsanitize=address,undefined"
+  else
+      CXXFLAGS=""
+  fi
   # This command uses buck2 to gather source files and buck2 could crash flakily
   # on MacOS
-  retry cmake -DPYTHON_EXECUTABLE="${PYTHON_EXECUTABLE}" -DCMAKE_BUILD_TYPE="${1:-Release}" ..
+  CXXFLAGS="$CXXFLAGS" retry cmake -DPYTHON_EXECUTABLE="${PYTHON_EXECUTABLE}" -DCMAKE_BUILD_TYPE="${1:-Release}" ..
   popd || return
 
   if [ "$(uname)" == "Darwin" ]; then

.ci/scripts/utils.sh

@@ -14,6 +14,12 @@
             test_base.ModelTest(
                 model=Model.Mv3,
                 backend=Backend.XnnpackQuantizationDelegation,
-            )
+            ),
+            # Enable this once CoreML is suppported out-of-the-box
+            # https://github.com/pytorch/executorch/issues/9019
+            # test_base.ModelTest(
+            #     model=Model.Mv3,
+            #     backend=Backend.CoreMlTest,
+            # )
         ]
     )

.ci/scripts/wheel/test_macos.py

@@ -14,7 +14,7 @@ on:
       - build/build_apple_frameworks.sh
       - build/build_apple_llm_demo.sh
       - build/create_frameworks.sh
-      - build/test_ios_ci.sh
+      - .ci/scripts/test_ios_ci.sh
       - examples/demo-apps/apple_ios/**
       - extension/apple/**
       - extension/benchmark/apple/**
@@ -75,7 +75,7 @@ jobs:
 
         # Build and test iOS Demo App
         PYTHON_EXECUTABLE=python ${CONDA_RUN} --no-capture-output \
-        build/test_ios_ci.sh "${ARTIFACTS_DIR_NAME}"
+        .ci/scripts/test_ios_ci.sh "${ARTIFACTS_DIR_NAME}"
 
   # Upload the test demo app to S3
   upload-demo-ios:

.github/workflows/apple.yml

@@ -176,7 +176,7 @@ jobs:
       id-token: write
       contents: read
     with:
-      runner: linux.2xlarge
+      runner: linux.2xlarge.memory
       docker-image: executorch-ubuntu-22.04-arm-sdk
       submodules: 'true'
       ref: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.sha || github.sha }}
@@ -206,7 +206,7 @@ jobs:
       id-token: write
       contents: read
     with:
-      runner: linux.2xlarge
+      runner: linux.2xlarge.memory
       docker-image: executorch-ubuntu-22.04-arm-sdk
       submodules: 'true'
       ref: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.sha || github.sha }}

.github/workflows/trunk.yml

@@ -460,7 +460,7 @@ endif()
 # tools like `flatc`, along with example executables like `executor_runner` and
 # libraries that it uses, like `gflags`. Disabling this can be helpful when
 # cross-compiling, but some required tools that would have been built need to be
-# provided directly (via, for example, FLATC_EXECUTABLE).
+# provided directly.
 cmake_dependent_option(
   EXECUTORCH_BUILD_HOST_TARGETS "Build host-only targets." ON
   "NOT CMAKE_TOOLCHAIN_IOS" OFF
@@ -471,10 +471,9 @@ cmake_dependent_option(
 #
 cmake_dependent_option(
   EXECUTORCH_BUILD_FLATC "Build the flatc executable." ON
-  "NOT FLATC_EXECUTABLE;EXECUTORCH_BUILD_HOST_TARGETS" OFF
+  "NOT FLATC_EXECUTABLE" OFF
 )
 
-
 set(FLATBUFFERS_BUILD_FLATC OFF CACHE BOOL "")
 set(FLATBUFFERS_BUILD_FLATHASH OFF CACHE BOOL "")
 set(FLATBUFFERS_BUILD_FLATLIB OFF CACHE BOOL "")
@@ -507,6 +506,8 @@ if(EXECUTORCH_BUILD_FLATC)
                -DFLATBUFFERS_BUILD_TESTS=${FLATBUFFERS_BUILD_TESTS}
                -DFLATBUFFERS_INSTALL=${FLATBUFFERS_INSTALL}
                -DCMAKE_CXX_FLAGS="-DFLATBUFFERS_MAX_ALIGNMENT=${FLATBUFFERS_MAX_ALIGNMENT}"
+               # If building for iOS, "unset" these variables to rely on the host (macOS) defaults.
+               $<$<AND:$<BOOL:${CMAKE_TOOLCHAIN_IOS}>,$<BOOL:$<FILTER:${PLATFORM},EXCLUDE,^MAC>>>:-DCMAKE_OSX_SYSROOT=>
     INSTALL_COMMAND ""
     BUILD_BYPRODUCTS <BINARY_DIR>/flatc
   )
@@ -515,6 +516,8 @@ if(EXECUTORCH_BUILD_FLATC)
     # flatbuffers does not use CMAKE_BUILD_TYPE. Internally, the build forces Release
     # config, but from CMake's perspective the build type is always Debug.
     set(FLATC_EXECUTABLE ${BINARY_DIR}/$<CONFIG>/flatc.exe)
+  elseif(CMAKE_GENERATOR STREQUAL "Xcode")
+    set(FLATC_EXECUTABLE ${BINARY_DIR}/$<CONFIG>/flatc)
   else()
     set(FLATC_EXECUTABLE ${BINARY_DIR}/flatc)
   endif()
@@ -528,12 +531,7 @@ if(NOT FLATC_EXECUTABLE)
   find_program(FLATC_EXECUTABLE flatc)
 
   if(NOT FLATC_EXECUTABLE)
-    message(
-      FATAL_ERROR
-        "FLATC_EXECUTABLE must be set when EXECUTORCH_BUILD_FLATC is disabled. "
-        "Note that EXECUTORCH_BUILD_FLATC may be disabled implicitly when "
-        "cross-compiling or when EXECUTORCH_BUILD_HOST_TARGETS is disabled."
-    )
+    message(FATAL_ERROR "FLATC_EXECUTABLE must be set when EXECUTORCH_BUILD_FLATC is disabled.")
   endif()
 endif()
 

CMakeLists.txt

@@ -32,7 +32,6 @@ cmake "$EXECUTORCH_ROOT_PATH" -B"$CMAKE_EXECUTORCH_BUILD_DIR_PATH" \
 -DCMAKE_TOOLCHAIN_FILE="$IOS_TOOLCHAIN_PATH" \
 -DPLATFORM=MAC_UNIVERSAL \
 -DDEPLOYMENT_TARGET=13.0 \
--DFLATC_EXECUTABLE="$(which flatc)" \
 -DEXECUTORCH_BUILD_EXECUTOR_RUNNER=OFF \
 -DEXECUTORCH_BUILD_XNNPACK=OFF \
 -DEXECUTORCH_BUILD_GFLAGS=OFF

backends/apple/coreml/scripts/build_tests.sh

@@ -22,11 +22,11 @@ static inline MTLLanguageVersion getMetalLanguageVersion(const id<MTLDevice>& de
   // MPS Advanced Indexing needs at least Metal 2.0 (support for Argument Buffers and function constants)
   // host_name attribute needs at least Metal 2.2 and ulong needs Metal 2.3 (supported on MacOS 11+)
   MTLLanguageVersion languageVersion = MTLLanguageVersion2_3;
-#if defined(__MAC_13_0)
-  if (macOS13Plus) {
-    languageVersion = MTLLanguageVersion3_0;
+  if (@available(iOS 16, macOS 13, *)) {
+    if (macOS13Plus) {
+      languageVersion = MTLLanguageVersion3_0;
+    }
   }
-#endif
 
   ET_CHECK_MSG([device supportsFamily:MTLGPUFamilyMac2], "Missing Metal support for MTLGPUFamilyMac2");
   return languageVersion;

backends/apple/mps/runtime/MPSDevice.mm

@@ -206,25 +206,32 @@
 
 Error
 MPSGraphBuilder::mpsScatterOp(NodePtr nodePtr) {
-  auto graphNode = nodePtr->mpsnode_union_as_MPSScatter();
-  ET_LOG(
-    Debug, "%s %d: %d",
-    __FUNCTION__, graphNode->input1_id(), graphNode->output_id()
-  );
+  if (@available(iOS 15.4, macOS 12.3, *)) {
+    auto graphNode = nodePtr->mpsnode_union_as_MPSScatter();
+    ET_LOG(
+      Debug, "%s %d: %d",
+      __FUNCTION__, graphNode->input1_id(), graphNode->output_id()
+    );
 
-  int64_t dim = graphNode->dim();
-  MPSGraphTensor* inputTensor = getMPSGraphTensor(graphNode->input1_id());
-  MPSGraphTensor* indicesTensor = getMPSGraphTensor(graphNode->idx_id());
-  MPSGraphTensor* updatesTensor = getMPSGraphTensor(graphNode->src_id());
+    int64_t dim = graphNode->dim();
+    MPSGraphTensor* inputTensor = getMPSGraphTensor(graphNode->input1_id());
+    MPSGraphTensor* indicesTensor = getMPSGraphTensor(graphNode->idx_id());
+    MPSGraphTensor* updatesTensor = getMPSGraphTensor(graphNode->src_id());
 
-  _idToMPSGraphTensor[graphNode->output_id()] =
-    [_mpsGraph scatterAlongAxis:dim
-                 withDataTensor:inputTensor
-                  updatesTensor:updatesTensor
-                  indicesTensor:indicesTensor
-                           mode:MPSGraphScatterModeSet
-                           name:nil];
-  return Error::Ok;
+    _idToMPSGraphTensor[graphNode->output_id()] =
+      [_mpsGraph scatterAlongAxis:dim
+                   withDataTensor:inputTensor
+                    updatesTensor:updatesTensor
+                    indicesTensor:indicesTensor
+                             mode:MPSGraphScatterModeSet
+                             name:nil];
+
+    return Error::Ok;
+  } else {
+    ET_LOG(Error, "MPS: scatter op is not supported on iOS < 15.4 and macOS < 12.3");
+
+    return Error::NotSupported;
+  }
 }
 
 

backends/apple/mps/runtime/operations/IndexingOps.mm

@@ -84,7 +84,6 @@ if [ "$build_with_etdump" = true ] ; then
         -DEXECUTORCH_ENABLE_EVENT_TRACER=ON               \
         -DEXECUTORCH_SEPARATE_FLATCC_HOST_PROJECT=ON      \
         -DFLATCC_ALLOW_WERROR=OFF                         \
-        -DFLATC_EXECUTABLE="$(which flatc)"               \
         -B"${et_build_host_dir}"                          \
         "${et_root_dir}"
 
@@ -133,7 +132,6 @@ cmake                                                 \
     -DEXECUTORCH_ENABLE_LOGGING=ON                    \
     ${build_devtools_flags}                           \
     ${build_with_etdump_flags}                        \
-    -DFLATC_EXECUTABLE="$(which flatc)"               \
     -B"${et_build_dir}"                               \
     "${et_root_dir}"
 

backends/arm/scripts/build_executorch.sh

@@ -19,7 +19,6 @@ python_library(
     srcs = ["runner_utils.py"],
     deps = [
         ":conftest",
-        "//executorch/backends/xnnpack/test/tester:tester",
         "//executorch/backends/arm:arm_backend",
         "//executorch/exir:lib",
         "//executorch/exir/backend:compile_spec_schema",
@@ -31,10 +30,7 @@ python_library(
     srcs = ["common.py"],
     deps = [
         ":runner_utils",
-        "//executorch/backends/xnnpack/test/tester:tester",
-        "//executorch/backends/arm:arm_backend",
-        "//executorch/exir:lib",
-        "//executorch/exir/backend:compile_spec_schema",
+        "//executorch/backends/arm:tosa_specification",
         "fbsource//third-party/pypi/pytest:pytest",
     ]
 )
@@ -43,12 +39,11 @@ python_library(
     name = "arm_tester",
     srcs = glob(["tester/*.py"]),
     deps = [
-        ":runner_utils",
         ":common",
-        "//executorch/backends/arm:tosa_mapping",
-        "//executorch/backends/arm:tosa_specification",
-        "//executorch/backends/arm/quantizer:arm_quantizer",
+        "//executorch/backends/xnnpack/test/tester:tester",
         "//executorch/backends/arm:arm_partitioner",
+        "//executorch/backends/arm/quantizer:arm_quantizer",
+        "//executorch/backends/arm:tosa_mapping",
         "//executorch/devtools/backend_debug:delegation_info",
         "fbsource//third-party/pypi/tabulate:tabulate",
     ]