1.. BSD LICENSE 2 Copyright(c) 2010-2014 Intel Corporation. All rights reserved. 3 All rights reserved. 4 5 Redistribution and use in source and binary forms, with or without 6 modification, are permitted provided that the following conditions 7 are met: 8 9 * Redistributions of source code must retain the above copyright 10 notice, this list of conditions and the following disclaimer. 11 * Redistributions in binary form must reproduce the above copyright 12 notice, this list of conditions and the following disclaimer in 13 the documentation and/or other materials provided with the 14 distribution. 15 * Neither the name of Intel Corporation nor the names of its 16 contributors may be used to endorse or promote products derived 17 from this software without specific prior written permission. 18 19 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 20 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 21 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 22 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 23 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 24 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 25 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 26 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 27 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 28 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 29 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 30 31Compiling and Running Sample Applications 32========================================= 33 34The chapter describes how to compile and run applications in an DPDK environment. 35It also provides a pointer to where sample applications are stored. 36 37.. note:: 38 39 Parts of this process can also be done using the setup script described the 40 :ref:`linux_setup_script` section of this document. 41 42Compiling a Sample Application 43------------------------------ 44 45Once an DPDK target environment directory has been created (such as ``x86_64-native-linuxapp-gcc``), 46it contains all libraries and header files required to build an application. 47 48When compiling an application in the Linux* environment on the DPDK, the following variables must be exported: 49 50* ``RTE_SDK`` - Points to the DPDK installation directory. 51 52* ``RTE_TARGET`` - Points to the DPDK target environment directory. 53 54The following is an example of creating the ``helloworld`` application, which runs in the DPDK Linux environment. 55This example may be found in the ``${RTE_SDK}/examples`` directory. 56 57The directory contains the ``main.c`` file. This file, when combined with the libraries in the DPDK target environment, 58calls the various functions to initialize the DPDK environment, 59then launches an entry point (dispatch application) for each core to be utilized. 60By default, the binary is generated in the build directory. 61 62.. code-block:: console 63 64 cd examples/helloworld/ 65 export RTE_SDK=$HOME/DPDK 66 export RTE_TARGET=x86_64-native-linuxapp-gcc 67 68 make 69 CC main.o 70 LD helloworld 71 INSTALL-APP helloworld 72 INSTALL-MAP helloworld.map 73 74 ls build/app 75 helloworld helloworld.map 76 77.. note:: 78 79 In the above example, ``helloworld`` was in the directory structure of the DPDK. 80 However, it could have been located outside the directory structure to keep the DPDK structure intact. 81 In the following case, the ``helloworld`` application is copied to a new directory as a new starting point. 82 83 .. code-block:: console 84 85 export RTE_SDK=/home/user/DPDK 86 cp -r $(RTE_SDK)/examples/helloworld my_rte_app 87 cd my_rte_app/ 88 export RTE_TARGET=x86_64-native-linuxapp-gcc 89 90 make 91 CC main.o 92 LD helloworld 93 INSTALL-APP helloworld 94 INSTALL-MAP helloworld.map 95 96Running a Sample Application 97---------------------------- 98 99.. warning:: 100 101 Before running the application make sure: 102 103 - Hugepages setup is done. 104 - Any kernel driver being used is loaded. 105 - In case needed, ports being used by the application should be 106 bound to the corresponding kernel driver. 107 108 refer to :ref:`linux_gsg_linux_drivers` for more details. 109 110The application is linked with the DPDK target environment's Environmental Abstraction Layer (EAL) library, 111which provides some options that are generic to every DPDK application. 112 113The following is the list of options that can be given to the EAL: 114 115.. code-block:: console 116 117 ./rte-app [-c COREMASK | -l CORELIST] [-n NUM] [-b <domain:bus:devid.func>] \ 118 [--socket-mem=MB,...] [-d LIB.so|DIR] [-m MB] [-r NUM] [-v] [--file-prefix] \ 119 [--proc-type <primary|secondary|auto>] [-- xen-dom0] 120 121The EAL options are as follows: 122 123* ``-c COREMASK`` or ``-l CORELIST``: 124 An hexadecimal bit mask of the cores to run on. Note that core numbering can 125 change between platforms and should be determined beforehand. The corelist is 126 a set of core numbers instead of a bitmap core mask. 127 128* ``-n NUM``: 129 Number of memory channels per processor socket. 130 131* ``-b <domain:bus:devid.func>``: 132 Blacklisting of ports; prevent EAL from using specified PCI device 133 (multiple ``-b`` options are allowed). 134 135* ``--use-device``: 136 use the specified Ethernet device(s) only. Use comma-separate 137 ``[domain:]bus:devid.func`` values. Cannot be used with ``-b`` option. 138 139* ``--socket-mem``: 140 Memory to allocate from hugepages on specific sockets. 141 142* ``-d``: 143 Add a driver or driver directory to be loaded. 144 The application should use this option to load the pmd drivers 145 that are built as shared libraries. 146 147* ``-m MB``: 148 Memory to allocate from hugepages, regardless of processor socket. It is 149 recommended that ``--socket-mem`` be used instead of this option. 150 151* ``-r NUM``: 152 Number of memory ranks. 153 154* ``-v``: 155 Display version information on startup. 156 157* ``--huge-dir``: 158 The directory where hugetlbfs is mounted. 159 160* ``mbuf-pool-ops-name``: 161 Pool ops name for mbuf to use. 162 163* ``--file-prefix``: 164 The prefix text used for hugepage filenames. 165 166* ``--proc-type``: 167 The type of process instance. 168 169* ``--xen-dom0``: 170 Support application running on Xen Domain0 without hugetlbfs. 171 172* ``--vmware-tsc-map``: 173 Use VMware TSC map instead of native RDTSC. 174 175* ``--base-virtaddr``: 176 Specify base virtual address. 177 178* ``--vfio-intr``: 179 Specify interrupt type to be used by VFIO (has no effect if VFIO is not used). 180 181The ``-c`` or ``-l`` and option is mandatory; the others are optional. 182 183Copy the DPDK application binary to your target, then run the application as follows 184(assuming the platform has four memory channels per processor socket, 185and that cores 0-3 are present and are to be used for running the application):: 186 187 ./helloworld -l 0-3 -n 4 188 189.. note:: 190 191 The ``--proc-type`` and ``--file-prefix`` EAL options are used for running 192 multiple DPDK processes. See the "Multi-process Sample Application" 193 chapter in the *DPDK Sample Applications User Guide* and the *DPDK 194 Programmers Guide* for more details. 195 196Logical Core Use by Applications 197~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 198 199The coremask (-c 0x0f) or corelist (-l 0-3) parameter is always mandatory for DPDK applications. 200Each 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. 201Since these logical core numbers, and their mapping to specific cores on specific NUMA sockets, can vary from platform to platform, 202it is recommended that the core layout for each platform be considered when choosing the coremask/corelist to use in each case. 203 204On initialization of the EAL layer by an DPDK application, the logical cores to be used and their socket location are displayed. 205This information can also be determined for all cores on the system by examining the ``/proc/cpuinfo`` file, for example, by running cat ``/proc/cpuinfo``. 206The physical id attribute listed for each processor indicates the CPU socket to which it belongs. 207This can be useful when using other processors to understand the mapping of the logical cores to the sockets. 208 209.. note:: 210 211 A more graphical view of the logical core layout may be obtained using the ``lstopo`` Linux utility. 212 On Fedora Linux, this may be installed and run using the following command:: 213 214 sudo yum install hwloc 215 ./lstopo 216 217.. warning:: 218 219 The logical core layout can change between different board layouts and should be checked before selecting an application coremask/corelist. 220 221Hugepage Memory Use by Applications 222~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 223 224When running an application, it is recommended to use the same amount of memory as that allocated for hugepages. 225This is done automatically by the DPDK application at startup, 226if no ``-m`` or ``--socket-mem`` parameter is passed to it when run. 227 228If more memory is requested by explicitly passing a ``-m`` or ``--socket-mem`` value, the application fails. 229However, 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. 230The reason is as follows. 231Suppose the system has 1024 reserved 2 MB pages in socket 0 and 1024 in socket 1. 232If the user requests 128 MB of memory, the 64 pages may not match the constraints: 233 234* The hugepage memory by be given to the application by the kernel in socket 1 only. 235 In this case, if the application attempts to create an object, such as a ring or memory pool in socket 0, it fails. 236 To avoid this issue, it is recommended that the ``--socket-mem`` option be used instead of the ``-m`` option. 237 238* These pages can be located anywhere in physical memory, and, although the DPDK EAL will attempt to allocate memory in contiguous blocks, 239 it is possible that the pages will not be contiguous. In this case, the application is not able to allocate big memory pools. 240 241The socket-mem option can be used to request specific amounts of memory for specific sockets. 242This is accomplished by supplying the ``--socket-mem`` flag followed by amounts of memory requested on each socket, 243for example, supply ``--socket-mem=0,512`` to try and reserve 512 MB for socket 1 only. 244Similarly, 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. 245No memory will be reserved on any CPU socket that is not explicitly referenced, for example, socket 3 in this case. 246If the DPDK cannot allocate enough memory on each socket, the EAL initialization fails. 247 248Additional Sample Applications 249------------------------------ 250 251Additional sample applications are included in the ${RTE_SDK}/examples directory. 252These sample applications may be built and run in a manner similar to that described in earlier sections in this manual. 253In addition, see the *DPDK Sample Applications User Guide* for a description of the application, 254specific instructions on compilation and execution and some explanation of the code. 255 256Additional Test Applications 257---------------------------- 258 259In addition, there are two other applications that are built when the libraries are created. 260The source files for these are in the DPDK/app directory and are called test and testpmd. 261Once the libraries are created, they can be found in the build/app directory. 262 263* The test application provides a variety of specific tests for the various functions in the DPDK. 264 265* The testpmd application provides a number of different packet throughput tests and 266 examples of features such as how to use the Flow Director found in the Intel® 82599 10 Gigabit Ethernet Controller. 267