build.sh

#!/usr/bin/env bash
# Copyright (c) Qualcomm Innovation Center, Inc.
# 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.
set -e

pip install pydot

# Check if running on macOS/Darwin
if [[ "$(uname -s)" == "Darwin" ]]; then
    echo "Error: Qualcomm backend Python interface requires Linux operating system."
    echo "macOS/Darwin is not supported for building the Qualcomm backend."
    echo "Please use a x64 Linux system or x64 Linux container to build this backend."
    exit 1
fi

if [[ -z ${QNN_SDK_ROOT} ]]; then
    echo "Please export QNN_SDK_ROOT=/path/to/qnn_sdk"
    exit -1
fi


set -o xtrace

usage() {
  echo "Usage: Build the aarch64 version of executor runner or the python interface of Qnn Manager"
  echo "First, you need to set the environment variable for QNN_SDK_ROOT"
  echo ", and if you want to build the android version of executor runner"
  echo ", you need to export ANDROID_NDK_ROOT=/path/to/android_ndkXX"
  echo "(or export TOOLCHAIN_ROOT_HOST=/path/to/sysroots/xx_host, "
  echo "TOOLCHAIN_ROOT_TARGET=/path/to/sysroots/xx_target for linux embedded with --enable_linux_embedded)"
  echo "e.g.: executorch$ ./backends/qualcomm/scripts/build.sh --skip_x86_64"
  exit 1
}


[ "$1" = -h ] && usage

BUILD_X86_64="true"
CMAKE_X86_64="build-x86"
BUILD_ANDROID="true"
CMAKE_ANDROID="build-android"
BUILD_OE_LINUX="false"
CMAKE_OE_LINUX="build-oe-linux"
CLEAN="true"
BUILD_TYPE="RelWithDebInfo"
BUILD_JOB_NUMBER="16"

if [ -z PYTHON_EXECUTABLE ]; then
  PYTHON_EXECUTABLE="python3"
fi

if [ -z BUCK2 ]; then
  BUCK2="buck2"
fi

long_options=skip_x86_64,skip_linux_android,skip_linux_embedded,enable_linux_embedded,no_clean,release,job_number:

parsed_args=$(getopt -a --options '' --longoptions $long_options --name "$0" -- "$@")
eval set -- "$parsed_args"


while true ; do
    case "$1" in
        --skip_x86_64) BUILD_X86_64="false"; shift;;
        --skip_linux_android) BUILD_ANDROID="false"; shift;;
        --skip_linux_embedded) BUILD_OE_LINUX="false"; shift;;
        --enable_linux_embedded) BUILD_ANDROID="false"; BUILD_OE_LINUX="true"; shift;;
        --no_clean) CLEAN="false"; shift;;
        --release) BUILD_TYPE="Release"; shift;;
        --job_number) BUILD_JOB_NUMBER="$2"; shift 2;;
        --) shift; break;;
    esac
done

PRJ_ROOT="$( cd "$(dirname "$0")/../../.." ; pwd -P)"

