1.. BSD LICENSE 2 Copyright(c) 2010-2015 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 31.. _linux_gsg_compiling_dpdk: 32 33Compiling the DPDK Target from Source 34===================================== 35 36.. note:: 37 38 Parts of this process can also be done using the setup script described in 39 the :ref:`linux_setup_script` section of this document. 40 41Install the DPDK and Browse Sources 42----------------------------------- 43 44First, uncompress the archive and move to the uncompressed DPDK source directory: 45 46.. code-block:: console 47 48 tar xJf dpdk-<version>.tar.xz 49 cd dpdk-<version> 50 51The DPDK is composed of several directories: 52 53* lib: Source code of DPDK libraries 54 55* drivers: Source code of DPDK poll-mode drivers 56 57* app: Source code of DPDK applications (automatic tests) 58 59* examples: Source code of DPDK application examples 60 61* config, buildtools, mk: Framework-related makefiles, scripts and configuration 62 63Installation of DPDK Target Environments 64---------------------------------------- 65 66The format of a DPDK target is:: 67 68 ARCH-MACHINE-EXECENV-TOOLCHAIN 69 70where: 71 72* ``ARCH`` can be: ``i686``, ``x86_64``, ``ppc_64`` 73 74* ``MACHINE`` can be: ``native``, ``power8`` 75 76* ``EXECENV`` can be: ``linuxapp``, ``bsdapp`` 77 78* ``TOOLCHAIN`` can be: ``gcc``, ``icc`` 79 80The targets to be installed depend on the 32-bit and/or 64-bit packages and compilers installed on the host. 81Available targets can be found in the DPDK/config directory. 82The defconfig\_ prefix should not be used. 83 84.. note:: 85 86 Configuration files are provided with the ``RTE_MACHINE`` optimization level set. 87 Within the configuration files, the ``RTE_MACHINE`` configuration value is set to native, 88 which means that the compiled software is tuned for the platform on which it is built. 89 For more information on this setting, and its possible values, see the *DPDK Programmers Guide*. 90 91When using the Intel® C++ Compiler (icc), one of the following commands should be invoked for 64-bit or 32-bit use respectively. 92Notice that the shell scripts update the ``$PATH`` variable and therefore should not be performed in the same session. 93Also, verify the compiler's installation directory since the path may be different: 94 95.. code-block:: console 96 97 source /opt/intel/bin/iccvars.sh intel64 98 source /opt/intel/bin/iccvars.sh ia32 99 100To install and make targets, use the ``make install T=<target>`` command in the top-level DPDK directory. 101 102For example, to compile a 64-bit target using icc, run: 103 104.. code-block:: console 105 106 make install T=x86_64-native-linuxapp-icc 107 108To compile a 32-bit build using gcc, the make command should be: 109 110.. code-block:: console 111 112 make install T=i686-native-linuxapp-gcc 113 114To prepare a target without building it, for example, if the configuration changes need to be made before compilation, 115use the ``make config T=<target>`` command: 116 117.. code-block:: console 118 119 make config T=x86_64-native-linuxapp-gcc 120 121.. warning:: 122 123 Any kernel modules to be used, e.g. ``igb_uio``, ``kni``, must be compiled with the 124 same kernel as the one running on the target. 125 If the DPDK is not being built on the target machine, 126 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. 127 128Once the target environment is created, the user may move to the target environment directory and continue to make code changes and re-compile. 129The user may also make modifications to the compile-time DPDK configuration by editing the .config file in the build directory. 130(This is a build-local copy of the defconfig file from the top- level config directory). 131 132.. code-block:: console 133 134 cd x86_64-native-linuxapp-gcc 135 vi .config 136 make 137 138In addition, the make clean command can be used to remove any existing compiled files for a subsequent full, clean rebuild of the code. 139 140Browsing the Installed DPDK Environment Target 141---------------------------------------------- 142 143Once 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. 144In addition, the test and testpmd applications are built under the build/app directory, which may be used for testing. 145A kmod directory is also present that contains kernel modules which may be loaded if needed. 146 147Loading Modules to Enable Userspace IO for DPDK 148----------------------------------------------- 149 150To run any DPDK application, a suitable uio module can be loaded into the running kernel. 151In many cases, the standard ``uio_pci_generic`` module included in the Linux kernel 152can provide the uio capability. This module can be loaded using the command 153 154.. code-block:: console 155 156 sudo modprobe uio_pci_generic 157 158As an alternative to the ``uio_pci_generic``, the DPDK also includes the igb_uio 159module which can be found in the kmod subdirectory referred to above. It can 160be loaded as shown below: 161 162.. code-block:: console 163 164 sudo modprobe uio 165 sudo insmod kmod/igb_uio.ko 166 167.. note:: 168 169 For some devices which lack support for legacy interrupts, e.g. virtual function 170 (VF) devices, the ``igb_uio`` module may be needed in place of ``uio_pci_generic``. 171 172Since DPDK release 1.7 onward provides VFIO support, use of UIO is optional 173for platforms that support using VFIO. 174 175Loading VFIO Module 176------------------- 177 178To run an DPDK application and make use of VFIO, the ``vfio-pci`` module must be loaded: 179 180.. code-block:: console 181 182 sudo modprobe vfio-pci 183 184Note that in order to use VFIO, your kernel must support it. 185VFIO kernel modules have been included in the Linux kernel since version 3.6.0 and are usually present by default, 186however please consult your distributions documentation to make sure that is the case. 187 188Also, to use VFIO, both kernel and BIOS must support and be configured to use IO virtualization (such as Intel® VT-d). 189 190For proper operation of VFIO when running DPDK applications as a non-privileged user, correct permissions should also be set up. 191This can be done by using the DPDK setup script (called dpdk-setup.sh and located in the usertools directory). 192 193.. _linux_gsg_binding_kernel: 194 195Binding and Unbinding Network Ports to/from the Kernel Modules 196-------------------------------------------------------------- 197 198As of release 1.4, DPDK applications no longer automatically unbind all supported network ports from the kernel driver in use. 199Instead, all ports that are to be used by an DPDK application must be bound to the 200``uio_pci_generic``, ``igb_uio`` or ``vfio-pci`` module before the application is run. 201Any network ports under Linux* control will be ignored by the DPDK poll-mode drivers and cannot be used by the application. 202 203.. warning:: 204 205 The DPDK will, by default, no longer automatically unbind network ports from the kernel driver at startup. 206 Any ports to be used by an DPDK application must be unbound from Linux* control and 207 bound to the ``uio_pci_generic``, ``igb_uio`` or ``vfio-pci`` module before the application is run. 208 209To bind ports to the ``uio_pci_generic``, ``igb_uio`` or ``vfio-pci`` module for DPDK use, 210and then subsequently return ports to Linux* control, 211a utility script called dpdk_nic _bind.py is provided in the usertools subdirectory. 212This utility can be used to provide a view of the current state of the network ports on the system, 213and to bind and unbind those ports from the different kernel modules, including the uio and vfio modules. 214The following are some examples of how the script can be used. 215A full description of the script and its parameters can be obtained by calling the script with the ``--help`` or ``--usage`` options. 216Note that the uio or vfio kernel modules to be used, should be loaded into the kernel before 217running the ``dpdk-devbind.py`` script. 218 219.. warning:: 220 221 Due to the way VFIO works, there are certain limitations to which devices can be used with VFIO. 222 Mainly it comes down to how IOMMU groups work. 223 Any Virtual Function device can be used with VFIO on its own, but physical devices will require either all ports bound to VFIO, 224 or some of them bound to VFIO while others not being bound to anything at all. 225 226 If your device is behind a PCI-to-PCI bridge, the bridge will then be part of the IOMMU group in which your device is in. 227 Therefore, the bridge driver should also be unbound from the bridge PCI device for VFIO to work with devices behind the bridge. 228 229.. warning:: 230 231 While any user can run the dpdk-devbind.py script to view the status of the network ports, 232 binding or unbinding network ports requires root privileges. 233 234To see the status of all network ports on the system: 235 236.. code-block:: console 237 238 ./usertools/dpdk-devbind.py --status 239 240 Network devices using DPDK-compatible driver 241 ============================================ 242 0000:82:00.0 '82599EB 10-GbE NIC' drv=uio_pci_generic unused=ixgbe 243 0000:82:00.1 '82599EB 10-GbE NIC' drv=uio_pci_generic unused=ixgbe 244 245 Network devices using kernel driver 246 =================================== 247 0000:04:00.0 'I350 1-GbE NIC' if=em0 drv=igb unused=uio_pci_generic *Active* 248 0000:04:00.1 'I350 1-GbE NIC' if=eth1 drv=igb unused=uio_pci_generic 249 0000:04:00.2 'I350 1-GbE NIC' if=eth2 drv=igb unused=uio_pci_generic 250 0000:04:00.3 'I350 1-GbE NIC' if=eth3 drv=igb unused=uio_pci_generic 251 252 Other network devices 253 ===================== 254 <none> 255 256To bind device ``eth1``,``04:00.1``, to the ``uio_pci_generic`` driver: 257 258.. code-block:: console 259 260 ./usertools/dpdk-devbind.py --bind=uio_pci_generic 04:00.1 261 262or, alternatively, 263 264.. code-block:: console 265 266 ./usertools/dpdk-devbind.py --bind=uio_pci_generic eth1 267 268To restore device ``82:00.0`` to its original kernel binding: 269 270.. code-block:: console 271 272 ./usertools/dpdk-devbind.py --bind=ixgbe 82:00.0 273