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