doc/guides/linux_gsg/cross_build_dpdk_for_arm64.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright(c) 2018 ARM Corporation.
   3
   4 Cross compile DPDK for ARM64
   5 ============================
   6 This chapter describes how to cross compile DPDK for ARM64 from x86 build hosts.
   7
   8 .. note::
   9
  10    Whilst it is recommended to natively build DPDK on ARM64 (just
  11    like with x86), it is also possible to cross-build DPDK for ARM64. An
  12    ARM64 cross compile GNU toolchain is used for this.
  13
  14 Obtain the cross tool chain
  15 ---------------------------
  16 The latest cross compile tool chain can be downloaded from:
  17 https://developer.arm.com/open-source/gnu-toolchain/gnu-a/downloads.
  18
  19 It is always recommended to check and get the latest compiler tool from the page and use
  20 it to generate better code. As of this writing 8.3-2019.03 is the newest, the following
  21 description is an example of this version.
  22
  23 .. code-block:: console
  24
  25    wget https://developer.arm.com/-/media/Files/downloads/gnu-a/8.3-2019.03/binrel/gcc-arm-8.3-2019.03-x86_64-aarch64-linux-gnu.tar.xz
  26
  27 Unzip and add into the PATH
  28 ---------------------------
  29
  30 .. code-block:: console
  31
  32    tar -xvf gcc-arm-8.3-2019.03-x86_64-aarch64-linux-gnu.tar.xz
  33    export PATH=$PATH:<cross_install_dir>/gcc-arm-8.3-2019.03-x86_64-aarch64-linux-gnu/bin
  34
  35 .. note::
  36
  37    For the host requirements and other info, refer to the release note section: https://releases.linaro.org/components/toolchain/binaries/
  38
  39 .. _arm_cross_build_getting_the_prerequisite_library:
  40
  41 Getting the prerequisite library
  42 --------------------------------
  43
  44 NUMA is required by most modern machines, not needed for non-NUMA architectures.
  45
  46 .. note::
  47
  48    For compiling the NUMA lib, run libtool --version to ensure the libtool version >= 2.2,
  49    otherwise the compilation will fail with errors.
  50
  51 .. code-block:: console
  52
  53    git clone https://github.com/numactl/numactl.git
  54    cd numactl
  55    git checkout v2.0.13 -b v2.0.13
  56    ./autogen.sh
  57    autoconf -i
  58    ./configure --host=aarch64-linux-gnu CC=aarch64-linux-gnu-gcc --prefix=<numa install dir>
  59    make install
  60
  61 The numa header files and lib file is generated in the include and lib folder respectively under <numa install dir>.
  62
  63 .. _augment_the_cross_toolchain_with_numa_support:
  64
  65 Augment the cross toolchain with NUMA support
  66 ---------------------------------------------
  67
  68 .. note::
  69
  70    This way is optional, an alternative is to use extra CFLAGS and LDFLAGS, depicted in :ref:`configure_and_cross_compile_dpdk_build` below.
  71
  72 Copy the NUMA header files and lib to the cross compiler's directories:
  73
  74 .. code-block:: console
  75
  76    cp <numa_install_dir>/include/numa*.h <cross_install_dir>/gcc-arm-8.3-2019.03-x86_64-aarch64-linux-gnu/aarch64-linux-gnu/libc/usr/include/
  77    cp <numa_install_dir>/lib/libnuma.a <cross_install_dir>/gcc-arm-8.3-2019.03-x86_64-aarch64-linux-gnu/lib/gcc/aarch64-linux-gnu/8.3.0/
  78    cp <numa_install_dir>/lib/libnuma.so <cross_install_dir>/gcc-arm-8.3-2019.03-x86_64-aarch64-linux-gnu/lib/gcc/aarch64-linux-gnu/8.3.0/
  79
  80 .. _configure_and_cross_compile_dpdk_build:
  81
  82 Cross Compiling DPDK using Meson
  83 --------------------------------
  84
  85 To cross-compile DPDK on a desired target machine we can use the following
  86 command::
  87
  88         meson cross-build --cross-file <target_machine_configuration>
  89         ninja -C cross-build
  90
  91 For example if the target machine is arm64 we can use the following
  92 command::
  93
  94         meson arm64-build --cross-file config/arm/arm64_armv8_linux_gcc
  95         ninja -C arm64-build
  96
  97 Configure and Cross Compile DPDK using Make
  98 -------------------------------------------
  99 To configure a build, choose one of the target configurations, like arm64-dpaa-linux-gcc and arm64-thunderx-linux-gcc.
 100
 101 .. code-block:: console
 102
 103    make config T=arm64-armv8a-linux-gcc
 104
 105 To cross-compile, without compiling the kernel modules, use the following command:
 106
 107 .. code-block:: console
 108
 109    make -j CROSS=aarch64-linux-gnu- CONFIG_RTE_KNI_KMOD=n CONFIG_RTE_EAL_IGB_UIO=n
 110
 111 To cross-compile, including the kernel modules, the kernel source tree needs to be specified by setting
 112 RTE_KERNELDIR:
 113
 114 .. code-block:: console
 115
 116    make -j CROSS=aarch64-linux-gnu- RTE_KERNELDIR=<kernel_src_rootdir> CROSS_COMPILE=aarch64-linux-gnu-
 117
 118 To compile for non-NUMA targets, without compiling the kernel modules, use the following command:
 119
 120 .. code-block:: console
 121
 122    make -j CROSS=aarch64-linux-gnu- CONFIG_RTE_KNI_KMOD=n CONFIG_RTE_EAL_IGB_UIO=n CONFIG_RTE_LIBRTE_VHOST_NUMA=n CONFIG_RTE_EAL_NUMA_AWARE_HUGEPAGES=n
 123
 124 .. note::
 125
 126    1. EXTRA_CFLAGS and EXTRA_LDFLAGS should be added to include the NUMA headers and link the library respectively,
 127    if the above step :ref:`augment_the_cross_toolchain_with_numa_support` was skipped therefore the toolchain was not
 128    augmented with NUMA support.
 129
 130    2. "-isystem <numa_install_dir>/include" should be add to EXTRA_CFLAGS, otherwise the numa.h file will get a lot of compiling
 131    errors of Werror=cast-qual, Werror=strict-prototypes and Werror=old-style-definition.
 132
 133    An example is given below:
 134
 135    .. code-block:: console
 136
 137       make -j CROSS=aarch64-linux-gnu- CONFIG_RTE_KNI_KMOD=n CONFIG_RTE_EAL_IGB_UIO=n EXTRA_CFLAGS="-isystem <numa_install_dir>/include" EXTRA_LDFLAGS="-L<numa_install_dir>/lib -lnuma"