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