if [ "$BUILD_ANDROID" = true ]; then
    if [[ -z ${ANDROID_NDK_ROOT} ]]; then
        echo "Please export ANDROID_NDK_ROOT=/path/to/android_ndkXX"
        exit -1
    fi

    BUILD_ROOT=$PRJ_ROOT/$CMAKE_ANDROID
    if [ "$CLEAN" = true ]; then
        rm -rf $BUILD_ROOT && mkdir $BUILD_ROOT
    else
        # Force rebuild flatccrt for the correct platform
        cd $BUILD_ROOT/third-party/flatcc && make clean
    fi

    cd $BUILD_ROOT
    cmake .. \
        -DCMAKE_INSTALL_PREFIX=$BUILD_ROOT \
        -DCMAKE_BUILD_TYPE=$BUILD_TYPE \
        -DEXECUTORCH_BUILD_QNN=ON \
        -DEXECUTORCH_BUILD_DEVTOOLS=ON \
        -DEXECUTORCH_BUILD_EXTENSION_LLM=ON \
        -DEXECUTORCH_BUILD_EXTENSION_LLM_RUNNER=ON \
        -DEXECUTORCH_BUILD_EXTENSION_MODULE=ON \
        -DEXECUTORCH_BUILD_EXTENSION_DATA_LOADER=ON \
        -DEXECUTORCH_BUILD_EXTENSION_FLAT_TENSOR=ON \
        -DEXECUTORCH_BUILD_EXTENSION_NAMED_DATA_MAP=ON \
        -DEXECUTORCH_BUILD_EXTENSION_TENSOR=ON \
        -DEXECUTORCH_ENABLE_EVENT_TRACER=ON \
        -DEXECUTORCH_ENABLE_LOGGING=ON \
        -DQNN_SDK_ROOT=$QNN_SDK_ROOT \
        -DCMAKE_TOOLCHAIN_FILE=$ANDROID_NDK_ROOT/build/cmake/android.toolchain.cmake \
        -DANDROID_ABI='arm64-v8a' \
        -DEXECUTORCH_BUILD_KERNELS_QUANTIZED=ON \
        -DANDROID_PLATFORM=android-30 \
        -DPYTHON_EXECUTABLE=$PYTHON_EXECUTABLE \
        -B$BUILD_ROOT

    cmake --build $BUILD_ROOT -j$BUILD_JOB_NUMBER --target install

    EXAMPLE_ROOT=examples/qualcomm
    CMAKE_PREFIX_PATH="${BUILD_ROOT};${BUILD_ROOT}/third-party/gflags;"

    cmake $PRJ_ROOT/$EXAMPLE_ROOT \
        -DCMAKE_TOOLCHAIN_FILE=$ANDROID_NDK_ROOT/build/cmake/android.toolchain.cmake \
        -DCMAKE_BUILD_TYPE=$BUILD_TYPE \
        -DANDROID_ABI='arm64-v8a' \
        -DANDROID_PLATFORM=android-30 \
        -DCMAKE_PREFIX_PATH=$CMAKE_PREFIX_PATH \
        -DSUPPORT_REGEX_LOOKAHEAD=ON \
        -DBUILD_TESTING=OFF \
        -DEXECUTORCH_ENABLE_LOGGING=ON \
        -DEXECUTORCH_BUILD_KERNELS_QUANTIZED=ON \
        -DCMAKE_FIND_ROOT_PATH_MODE_PACKAGE=BOTH \
        -DPYTHON_EXECUTABLE=$PYTHON_EXECUTABLE \
        -B$EXAMPLE_ROOT

    cmake --build $EXAMPLE_ROOT -j$BUILD_JOB_NUMBER

    LLAMA_EXAMPLE_ROOT=examples/models/llama
    cmake $PRJ_ROOT/$LLAMA_EXAMPLE_ROOT \
        -DBUILD_TESTING=OFF \
        -DCMAKE_TOOLCHAIN_FILE=$ANDROID_NDK_ROOT/build/cmake/android.toolchain.cmake \
        -DCMAKE_BUILD_TYPE=$BUILD_TYPE \
        -DANDROID_ABI='arm64-v8a' \
        -DANDROID_PLATFORM=android-30 \
        -DCMAKE_PREFIX_PATH=$CMAKE_PREFIX_PATH \
        -DEXECUTORCH_ENABLE_LOGGING=ON \
        -DCMAKE_FIND_ROOT_PATH_MODE_PACKAGE=BOTH \
        -DPYTHON_EXECUTABLE=$PYTHON_EXECUTABLE \
        -B$LLAMA_EXAMPLE_ROOT

    cmake --build $LLAMA_EXAMPLE_ROOT -j$BUILD_JOB_NUMBER
fi

