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://releases.linaro.org/components/toolchain/binaries/latest/aarch64-linux-gnu/.
  18
  19 Following is the step to get the version 7.2.1, latest one at the time of this writing.
  20
  21 .. code-block:: console
  22
  23    wget https://releases.linaro.org/components/toolchain/binaries/latest/aarch64-linux-gnu/gcc-linaro-7.2.1-2017.11-x86_64_aarch64-linux-gnu.tar.xz
  24
  25 Unzip and add into the PATH
  26 ---------------------------
  27
  28 .. code-block:: console
  29
  30    tar -xvf gcc-linaro-7.2.1-2017.11-x86_64_aarch64-linux-gnu.tar.xz
  31    export PATH=$PATH:<cross_install_dir>/gcc-linaro-7.2.1-2017.11-x86_64_aarch64-linux-gnu/bin
  32
  33 .. note::
  34
  35    For the host requirements and other info, refer to the release note section: https://releases.linaro.org/components/toolchain/binaries/latest/
  36
  37 Getting the prerequisite library
  38 --------------------------------
  39
  40 NUMA is required by most modern machines, not needed for non-NUMA architectures.
  41
  42 .. note::
  43
  44    For compiling the NUMA lib, run libtool --version to ensure the libtool version >= 2.2,
  45    otherwise the compilation will fail with errors.
  46
  47 .. code-block:: console
  48
  49    git clone https://github.com/numactl/numactl.git
  50    cd numactl
  51    git checkout v2.0.11 -b v2.0.11
  52    ./autogen.sh
  53    autoconf -i
  54    ./configure --host=aarch64-linux-gnu CC=aarch64-linux-gnu-gcc --prefix=<numa install dir>
  55    make install
  56
  57 The numa header files and lib file is generated in the include and lib folder respectively under <numa install dir>.
  58
  59 .. _augment_the_cross_toolchain_with_numa_support:
  60
  61 Augment the cross toolchain with NUMA support
  62 ---------------------------------------------
  63
  64 .. note::
  65
  66    This way is optional, an alternative is to use extra CFLAGS and LDFLAGS, depicted in :ref:`configure_and_cross_compile_dpdk_build` below.
  67
  68 Copy the NUMA header files and lib to the cross compiler's directories:
  69
  70 .. code-block:: console
  71
  72    cp <numa_install_dir>/include/numa*.h <cross_install_dir>/gcc-linaro-7.2.1-2017.11-x86_64_aarch64-linux-gnu/bin/../aarch64-linux-gnu/libc/usr/include/
  73    cp <numa_install_dir>/lib/libnuma.a <cross_install_dir>/gcc-linaro-7.2.1-2017.11-x86_64_aarch64-linux-gnu/lib/gcc/aarch64-linux-gnu/7.2.1/
  74
  75 .. _configure_and_cross_compile_dpdk_build:
  76
  77 Configure and cross compile DPDK Build
  78 --------------------------------------
  79 To configure a build, choose one of the target configurations, like arm64-dpaa2-linuxapp-gcc and arm64-thunderx-linuxapp-gcc.
  80
  81 .. code-block:: console
  82
  83    make config T=arm64-armv8a-linuxapp-gcc
  84
  85 To cross-compile, without compiling the kernel modules, use the following command:
  86
  87 .. code-block:: console
  88
  89    make -j CROSS=aarch64-linux-gnu- CONFIG_RTE_KNI_KMOD=n CONFIG_RTE_EAL_IGB_UIO=n
  90
  91 To cross-compile, including the kernel modules, the kernel source tree needs to be specified by setting
  92 RTE_KERNELDIR:
  93
  94 .. code-block:: console
  95
  96    make -j CROSS=aarch64-linux-gnu- RTE_KERNELDIR=<kernel_src_rootdir> CROSS_COMPILE=aarch64-linux-gnu-
  97
  98 To compile for non-NUMA targets, without compiling the kernel modules, use the following command:
  99
 100 .. code-block:: console
 101
 102    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
 103
 104 .. note::
 105
 106    1. EXTRA_CFLAGS and EXTRA_LDFLAGS should be added to include the NUMA headers and link the library respectively,
 107    if the above step :ref:`augment_the_cross_toolchain_with_numa_support` was skipped therefore the toolchain was not
 108    augmented with NUMA support.
 109
 110    2. "-isystem <numa_install_dir>/include" should be add to EXTRA_CFLAGS, otherwise the numa.h file will get a lot of compiling
 111    errors of Werror=cast-qual, Werror=strict-prototypes and Werror=old-style-definition.
 112
 113    An example is given below:
 114
 115    .. code-block:: console
 116
 117       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"
 118
 119 Meson Cross Compiling DPDK
 120 --------------------------
 121
 122 To cross-compile DPDK on a desired target machine we can use the following
 123 command::
 124
 125         meson cross-build --cross-file <target_machine_configuration>
 126         ninja -C cross-build
 127
 128 For example if the target machine is arm64 we can use the following
 129 command::
 130
 131         meson arm64-build --cross-file config/arm/arm64_armv8_linuxapp_gcc
 132         ninja -C arm64-build