doc/guides/linux_gsg/build_sample_apps.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright(c) 2010-2014 Intel Corporation.
   3
   4 Running Sample Applications
   5 ===========================
   6
   7 The chapter describes how to compile and run applications in a DPDK environment.
   8 It also provides a pointer to where sample applications are stored.
   9
  10 Compiling a Sample Application
  11 ------------------------------
  12
  13 Please refer to :ref:`building_app_using_installed_dpdk` for detail on compiling sample apps.
  14
  15 Running a Sample Application
  16 ----------------------------
  17
  18 .. warning::
  19
  20     Before running the application make sure:
  21
  22     - Hugepages setup is done.
  23     - Any kernel driver being used is loaded.
  24     - In case needed, ports being used by the application should be
  25       bound to the corresponding kernel driver.
  26
  27     refer to :ref:`linux_gsg_linux_drivers` for more details.
  28
  29 The application is linked with the DPDK target environment's Environmental Abstraction Layer (EAL) library,
  30 which provides some options that are generic to every DPDK application.
  31
  32 The following is the list of options that can be given to the EAL:
  33
  34 .. code-block:: console
  35
  36     ./rte-app [-c COREMASK | -l CORELIST] [-n NUM] [-b <domain:bus:devid.func>] \
  37               [--socket-mem=MB,...] [-d LIB.so|DIR] [-m MB] [-r NUM] [-v] [--file-prefix] \
  38               [--proc-type <primary|secondary|auto>]
  39
  40 The EAL options are as follows:
  41
  42 * ``-c COREMASK`` or ``-l CORELIST``:
  43   An hexadecimal bit mask of the cores to run on. Note that core numbering can
  44   change between platforms and should be determined beforehand. The corelist is
  45   a set of core numbers instead of a bitmap core mask.
  46
  47 * ``-n NUM``:
  48   Number of memory channels per processor socket.
  49
  50 * ``-b <domain:bus:devid.func>``:
  51   Blocklisting of ports; prevent EAL from using specified PCI device
  52   (multiple ``-b`` options are allowed).
  53
  54 * ``--use-device``:
  55   use the specified Ethernet device(s) only. Use comma-separate
  56   ``[domain:]bus:devid.func`` values. Cannot be used with ``-b`` option.
  57
  58 * ``--socket-mem``:
  59   Memory to allocate from hugepages on specific sockets. In dynamic memory mode,
  60   this memory will also be pinned (i.e. not released back to the system until
  61   application closes).
  62
  63 * ``--socket-limit``:
  64   Limit maximum memory available for allocation on each socket. Does not support
  65   legacy memory mode.
  66
  67 * ``-d``:
  68   Add a driver or driver directory to be loaded.
  69   The application should use this option to load the pmd drivers
  70   that are built as shared libraries.
  71
  72 * ``-m MB``:
  73   Memory to allocate from hugepages, regardless of processor socket. It is
  74   recommended that ``--socket-mem`` be used instead of this option.
  75
  76 * ``-r NUM``:
  77   Number of memory ranks.
  78
  79 * ``-v``:
  80   Display version information on startup.
  81
  82 * ``--huge-dir``:
  83   The directory where hugetlbfs is mounted.
  84
  85 * ``mbuf-pool-ops-name``:
  86   Pool ops name for mbuf to use.
  87
  88 * ``--file-prefix``:
  89   The prefix text used for hugepage filenames.
  90
  91 * ``--proc-type``:
  92   The type of process instance.
  93
  94 * ``--vmware-tsc-map``:
  95   Use VMware TSC map instead of native RDTSC.
  96
  97 * ``--base-virtaddr``:
  98   Specify base virtual address.
  99
 100 * ``--vfio-intr``:
 101   Specify interrupt type to be used by VFIO (has no effect if VFIO is not used).
 102
 103 * ``--legacy-mem``:
 104   Run DPDK in legacy memory mode (disable memory reserve/unreserve at runtime,
 105   but provide more IOVA-contiguous memory).
 106
 107 * ``--single-file-segments``:
 108   Store memory segments in fewer files (dynamic memory mode only - does not
 109   affect legacy memory mode).
 110
 111 The ``-c`` or ``-l`` and option is mandatory; the others are optional.
 112
 113 Copy the DPDK application binary to your target, then run the application as follows
 114 (assuming the platform has four memory channels per processor socket,
 115 and that cores 0-3 are present and are to be used for running the application)::
 116
 117     ./dpdk-helloworld -l 0-3 -n 4
 118
 119 .. note::
 120
 121     The ``--proc-type`` and ``--file-prefix`` EAL options are used for running
 122     multiple DPDK processes. See the "Multi-process Sample Application"
 123     chapter in the *DPDK Sample Applications User Guide* and the *DPDK
 124     Programmers Guide* for more details.
 125
 126 Logical Core Use by Applications
 127 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 128
 129 The coremask (-c 0x0f) or corelist (-l 0-3) parameter is always mandatory for DPDK applications.
 130 Each bit of the mask corresponds to the equivalent logical core number as reported by Linux. The preferred corelist option is a cleaner method to define cores to be used.
 131 Since these logical core numbers, and their mapping to specific cores on specific NUMA sockets, can vary from platform to platform,
 132 it is recommended that the core layout for each platform be considered when choosing the coremask/corelist to use in each case.
 133
 134 On initialization of the EAL layer by a DPDK application, the logical cores to be used and their socket location are displayed.
 135 This information can also be determined for all cores on the system by examining the ``/proc/cpuinfo`` file, for example, by running cat ``/proc/cpuinfo``.
 136 The physical id attribute listed for each processor indicates the CPU socket to which it belongs.
 137 This can be useful when using other processors to understand the mapping of the logical cores to the sockets.
 138
 139 .. note::
 140
 141     A more graphical view of the logical core layout may be obtained using the ``lstopo`` Linux utility.
 142     On Fedora Linux, this may be installed and run using the following command::
 143
 144         sudo yum install hwloc
 145         ./lstopo
 146
 147 .. warning::
 148
 149     The logical core layout can change between different board layouts and should be checked before selecting an application coremask/corelist.
 150
 151 Hugepage Memory Use by Applications
 152 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 153
 154 When running an application, it is recommended to use the same amount of memory as that allocated for hugepages.
 155 This is done automatically by the DPDK application at startup,
 156 if no ``-m`` or ``--socket-mem`` parameter is passed to it when run.
 157
 158 If more memory is requested by explicitly passing a ``-m`` or ``--socket-mem`` value, the application fails.
 159 However, the application itself can also fail if the user requests less memory than the reserved amount of hugepage-memory, particularly if using the ``-m`` option.
 160 The reason is as follows.
 161 Suppose the system has 1024 reserved 2 MB pages in socket 0 and 1024 in socket 1.
 162 If the user requests 128 MB of memory, the 64 pages may not match the constraints:
 163
 164 *   The hugepage memory by be given to the application by the kernel in socket 1 only.
 165     In this case, if the application attempts to create an object, such as a ring or memory pool in socket 0, it fails.
 166     To avoid this issue, it is recommended that the ``--socket-mem`` option be used instead of the ``-m`` option.
 167
 168 *   These pages can be located anywhere in physical memory, and, although the DPDK EAL will attempt to allocate memory in contiguous blocks,
 169     it is possible that the pages will not be contiguous. In this case, the application is not able to allocate big memory pools.
 170
 171 The socket-mem option can be used to request specific amounts of memory for specific sockets.
 172 This is accomplished by supplying the ``--socket-mem`` flag followed by amounts of memory requested on each socket,
 173 for example, supply ``--socket-mem=0,512`` to try and reserve 512 MB for socket 1 only.
 174 Similarly, on a four socket system, to allocate 1 GB memory on each of sockets 0 and 2 only, the parameter ``--socket-mem=1024,0,1024`` can be used.
 175 No memory will be reserved on any CPU socket that is not explicitly referenced, for example, socket 3 in this case.
 176 If the DPDK cannot allocate enough memory on each socket, the EAL initialization fails.
 177
 178 Additional Sample Applications
 179 ------------------------------
 180
 181 Additional sample applications are included in the DPDK examples directory.
 182 These sample applications may be built and run in a manner similar to that described in earlier sections in this manual.
 183 In addition, see the *DPDK Sample Applications User Guide* for a description of the application,
 184 specific instructions on compilation and execution and some explanation of the code.