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 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 * Get protobuf-all-3.5.1.tar.gz from here: https://github.com/protocolbuffers/protobuf/releases/tag/v3.5.1
  27 * Extract:
  28     ```bash
  29     tar -zxvf protobuf-all-3.5.1.tar.gz
  30     cd protobuf-3.5.1
  31     ```
  32 * Build a native (x86_64) version of the protobuf libraries and compiler (protoc):
  33   (Requires cUrl, autoconf, llibtool, and other build dependencies if not previously installed: sudo apt install curl autoconf libtool build-essential g++)
  34     ```
  35     mkdir x86_64_build
  36     cd x86_64_build
  37     ../configure --prefix=$HOME/armnn-devenv/google/x86_64_pb_install
  38     make install -j16
  39     cd ..
  40     ```
  41 * Build the arm64 version of the protobuf libraries:
  42     ```
  43     mkdir arm64_build
  44     cd arm64_build
  45     CC=aarch64-linux-gnu-gcc \
  46     CXX=aarch64-linux-gnu-g++ \
  47     ../configure --host=aarch64-linux \
  48     --prefix=$HOME/armnn-devenv/google/arm64_pb_install \
  49     --with-protoc=$HOME/armnn-devenv/google/x86_64_pb_install/bin/protoc
  50     make install -j16
  51     cd ..
  52     ```
  53
  54 #### <a name="buildCaffe">Build Caffe for x86_64</a>
  55 * Ubuntu 16.04 installation. These steps are taken from the full Caffe installation documentation at: http://caffe.berkeleyvision.org/install_apt.html
  56 * Install dependencies:
  57     ```bash
  58     sudo apt-get install libleveldb-dev libsnappy-dev libopencv-dev libhdf5-serial-dev
  59     sudo apt-get install --no-install-recommends libboost-all-dev
  60     sudo apt-get install libgflags-dev libgoogle-glog-dev liblmdb-dev
  61     sudo apt-get install libopenblas-dev
  62     sudo apt-get install libatlas-base-dev
  63     ```
  64 * Download Caffe-Master from: https://github.com/BVLC/caffe
  65     ```bash
  66     git clone https://github.com/BVLC/caffe.git
  67     cd caffe
  68     cp Makefile.config.example Makefile.config
  69     ```
  70 * Adjust Makefile.config as necessary for your environment, for example:
  71     ```
  72     #CPU only version:
  73     CPU_ONLY := 1
  74
  75     #Add hdf5 and protobuf include and library directories (Replace $HOME with explicit /home/username dir):
  76     INCLUDE_DIRS := $(PYTHON_INCLUDE) /usr/local/include /usr/include/hdf5/serial/ $HOME/armnn-devenv/google/x86_64_pb_install/include/
  77     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/
  78     ```
  79 * Setup environment:
  80     ```bash
  81     export PATH=$HOME/armnn-devenv/google/x86_64_pb_install/bin/:$PATH
  82     export LD_LIBRARY_PATH=$HOME/armnn-devenv/google/x86_64_pb_install/lib/:$LD_LIBRARY_PATH
  83     ```
  84 * Compilation with Make:
  85     ```bash
  86     make all
  87     make test
  88     make runtest
  89     ```
  90     These should all run without errors
  91 * caffe.pb.h and caffe.pb.cc will be needed when building ArmNN's Caffe Parser
  92
  93 #### <a name="installBaarch">Build Boost library for arm64</a>
  94 * Build Boost library for arm64
  95     Download Boost version 1.64 from http://www.boost.org/doc/libs/1_64_0/more/getting_started/unix-variants.html
  96     Version 1.66 is not supported.
  97     ```bash
  98     tar -zxvf boost_1_64_0.tar.gz
  99     cd boost_1_64_0
 100     echo "using gcc : arm : aarch64-linux-gnu-g++ ;" > user_config.jam
 101     ./bootstrap.sh --prefix=$HOME/armnn-devenv/boost_arm64_install
 102     ./b2 install toolset=gcc-arm link=static cxxflags=-fPIC --with-filesystem --with-test --with-log --with-program_options -j32 --user-config=user_config.jam
 103     ```
 104
 105 #### <a name="buildCL">Build Compute Library</a>
 106 * Building the Arm Compute Library:
 107     ```bash
 108     git clone https://github.com/ARM-software/ComputeLibrary.git
 109     cd ComputeLibrary/
 110     scons arch=arm64-v8a neon=1 opencl=1 embed_kernels=1 extra_cxx_flags="-fPIC" -j8 internal_only=0
 111     ```
 112
 113 #### <a name="buildANN">Build ArmNN</a>
 114 * Compile ArmNN for arm64:
 115     ```bash
 116     git clone https://github.com/ARM-software/armnn.git
 117     cd armnn
 118     mkdir build
 119     cd build
 120     ```
 121
 122 * 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:
 123     ```bash
 124     #!/bin/bash
 125     CXX=aarch64-linux-gnu-g++ \
 126     CC=aarch64-linux-gnu-gcc \
 127     cmake .. \
 128     -DARMCOMPUTE_ROOT=$HOME/armnn-devenv/ComputeLibrary \
 129     -DARMCOMPUTE_BUILD_DIR=$HOME/armnn-devenv/ComputeLibrary/build/ \
 130     -DBOOST_ROOT=$HOME/armnn-devenv/boost_arm64_install/ \
 131     -DARMCOMPUTENEON=1  -DARMCOMPUTECL=1 \
 132     -DCAFFE_GENERATED_SOURCES=$HOME/armnn-devenv/caffe/build/src \
 133     -DBUILD_CAFFE_PARSER=1 \
 134     -DPROTOBUF_ROOT=$HOME/armnn-devenv/google/x86_64_pb_install/ \
 135     -DPROTOBUF_LIBRARY_DEBUG=$HOME/armnn-devenv/google/arm64_pb_install/lib/libprotobuf.so.15.0.1 \
 136     -DPROTOBUF_LIBRARY_RELEASE=$HOME/armnn-devenv/google/arm64_pb_install/lib/libprotobuf.so.15.0.1
 137     ```
 138 * Run the build
 139     ```bash
 140     make -j32
 141     ```
 142
 143 #### <a name="unittests">Run Unit Tests</a>
 144 * Copy the build folder to an arm64 linux machine
 145 * Copy the libprotobuf.so.15.0.1 library file to the build folder
 146 * cd to the build folder on your arm64 machine and set your LD_LIBRARY_PATH to its current location:
 147     ```
 148     cd build/
 149     export LD_LIBRARY_PATH=`pwd`
 150     ```
 151 * Create a symbolic link to libprotobuf.so.15.0.1:
 152     ```
 153     ln -s libprotobuf.so.15.0.1 ./libprotobuf.so.15
 154     ```
 155 * Run the UnitTests:
 156     ```
 157     ./UnitTests
 158     Running 567 test cases...
 159
 160     *** No errors detected
 161     ```
 162 #### <a name="troubleshooting">Troubleshooting and Errors:</a>
 163 #### Error adding symbols: File in wrong format
 164 * When building armNN:
 165     ```
 166     /usr/local/lib/libboost_log.a: error adding symbols: File in wrong format
 167     collect2: error: ld returned 1 exit status
 168     CMakeFiles/armnn.dir/build.make:4028: recipe for target 'libarmnn.so' failed
 169     make[2]: *** [libarmnn.so] Error 1
 170     CMakeFiles/Makefile2:105: recipe for target 'CMakeFiles/armnn.dir/all' failed
 171     make[1]: *** [CMakeFiles/armnn.dir/all] Error 2
 172     Makefile:127: recipe for target 'all' failed
 173     make: *** [all] Error 2
 174     ```
 175 * Boost libraries are not compiled for the correct architecture, try recompiling for arm64
 176 ##
 177 #### Virtual memory exhausted
 178 * When compiling the boost libraries:
 179     ```bash
 180     virtual memory exhausted: Cannot allocate memory
 181     ```
 182 * Not enough memory available to compile. Increase the amount of RAM or swap space available.
 183
 184 ##
 185 #### Unrecognized command line option '-m64'
 186 * When compiling the boost libraries:
 187     ```bash
 188     aarch64-linux-gnu-g++: error: unrecognized command line option ‘-m64’
 189     ```
 190 * Clean the boost library directory before trying to build with a different architecture:
 191     ```bash
 192     sudo ./b2 clean
 193     ```
 194 * It should show the following for arm64:
 195     ```bash
 196     - 32-bit                   : no
 197     - 64-bit                   : yes
 198     - arm                      : yes
 199     ```
 200
 201 ##
 202 #### Missing libz.so.1
 203 * When compiling armNN:
 204     ```bash
 205     /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)
 206     ```
 207
 208 * Missing arm64 libraries for libz.so.1, these can be added by adding a second architecture to dpkg and explicitly installing them:
 209     ```bash
 210     sudo dpkg --add-architecture arm64
 211     sudo apt-get install zlib1g:arm64
 212     sudo apt-get update
 213     sudo ldconfig
 214     ```
 215 * If apt-get update returns 404 errors for arm64 repos refer to section 5 below.
 216 * Alternatively the missing arm64 version of libz.so.1 can be downloaded and installed from a .deb package here:
 217       https://launchpad.net/ubuntu/wily/arm64/zlib1g/1:1.2.8.dfsg-2ubuntu4
 218     ```bash
 219     sudo dpkg -i zlib1g_1.2.8.dfsg-2ubuntu4_arm64.deb
 220     ```
 221 ##
 222 #### Unable to install arm64 packages after adding arm64 architecture
 223 * 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:
 224 * From stackoverflow:
 225 https://askubuntu.com/questions/430705/how-to-use-apt-get-to-download-multi-arch-library/430718
 226 * Open /etc/apt/sources.list with your preferred text editor.
 227
 228 * Mark all the current (default) repos as \[arch=<current_os_arch>], e.g.
 229     ```bash
 230     deb [arch=amd64] http://archive.ubuntu.com/ubuntu/ xenial main restricted
 231     ```
 232 * Then add the following:
 233     ```bash
 234     deb [arch=arm64] http://ports.ubuntu.com/ xenial main restricted
 235     deb [arch=arm64] http://ports.ubuntu.com/ xenial-updates main restricted
 236     deb [arch=arm64] http://ports.ubuntu.com/ xenial universe
 237     deb [arch=arm64] http://ports.ubuntu.com/ xenial-updates universe
 238     deb [arch=arm64] http://ports.ubuntu.com/ xenial multiverse
 239     deb [arch=arm64] http://ports.ubuntu.com/ xenial-updates multiverse
 240     deb [arch=arm64] http://ports.ubuntu.com/ xenial-backports main restricted universe multiverse
 241     ```
 242 * Update and install again:
 243     ```bash
 244     sudo apt-get install zlib1g:arm64
 245     sudo apt-get update
 246     sudo ldconfig
 247     ```
 248 ##
 249 #### Undefined references to google::protobuf:: functions
 250 * When compiling armNN there are multiple errors of the following type:
 251     ```
 252     libarmnnCaffeParser.so: undefined reference to `google::protobuf:*
 253     ```
 254 * Missing or out of date protobuf compilation libraries.
 255     Use the command 'protoc --version' to check which version of protobuf is available (version 3.5.1 is required).
 256     Follow the instructions above to install protobuf 3.5.1
 257     Note this will require you to recompile Caffe for x86_64
 258
 259 ##
 260 #### Errors on strict-aliasing rules when compiling the Compute Library
 261 * When compiling the Compute Library there are multiple errors on strict-aliasing rules:
 262      ```
 263     cc1plus: error: unrecognized command line option ‘-Wno-implicit-fallthrough’ [-Werror]
 264      ```
 265 * Add Werror=0 to the scons command:
 266     ```
 267     scons arch=arm64-v8a neon=1 opencl=1 embed_kernels=1 extra_cxx_flags="-fPIC" -j8 internal_only=0 Werror=0
 268     ```