1.. SPDX-License-Identifier: BSD-3-Clause 2 Copyright(c) 2010-2015 Intel Corporation. 3 4.. _linux_gsg_compiling_dpdk: 5 6Compiling the DPDK Target from Source 7===================================== 8 9.. note:: 10 11 Parts of this process can also be done using the setup script described in 12 the :ref:`linux_setup_script` section of this document. 13 14Uncompress DPDK and Browse Sources 15---------------------------------- 16 17First, uncompress the archive and move to the uncompressed DPDK source directory: 18 19.. code-block:: console 20 21 tar xJf dpdk-<version>.tar.xz 22 cd dpdk-<version> 23 24The DPDK is composed of several directories: 25 26* lib: Source code of DPDK libraries 27 28* drivers: Source code of DPDK poll-mode drivers 29 30* app: Source code of DPDK applications (automatic tests) 31 32* examples: Source code of DPDK application examples 33 34* config, buildtools, mk: Framework-related makefiles, scripts and configuration 35 36Compiling and Installing DPDK System-wide 37----------------------------------------- 38 39DPDK can be configured, built and installed on your system using the tools 40``meson`` and ``ninja``. 41 42.. note:: 43 44 The older makefile-based build system used in older DPDK releases is 45 still present and its use is described in section 46 `Installation of DPDK Target Environment using Make`_. 47 48DPDK Configuration 49~~~~~~~~~~~~~~~~~~ 50 51To configure a DPDK build use: 52 53.. code-block:: console 54 55 meson <options> build 56 57where "build" is the desired output build directory, and "<options>" can be 58empty or one of a number of meson or DPDK-specific build options, described 59later in this section. The configuration process will finish with a summary 60of what DPDK libraries and drivers are to be built and installed, and for 61each item disabled, a reason why that is the case. This information can be 62used, for example, to identify any missing required packages for a driver. 63 64Once configured, to build and then install DPDK system-wide use: 65 66.. code-block:: console 67 68 cd build 69 ninja 70 ninja install 71 ldconfig 72 73The last two commands above generally need to be run as root, 74with the `ninja install` step copying the built objects to their final system-wide locations, 75and the last step causing the dynamic loader `ld.so` to update its cache to take account of the new objects. 76 77.. note:: 78 79 On some linux distributions, such as Fedora or Redhat, paths in `/usr/local` are 80 not in the default paths for the loader. Therefore, on these 81 distributions, `/usr/local/lib` and `/usr/local/lib64` should be added 82 to a file in `/etc/ld.so.conf.d/` before running `ldconfig`. 83 84 85Adjusting Build Options 86~~~~~~~~~~~~~~~~~~~~~~~ 87 88DPDK has a number of options that can be adjusted as part of the build configuration process. 89These options can be listed by running ``meson configure`` inside a configured build folder. 90Many of these options come from the "meson" tool itself and can be seen documented on the 91`Meson Website <https://mesonbuild.com/Builtin-options.html>`_. 92 93For example, to change the build-type from the default, "debugoptimized", 94to a regular "debug" build, you can either: 95 96* pass ``-Dbuildtype=debug`` or ``--buildtype=debug`` to meson when configuring the build folder initially 97 98* run ``meson configure -Dbuildtype=debug`` inside the build folder after the initial meson run. 99 100Other options are specific to the DPDK project but can be adjusted similarly. 101To set the "max_lcores" value to 256, for example, you can either: 102 103* pass ``-Dmax_lcores=256`` to meson when configuring the build folder initially 104 105* run ``meson configure -Dmax_lcores=256`` inside the build folder after the initial meson run. 106 107Some of the DPDK sample applications in the `examples` directory can be 108automatically built as part of a meson build too. 109To do so, pass a comma-separated list of the examples to build to the 110`-Dexamples` meson option as below:: 111 112 meson -Dexamples=l2fwd,l3fwd build 113 114As with other meson options, this can also be set post-initial-config using `meson configure` in the build directory. 115There is also a special value "all" to request that all example applications whose 116dependencies are met on the current system are built. 117When `-Dexamples=all` is set as a meson option, meson will check each example application to see if it can be built, 118and add all which can be built to the list of tasks in the ninja build configuration file. 119 120Building Applications Using Installed DPDK 121~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 122 123When installed system-wide, DPDK provides a pkg-config file ``libdpdk.pc`` for applications to query as part of their build. 124It's recommended that the pkg-config file be used, rather than hard-coding the parameters (cflags/ldflags) 125for DPDK into the application build process. 126 127An example of how to query and use the pkg-config file can be found in the ``Makefile`` of each of the example applications included with DPDK. 128A simplified example snippet is shown below, where the target binary name has been stored in the variable ``$(APP)`` 129and the sources for that build are stored in ``$(SRCS-y)``. 130 131.. code-block:: makefile 132 133 PKGCONF = pkg-config 134 135 CFLAGS += -O3 $(shell $(PKGCONF) --cflags libdpdk) 136 LDFLAGS += $(shell $(PKGCONF) --libs libdpdk) 137 138 $(APP): $(SRCS-y) Makefile 139 $(CC) $(CFLAGS) $(SRCS-y) -o $@ $(LDFLAGS) 140 141.. note:: 142 143 Unlike with the older make build system, the meson system is not 144 designed to be used directly from a build directory. Instead it is 145 recommended that it be installed either system-wide or to a known 146 location in the user's home directory. The install location can be set 147 using the `--prefix` meson option (default: `/usr/local`). 148 149an equivalent build recipe for a simple DPDK application using meson as a 150build system is shown below: 151 152.. code-block:: python 153 154 project('dpdk-app', 'c') 155 156 dpdk = dependency('libdpdk') 157 sources = files('main.c') 158 executable('dpdk-app', sources, dependencies: dpdk) 159 160 161Installation of DPDK Target Environment using Make 162-------------------------------------------------- 163 164.. note:: 165 166 The building of DPDK using make will be deprecated in a future release. It 167 is therefore recommended that DPDK installation is done using meson and 168 ninja as described above. 169 170The format of a DPDK target is:: 171 172 ARCH-MACHINE-EXECENV-TOOLCHAIN 173 174where: 175 176* ``ARCH`` can be: ``i686``, ``x86_64``, ``ppc_64``, ``arm64`` 177 178* ``MACHINE`` can be: ``native``, ``power8``, ``armv8a`` 179 180* ``EXECENV`` can be: ``linux``, ``freebsd`` 181 182* ``TOOLCHAIN`` can be: ``gcc``, ``icc`` 183 184The targets to be installed depend on the 32-bit and/or 64-bit packages and compilers installed on the host. 185Available targets can be found in the DPDK/config directory. 186The defconfig\_ prefix should not be used. 187 188.. note:: 189 190 Configuration files are provided with the ``RTE_MACHINE`` optimization level set. 191 Within the configuration files, the ``RTE_MACHINE`` configuration value is set to native, 192 which means that the compiled software is tuned for the platform on which it is built. 193 For more information on this setting, and its possible values, see the *DPDK Programmers Guide*. 194 195When using the Intel® C++ Compiler (icc), one of the following commands should be invoked for 64-bit or 32-bit use respectively. 196Notice that the shell scripts update the ``$PATH`` variable and therefore should not be performed in the same session. 197Also, verify the compiler's installation directory since the path may be different: 198 199.. code-block:: console 200 201 source /opt/intel/bin/iccvars.sh intel64 202 source /opt/intel/bin/iccvars.sh ia32 203 204To install and make targets, use the ``make install T=<target>`` command in the top-level DPDK directory. 205 206For example, to compile a 64-bit target using icc, run: 207 208.. code-block:: console 209 210 make install T=x86_64-native-linux-icc 211 212To compile a 32-bit build using gcc, the make command should be: 213 214.. code-block:: console 215 216 make install T=i686-native-linux-gcc 217 218To prepare a target without building it, for example, if the configuration changes need to be made before compilation, 219use the ``make config T=<target>`` command: 220 221.. code-block:: console 222 223 make config T=x86_64-native-linux-gcc 224 225.. warning:: 226 227 Any kernel modules to be used, e.g. ``igb_uio``, ``kni``, must be compiled with the 228 same kernel as the one running on the target. 229 If the DPDK is not being built on the target machine, 230 the ``RTE_KERNELDIR`` environment variable should be used to point the compilation at a copy of the kernel version to be used on the target machine. 231 232Once the target environment is created, the user may move to the target environment directory and continue to make code changes and re-compile. 233The user may also make modifications to the compile-time DPDK configuration by editing the .config file in the build directory. 234(This is a build-local copy of the defconfig file from the top- level config directory). 235 236.. code-block:: console 237 238 cd x86_64-native-linux-gcc 239 vi .config 240 make 241 242In addition, the make clean command can be used to remove any existing compiled files for a subsequent full, clean rebuild of the code. 243 244Browsing the Installed DPDK Environment Target 245---------------------------------------------- 246 247Once a target is created it contains all libraries, including poll-mode drivers, and header files for the DPDK environment that are required to build customer applications. 248In addition, the test and testpmd applications are built under the build/app directory, which may be used for testing. 249A kmod directory is also present that contains kernel modules which may be loaded if needed. 250