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