IVGCVSW-6776 Add Arm NN build-tool scripts
* Initial scripts which download and build Arm NN
dependencies (setup-armnn.sh) and build both
Arm NN and ACL (build-armnn.sh).
* Also added common.sh for handling common variables
between scripts and validation.sh for common
command line arg validation.
Signed-off-by: James Conroy <james.conroy@arm.com>
Change-Id: I6a61149d048f618b4cc9770cc9dd6ec2e5f64ea5
diff --git a/build-tool/scripts/setup-armnn.sh b/build-tool/scripts/setup-armnn.sh
new file mode 100755
index 0000000..6a9c22e
--- /dev/null
+++ b/build-tool/scripts/setup-armnn.sh
@@ -0,0 +1,452 @@
+#!/bin/bash
+#
+# Copyright © 2022 Arm Ltd and Contributors. All rights reserved.
+# SPDX-License-Identifier: MIT
+#
+
+# Script which downloads and builds Arm NN dependencies
+# Perquisite to running build-armnn.sh
+
+set -o nounset # Catch references to undefined variables.
+set -o pipefail # Catch non zero exit codes within pipelines.
+set -o errexit # Catch and propagate non zero exit codes.
+
+rel_path=$(dirname "$0") # relative path from where script is executed to script location
+
+# Download an archive using wget and extract using tar
+# Takes three arguments:
+# 1. Name of dependency being downloaded e.g. Flatbuffers
+# 2. Link to archive
+# 3. Filename given to archive upon downloading
+download_and_extract()
+{
+ cd "$SOURCE_DIR"
+
+ echo -e "\n***** Downloading $1 *****"
+ wget -O "$3" "$2"
+
+ echo -e "\n***** Extracting archive *****"
+ tar -xzf "$3"
+
+ echo -e "\n***** Removing archive *****"
+ rm "$3"
+
+ echo -e "\n***** $1 downloaded *****"
+}
+
+download_protobuf()
+{
+ download_and_extract \
+ "Protobuf" \
+ "https://github.com/protocolbuffers/protobuf/releases/download/v$PROTOBUF_VERSION/protobuf-all-$PROTOBUF_VERSION.tar.gz" \
+ "protobuf-all-$PROTOBUF_VERSION.tar.gz"
+}
+
+build_protobuf()
+{
+ local native_build=$1
+ local build_dir="$PROTOBUF_BUILD_TARGET"
+ local cmake_flags=""
+ local target_arch="$TARGET_ARCH"
+ local additional_cmds=""
+
+ if [ "$native_build" -eq 0 ]; then
+ mkdir -p "$PROTOBUF_BUILD_TARGET"
+ additional_cmds+="--with-protoc=$PROTOCOL_COMPILER_HOST "
+ if [ "$TARGET_ARCH" == "aarch64" ]; then
+ cmake_flags+="$AARCH64_COMPILER_FLAGS"
+ additional_cmds+="--host=aarch64-linux "
+ elif [ "$TARGET_ARCH" == "aarch32" ]; then
+ cmake_flags+="$AARCH32_COMPILER_FLAGS"
+ additional_cmds+="--host=arm-linux "
+ fi
+ else
+ target_arch="$HOST_ARCH"
+ mkdir -p "$PROTOBUF_BUILD_HOST"
+ build_dir="$PROTOBUF_BUILD_HOST"
+ fi
+
+ echo -e "\n***** Building Protobuf for $target_arch ***** "
+
+ cd "$PROTOBUF_BUILD_ROOT"
+
+ # Cleanup any previous cmake files, except actual builds which we keep
+ find . -mindepth 1 -name "*_build" -prune -o -exec rm -rf {} +
+
+ eval "$cmake_flags" \
+ "$PROTOBUF_SRC"/configure --prefix="$build_dir" "$additional_cmds"
+ make install -j "$NUM_THREADS"
+
+ echo -e "\n***** Protobuf built for $target_arch ***** "
+}
+
+download_flatbuffers()
+{
+ download_and_extract \
+ "Flatbuffers" \
+ "https://github.com/google/flatbuffers/archive/v$FLATBUFFERS_VERSION.tar.gz" \
+ "flatbuffers-$FLATBUFFERS_VERSION.tar.gz"
+}
+
+build_flatbuffers()
+{
+ local native_build=$1
+ local build_dir="$FLATBUFFERS_BUILD_TARGET"
+ local target_arch="$TARGET_ARCH"
+
+ local cmake_flags="CXXFLAGS=-fPIC "
+
+ if [ "$native_build" -eq 0 ]; then
+ mkdir -p "$FLATBUFFERS_BUILD_TARGET"
+ if [ "$TARGET_ARCH" == "aarch64" ]; then
+ cmake_flags+="$AARCH64_COMPILER_FLAGS"
+ elif [ "$TARGET_ARCH" == "aarch32" ]; then
+ cmake_flags+="$AARCH32_COMPILER_FLAGS"
+ fi
+ else
+ target_arch="$HOST_ARCH"
+ mkdir -p "$FLATBUFFERS_BUILD_HOST"
+ build_dir="$FLATBUFFERS_BUILD_HOST"
+ fi
+
+ echo -e "\n***** Building flatbuffers for $target_arch *****"
+
+ mkdir -p "$FLATBUFFERS_BUILD_ROOT"
+ cd "$FLATBUFFERS_BUILD_ROOT"
+
+ # Cleanup any previous cmake files, except actual builds which we keep
+ find . -mindepth 1 -name "*_build" -prune -o -exec rm -rf {} +
+
+ eval "$cmake_flags" \
+ cmake -DFLATBUFFERS_BUILD_FLATC=1 \
+ -DCMAKE_INSTALL_PREFIX:PATH="$build_dir" \
+ -DFLATBUFFERS_BUILD_TESTS=0 \
+ "$FLATBUFFERS_SRC"
+ make all install -j "$NUM_THREADS"
+
+ echo -e "\n***** Built flatbuffers for $target_arch *****"
+}
+
+download_tensorflow()
+{
+ cd "$SOURCE_DIR"
+
+ echo -e "\n***** Downloading TensorFlow *****"
+ git clone https://github.com/tensorflow/tensorflow.git
+ cd "$TENSORFLOW_SRC"
+
+ git checkout "$("$ARMNN_SRC"/scripts/get_tensorflow.sh -p)"
+ echo -e "\n***** TensorFlow downloaded *****"
+}
+
+build_tflite()
+{
+ mkdir -p "$TFLITE_BUILD_TARGET"
+ cd "$TFLITE_BUILD_TARGET"
+
+ local target_arch_cmd="" # default is native, no command needed
+ local cmake_flags=""
+
+ case "$TARGET_ARCH" in
+ "aarch64")
+ cmake_flags+="$AARCH64_COMPILER_FLAGS"
+ target_arch_cmd="-DCMAKE_SYSTEM_PROCESSOR=aarch64 "
+
+ if [ "$NATIVE_BUILD" -eq 0 ]; then
+ cmake_flags+="ARMCC_FLAGS='-funsafe-math-optimizations' "
+ fi
+ ;;
+
+ "aarch32")
+ cmake_flags+="$AARCH32_COMPILER_FLAGS"
+ target_arch_cmd="-DCMAKE_SYSTEM_PROCESSOR=armv7 "
+
+ if [ "$NATIVE_BUILD" -eq 0 ]; then
+ cmake_flags+="ARMCC_FLAGS='-march=armv7-a -mfpu=neon-vfpv4 -funsafe-math-optimizations -mfp16-format=ieee' "
+ fi
+ ;;
+ esac
+
+ echo -e "\n***** Building TF Lite for $TARGET_ARCH *****"
+
+ # Cleanup any previous cmake files, except actual builds which we keep
+ find . -mindepth 1 -name "*_build" -prune -o -exec rm -rf {} +
+
+ eval "$cmake_flags" \
+ cmake -DTFLITE_ENABLE_XNNPACK=OFF \
+ "$target_arch_cmd" \
+ "$TFLITE_SRC"
+ cmake --build . -j "$NUM_THREADS"
+
+ echo -e "\n***** Built TF Lite for $TARGET_ARCH *****"
+}
+
+generate_tflite_schema()
+{
+ echo -e "\n***** Generating TF Lite Schema *****"
+ mkdir -p "$TFLITE_BUILD_ROOT"
+ cd "$TFLITE_BUILD_ROOT"
+
+ cp "$SCHEMA_SRC" .
+
+ $FLATC -c --gen-object-api --reflect-types --reflect-names schema.fbs
+
+ echo -e "\n***** Generated TF Lite Schema *****"
+}
+
+download_onnx()
+{
+ download_and_extract \
+ "ONNX" \
+ "https://github.com/onnx/onnx/releases/download/v$ONNX_VERSION/onnx-$ONNX_VERSION.tar.gz" \
+ "onnx-$ONNX_VERSION.tar.gz"
+}
+
+generate_onnx_sources()
+{
+ mkdir -p "$ONNX_BUILD_TARGET"
+ cd "$ONNX_SRC"
+
+ echo -e "\n***** Generating ONNX sources for $TARGET_ARCH *****"
+
+ export LD_LIBRARY_PATH="$PROTOBUF_BUILD_HOST"/lib${LD_LIBRARY_PATH:+:$LD_LIBRARY_PATH}
+
+ eval "$PROTOCOL_COMPILER_HOST" onnx/onnx.proto \
+ --proto_path=. \
+ --proto_path="$ONNX_SRC" \
+ --proto_path="$PROTOBUF_BUILD_HOST"/include \
+ --cpp_out "$ONNX_BUILD_TARGET"
+
+ echo -e "\n***** Generated ONNX sources for $TARGET_ARCH *****"
+}
+
+download_armnn()
+{
+ cd "$SOURCE_DIR"
+
+ echo -e "\n***** Downloading Arm NN *****"
+
+ # Latest release branch of Arm NN is checked out by default
+ git clone https://github.com/ARM-software/armnn.git armnn
+
+ cd "$ARMNN_SRC"
+ armnn_branch="$(git rev-parse --abbrev-ref HEAD)"
+
+ echo -e "\n***** Arm NN Downloaded: $armnn_branch *****"
+}
+
+download_acl()
+{
+ cd "$SOURCE_DIR"
+
+ echo -e "\n***** Downloading ACL *****"
+
+ git clone https://github.com/ARM-software/ComputeLibrary.git acl
+
+ # Get corresponding release tag for ACL by parsing release branch number for Arm NN
+ local acl_tag=""
+ acl_tag="$(echo "$armnn_branch" | tr '\n' ' ' | sed -e 's/[^0-9]/ /g' -e 's/^ *//g' -e 's/ *$//g' | tr -s ' ' | sed 's/ /./g')"
+
+ cd "$ACL_SRC"
+ git checkout v"$acl_tag"
+
+ echo -e "\n***** ACL Downloaded: $acl_tag *****"
+}
+
+usage()
+{
+ cat <<EOF
+setup-armnn.sh - Download and build Arm NN dependencies in the current directory (ROOT_DIR)
+setup-armnn.sh [OPTION]...
+ --tflite-delegate
+ setup dependencies for the Arm NN TF Lite Delegate
+ --tflite-parser
+ setup dependencies for the Arm NN TF Lite Parser
+ --onnx-parser
+ setup dependencies for the Arm NN ONNX parser
+ --all
+ setup dependencies for all Arm NN components listed above
+ --target-arch=[aarch64|aarch32|x86_64]
+ specify a target architecture (mandatory)
+ --num-threads=<INTEGER>
+ specify number of threads/cores to build dependencies with (optional: defaults to number of online CPU cores on host)
+ -h, --help
+ print brief usage information and exit
+ -x
+ enable shell tracing in this script
+
+At least one dependency flag (e.g. --tflite-delegate) must be provided or else provide --all to setup all dependencies.
+Directories called "source" and "build" will be generated in the current directory (ROOT_DIR) from which this script is called.
+It's recommended to call this script in a directory outside of this Arm NN source repo, to avoid nested repositories.
+
+This script will download the latest release branches of Arm NN and ACL, by default.
+Alternatively, manually create a "source" directory in ROOT_DIR and place custom repositories there.
+Custom repositories in "source" must be named "armnn" and "acl".
+
+Examples:
+Setup for aarch64 with all Arm NN dependencies:
+ <PATH_TO>/setup-armnn.sh --target-arch=aarch64 --all
+Setup for aarch64 with TF Lite Delegate and TF Lite Parser dependencies only:
+ <PATH_TO>/setup-armnn.sh --target-arch=aarch64 --tflite-delegate --tflite-parser
+Setup for aarch32 with all Arm NN dependencies:
+ <PATH_TO>/setup-armnn.sh --target-arch=aarch32 --all
+EOF
+}
+
+# This will catch in validation.sh if not set
+target_arch=""
+
+# Default flag values
+flag_tflite_delegate=0
+flag_tflite_parser=0
+flag_onnx_parser=0
+
+# If --num-threads is not set, the default NUM_THREADS value in common.sh will be used
+num_threads=0
+
+name=$(basename "$0")
+
+# If no options provided, show help
+if [ $# -eq 0 ]; then
+ usage
+ exit 1
+fi
+
+args=$(getopt -ohx -l tflite-delegate,tflite-parser,onnx-parser,all,target-arch:,num-threads:,help -n "$name" -- "$@")
+eval set -- "$args"
+while [ $# -gt 0 ]; do
+ if [ -n "${opt_prev:-}" ]; then
+ eval "$opt_prev=\$1"
+ opt_prev=
+ shift 1
+ continue
+ elif [ -n "${opt_append:-}" ]; then
+ if [ -n "$1" ]; then
+ eval "$opt_append=\"\${$opt_append:-} \$1\""
+ fi
+ opt_append=
+ shift 1
+ continue
+ fi
+ case $1 in
+ --tflite-parser)
+ flag_tflite_parser=1
+ ;;
+
+ --tflite-delegate)
+ flag_tflite_delegate=1
+ ;;
+
+ --onnx-parser)
+ flag_onnx_parser=1
+ ;;
+
+ --all)
+ flag_tflite_delegate=1
+ flag_tflite_parser=1
+ flag_onnx_parser=1
+ ;;
+
+ --target-arch)
+ opt_prev=target_arch
+ ;;
+
+ --num-threads)
+ opt_prev=num_threads
+ ;;
+
+ -h | --help)
+ usage
+ exit 0
+ ;;
+
+ -x)
+ set -x
+ ;;
+
+ --)
+ shift
+ break 2
+ ;;
+
+ esac
+ shift 1
+done
+
+# shellcheck source=common.sh
+source "$rel_path"/common.sh
+
+echo -e "\nINFO: Displaying configuration information before execution of $name"
+echo " target-arch: $TARGET_ARCH"
+echo " host-arch: $HOST_ARCH"
+echo " tflite-delegate: $flag_tflite_delegate"
+echo " tflite-parser: $flag_tflite_parser"
+echo " onnx-parser: $flag_onnx_parser"
+echo " num-threads: $NUM_THREADS"
+echo " root directory: $ROOT_DIR"
+echo "source directory: $SOURCE_DIR"
+echo " build directory: $BUILD_DIR"
+
+if [ "$(git rev-parse --is-inside-work-tree 2> /dev/null)" ]; then
+ echo -e "\n***** WARNING: Running script inside a git repository. To avoid nested repos, call this script from outside of this repo. *****"
+fi
+
+echo -e "\nScript execution will begin in 10 seconds..."
+
+sleep 10
+
+mkdir -p "$SOURCE_DIR"
+mkdir -p "$BUILD_DIR"
+
+if [ -d "$ARMNN_SRC" ]; then
+ echo -e "\n***** Arm NN source repository already located at $ARMNN_SRC. Skipping cloning of Arm NN. *****"
+else
+ download_armnn
+fi
+
+if [ -d "$ACL_SRC" ]; then
+ echo -e "\n***** ACL source repository already located at $ACL_SRC. Skipping cloning of ACL. *****"
+else
+ download_acl
+fi
+
+if [ "$flag_tflite_delegate" -eq 1 ] || [ "$flag_tflite_parser" -eq 1 ]; then
+ download_flatbuffers
+
+ # Host build
+ build_flatbuffers 1
+
+ # Target build for cross compile
+ if [ "$NATIVE_BUILD" -eq 0 ]; then
+ build_flatbuffers 0
+ fi
+
+ download_tensorflow
+fi
+
+if [ "$flag_tflite_parser" -eq 1 ]; then
+ generate_tflite_schema
+fi
+
+if [ "$flag_tflite_delegate" -eq 1 ]; then
+ build_tflite
+fi
+
+if [ "$flag_onnx_parser" -eq 1 ]; then
+ download_protobuf
+
+ # Host build
+ build_protobuf 1
+
+ # Target build for cross compile
+ if [ "$NATIVE_BUILD" -eq 0 ]; then
+ build_protobuf 0
+ fi
+
+ download_onnx
+ generate_onnx_sources
+fi
+
+echo -e "\n***** Arm NN setup complete. Now build with build-armnn.sh. *****\n"
+
+exit 0
\ No newline at end of file