1 # How to use the Android NDK to build ArmNN
3 * [Introduction](#introduction)
4 * [Download the Android NDK and make a standalone toolchain](#downloadNDK)
5 * [Build the Boost C++ libraries](#buildBoost)
6 * [Build the Compute Library](#buildCL)
7 * [Build Google's Protobuf library](#buildProtobuf)
8 * [Download TensorFlow](#downloadTF)
9 * [Build ArmNN](#buildArmNN)
10 * [Run ArmNN UnitTests on an Android device](#runArmNNUnitTests)
13 #### <a name="introduction">Introduction</a>
14 These are step by step instructions for using the Android NDK to build ArmNN.
15 They have been tested on a clean install of Ubuntu 18.04, and should also work with other OS versions.
16 The instructions show how to build the ArmNN core library and the optional TensorFlow parser.
17 All downloaded or generated files will be saved inside the `~/armnn-devenv` directory.
19 #### <a name="downloadNDK">Download the Android NDK and make a standalone toolchain</a>
21 * Download the Android NDK from [the official website](https://developer.android.com/ndk/downloads/index.html):
24 mkdir -p ~/armnn-devenv/toolchains
25 cd ~/armnn-devenv/toolchains
26 # For Mac OS, change the NDK download link accordingly.
27 wget https://dl.google.com/android/repository/android-ndk-r17b-linux-x86_64.zip
28 unzip android-ndk-r17b-linux-x86_64.zip
29 export NDK=~/armnn-devenv/toolchains/android-ndk-r17b
32 You may want to append `export NDK=~/armnn-devenv/toolchains/android-ndk-r17b` to your `~/.bashrc` (or `~/.bash_profile` in Mac OS).
34 * Make a standalone toolchain:
36 (Requires python if not previously installed: `sudo apt install python`)
39 # Create an arm64 API 26 libc++ toolchain.
40 $NDK/build/tools/make_standalone_toolchain.py \
44 --install-dir=$HOME/armnn-devenv/toolchains/aarch64-android-r17b
45 export PATH=$HOME/armnn-devenv/toolchains/aarch64-android-r17b/bin:$PATH
48 You may want to append `export PATH=$HOME/armnn-devenv/toolchains/aarch64-android-r17b/bin:$PATH` to your `~/.bashrc` (or `~/.bash_profile` in Mac OS).
50 #### <a name="buildBoost">Build the Boost C++ libraries</a>
52 * Download Boost version 1.64:
55 mkdir ~/armnn-devenv/boost
56 cd ~/armnn-devenv/boost
57 wget https://dl.bintray.com/boostorg/release/1.64.0/source/boost_1_64_0.tar.bz2
58 tar xvf boost_1_64_0.tar.bz2
63 (Requires gcc if not previously installed: `sudo apt install gcc`)
65 echo "using gcc : arm : aarch64-linux-android-clang++ ;" > $HOME/armnn-devenv/boost/user-config.jam
66 cd ~/armnn-devenv/boost/boost_1_64_0
67 ./bootstrap.sh --prefix=$HOME/armnn-devenv/boost/install
68 ./b2 install --user-config=$HOME/armnn-devenv/boost/user-config.jam \
69 toolset=gcc-arm link=static cxxflags=-fPIC --with-filesystem \
70 --with-test --with-log --with-program_options -j16
73 #### <a name="buildCL">Build the Compute Library</a>
74 * Clone the Compute Library:
76 (Requires Git if not previously installed: `sudo apt install git`)
80 git clone https://github.com/ARM-software/ComputeLibrary.git
85 (Requires SCons if not previously installed: `sudo apt install scons`)
88 scons arch=arm64-v8a neon=1 opencl=1 embed_kernels=1 extra_cxx_flags="-fPIC" \
89 benchmark_tests=0 validation_tests=0 os=android -j16
92 #### <a name="buildProtobuf">Build Google's Protobuf library</a>
96 mkdir ~/armnn-devenv/google
97 cd ~/armnn-devenv/google
98 git clone https://github.com/google/protobuf.git
100 git checkout -b v3.5.2 v3.5.2
103 * Build a native (x86) version of the protobuf libraries and compiler (protoc):
105 (Requires cUrl, autoconf, llibtool, and other build dependencies if not previously installed: `sudo apt install curl autoconf libtool build-essential g++`)
111 ../configure --prefix=$HOME/armnn-devenv/google/x86_pb_install
116 * Build the arm64 version of the protobuf libraries:
121 CC=aarch64-linux-android-clang \
122 CXX=aarch64-linux-android-clang++ \
123 CFLAGS="-fPIE -fPIC" LDFLAGS="-pie -llog" \
124 ../configure --host=aarch64-linux-android \
125 --prefix=$HOME/armnn-devenv/google/arm64_pb_install \
126 --with-protoc=$HOME/armnn-devenv/google/x86_pb_install/bin/protoc
131 #### <a name="downloadTF">Download TensorFlow</a>
132 * Clone TensorFlow source code:
135 cd ~/armnn-devenv/google/
136 git clone https://github.com/tensorflow/tensorflow.git
138 git checkout a0043f9262dc1b0e7dc4bdf3a7f0ef0bebc4891e
141 You need tensorflow/contrib/makefile/tf_proto_files.txt from TensorFlow to generate TensorFlow protobuf definitions. This file is not available in TensorFlow master branch.
143 #### <a name="buildArmNN">Build ArmNN</a>
145 * Clone ArmNN source code:
149 git clone https://github.com/ARM-software/armnn.git
152 * Generate TensorFlow protobuf definitions:
155 cd ~/armnn-devenv/google/tensorflow
156 ~/armnn-devenv/armnn/scripts/generate_tensorflow_protobuf.sh \
157 $HOME/armnn-devenv/google/tf_pb $HOME/armnn-devenv/google/x86_pb_install
162 (Requires CMake if not previously installed: `sudo apt install cmake`)
165 mkdir ~/armnn-devenv/armnn/build
166 cd ~/armnn-devenv/armnn/build
167 CXX=aarch64-linux-android-clang++ \
168 CC=aarch64-linux-android-clang \
169 CXX_FLAGS="-fPIE -fPIC" \
171 -DCMAKE_SYSTEM_NAME=Android \
172 -DCMAKE_ANDROID_ARCH_ABI=arm64-v8a \
173 -DCMAKE_ANDROID_STANDALONE_TOOLCHAIN=$HOME/armnn-devenv/toolchains/aarch64-android-r17b/ \
174 -DCMAKE_EXE_LINKER_FLAGS="-pie -llog" \
175 -DARMCOMPUTE_ROOT=$HOME/armnn-devenv/ComputeLibrary/ \
176 -DARMCOMPUTE_BUILD_DIR=$HOME/armnn-devenv/ComputeLibrary/build \
177 -DBOOST_ROOT=$HOME/armnn-devenv/boost/install/ \
178 -DARMCOMPUTENEON=1 -DARMCOMPUTECL=1 -DARMNNREF=1 \
179 -DTF_GENERATED_SOURCES=$HOME/armnn-devenv/google/tf_pb/ -DBUILD_TF_PARSER=1 \
180 -DPROTOBUF_ROOT=$HOME/armnn-devenv/google/arm64_pb_install/
184 #### <a name="runArmNNUnitTests">Run the ArmNN unit tests on an Android device</a>
187 * Push the build results to an Android device and make symbolic links for shared libraries:
190 adb push libarmnnTfParser.so /data/local/tmp/
191 adb push libarmnn.so /data/local/tmp/
192 adb push UnitTests /data/local/tmp/
193 adb push $NDK/sources/cxx-stl/llvm-libc++/libs/arm64-v8a/libc++_shared.so /data/local/tmp/
194 adb push $HOME/armnn-devenv/google/arm64_pb_install/lib/libprotobuf.so /data/local/tmp/libprotobuf.so.15.0.1
195 adb shell 'ln -s libprotobuf.so.15.0.1 /data/local/tmp/libprotobuf.so.15'
196 adb shell 'ln -s libprotobuf.so.15.0.1 /data/local/tmp/libprotobuf.so'
199 * Push the files needed for the unit tests (they are a mix of files, directories and symbolic links):
202 adb shell mkdir -p /data/local/tmp/src/backends/backendsCommon/test/testSharedObject
203 adb push -p ~/armnn-devenv/armnn/build/src/backends/backendsCommon/test/testSharedObject/* /data/local/tmp/src/backends/backendsCommon/test/testSharedObject/
205 adb shell mkdir -p /data/local/tmp/src/backends/backendsCommon/test/testDynamicBackend
206 adb push -p ~/armnn-devenv/armnn/build/src/backends/backendsCommon/test/testDynamicBackend/* /data/local/tmp/src/backends/backendsCommon/test/testDynamicBackend/
208 adb shell mkdir -p /data/local/tmp/src/backends/backendsCommon/test/backendsTestPath1
209 adb push -p ~/armnn-devenv/armnn/build/src/backends/backendsCommon/test/backendsTestPath1/* /data/local/tmp/src/backends/backendsCommon/test/backendsTestPath1/
211 adb shell mkdir -p /data/local/tmp/src/backends/backendsCommon/test/backendsTestPath2
212 adb push -p ~/armnn-devenv/armnn/build/src/backends/backendsCommon/test/backendsTestPath2/Arm_CpuAcc_backend.so /data/local/tmp/src/backends/backendsCommon/test/backendsTestPath2/
213 adb shell ln -s Arm_CpuAcc_backend.so /data/local/tmp/src/backends/backendsCommon/test/backendsTestPath2/Arm_CpuAcc_backend.so.1
214 adb shell ln -s Arm_CpuAcc_backend.so.1 /data/local/tmp/src/backends/backendsCommon/test/backendsTestPath2/Arm_CpuAcc_backend.so.1.2
215 adb shell ln -s Arm_CpuAcc_backend.so.1.2 /data/local/tmp/src/backends/backendsCommon/test/backendsTestPath2/Arm_CpuAcc_backend.so.1.2.3
216 adb push -p ~/armnn-devenv/armnn/build/src/backends/backendsCommon/test/backendsTestPath2/Arm_GpuAcc_backend.so /data/local/tmp/src/backends/backendsCommon/test/backendsTestPath2/
217 adb shell ln -s nothing /data/local/tmp/src/backends/backendsCommon/test/backendsTestPath2/Arm_no_backend.so
219 adb shell mkdir -p /data/local/tmp/src/backends/backendsCommon/test/backendsTestPath3
221 adb shell mkdir -p /data/local/tmp/src/backends/backendsCommon/test/backendsTestPath5
222 adb push -p ~/armnn-devenv/armnn/build/src/backends/backendsCommon/test/backendsTestPath5/* /data/local/tmp/src/backends/backendsCommon/test/backendsTestPath5/
224 adb shell mkdir -p /data/local/tmp/src/backends/backendsCommon/test/backendsTestPath6
225 adb push -p ~/armnn-devenv/armnn/build/src/backends/backendsCommon/test/backendsTestPath6/* /data/local/tmp/src/backends/backendsCommon/test/backendsTestPath6/
227 adb shell mkdir -p /data/local/tmp/src/backends/backendsCommon/test/backendsTestPath7
229 adb shell mkdir -p /data/local/tmp/src/backends/backendsCommon/test/backendsTestPath9
230 adb push -p ~/armnn-devenv/armnn/build/src/backends/backendsCommon/test/backendsTestPath9/* /data/local/tmp/src/backends/backendsCommon/test/backendsTestPath9/
232 adb shell mkdir -p /data/local/tmp/src/backends/dynamic/reference
233 adb push -p ~/armnn-devenv/armnn/build/src/backends/dynamic/reference/Arm_CpuRef_backend.so /data/local/tmp/src/backends/dynamic/reference/
236 * Run ArmNN unit tests:
239 adb shell 'LD_LIBRARY_PATH=/data/local/tmp /data/local/tmp/UnitTests'
242 If libarmnnUtils.a is present in `~/armnn-devenv/armnn/build/` and the unit tests run without failure then the build was successful.