xref: /dpdk/doc/guides/linux_gsg/cross_build_dpdk_for_arm64.rst (revision 3cc6ecfdfe85d2577fef30e1791bb7534e3d60b3)
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
19It is always recommended to check and get the latest compiler tool from the page and use
20it to generate better code. As of this writing 8.3-2019.03 is the newest, the following
21description 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
27Unzip 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
41Getting the prerequisite library
42--------------------------------
43
44NUMA 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
61The 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
65Augment 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.
71
72Copy 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
82Cross Compiling DPDK
83--------------------
84
85Meson depends on pkgconfig to find the dependencies.
86The package ``pkg-config-aarch64-linux-gnu`` is required for aarch64.
87To install it in Ubuntu::
88
89   sudo apt-get install pkg-config-aarch64-linux-gnu
90
91To cross-compile DPDK on a desired target machine we can use the following
92command::
93
94	meson cross-build --cross-file <target_machine_configuration>
95	ninja -C cross-build
96
97For example if the target machine is arm64 we can use the following
98command::
99
100	meson arm64-build --cross-file config/arm/arm64_armv8_linux_gcc
101	ninja -C arm64-build
102