if [ "$BUILD_OE_LINUX" = true ]; then
    if [[ -z ${TOOLCHAIN_ROOT_HOST} ]]; then
        echo "Please export e.g. TOOLCHAIN_ROOT_HOST=/path/to/sysroots/x86_64-qtisdk-linux"
        exit -1
    fi
    if [[ -z ${TOOLCHAIN_ROOT_TARGET} ]]; then
        echo "Please export e.g. TOOLCHAIN_ROOT_TARGET=/path/to/sysroots/armv8a-oe-linux"
        exit -1
    fi

    BUILD_ROOT=$PRJ_ROOT/$CMAKE_OE_LINUX
    if [ "$CLEAN" = true ]; then
        rm -rf $BUILD_ROOT && mkdir $BUILD_ROOT
    else
        # Force rebuild flatccrt for the correct platform
        cd $BUILD_ROOT/third-party/flatcc && make clean
    fi

    TOOLCHAN_PREFIX=$TOOLCHAIN_ROOT_HOST/usr/bin/aarch64-oe-linux/aarch64-oe-linux-
    cd $BUILD_ROOT
    cmake .. \
        -DCMAKE_INSTALL_PREFIX=$BUILD_ROOT \
        -DCMAKE_BUILD_TYPE=$BUILD_TYPE \
        -DCMAKE_C_COMPILER=${TOOLCHAN_PREFIX}gcc \
        -DCMAKE_CXX_COMPILER=${TOOLCHAN_PREFIX}g++ \
        -DCMAKE_SYSROOT=$TOOLCHAIN_ROOT_TARGET \
        -DCMAKE_SYSTEM_NAME=Linux \
        -DCMAKE_SYSTEM_PROCESSOR=aarch64 \
        -DCMAKE_FIND_ROOT_PATH_MODE_PROGRAM=NEVER \
        -DEXECUTORCH_BUILD_QNN=ON \
        -DEXECUTORCH_BUILD_DEVTOOLS=ON \
        -DEXECUTORCH_BUILD_EXTENSION_LLM=ON \
        -DEXECUTORCH_BUILD_EXTENSION_LLM_RUNNER=ON \
        -DEXECUTORCH_BUILD_EXTENSION_MODULE=ON \
        -DEXECUTORCH_BUILD_EXTENSION_DATA_LOADER=ON \
        -DEXECUTORCH_BUILD_EXTENSION_FLAT_TENSOR=ON \
        -DEXECUTORCH_BUILD_EXTENSION_NAMED_DATA_MAP=ON \
        -DEXECUTORCH_BUILD_EXTENSION_TENSOR=ON \
        -DEXECUTORCH_ENABLE_EVENT_TRACER=ON \
        -DEXECUTORCH_ENABLE_LOGGING=ON \
        -DQNN_SDK_ROOT=$QNN_SDK_ROOT \
        -DEXECUTORCH_BUILD_KERNELS_QUANTIZED=ON \
        -DPYTHON_EXECUTABLE=$PYTHON_EXECUTABLE \
        -B$BUILD_ROOT

    cmake --build $BUILD_ROOT -j$BUILD_JOB_NUMBER --target install

    EXAMPLE_ROOT=examples/qualcomm
    CMAKE_PREFIX_PATH="${BUILD_ROOT};${BUILD_ROOT}/third-party/gflags;"

    cmake $PRJ_ROOT/$EXAMPLE_ROOT \
        -DCMAKE_BUILD_TYPE=$BUILD_TYPE \
        -DCMAKE_PREFIX_PATH=$CMAKE_PREFIX_PATH \
        -DSUPPORT_REGEX_LOOKAHEAD=ON \
        -DBUILD_TESTING=OFF \
        -DEXECUTORCH_ENABLE_LOGGING=ON \
        -DCMAKE_C_COMPILER=${TOOLCHAN_PREFIX}gcc \
        -DCMAKE_CXX_COMPILER=${TOOLCHAN_PREFIX}g++ \
        -DCMAKE_SYSROOT=$TOOLCHAIN_ROOT_TARGET \
        -DCMAKE_SYSTEM_NAME=Linux \
        -DCMAKE_SYSTEM_PROCESSOR=aarch64 \
        -DEXECUTORCH_BUILD_KERNELS_QUANTIZED=ON \
        -DCMAKE_FIND_ROOT_PATH_MODE_PROGRAM=NEVER \
        -DCMAKE_FIND_ROOT_PATH_MODE_PACKAGE=BOTH \
        -DPYTHON_EXECUTABLE=$PYTHON_EXECUTABLE \
        -B$EXAMPLE_ROOT

    cmake --build $EXAMPLE_ROOT -j$BUILD_JOB_NUMBER

    LLAMA_EXAMPLE_ROOT=examples/models/llama
    cmake $PRJ_ROOT/$LLAMA_EXAMPLE_ROOT \
        -DBUILD_TESTING=OFF \
        -DCMAKE_BUILD_TYPE=$BUILD_TYPE \
        -DCMAKE_C_COMPILER=${TOOLCHAN_PREFIX}gcc \
        -DCMAKE_CXX_COMPILER=${TOOLCHAN_PREFIX}g++ \
        -DCMAKE_SYSROOT=$TOOLCHAIN_ROOT_TARGET \
        -DCMAKE_SYSTEM_NAME=Linux \
        -DCMAKE_SYSTEM_PROCESSOR=aarch64 \
        -DCMAKE_FIND_ROOT_PATH_MODE_PROGRAM=NEVER \
        -DCMAKE_PREFIX_PATH=$CMAKE_PREFIX_PATH \
        -DEXECUTORCH_ENABLE_LOGGING=ON \
        -DCMAKE_FIND_ROOT_PATH_MODE_PACKAGE=BOTH \
        -DPYTHON_EXECUTABLE=$PYTHON_EXECUTABLE \
        -B$LLAMA_EXAMPLE_ROOT

    cmake --build $LLAMA_EXAMPLE_ROOT -j$BUILD_JOB_NUMBER
