BuildGuideCrossCompilation.md

   1 # How to Cross-Compile ArmNN on x86_64 for arm64
   2
   3 *  [Introduction](#introduction)
   4 *  [Cross-compiling ToolChain](#installCCT)
   5 *  [Build and install Google's Protobuf library](#buildProtobuf)
   6 *  [Build Caffe for x86_64](#buildCaffe)
   7 *  [Build Boost library for arm64](#installBaarch)
   8 *  [Build Compute Library](#buildCL)
   9 *  [Build ArmNN](#buildANN)
  10 *  [Run Unit Tests](#unittests)
  11 *  [Troubleshooting and Errors](#troubleshooting)
  12
  13
  14 #### <a name="introduction">Introduction</a>
  15 These are the step by step instructions on Cross-Compiling ArmNN under an x86_64 system to target an Arm64 system. This build flow has been tested with Ubuntu 16.04.
  16 The instructions show how to build the ArmNN core library and the Boost, Protobuf, Caffe, Tensorflow, Tflite, Flatbuffer and Compute Libraries necessary for compilation.
  17
  18 #### <a name="installCCT">Cross-compiling ToolChain</a>
  19 * Install the standard cross-compilation libraries for arm64:
  20     ```
  21     sudo apt install crossbuild-essential-arm64
  22     ```
  23
  24 #### <a name="buildProtobuf">Build and install Google's Protobuf library</a>
  25
  26 ## We support protobuf version 3.5.2
  27 * Get protobuf from here: https://github.com/protocolbuffers/protobuf :
  28     ```bash
  29     git clone -b v3.5.2 https://github.com/google/protobuf.git protobuf
  30     cd protobuf
  31     git submodule update --init --recursive
  32     ./autogen
  33     ```
  34 * Build a native (x86_64) version of the protobuf libraries and compiler (protoc):
  35   (Requires cUrl, autoconf, llibtool, and other build dependencies if not previously installed: sudo apt install curl autoconf libtool build-essential g++)
  36     ```
  37     mkdir x86_64_build
  38     cd x86_64_build
  39     ../configure --prefix=$HOME/armnn-devenv/google/x86_64_pb_install
  40     make install -j16
  41     cd ..
  42     ```
  43 * Build the arm64 version of the protobuf libraries:
  44     ```
  45     mkdir arm64_build
  46     cd arm64_build
  47     export CC=aarch64-linux-gnu-gcc \
  48     export CXX=aarch64-linux-gnu-g++ \
  49     ../configure --host=aarch64-linux \
  50     --prefix=$HOME/armnn-devenv/google/arm64_pb_install \
  51     --with-protoc=$HOME/armnn-devenv/google/x86_64_pb_install/bin/protoc
  52     make install -j16
  53     cd ..
  54     ```
  55
  56 #### <a name="buildCaffe">Build Caffe for x86_64</a>
  57 * Ubuntu 16.04 installation. These steps are taken from the full Caffe installation documentation at: http://caffe.berkeleyvision.org/install_apt.html
  58 * Install dependencies:
  59     ```bash
  60     sudo apt-get install libleveldb-dev libsnappy-dev libopencv-dev libhdf5-serial-dev
  61     sudo apt-get install --no-install-recommends libboost-all-dev
  62     sudo apt-get install libgflags-dev libgoogle-glog-dev liblmdb-dev
  63     sudo apt-get install libopenblas-dev
  64     sudo apt-get install libatlas-base-dev
  65     ```
  66 * Download Caffe-Master from: https://github.com/BVLC/caffe
  67     ```bash
  68     git clone https://github.com/BVLC/caffe.git
  69     cd caffe
  70     cp Makefile.config.example Makefile.config
  71     ```
  72 * Adjust Makefile.config as necessary for your environment, for example:
  73     ```
  74     #CPU only version:
  75     CPU_ONLY := 1
  76
  77     #Add hdf5 and protobuf include and library directories (Replace $HOME with explicit /home/username dir):
  78     INCLUDE_DIRS := $(PYTHON_INCLUDE) /usr/local/include /usr/include/hdf5/serial/ $HOME/armnn-devenv/google/x86_64_pb_install/include/
  79     LIBRARY_DIRS := $(PYTHON_LIB) /usr/local/lib /usr/lib /usr/lib/x86_64-linux-gnu/hdf5/serial/ $HOME/armnn-devenv/google/x86_64_pb_install/lib/
  80     ```
  81 * Setup environment:
  82     ```bash
  83     export PATH=$HOME/armnn-devenv/google/x86_64_pb_install/bin/:$PATH
  84     export LD_LIBRARY_PATH=$HOME/armnn-devenv/google/x86_64_pb_install/lib/:$LD_LIBRARY_PATH
  85     ```
  86 * Compilation with Make:
  87     ```bash
  88     make all
  89     make test
  90     make runtest
  91     ```
  92     These should all run without errors
  93 * caffe.pb.h and caffe.pb.cc will be needed when building ArmNN's Caffe Parser
  94
  95 #### <a name="installBaarch">Build Boost library for arm64</a>
  96 * Build Boost library for arm64
  97     Download Boost version 1.64 from http://www.boost.org/doc/libs/1_64_0/more/getting_started/unix-variants.html
  98     Using any version of Boost greater than 1.64 will fail to build ArmNN, due to different dependency issues.
  99     ```bash
 100     tar -zxvf boost_1_64_0.tar.gz
 101     cd boost_1_64_0
 102     echo "using gcc : arm : aarch64-linux-gnu-g++ ;" > user_config.jam
 103     ./bootstrap.sh --prefix=$HOME/armnn-devenv/boost_arm64_install
 104     ./b2 install toolset=gcc-arm link=static cxxflags=-fPIC --with-filesystem --with-test --with-log --with-program_options -j32 --user-config=user_config.jam
 105     ```
 106
 107 #### <a name="buildCL">Build Compute Library</a>
 108 * Building the Arm Compute Library:
 109     ```bash
 110     git clone https://github.com/ARM-software/ComputeLibrary.git
 111     cd ComputeLibrary/
 112     scons arch=arm64-v8a neon=1 opencl=1 embed_kernels=1 extra_cxx_flags="-fPIC" -j8 internal_only=0
 113     ```
 114
 115 #### <a name="buildtf">Build Tensorflow</a>
 116 * Building Tensorflow version 1.15:
 117     '''bash
 118     git clone https://github.com/tensorflow/tensorflow.git
 119     cd tensorflow/
 120     git checkout 590d6eef7e91a6a7392c8ffffb7b58f2e0c8bc6b
 121     ../armnn/scripts/generate_tensorflow_protobuf.sh ../tensorflow-protobuf ../google/x86_64_pb_install
 122     '''
 123
 124 #### <"a name=buildflatbuffer">Build Flatbuffer</a>
 125 * Building Flatbuffer version 1.10.0
 126     '''bash
 127     wget -O flatbuffers-1.10.0.tar.gz https://github.com/google/flatbuffers/archive/v1.10.0.tar.gz
 128     tar xf flatbuffers-1.10.0.tar.gz
 129     cd flatbuffers-1.10.0
 130     rm -f CMakeCache.txt
 131     mkdir build
 132     cd build
 133     cmake .. -DFLATBUFFERS_BUILD_FLATC=1 \
 134              -DCMAKE_INSTALL_PREFIX:PATH=$<DIRECTORY_PATH> \
 135              -DFLATBUFFERS_BUILD_TESTS=0
 136     make all install
 137     '''
 138 * Build arm64 version of flatbuffer
 139     '''bash
 140     mkdir build-arm64
 141     cd build-arm64
 142     cmake .. -DCMAKE_C_COMPILER=/usr/bin/aarch64-linux-gnu-gcc \
 143              -DCMAKE_CXX_COMPILER=/usr/bin/aarch64-linux-gnu-g++ \
 144              -DFLATBUFFERS_BUILD_FLATC=1 \
 145              -DCMAKE_INSTALL_PREFIX:PATH=$<DIRECTORY_PATH> \
 146              -DFLATBUFFERS_BUILD_TESTS=0
 147     make all install
 148     '''
 149
 150 #### <a name="buildingONNX">Build Onnx</a>
 151 * Building Onnx
 152     '''bash
 153     git clone https://github.com/onnx/onnx.git
 154     cd onnx
 155     git fetch https://github.com/onnx/onnx.git f612532843bd8e24efeab2815e45b436479cc9ab && git checkout FETCH_HEAD
 156     export LD_LIBRARY_PATH=$<DIRECTORY_PATH>/protobuf-host/lib:$LD_LIBRARY_PATH
 157     ../google/x86_64_pb_install/bin/protoc onnx/onnx.proto --proto_path=. --proto_path=../google/x86_64_pb_install/include --cpp_out ../onnx
 158     '''
 159
 160 #### <a name="buildingtflite">Build TfLite</a>
 161 * Building TfLite
 162     '''bash
 163     mkdir tflite
 164     cd tflite
 165     cp ../tensorflow/tensorflow/lite/schema/schema.fbs .
 166     ../flatbuffers-1.10.0/build/flatc -c --gen-object-api --reflect-types --reflect-names schema.fbs
 167     '''
 168
 169 #### <a name="buildANN">Build ArmNN</a>
 170 * Compile ArmNN for arm64:
 171     ```bash
 172     git clone https://github.com/ARM-software/armnn.git
 173     cd armnn
 174     mkdir build
 175     cd build
 176     ```
 177
 178 * Use CMake to configure your build environment, update the following script and run it from the armnn/build directory to set up the armNN build:
 179     ```bash
 180     #!/bin/bash
 181     export CXX=aarch64-linux-gnu-g++ \
 182     export CC=aarch64-linux-gnu-gcc \
 183     cmake .. \
 184     -DARMCOMPUTE_ROOT=$HOME/armnn-devenv/ComputeLibrary \
 185     -DARMCOMPUTE_BUILD_DIR=$HOME/armnn-devenv/ComputeLibrary/build/ \
 186     -DBOOST_ROOT=$HOME/armnn-devenv/boost_arm64_install/ \
 187     -DARMCOMPUTENEON=1 -DARMCOMPUTECL=1 -DARMNNREF=1 \
 188     -DCAFFE_GENERATED_SOURCES=$HOME/armnn-devenv/caffe/build/src \
 189     -DBUILD_CAFFE_PARSER=1 \
 190     -DONNX_GENERATED_SOURCES=$HOME/onnx \
 191     -DBUILD_ONNX_PARSER=1 \
 192     -DTF_GENERATED_SOURCES=$HOME/tensorflow-protobuf \
 193     -DBUILD_TF_PARSER=1 \
 194     -DBUILD_TF_LITE_PARSER=1 \
 195     -DTF_LITE_GENERATED_PATH=$HOME/tflite \
 196     -DFLATBUFFERS_ROOT=$HOME/flatbuffers-arm64 \
 197     -DFLATC_DIR=$HOME/flatbuffers-1.10.0/build \
 198     -DPROTOBUF_ROOT=$HOME/google/x86_64_pb_install \
 199     -DPROTOBUF_ROOT=$HOME/armnn-devenv/google/x86_64_pb_install/ \
 200     -DPROTOBUF_LIBRARY_DEBUG=$HOME/armnn-devenv/google/arm64_pb_install/lib/libprotobuf.so.15.0.1 \
 201     -DPROTOBUF_LIBRARY_RELEASE=$HOME/armnn-devenv/google/arm64_pb_install/lib/libprotobuf.so.15.0.1
 202     ```
 203
 204 * If you want to include standalone sample dynamic backend tests, add the argument to enable the tests and the dynamic backend path to the CMake command:
 205     ```bash
 206     -DSAMPLE_DYNAMIC_BACKEND=1 \
 207     -DDYNAMIC_BACKEND_PATHS=$SAMPLE_DYNAMIC_BACKEND_PATH
 208     ```
 209 * Run the build
 210     ```bash
 211     make -j32
 212     ```
 213
 214 #### <a name="buildStandaloneBackend">Build Standalone Sample Dynamic Backend</a>
 215 * The sample dynamic backend is located in armnn/src/dynamic/sample
 216     ```bash
 217     mkdir build
 218     cd build
 219     ```
 220
 221 * Use CMake to configure your build environment, update the following script and run it from the armnn/src/dynamic/sample/build directory to set up the armNN build:
 222     ```bash
 223     #!/bin/bash
 224     export CXX=aarch64-linux-gnu-g++ \
 225     export CC=aarch64-linux-gnu-gcc \
 226     cmake .. \
 227     -DCMAKE_CXX_FLAGS=--std=c++14 \
 228     -DBOOST_ROOT=$HOME/armnn-devenv/boost_arm64_install/ \
 229     -DBoost_SYSTEM_LIBRARY=$HOME/armnn-devenv/boost_arm64_install/lib/libboost_system.a \
 230     -DBoost_FILESYSTEM_LIBRARY=$HOME/armnn-devenv/boost_arm64_install/lib/libboost_filesystem.a \
 231     -DARMNN_PATH=$HOME/armnn-devenv/armnn/build/libarmnn.so
 232     ```
 233
 234 * Run the build
 235     ```bash
 236     make
 237     ```
 238
 239 #### <a name="unittests">Run Unit Tests</a>
 240 * Copy the build folder to an arm64 linux machine
 241 * Copy the libprotobuf.so.15.0.1 library file to the build folder
 242 * If you enable the standalone sample dynamic tests, also copy libArm_SampleDynamic_backend.so library file to the folder specified as $SAMPLE_DYNAMIC_BACKEND_PATH when you build ArmNN
 243 * cd to the build folder on your arm64 machine and set your LD_LIBRARY_PATH to its current location:
 244     ```
 245     cd build/
 246     export LD_LIBRARY_PATH=`pwd`
 247     ```
 248 * Create a symbolic link to libprotobuf.so.15.0.1:
 249     ```
 250     ln -s libprotobuf.so.15.0.1 ./libprotobuf.so.15
 251     ```
 252 * Run the UnitTests:
 253     ```
 254     ./UnitTests
 255     Running 567 test cases...
 256
 257     *** No errors detected
 258     ```
 259 #### <a name="troubleshooting">Troubleshooting and Errors:</a>
 260 #### Error adding symbols: File in wrong format
 261 * When building armNN:
 262     ```
 263     /usr/local/lib/libboost_log.a: error adding symbols: File in wrong format
 264     collect2: error: ld returned 1 exit status
 265     CMakeFiles/armnn.dir/build.make:4028: recipe for target 'libarmnn.so' failed
 266     make[2]: *** [libarmnn.so] Error 1
 267     CMakeFiles/Makefile2:105: recipe for target 'CMakeFiles/armnn.dir/all' failed
 268     make[1]: *** [CMakeFiles/armnn.dir/all] Error 2
 269     Makefile:127: recipe for target 'all' failed
 270     make: *** [all] Error 2
 271     ```
 272 * Boost libraries are not compiled for the correct architecture, try recompiling for arm64
 273 ##
 274 #### Virtual memory exhausted
 275 * When compiling the boost libraries:
 276     ```bash
 277     virtual memory exhausted: Cannot allocate memory
 278     ```
 279 * Not enough memory available to compile. Increase the amount of RAM or swap space available.
 280
 281 ##
 282 #### Unrecognized command line option '-m64'
 283 * When compiling the boost libraries:
 284     ```bash
 285     aarch64-linux-gnu-g++: error: unrecognized command line option ‘-m64’
 286     ```
 287 * Clean the boost library directory before trying to build with a different architecture:
 288     ```bash
 289     sudo ./b2 clean
 290     ```
 291 * It should show the following for arm64:
 292     ```bash
 293     - 32-bit                   : no
 294     - 64-bit                   : yes
 295     - arm                      : yes
 296     ```
 297
 298 ##
 299 #### Missing libz.so.1
 300 * When compiling armNN:
 301     ```bash
 302     /usr/lib/gcc-cross/aarch64-linux-gnu/5/../../../../aarch64-linux-gnu/bin/ld: warning: libz.so.1, needed by /home/<username>/armNN/usr/lib64/libprotobuf.so.15.0.0, not found (try using -rpath or -rpath-link)
 303     ```
 304
 305 * Missing arm64 libraries for libz.so.1, these can be added by adding a second architecture to dpkg and explicitly installing them:
 306     ```bash
 307     sudo dpkg --add-architecture arm64
 308     sudo apt-get install zlib1g:arm64
 309     sudo apt-get update
 310     sudo ldconfig
 311     ```
 312 * If apt-get update returns 404 errors for arm64 repos refer to section 5 below.
 313 * Alternatively the missing arm64 version of libz.so.1 can be downloaded and installed from a .deb package here:
 314       https://launchpad.net/ubuntu/wily/arm64/zlib1g/1:1.2.8.dfsg-2ubuntu4
 315     ```bash
 316     sudo dpkg -i zlib1g_1.2.8.dfsg-2ubuntu4_arm64.deb
 317     ```
 318 ##
 319 #### Unable to install arm64 packages after adding arm64 architecture
 320 * Using sudo apt-get update should add all of the required repos for arm64 but if it does not or you are getting 404 errors the following instructions can be used to add the repos manually:
 321 * From stackoverflow:
 322 https://askubuntu.com/questions/430705/how-to-use-apt-get-to-download-multi-arch-library/430718
 323 * Open /etc/apt/sources.list with your preferred text editor.
 324
 325 * Mark all the current (default) repos as \[arch=<current_os_arch>], e.g.
 326     ```bash
 327     deb [arch=amd64] http://archive.ubuntu.com/ubuntu/ xenial main restricted
 328     ```
 329 * Then add the following:
 330     ```bash
 331     deb [arch=arm64] http://ports.ubuntu.com/ xenial main restricted
 332     deb [arch=arm64] http://ports.ubuntu.com/ xenial-updates main restricted
 333     deb [arch=arm64] http://ports.ubuntu.com/ xenial universe
 334     deb [arch=arm64] http://ports.ubuntu.com/ xenial-updates universe
 335     deb [arch=arm64] http://ports.ubuntu.com/ xenial multiverse
 336     deb [arch=arm64] http://ports.ubuntu.com/ xenial-updates multiverse
 337     deb [arch=arm64] http://ports.ubuntu.com/ xenial-backports main restricted universe multiverse
 338     ```
 339 * Update and install again:
 340     ```bash
 341     sudo apt-get install zlib1g:arm64
 342     sudo apt-get update
 343     sudo ldconfig
 344     ```
 345 ##
 346 #### Undefined references to google::protobuf:: functions
 347 * When compiling armNN there are multiple errors of the following type:
 348     ```
 349     libarmnnCaffeParser.so: undefined reference to `google::protobuf:*
 350     ```
 351 * Missing or out of date protobuf compilation libraries.
 352     Use the command 'protoc --version' to check which version of protobuf is available (version 3.5.2 is required).
 353     Follow the instructions above to install protobuf 3.5.2
 354     Note this will require you to recompile Caffe for x86_64
 355
 356 ##
 357 #### Errors on strict-aliasing rules when compiling the Compute Library
 358 * When compiling the Compute Library there are multiple errors on strict-aliasing rules:
 359      ```
 360     cc1plus: error: unrecognized command line option ‘-Wno-implicit-fallthrough’ [-Werror]
 361      ```
 362 * Add Werror=0 to the scons command:
 363     ```
 364     scons arch=arm64-v8a neon=1 opencl=1 embed_kernels=1 extra_cxx_flags="-fPIC" -j8 internal_only=0 Werror=0
 365     ```