doc/guides/linux_gsg/build_dpdk.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright(c) 2010-2015 Intel Corporation.
   3
   4 .. _linux_gsg_compiling_dpdk:
   5
   6 Compiling 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
  14 Uncompress DPDK and Browse Sources
  15 ----------------------------------
  16
  17 First, 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
  24 The 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: Framework-related scripts and configuration
  35
  36 Compiling and Installing DPDK System-wide
  37 -----------------------------------------
  38
  39 DPDK can be configured, built and installed on your system using the tools
  40 ``meson`` and ``ninja``.
  41
  42
  43 DPDK Configuration
  44 ~~~~~~~~~~~~~~~~~~
  45
  46 To configure a DPDK build use:
  47
  48 .. code-block:: console
  49
  50      meson <options> build
  51
  52 where "build" is the desired output build directory, and "<options>" can be
  53 empty or one of a number of meson or DPDK-specific build options, described
  54 later in this section. The configuration process will finish with a summary
  55 of what DPDK libraries and drivers are to be built and installed, and for
  56 each item disabled, a reason why that is the case. This information can be
  57 used, for example, to identify any missing required packages for a driver.
  58
  59 Once configured, to build and then install DPDK system-wide use:
  60
  61 .. code-block:: console
  62
  63         cd build
  64         ninja
  65         ninja install
  66         ldconfig
  67
  68 The last two commands above generally need to be run as root,
  69 with the `ninja install` step copying the built objects to their final system-wide locations,
  70 and the last step causing the dynamic loader `ld.so` to update its cache to take account of the new objects.
  71
  72 .. note::
  73
  74    On some linux distributions, such as Fedora or Redhat, paths in `/usr/local` are
  75    not in the default paths for the loader. Therefore, on these
  76    distributions, `/usr/local/lib` and `/usr/local/lib64` should be added
  77    to a file in `/etc/ld.so.conf.d/` before running `ldconfig`.
  78
  79 .. _adjusting_build_options:
  80
  81 Adjusting Build Options
  82 ~~~~~~~~~~~~~~~~~~~~~~~
  83
  84 DPDK has a number of options that can be adjusted as part of the build configuration process.
  85 These options can be listed by running ``meson configure`` inside a configured build folder.
  86 Many of these options come from the "meson" tool itself and can be seen documented on the
  87 `Meson Website <https://mesonbuild.com/Builtin-options.html>`_.
  88
  89 For example, to change the build-type from the default, "debugoptimized",
  90 to a regular "debug" build, you can either:
  91
  92 * pass ``-Dbuildtype=debug`` or ``--buildtype=debug`` to meson when configuring the build folder initially
  93
  94 * run ``meson configure -Dbuildtype=debug`` inside the build folder after the initial meson run.
  95
  96 Other options are specific to the DPDK project but can be adjusted similarly.
  97 To set the "max_lcores" value to 256, for example, you can either:
  98
  99 * pass ``-Dmax_lcores=256`` to meson when configuring the build folder initially
 100
 101 * run ``meson configure -Dmax_lcores=256`` inside the build folder after the initial meson run.
 102
 103 Some of the DPDK sample applications in the `examples` directory can be
 104 automatically built as part of a meson build too.
 105 To do so, pass a comma-separated list of the examples to build to the
 106 `-Dexamples` meson option as below::
 107
 108   meson -Dexamples=l2fwd,l3fwd build
 109
 110 As with other meson options, this can also be set post-initial-config using `meson configure` in the build directory.
 111 There is also a special value "all" to request that all example applications whose
 112 dependencies are met on the current system are built.
 113 When `-Dexamples=all` is set as a meson option, meson will check each example application to see if it can be built,
 114 and add all which can be built to the list of tasks in the ninja build configuration file.
 115
 116
 117 Building 32-bit DPDK on 64-bit Systems
 118 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 119
 120 To build a 32-bit copy of DPDK on a 64-bit OS,
 121 the ``-m32`` flag should be passed to the compiler and linker
 122 to force the generation of 32-bit objects and binaries.
 123 This can be done either by setting ``CFLAGS`` and ``LDFLAGS`` in the environment,
 124 or by passing the value to meson using ``-Dc_args=-m32`` and ``-Dc_link_args=-m32``.
 125 For correctly identifying and using any dependency packages,
 126 the ``pkg-config`` tool must also be configured
 127 to look in the appropriate directory for .pc files for 32-bit libraries.
 128 This is done by setting ``PKG_CONFIG_LIBDIR`` to the appropriate path.
 129
 130 The following meson command can be used on RHEL/Fedora systems to configure a 32-bit build,
 131 assuming the relevant 32-bit development packages, such as a 32-bit libc, are installed::
 132
 133   PKG_CONFIG_LIBDIR=/usr/lib/pkgconfig \
 134       meson -Dc_args='-m32' -Dc_link_args='-m32' build
 135
 136 For Debian/Ubuntu systems, the equivalent command is::
 137
 138   PKG_CONFIG_LIBDIR=/usr/lib/i386-linux-gnu/pkgconfig \
 139       meson -Dc_args='-m32' -Dc_link_args='-m32' build
 140
 141 Once the build directory has been configured,
 142 DPDK can be compiled using ``ninja`` as described above.
 143
 144
 145 .. _building_app_using_installed_dpdk:
 146
 147 Building Applications Using Installed DPDK
 148 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 149
 150 When installed system-wide, DPDK provides a pkg-config file ``libdpdk.pc`` for applications to query as part of their build.
 151 It's recommended that the pkg-config file be used, rather than hard-coding the parameters (cflags/ldflags)
 152 for DPDK into the application build process.
 153
 154 An 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.
 155 A simplified example snippet is shown below, where the target binary name has been stored in the variable ``$(APP)``
 156 and the sources for that build are stored in ``$(SRCS-y)``.
 157
 158 .. code-block:: makefile
 159
 160         PKGCONF = pkg-config
 161
 162         CFLAGS += -O3 $(shell $(PKGCONF) --cflags libdpdk)
 163         LDFLAGS += $(shell $(PKGCONF) --libs libdpdk)
 164
 165         $(APP): $(SRCS-y) Makefile
 166                 $(CC) $(CFLAGS) $(SRCS-y) -o $@ $(LDFLAGS)
 167
 168 .. note::
 169
 170    Unlike with the make build system present in older DPDK releases,
 171    the meson system is not
 172    designed to be used directly from a build directory. Instead it is
 173    recommended that it be installed either system-wide or to a known
 174    location in the user's home directory. The install location can be set
 175    using the `--prefix` meson option (default: `/usr/local`).
 176
 177 an equivalent build recipe for a simple DPDK application using meson as a
 178 build system is shown below:
 179
 180 .. code-block:: python
 181
 182    project('dpdk-app', 'c')
 183
 184    dpdk = dependency('libdpdk')
 185    sources = files('main.c')
 186    executable('dpdk-app', sources, dependencies: dpdk)