fi

if [ "$BUILD_X86_64" = true ]; then
    BUILD_ROOT=$PRJ_ROOT/$CMAKE_X86_64
    if [ "$CLEAN" = true ]; then
        rm -rf $BUILD_ROOT && mkdir $BUILD_ROOT
    else
        # Force rebuild flatccrt for the correct platform
        cd $BUILD_ROOT/third-party/flatcc && make clean
    fi

    cd $BUILD_ROOT
    cmake \
        -DCMAKE_BUILD_TYPE=$BUILD_TYPE \
        -DCMAKE_INSTALL_PREFIX=$BUILD_ROOT \
        -DQNN_SDK_ROOT=${QNN_SDK_ROOT} \
        -DEXECUTORCH_BUILD_QNN=ON \
        -DEXECUTORCH_BUILD_DEVTOOLS=ON \
        -DEXECUTORCH_BUILD_EXTENSION_LLM=ON \
        -DEXECUTORCH_BUILD_EXTENSION_LLM_RUNNER=ON \
        -DEXECUTORCH_BUILD_EXTENSION_MODULE=ON \
        -DEXECUTORCH_BUILD_EXTENSION_DATA_LOADER=ON \
        -DEXECUTORCH_BUILD_EXTENSION_FLAT_TENSOR=ON \
        -DEXECUTORCH_BUILD_EXTENSION_NAMED_DATA_MAP=ON \
        -DEXECUTORCH_BUILD_KERNELS_QUANTIZED=ON \
        -DEXECUTORCH_BUILD_EXTENSION_TENSOR=ON \
        -DEXECUTORCH_ENABLE_EVENT_TRACER=ON \
        -DEXECUTORCH_ENABLE_LOGGING=ON \
        -DPYTHON_EXECUTABLE=$PYTHON_EXECUTABLE \
        -S $PRJ_ROOT \
        -B $BUILD_ROOT \

    cmake --build $BUILD_ROOT -j$BUILD_JOB_NUMBER --target install

    rm -f $PRJ_ROOT/backends/qualcomm/python/*
    cp -fv $BUILD_ROOT/backends/qualcomm/Py* "$PRJ_ROOT/backends/qualcomm/python"
    cp -fv "$PRJ_ROOT/schema/program.fbs" "$PRJ_ROOT/exir/_serialize/program.fbs"
    cp -fv "$PRJ_ROOT/schema/scalar_type.fbs" "$PRJ_ROOT/exir/_serialize/scalar_type.fbs"

   EXAMPLE_ROOT=examples/qualcomm
   CMAKE_PREFIX_PATH="${BUILD_ROOT};${BUILD_ROOT}/third-party/gflags;"

   echo "Update tokenizers submodule..."
   pushd $PRJ_ROOT/extension/llm/tokenizers
   git submodule update --init
   popd
   cmake $PRJ_ROOT/$EXAMPLE_ROOT \
       -DCMAKE_BUILD_TYPE=$BUILD_TYPE \
       -DCMAKE_PREFIX_PATH=$CMAKE_PREFIX_PATH \
       -DCMAKE_FIND_ROOT_PATH_MODE_PACKAGE=BOTH \
       -DPYTHON_EXECUTABLE=$PYTHON_EXECUTABLE \
       -DSUPPORT_REGEX_LOOKAHEAD=ON \
       -DBUILD_TESTING=OFF \
       -DEXECUTORCH_ENABLE_LOGGING=ON \
       -B$EXAMPLE_ROOT

   cmake --build $EXAMPLE_ROOT -j$BUILD_JOB_NUMBER

   LLAMA_EXAMPLE_ROOT=examples/models/llama
    cmake $PRJ_ROOT/$LLAMA_EXAMPLE_ROOT \
        -DBUILD_TESTING=OFF \
        -DCMAKE_BUILD_TYPE=$BUILD_TYPE \
        -DANDROID_ABI='arm64-v8a' \
        -DANDROID_PLATFORM=android-30 \
        -DCMAKE_PREFIX_PATH=$CMAKE_PREFIX_PATH \
        -DEXECUTORCH_ENABLE_LOGGING=ON \
        -DCMAKE_FIND_ROOT_PATH_MODE_PACKAGE=BOTH \
        -DPYTHON_EXECUTABLE=$PYTHON_EXECUTABLE \
        -B$LLAMA_EXAMPLE_ROOT

    cmake --build $LLAMA_EXAMPLE_ROOT -j$BUILD_JOB_NUMBER
fi