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