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 compile all 64-bit targets using gcc, use: 114 115.. code-block:: console 116 117 make install T=x86_64*gcc 118 119To compile all 64-bit targets using both gcc and icc, use: 120 121.. code-block:: console 122 123 make install T=x86_64-* 124 125.. note:: 126 127 The wildcard operator (*) can be used to create multiple targets at the same time. 128 129To prepare a target without building it, for example, if the configuration changes need to be made before compilation, 130use the make config T=<target> command: 131 132.. code-block:: console 133 134 make config T=x86_64-native-linuxapp-gcc 135 136.. warning:: 137 138 Any kernel modules to be used, e.g. igb_uio, kni, must be compiled with the 139 same kernel as the one running on the target. 140 If the DPDK is not being built on the target machine, 141 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. 142 143Once the target environment is created, the user may move to the target environment directory and continue to make code changes and re-compile. 144The user may also make modifications to the compile-time DPDK configuration by editing the .config file in the build directory. 145(This is a build-local copy of the defconfig file from the top- level config directory). 146 147.. code-block:: console 148 149 cd x86_64-native-linuxapp-gcc 150 vi .config 151 make 152 153In addition, the make clean command can be used to remove any existing compiled files for a subsequent full, clean rebuild of the code. 154 155Browsing the Installed DPDK Environment Target 156---------------------------------------------- 157 158Once 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. 159In addition, the test and testpmd applications are built under the build/app directory, which may be used for testing. 160A kmod directory is also present that contains kernel modules which may be loaded if needed. 161 162.. code-block:: console 163 164 $ ls x86_64-native-linuxapp-gcc 165 app build hostapp include kmod lib Makefile 166 167Loading Modules to Enable Userspace IO for DPDK 168----------------------------------------------- 169 170To run any DPDK application, a suitable uio module can be loaded into the running kernel. 171In many cases, the standard uio_pci_generic module included in the Linux kernel 172can provide the uio capability. This module can be loaded using the command 173 174.. code-block:: console 175 176 sudo modprobe uio_pci_generic 177 178As an alternative to the uio_pci_generic, the DPDK also includes the igb_uio 179module which can be found in the kmod subdirectory referred to above. It can 180be loaded as shown below: 181 182.. code-block:: console 183 184 sudo modprobe uio 185 sudo insmod kmod/igb_uio.ko 186 187.. note:: 188 189 For some devices which lack support for legacy interrupts, e.g. virtual function 190 (VF) devices, the igb_uio module may be needed in place of uio_pci_generic. 191 192Since DPDK release 1.7 onward provides VFIO support, use of UIO is optional 193for platforms that support using VFIO. 194 195Loading VFIO Module 196------------------- 197 198To run an DPDK application and make use of VFIO, the vfio-pci module must be loaded: 199 200.. code-block:: console 201 202 sudo modprobe vfio-pci 203 204Note that in order to use VFIO, your kernel must support it. 205VFIO kernel modules have been included in the Linux kernel since version 3.6.0 and are usually present by default, 206however please consult your distributions documentation to make sure that is the case. 207 208Also, to use VFIO, both kernel and BIOS must support and be configured to use IO virtualization (such as Intel® VT-d). 209 210For proper operation of VFIO when running DPDK applications as a non-privileged user, correct permissions should also be set up. 211This can be done by using the DPDK setup script (called setup.sh and located in the tools directory). 212 213Binding and Unbinding Network Ports to/from the Kernel Modules 214---------------------------------------------------------------------- 215 216As of release 1.4, DPDK applications no longer automatically unbind all supported network ports from the kernel driver in use. 217Instead, all ports that are to be used by an DPDK application must be bound to the 218uio_pci_generic, igb_uio or vfio-pci module before the application is run. 219Any network ports under Linux* control will be ignored by the DPDK poll-mode drivers and cannot be used by the application. 220 221.. warning:: 222 223 The DPDK will, by default, no longer automatically unbind network ports from the kernel driver at startup. 224 Any ports to be used by an DPDK application must be unbound from Linux* control and 225 bound to the uio_pci_generic, igb_uio or vfio-pci module before the application is run. 226 227To bind ports to the uio_pci_generic, igb_uio or vfio-pci module for DPDK use, 228and then subsequently return ports to Linux* control, 229a utility script called dpdk_nic _bind.py is provided in the tools subdirectory. 230This utility can be used to provide a view of the current state of the network ports on the system, 231and to bind and unbind those ports from the different kernel modules, including the uio and vfio modules. 232The following are some examples of how the script can be used. 233A full description of the script and its parameters can be obtained by calling the script with the --help or --usage options. 234Note that the uio or vfio kernel modules to be used, should be loaded into the kernel before 235running the dpdk_nic_bind.py script. 236 237.. warning:: 238 239 Due to the way VFIO works, there are certain limitations to which devices can be used with VFIO. 240 Mainly it comes down to how IOMMU groups work. 241 Any Virtual Function device can be used with VFIO on its own, but physical devices will require either all ports bound to VFIO, 242 or some of them bound to VFIO while others not being bound to anything at all. 243 244 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. 245 Therefore, the bridge driver should also be unbound from the bridge PCI device for VFIO to work with devices behind the bridge. 246 247.. warning:: 248 249 While any user can run the dpdk_nic_bind.py script to view the status of the network ports, 250 binding or unbinding network ports requires root privileges. 251 252To see the status of all network ports on the system: 253 254.. code-block:: console 255 256 root@host:DPDK# ./tools/dpdk_nic_bind.py --status 257 258 Network devices using DPDK-compatible driver 259 ============================================ 260 0000:82:00.0 '82599EB 10-Gigabit SFI/SFP+ Network Connection' drv=uio_pci_generic unused=ixgbe 261 0000:82:00.1 '82599EB 10-Gigabit SFI/SFP+ Network Connection' drv=uio_pci_generic unused=ixgbe 262 263 Network devices using kernel driver 264 =================================== 265 0000:04:00.0 'I350 Gigabit Network Connection' if=em0 drv=igb unused=uio_pci_generic *Active* 266 0000:04:00.1 'I350 Gigabit Network Connection' if=eth1 drv=igb unused=uio_pci_generic 267 0000:04:00.2 'I350 Gigabit Network Connection' if=eth2 drv=igb unused=uio_pci_generic 268 0000:04:00.3 'I350 Gigabit Network Connection' if=eth3 drv=igb unused=uio_pci_generic 269 270 Other network devices 271 ===================== 272 <none> 273 274To bind device eth1, 04:00.1, to the uio_pci_generic driver: 275 276.. code-block:: console 277 278 root@host:DPDK# ./tools/dpdk_nic_bind.py --bind=uio_pci_generic 04:00.1 279 280or, alternatively, 281 282.. code-block:: console 283 284 root@host:DPDK# ./tools/dpdk_nic_bind.py --bind=uio_pci_generic eth1 285 286To restore device 82:00.0 to its original kernel binding: 287 288.. code-block:: console 289 290 root@host:DPDK# ./tools/dpdk_nic_bind.py --bind=ixgbe 82:00.0 291