1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
|
<!-- Copyright (c) 2020 ARM Limited. -->
<!-- -->
<!-- SPDX-License-Identifier: MIT -->
<!-- -->
<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="robots" content="NOINDEX, NOFOLLOW" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ArmNN: How to use the Android NDK to build Arm NN</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="stylesheet.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 10rem; margin-top: .5rem; margin-left 10px"/>
<td style="padding-left: 0.5em;">
<div id="projectname">
 <span id="projectnumber">21.02</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('md__build_guide_android_n_d_k.xhtml','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">How to use the Android NDK to build Arm NN </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><ul>
<li><a href="#introduction">Introduction</a></li>
<li><a href="#download-the-android-ndk-and-make-a-standalone-toolchain">Download the Android NDK and make a standalone toolchain</a></li>
<li><a href="#build-the-boost-c---libraries">Build the Boost C++ libraries</a></li>
<li><a href="#build-the-compute-library">Build the Compute Library</a></li>
<li><a href="#build-google-s-protobuf-library">Build Google's Protobuf library</a></li>
<li><a href="#download-tensorflow">Download TensorFlow</a></li>
<li><a href="#build-armnn">Build Arm NN</a></li>
<li><a href="#build-standalone-sample-dynamic-backend">Build Standalone Sample Dynamic Backend</a></li>
<li><a href="#run-the-armnn-unit-tests-on-an-android-device">Run the Arm NN unit tests on an Android device</a></li>
</ul>
<h2>Introduction</h2>
<p>These are step by step instructions for using the Android NDK to build Arm NN. They have been tested on a clean install of Ubuntu 16.04, and should also work with other OS versions. The instructions show how to build the Arm NN core library and the optional TensorFlow parser. All downloaded or generated files will be saved inside the <code>~/armnn-devenv</code> directory.</p>
<h5>Note: We are currently in the process of removing boost as a dependency to Arm NN. This process is finished for everything apart from our unit tests. This means you don't need boost to build and use Arm NN but you need it to execute our unit tests. Boost will soon be removed from Arm NN entirely. We also are deprecating support for Tensorflow parsers in 21.02. This will be removed in 21.05.</h5>
<h2>Download the Android NDK and make a standalone toolchain</h2>
<ul>
<li>Download the Android NDK from <a href="https://developer.android.com/ndk/downloads/index.html">the official website</a>: <div class="fragment"><div class="line">mkdir -p ~/armnn-devenv/toolchains</div><div class="line">cd ~/armnn-devenv/toolchains</div><div class="line"># For Mac OS, change the NDK download link accordingly.</div><div class="line">wget https://dl.google.com/android/repository/android-ndk-r20b-linux-x86_64.zip</div><div class="line">unzip android-ndk-r20b-linux-x86_64.zip</div><div class="line">export NDK=~/armnn-devenv/android-ndk-r20b</div><div class="line">export NDK_TOOLCHAIN_ROOT=$NDK/toolchains/llvm/prebuilt/linux-x86_64</div><div class="line">export PATH=$NDK_TOOLCHAIN_ROOT/bin/:$PATH</div><div class="line"></div><div class="line"># You may want to append the above export variables commands to your `~/.bashrc` (or `~/.bash_profile` in Mac OS).</div></div><!-- fragment --></li>
<li>With the android ndk-20b, you don't need to use the make_standalone_toolchain script to create a toolchain for a specific version of android. Android's current preference is for you to just specify the architecture and operating system while setting the compiler and just use the ndk directory.</li>
</ul>
<h2>Build the Boost C++ libraries</h2>
<ul>
<li>Download Boost version 1.64: <div class="fragment"><div class="line">mkdir ~/armnn-devenv/boost</div><div class="line">cd ~/armnn-devenv/boost</div><div class="line">wget https://dl.bintray.com/boostorg/release/1.64.0/source/boost_1_64_0.tar.bz2</div><div class="line">tar xvf boost_1_64_0.tar.bz2</div></div><!-- fragment --></li>
<li><p class="startli">Build:</p>
<p class="startli">(Requires clang if not previously installed: <code>sudo apt-get install clang</code>)</p>
<p class="startli">Note: You can specify the 'Android_API' version you want. For example, if your ANDROID_API is 27 then the compiler will be aarch64-linux-android27-clang++. </p><div class="fragment"><div class="line">echo "using clang : arm : aarch64-linux-android<Android_API>-clang++ ;" > $HOME/armnn-devenv/boost/user-config.jam</div><div class="line">cd ~/armnn-devenv/boost/boost_1_64_0</div><div class="line">./bootstrap.sh --prefix=$HOME/armnn-devenv/boost/install</div><div class="line">./b2 install --user-config=$HOME/armnn-devenv/boost/user-config.jam \</div><div class="line"> toolset=clang-arm link=static cxxflags=-fPIC \</div><div class="line"> --with-test --with-log --with-program_options -j16</div></div><!-- fragment --></li>
</ul>
<h2>Build the Compute Library</h2>
<ul>
<li><p class="startli">Clone the Compute Library:</p>
<p class="startli">(Requires Git if not previously installed: <code>sudo apt install git</code>) </p><div class="fragment"><div class="line">cd ~/armnn-devenv</div><div class="line">git clone https://github.com/ARM-software/ComputeLibrary.git</div></div><!-- fragment --></li>
<li>Checkout ComputeLibrary branch: <div class="fragment"><div class="line">cd ComputeLibrary</div><div class="line">git checkout <branch_name></div><div class="line">git pull</div></div><!-- fragment --> For example, if you want to checkout release branch of 20.02: <div class="fragment"><div class="line">git checkout branches/arm_compute_20_02</div><div class="line">git pull</div></div><!-- fragment --></li>
<li><p class="startli">Build:</p>
<p class="startli">(Requires SCons if not previously installed: <code>sudo apt install scons</code>) </p><div class="fragment"><div class="line">scons arch=arm64-v8a neon=1 opencl=1 embed_kernels=1 extra_cxx_flags="-fPIC" \</div><div class="line"> benchmark_tests=0 validation_tests=0 os=android -j16</div></div><!-- fragment --></li>
</ul>
<h2>Build Google's Protobuf library</h2>
<ul>
<li>Clone protobuf: <div class="fragment"><div class="line">mkdir ~/armnn-devenv/google</div><div class="line">cd ~/armnn-devenv/google</div><div class="line">git clone https://github.com/google/protobuf.git</div><div class="line">cd protobuf</div><div class="line">git checkout -b v3.12.0 v3.12.0</div></div><!-- fragment --></li>
<li><p class="startli">Build a native (x86) version of the protobuf libraries and compiler (protoc):</p>
<p class="startli">(Requires cUrl, autoconf, llibtool, and other build dependencies if not previously installed: <code>sudo apt install curl autoconf libtool build-essential g++</code>) </p><div class="fragment"><div class="line">./autogen.sh</div><div class="line">mkdir x86_build</div><div class="line">cd x86_build</div><div class="line">../configure --prefix=$HOME/armnn-devenv/google/x86_pb_install</div><div class="line">make install -j16</div><div class="line">cd ..</div></div><!-- fragment --></li>
<li>Build the arm64 version of the protobuf libraries: <div class="fragment"><div class="line">mkdir arm64_build</div><div class="line">cd arm64_build</div><div class="line">CC=aarch64-linux-android<Android_API>-clang \</div><div class="line">CXX=aarch64-linux-android<Android_API>-clang++ \</div><div class="line">CFLAGS="-fPIE -fPIC" \</div><div class="line"> LDFLAGS="-llog -lz -lc++_static" \</div><div class="line"> ../configure --host=aarch64-linux-android \</div><div class="line"> --prefix=$HOME/armnn-devenv/google/arm64_pb_install \</div><div class="line"> --enable-cross-compile \</div><div class="line"> --with-protoc=$HOME/armnn-devenv/google/x86_pb_install/bin/protoc</div><div class="line">make install -j16</div><div class="line">cd ..</div></div><!-- fragment --></li>
</ul>
<h2>Download TensorFlow</h2>
<ul>
<li>Clone TensorFlow source code: <div class="fragment"><div class="line">cd ~/armnn-devenv/google/</div><div class="line">git clone https://github.com/tensorflow/tensorflow.git</div><div class="line"> cd tensorflow/</div><div class="line"> git checkout fcc4b966f1265f466e82617020af93670141b009</div></div><!-- fragment --></li>
</ul>
<h2>Build Arm NN</h2>
<ul>
<li>Clone Arm NN source code: <div class="fragment"><div class="line">cd ~/armnn-devenv/</div><div class="line">git clone https://github.com/ARM-software/armnn.git</div></div><!-- fragment --></li>
<li>Checkout Arm NN branch: <div class="fragment"><div class="line">cd armnn</div><div class="line">git checkout <branch_name></div><div class="line">git pull</div></div><!-- fragment --></li>
</ul>
<p>For example, if you want to checkout release branch of 20.02: </p><div class="fragment"><div class="line">git checkout branches/armnn_20_02</div><div class="line">git pull</div></div><!-- fragment --><ul>
<li>Generate TensorFlow protobuf definitions: <div class="fragment"><div class="line">cd ~/armnn-devenv/google/tensorflow</div><div class="line">~/armnn-devenv/armnn/scripts/generate_tensorflow_protobuf.sh \</div><div class="line"> $HOME/armnn-devenv/google/tf_pb $HOME/armnn-devenv/google/x86_pb_install</div></div><!-- fragment --></li>
<li><p class="startli">Build Arm NN:</p>
<p class="startli">(Requires CMake if not previously installed: <code>sudo apt install cmake</code>) </p><div class="fragment"><div class="line">mkdir ~/armnn-devenv/armnn/build</div><div class="line">cd ~/armnn-devenv/armnn/build</div><div class="line">CXX=aarch64-linux-android<Android_API>-clang++ \</div><div class="line">CC=aarch64-linux-android<Android_API>-clang \</div><div class="line">CXX_FLAGS="-fPIE -fPIC" \</div><div class="line">cmake .. \</div><div class="line"> -DCMAKE_ANDROID_NDK=$NDK \</div><div class="line"> -DCMAKE_SYSTEM_NAME=Android \</div><div class="line"> -DCMAKE_SYSTEM_VERSION=<Android_API> \</div><div class="line"> -DCMAKE_ANDROID_ARCH_ABI=arm64-v8a \</div><div class="line"> -DCMAKE_EXE_LINKER_FLAGS="-pie -llog -lz" \</div><div class="line"> -DARMCOMPUTE_ROOT=$HOME/armnn-devenv/ComputeLibrary/ \</div><div class="line"> -DARMCOMPUTE_BUILD_DIR=$HOME/armnn-devenv/ComputeLibrary/build \</div><div class="line"> -DBOOST_ROOT=$HOME/armnn-devenv/boost/install/ \</div><div class="line"> -DARMCOMPUTENEON=1 -DARMCOMPUTECL=1 -DARMNNREF=1 \</div><div class="line"> -DTF_GENERATED_SOURCES=$HOME/armnn-devenv/google/tf_pb/ -DBUILD_TF_PARSER=1 \</div><div class="line"> -DPROTOBUF_ROOT=$HOME/armnn-devenv/google/arm64_pb_install/</div></div><!-- fragment --></li>
</ul>
<p>To include standalone sample dynamic backend tests, add the argument to enable the tests and the dynamic backend path to the CMake command:</p>
<div class="fragment"><div class="line">-DSAMPLE_DYNAMIC_BACKEND=1 \</div><div class="line">-DDYNAMIC_BACKEND_PATHS=$SAMPLE_DYNAMIC_BACKEND_PATH</div><div class="line"># Where $SAMPLE_DYNAMIC_BACKEND_PATH is the path where libArm_SampleDynamic_backend.so library file is pushed</div></div><!-- fragment --><ul>
<li>Run the build <div class="fragment"><div class="line">make -j16</div></div><!-- fragment --></li>
</ul>
<h2>Build Standalone Sample Dynamic Backend</h2>
<ul>
<li>The sample dynamic backend is located in armnn/src/dynamic/sample <div class="fragment"><div class="line">mkdir build</div><div class="line">cd build</div></div><!-- fragment --></li>
<li>Use CMake to configure the build environment, update the following script and run it from the armnn/src/dynamic/sample/build directory to set up the Arm NN build: <div class="fragment"><div class="line">#!/bin/bash</div><div class="line">CXX=aarch64-linux-android<Android_API>-clang++ \</div><div class="line">CC=aarch64-linux-android<Android_API>-clang \</div><div class="line">CXX_FLAGS="-fPIE -fPIC" \</div><div class="line">cmake \</div><div class="line">-DCMAKE_SYSTEM_NAME=Android \</div><div class="line">-DCMAKE_CXX_FLAGS=--std=c++14 \</div><div class="line">-DCMAKE_EXE_LINKER_FLAGS="-pie -llog" \</div><div class="line">-DCMAKE_MODULE_LINKER_FLAGS="-llog" \</div><div class="line">-DBOOST_ROOT=$HOME/armnn-devenv/boost/install \</div><div class="line">-DBoost_SYSTEM_LIBRARY=$HOME/armnn-devenv/boost/install/lib/libboost_system.a \</div><div class="line">-DARMNN_PATH=$HOME/armnn-devenv/armnn/build/libarmnn.so ..</div></div><!-- fragment --></li>
<li>Run the build <div class="fragment"><div class="line">make</div></div><!-- fragment --></li>
</ul>
<h2>Run the Arm NN unit tests on an Android device</h2>
<ul>
<li>Push the build results to an Android device and make symbolic links for shared libraries: Currently adb version we have used for testing is 1.0.41. <div class="fragment"><div class="line">adb push libarmnnTfParser.so /data/local/tmp/</div><div class="line">adb push libarmnn.so /data/local/tmp/</div><div class="line"> adb push libtimelineDecoder.so /data/local/tmp/</div><div class="line">adb push UnitTests /data/local/tmp/</div><div class="line">adb push $NDK/sources/cxx-stl/llvm-libc++/libs/arm64-v8a/libc++_shared.so /data/local/tmp/</div><div class="line">adb push $HOME/armnn-devenv/google/arm64_pb_install/lib/libprotobuf.so /data/local/tmp/libprotobuf.so.24.0.0</div><div class="line">adb shell 'ln -s libprotobuf.so.24.0.0 /data/local/tmp/libprotobuf.so.24'</div><div class="line">adb shell 'ln -s libprotobuf.so.24.0.0 /data/local/tmp/libprotobuf.so'</div></div><!-- fragment --></li>
<li>Push the files needed for the unit tests (they are a mix of files, directories and symbolic links): <div class="fragment"><div class="line">adb shell mkdir -p /data/local/tmp/src/backends/backendsCommon/test/testSharedObject</div><div class="line">adb push -p ~/armnn-devenv/armnn/build/src/backends/backendsCommon/test/testSharedObject/* /data/local/tmp/src/backends/backendsCommon/test/testSharedObject/</div><div class="line"></div><div class="line">adb shell mkdir -p /data/local/tmp/src/backends/backendsCommon/test/testDynamicBackend</div><div class="line">adb push -p ~/armnn-devenv/armnn/build/src/backends/backendsCommon/test/testDynamicBackend/* /data/local/tmp/src/backends/backendsCommon/test/testDynamicBackend/</div><div class="line"></div><div class="line">adb shell mkdir -p /data/local/tmp/src/backends/backendsCommon/test/backendsTestPath1</div><div class="line">adb push -p ~/armnn-devenv/armnn/build/src/backends/backendsCommon/test/backendsTestPath1/* /data/local/tmp/src/backends/backendsCommon/test/backendsTestPath1/</div><div class="line"></div><div class="line">adb shell mkdir -p /data/local/tmp/src/backends/backendsCommon/test/backendsTestPath2</div><div class="line">adb push -p ~/armnn-devenv/armnn/build/src/backends/backendsCommon/test/backendsTestPath2/Arm_CpuAcc_backend.so /data/local/tmp/src/backends/backendsCommon/test/backendsTestPath2/</div><div class="line">adb shell ln -s Arm_CpuAcc_backend.so /data/local/tmp/src/backends/backendsCommon/test/backendsTestPath2/Arm_CpuAcc_backend.so.1</div><div class="line">adb shell ln -s Arm_CpuAcc_backend.so.1 /data/local/tmp/src/backends/backendsCommon/test/backendsTestPath2/Arm_CpuAcc_backend.so.1.2</div><div class="line">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</div><div class="line">adb push -p ~/armnn-devenv/armnn/build/src/backends/backendsCommon/test/backendsTestPath2/Arm_GpuAcc_backend.so /data/local/tmp/src/backends/backendsCommon/test/backendsTestPath2/</div><div class="line">adb shell ln -s nothing /data/local/tmp/src/backends/backendsCommon/test/backendsTestPath2/Arm_no_backend.so</div><div class="line"></div><div class="line">adb shell mkdir -p /data/local/tmp/src/backends/backendsCommon/test/backendsTestPath3</div><div class="line"></div><div class="line">adb shell mkdir -p /data/local/tmp/src/backends/backendsCommon/test/backendsTestPath5</div><div class="line">adb push -p ~/armnn-devenv/armnn/build/src/backends/backendsCommon/test/backendsTestPath5/* /data/local/tmp/src/backends/backendsCommon/test/backendsTestPath5/</div><div class="line"></div><div class="line">adb shell mkdir -p /data/local/tmp/src/backends/backendsCommon/test/backendsTestPath6</div><div class="line">adb push -p ~/armnn-devenv/armnn/build/src/backends/backendsCommon/test/backendsTestPath6/* /data/local/tmp/src/backends/backendsCommon/test/backendsTestPath6/</div><div class="line"></div><div class="line">adb shell mkdir -p /data/local/tmp/src/backends/backendsCommon/test/backendsTestPath7</div><div class="line"></div><div class="line">adb shell mkdir -p /data/local/tmp/src/backends/backendsCommon/test/backendsTestPath9</div><div class="line">adb push -p ~/armnn-devenv/armnn/build/src/backends/backendsCommon/test/backendsTestPath9/* /data/local/tmp/src/backends/backendsCommon/test/backendsTestPath9/</div><div class="line"></div><div class="line">adb shell mkdir -p /data/local/tmp/src/backends/dynamic/reference</div><div class="line">adb push -p ~/armnn-devenv/armnn/build/src/backends/dynamic/reference/Arm_CpuRef_backend.so /data/local/tmp/src/backends/dynamic/reference/</div><div class="line"></div><div class="line"># If the standalone sample dynamic tests are enabled, also push libArm_SampleDynamic_backend.so library file to the folder specified as $SAMPLE_DYNAMIC_BACKEND_PATH when Arm NN is built.</div><div class="line"># This is the example when $SAMPLE_DYNAMIC_BACKEND_PATH is specified as /data/local/tmp/dynamic/sample/:</div><div class="line"></div><div class="line">adb shell mkdir -p /data/local/tmp/dynamic/sample/</div><div class="line">adb push -p ${WORKING_DIR}/armnn/src/dynamic/sample/build/libArm_SampleDynamic_backend.so /data/local/tmp/dynamic/sample/</div></div><!-- fragment --></li>
<li>Run Arm NN unit tests: <div class="fragment"><div class="line">adb shell 'LD_LIBRARY_PATH=/data/local/tmp:/vendor/lib64:/vendor/lib64/egl /data/local/tmp/UnitTests'</div></div><!-- fragment --> If libarmnnUtils.a is present in <code>~/armnn-devenv/armnn/build/</code> and the unit tests run without failure then the build was successful. </li>
</ul>
</div></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="buildguides.xhtml">Installation and build Guides</a></li>
<li class="footer">Generated on Thu Feb 25 2021 17:27:56 for ArmNN by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
</div>
</body>
</html>
|
