Update on "Add CMakeLists.txt to run GTEST for runtime/kernel/test"

Summary:

Test Plan:

Reviewers:

Subscribers:

Tasks:

Tags:

[ghstack-poisoned]

Author: larryliu0820

.ci/docker/ci_commit_pins/buck2.txt

@@ -1 +1 @@
-2023-08-01
+2024-02-15

.ci/docker/ci_commit_pins/pytorch.txt

@@ -1 +1 @@
-930b60f5aa7e17402491900a545d96822796b638
+f5b99976adcbb01fd71bd0a39ea15bdac6c9e48a

.ci/scripts/setup-macos.sh

@@ -27,34 +27,25 @@ install_buck() {
     brew install wget
   fi
 
-  BUCK2_NOT_AVAILABLE=false
-  if ! command -v buck2 &> /dev/null; then
-    BUCK2_NOT_AVAILABLE=true
-  else
-    BUCK2_BINARY=$(which buck2)
-    BUCK2_ARCH=$(file -b "${BUCK2_BINARY}")
-
-    if [[ "${BUCK2_ARCH}" != "Mach-O 64-bit executable arm64" ]]; then
-      echo "Reinstall buck2 because ${BUCK2_BINARY} is ${BUCK2_ARCH}, not 64-bit arm64"
-      BUCK2_NOT_AVAILABLE=true
-    fi
-  fi
-
-  if [[ "${BUCK2_NOT_AVAILABLE}" == true ]]; then
-    pushd .ci/docker
+  pushd .ci/docker
 
-    BUCK2=buck2-aarch64-apple-darwin.zst
-    BUCK2_VERSION=$(cat ci_commit_pins/buck2.txt)
+  # TODO(huydo): This is a one-off copy of buck2 2024-02-15 to unblock Jon and
+  # re-enable ShipIt. It’s not ideal that upgrading buck2 will require a manual
+  # update the cached binary on S3 bucket too. Let me figure out if there is a
+  # way to correctly implement the previous setup of installing a new version of
+  # buck2 only when it’s needed. AFAIK, the complicated part was that buck2
+  # --version doesn't say anything w.r.t its release version, i.e. 2024-02-15.
+  # See D53878006 for more details.
+  BUCK2=buck2-aarch64-apple-darwin.zst
+  wget -q "https://ossci-macos.s3.amazonaws.com/${BUCK2}"
 
-    wget -q "https://github.com/facebook/buck2/releases/download/${BUCK2_VERSION}/${BUCK2}"
-    zstd -d "${BUCK2}" -o buck2
+  zstd -d "${BUCK2}" -o buck2
 
-    chmod +x buck2
-    mv buck2 /opt/homebrew/bin
+  chmod +x buck2
+  mv buck2 /opt/homebrew/bin
 
-    rm "${BUCK2}"
-    popd
-  fi
+  rm "${BUCK2}"
+  popd
 }
 
 function write_sccache_stub() {

.ci/scripts/test_llama.sh

@@ -6,9 +6,11 @@
 # LICENSE file in the root directory of this source tree.
 
 set -exu
+# shellcheck source=/dev/null
+source "$(dirname "${BASH_SOURCE[0]}")/utils.sh"
 
 MODEL_NAME=$1 # stories110M.pt
-BUILD_TOOL=$2 # buck2
+BUILD_TOOL=$2 # buck2 or cmake
 DTYPE=$3 # fp16 or fp32
 
 if [[ -z "${MODEL_NAME:-}" ]]; then
@@ -26,33 +28,58 @@ if [[ -z "${DTYPE:-}" ]]; then
   exit 1
 fi
 
-which "${PYTHON_EXECUTABLE}"
+if [[ -z "${BUCK:-}" ]]; then
+  BUCK=buck2
+fi
 
-# Check build tool.
-if [[ "${BUILD_TOOL}" == "buck2" ]]; then
-  :
-else
-  echo "Invalid build tool ${BUILD_TOOL}. Only buck2 is supported atm"
-  exit 1
+if [[ -z "${PYTHON_EXECUTABLE:-}" ]]; then
+  PYTHON_EXECUTABLE=python3
 fi
 
+which "${PYTHON_EXECUTABLE}"
+
+
+cmake_install_executorch_libraries() {
+    echo "Installing libexecutorch.a, libextension_module.so, libportable_ops_lib.a"
+    rm -rf cmake-out
+    retry cmake -DBUCK2="$BUCK" \
+        -DCMAKE_INSTALL_PREFIX=cmake-out \
+        -DCMAKE_BUILD_TYPE=Release \
+        -DEXECUTORCH_BUILD_EXTENSION_MODULE=ON \
+        -DEXECUTORCH_BUILD_EXTENSION_DATA_LOADER=ON \
+        -DPYTHON_EXECUTABLE="$PYTHON_EXECUTABLE" \
+        -Bcmake-out .
+    cmake --build cmake-out -j9 --target install --config Release
+}
+
+cmake_build_llama_runner() {
+    echo "Building llama runner"
+    dir="examples/models/llama2"
+    retry cmake -DBUCK2="$BUCK" \
+        -DCMAKE_INSTALL_PREFIX=cmake-out \
+        -DCMAKE_BUILD_TYPE=Release \
+        -DPYTHON_EXECUTABLE="$PYTHON_EXECUTABLE" \
+        -Bcmake-out/${dir} \
+        ${dir}
+    cmake --build cmake-out/${dir} -j9 --config Release
+
+}
+
 cleanup_files() {
   echo "Deleting downloaded and generated files"
   rm "${MODEL_NAME}"
   rm tokenizer.model
   rm tokenizer.bin
   rm "${EXPORTED_MODEL_NAME}"
+  rm result.txt
+  rm params.json
 }
 
 # Download and create artifacts.
 PARAMS="params.json"
 touch "${PARAMS}"
 if [[ "${MODEL_NAME}" == "stories110M.pt" ]]; then
-  # Download stories110M.pt and tokenizer from Github
-  wget "https://huggingface.co/karpathy/tinyllamas/resolve/main/stories110M.pt"
-  wget "https://raw.githubusercontent.com/karpathy/llama2.c/master/tokenizer.model"
-  # Create params.json file
-  echo '{"dim": 768, "multiple_of": 32, "n_heads": 12, "n_layers": 12, "norm_eps": 1e-05, "vocab_size": 32000}' > "${PARAMS}"
+  download_stories_model_artifacts
 else
   echo "Unsupported model name ${MODEL_NAME}"
   exit 1
@@ -72,16 +99,35 @@ fi
 # Export model.
 EXPORTED_MODEL_NAME="${EXPORTED_MODEL_NAME}.pte"
 echo "Exporting ${EXPORTED_MODEL_NAME}"
-python3 -m examples.models.llama2.export_llama -c stories110M.pt -p "${PARAMS}" -d "${DTYPE}"
+$PYTHON_EXECUTABLE -m examples.models.llama2.export_llama -c stories110M.pt -p "${PARAMS}" -d "${DTYPE}"
 
 # Create tokenizer.bin.
 echo "Creating tokenizer.bin"
-buck2 run examples/models/llama2/tokenizer:tokenizer_py -- -t tokenizer.model -o tokenizer.bin
+$PYTHON_EXECUTABLE -m examples.models.llama2.tokenizer.tokenizer -t tokenizer.model -o tokenizer.bin
 
-# Run model.
-echo "Running ${EXPORTED_MODEL_NAME} in portable mode"
-RESULT=$(timeout 500s buck2 run examples/models/llama2:main -- --model_path="${EXPORTED_MODEL_NAME}" --tokenizer_path=tokenizer.bin --prompt="Once" --temperature=0) || true
 
+RUNTIME_ARGS="--model_path=${EXPORTED_MODEL_NAME} --tokenizer_path=tokenizer.bin --prompt=Once --temperature=0 --seq_len=10"
+# Check build tool.
+echo "Running ${EXPORTED_MODEL_NAME} in portable mode"
+if [[ "${BUILD_TOOL}" == "buck2" ]]; then
+  # Run model.
+  # shellcheck source=/dev/null
+  $BUCK run examples/models/llama2:main -- ${RUNTIME_ARGS} > result.txt
+elif [[ "${BUILD_TOOL}" == "cmake" ]]; then
+  cmake_install_executorch_libraries
+  cmake_build_llama_runner
+  # Run llama runner
+  NOW=$(date +"%H:%M:%S")
+  echo "Starting to run llama runner at ${NOW}"
+  # shellcheck source=/dev/null
+  cmake-out/examples/models/llama2/llama_main ${RUNTIME_ARGS} > result.txt
+  NOW=$(date +"%H:%M:%S")
+  echo "Finished at ${NOW}"
+else
+  echo "Invalid build tool ${BUILD_TOOL}. Only buck2 is supported atm"
+  exit 1
+fi
+RESULT=$(cat result.txt)
 # Check results.
 EXPECTED_PREFIX="Once upon a time,"
 # Expected result - may take too long to generate:

.ci/scripts/utils.sh

@@ -131,3 +131,12 @@ cmake_install_executorch_lib() {
           -Bcmake-out .
   cmake --build cmake-out -j9 --target install --config Release
 }
+
+download_stories_model_artifacts() {
+    # Download stories110M.pt and tokenizer from Github
+  wget "https://huggingface.co/karpathy/tinyllamas/resolve/main/stories110M.pt"
+  wget "https://raw.githubusercontent.com/karpathy/llama2.c/master/tokenizer.model"
+  # Create params.json file
+  touch params.json
+  echo '{"dim": 768, "multiple_of": 32, "n_heads": 12, "n_layers": 12, "norm_eps": 1e-05, "vocab_size": 32000}' > params.json
+}

.github/merge_rules.yaml

@@ -0,0 +1,9 @@
+- name: superuser
+  patterns:
+  - '*'
+  approved_by:
+  - pytorch/metamates
+  mandatory_checks_name:
+  - Facebook CLA Check
+  - Lint
+  - pull

.github/workflows/app-build.yml

@@ -14,6 +14,7 @@ on:
       - build/build_apple_frameworks.sh
       - build/test_ios_ci.sh
       - examples/demo-apps/**
+      - extension/module/**
   workflow_dispatch:
 
 concurrency:

.github/workflows/pull.yml

@@ -83,12 +83,13 @@ jobs:
         # Build and test ExecuTorch
         PYTHON_EXECUTABLE=python bash .ci/scripts/test.sh "${MODEL_NAME}" "${BUILD_TOOL}" "${BACKEND}" "${DEMO_BACKEND_DELEGATION}"
 
-  test-llama-linux:
-    name: test-llama-linux
+  test-llama-runner-linux:
+    name: test-llama-runner-linux
     uses: pytorch/test-infra/.github/workflows/linux_job.yml@main
     strategy:
       matrix:
         dtype: [fp16, fp32]
+        build-tool: [buck2, cmake]
       fail-fast: false
     with:
       runner: linux.2xlarge
@@ -102,13 +103,14 @@ jobs:
         conda activate "${CONDA_ENV}"
 
         DTYPE=${{ matrix.dtype }}
+        BUILD_TOOL=${{ matrix.build-tool }}
 
         # Setup executorch
         PYTHON_EXECUTABLE=python bash .ci/scripts/setup-linux.sh buck2
         # Install requirements for export_llama
         PYTHON_EXECUTABLE=python bash examples/models/llama2/install_requirements.sh
         # Test llama2
-        PYTHON_EXECUTABLE=python bash .ci/scripts/test_llama.sh stories110M.pt buck2 "${DTYPE}"
+        PYTHON_EXECUTABLE=python bash .ci/scripts/test_llama.sh stories110M.pt "${BUILD_TOOL}" "${DTYPE}"
 
   test-custom-ops-linux:
     name: test-custom-ops-linux

.github/workflows/trunk.yml

@@ -137,27 +137,31 @@ jobs:
         # Test selective build
         PYTHON_EXECUTABLE=python bash examples/portable/scripts/test_demo_backend_delegation.sh "${BUILD_TOOL}"
 
-  # TODO(Jerry-Ge): Enable this back https://github.com/pytorch/executorch/issues/1947
-  # test-arm-backend-delegation:
-  #   name: test-arm-backend-delegation
-  #   uses: pytorch/test-infra/.github/workflows/linux_job.yml@main
-  #   with:
-  #     runner: linux.2xlarge
-  #     docker-image: executorch-ubuntu-22.04-arm-sdk
-  #     submodules: 'true'
-  #     ref: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.sha || github.sha }}
-  #     script: |
-  #       # The generic Linux job chooses to use base env, not the one setup by the image
-  #       CONDA_ENV=$(conda env list --json | jq -r ".envs | .[-1]")
-  #       conda activate "${CONDA_ENV}"
-
-  #       source .ci/scripts/utils.sh
-  #       install_flatc_from_source
-  #       install_executorch
-
-  #       # Test selective build
-  #       source /opt/arm-sdk/setup_path.sh
-  #       PYTHON_EXECUTABLE=python bash examples/arm/run.sh /opt/arm-sdk buck2
+  test-arm-backend-delegation:
+    name: test-arm-backend-delegation
+    uses: pytorch/test-infra/.github/workflows/linux_job.yml@main
+    with:
+      runner: linux.2xlarge
+      docker-image: executorch-ubuntu-22.04-arm-sdk
+      submodules: 'true'
+      ref: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.sha || github.sha }}
+      script: |
+        # The generic Linux job chooses to use base env, not the one setup by the image
+        CONDA_ENV=$(conda env list --json | jq -r ".envs | .[-1]")
+        conda activate "${CONDA_ENV}"
+
+        source .ci/scripts/utils.sh
+        install_flatc_from_source
+        install_executorch
+
+        # Setup arm example environment (including TOSA tools)
+        git config --global user.email "[email protected]"
+        git config --global user.name "Github Executorch"
+        bash examples/arm/setup.sh --i-agree-to-the-contained-eula
+
+        # Test ethos-u delegate examples with run.sh
+        source examples/arm/ethos-u-scratch/setup_path.sh
+        PYTHON_EXECUTABLE=python bash examples/arm/run.sh examples/arm/ethos-u-scratch/ buck2
 
   test-arm-reference-delegation:
     name: test-arm-reference-delegation
@@ -176,13 +180,16 @@ jobs:
         install_flatc_from_source
         install_executorch
 
+        # Setup arm example environment (including TOSA tools)
         git config --global user.email "[email protected]"
         git config --global user.name "Github Executorch"
         bash examples/arm/setup.sh --i-agree-to-the-contained-eula
 
-        source /opt/arm-sdk/setup_path.sh
+        # Test tosa_reference flow
+        source examples/arm/ethos-u-scratch/setup_path.sh
         PYTHON_EXECUTABLE=python bash backends/arm/test/run_tosa_reference.sh
 
+        # Run Arm specific unit-tests
         # Run pytest only on specified folders. These test should migrate into
         # the _unittest.yml once that test env is fixed
         pytest -c /dev/null -v -n auto --cov=./ --cov-report=xml backends/arm/test/ops/ backends/arm/test/models

.gitmodules

@@ -46,3 +46,12 @@
 [submodule "backends/arm/third-party/ethos-u-core-driver"]
 	path = backends/arm/third-party/ethos-u-core-driver
 	url = https://review.mlplatform.org/ml/ethos-u/ethos-u-core-driver
+[submodule "backends/vulkan/third-party/VulkanMemoryAllocator"]
+	path = backends/vulkan/third-party/VulkanMemoryAllocator
+	url = https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator.git
+[submodule "backends/vulkan/third-party/volk"]
+	path = backends/vulkan/third-party/volk
+	url = https://github.com/zeux/volk
+[submodule "backends/vulkan/third-party/Vulkan-Headers"]
+	path = backends/vulkan/third-party/Vulkan-Headers
+	url = https://github.com/KhronosGroup/Vulkan-Headers

CMakeLists.txt

@@ -94,14 +94,24 @@ if(EXECUTORCH_ENABLE_EVENT_TRACER)
   add_definitions(-DET_EVENT_TRACER_ENABLED)
 endif()
 
-# -O2: Moderate opt. -ffunction-sections -fdata-sections: breaks function and
+# -ffunction-sections -fdata-sections: breaks function and
 # data into sections so they can be properly gc'd. -s: strip symbol.
 # -fno-exceptions -fno-rtti: disables exceptions and runtime type.
 set(CMAKE_CXX_FLAGS_RELEASE
     "-O2 -ffunction-sections -fdata-sections -fno-exceptions -fno-rtti")
 if(NOT APPLE)
   set(CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} -s")
 endif()
+
+option(OPTIMIZE_SIZE "Build executorch runtime optimizing for binary size" OFF)
+if(OPTIMIZE_SIZE)
+  # -Os: Optimize for size
+  set(CMAKE_CXX_FLAGS_RELEASE "-Os ${CMAKE_CXX_FLAGS_RELEASE}")
+else()
+  # -O2: Moderate opt.
+  set(CMAKE_CXX_FLAGS_RELEASE "-O2 ${CMAKE_CXX_FLAGS_RELEASE}")
+endif()
+
 set(CMAKE_CXX_FLAGS_DEBUG "-O0 -g")
 
 # Option to register quantized ops with quantized kernels. See
@@ -368,7 +378,10 @@ endif()
 # Build pybind
 option(EXECUTORCH_BUILD_PYBIND "Build pybindings" OFF)
 if(EXECUTORCH_BUILD_PYBIND)
-  add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/extension/data_loader)
+  if(NOT EXECUTORCH_BUILD_EXTENSION_DATA_LOADER)
+    # This has already been added if above flag is on
+    add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/extension/data_loader)
+  endif()
   add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/sdk)
   add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/third-party/pybind11)
 
@@ -382,8 +395,8 @@ if(EXECUTORCH_BUILD_PYBIND)
     set(PYBIND_LINK_MPS "mpsdelegate")
   endif()
 
-  if(PYBIND_LINK_XNNPACK)
-    add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/backends/xnnpack)
+  if(EXECUTORCH_BUILD_XNNPACK)
+    # set PYBIND_LINK_XNNPACK variable to link with portable lib library
     set(PYBIND_LINK_XNNPACK "xnnpack_backend")
   endif()
 
@@ -424,6 +437,7 @@ if(EXECUTORCH_BUILD_PYBIND)
       flatcc
       portable_ops_lib
       util
+      torch
       ${PYBIND_LINK_COREML}
       ${PYBIND_LINK_MPS}
       ${PYBIND_LINK_XNNPACK}