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