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 Intel® DPDK Target from Source 32============================================ 33 34Install the Intel® DPDK and Browse Sources 35------------------------------------------ 36 37First, uncompress the archive and move to the Intel® DPDK source directory: 38 39.. code-block:: console 40 41 user@host:~ # unzip DPDK-<version>zip 42 user@host:~ # cd DPDK-<version> 43 user@host:~/DPDK # ls 44 app/ config/ examples/ lib/ LICENSE.GPL LICENSE.LGPL Makefile mk/ scripts/ tools/ 45 46The Intel® DPDK is composed of several directories: 47 48* lib: Source code of Intel® DPDK libraries 49 50* app: Source code of Intel® DPDK applications (automatic tests) 51 52* examples: Source code of Intel® DPDK applications 53 54* config, tools, scripts, mk: Framework-related makefiles, scripts and configuration 55 56Installation of the Intel® DPDK Target Environments 57--------------------------------------------------- 58 59The format of an Intel® DPDK target is: 60 61ARCH-MACHINE-EXECENV-TOOLCHAIN 62 63Where: 64 65* ARCH is: x86_64 66 67* MACHINE is: native 68 69* EXECENV is: bsdapp 70 71* TOOLCHAIN is: gcc 72 73The configuration files for the Intel® DPDK targets can be found in the DPDK/config directory in the form of: 74 75:: 76 77 defconfig_ARCH-MACHINE-EXECENV-TOOLCHAIN 78 79.. note:: 80 81 Configuration files are provided with the RTE_MACHINE optimization level set. 82 Within the configuration files, the RTE_MACHINE configuration value is set to native, 83 which means that the compiled software is tuned for the platform on which it is built. 84 For more information on this setting, and its possible values, 85 see the *Intel® DPDK Programmers Guide*. 86 87To install and make the target, use gmake install T=<target> CC=gcc48. 88 89For example to compile for FreeBSD* use: 90 91.. code-block:: console 92 93 gmake install T=x86_64-native-bsdapp-gcc CC=gcc48 94 95To prepare a target without building it, for example, 96if the configuration changes need to be made before compilation, 97use the gmake config T=<target> command: 98 99.. code-block:: console 100 101 gmake config T=x86_64-native-bsdapp-gcc CC=gcc48 102 103To build after configuration, change directory to ./x86_64-native-bsdapp-gcc and use: 104 105.. code-block:: console 106 107 gmake CC=gcc48 108 109Browsing the Installed Intel®DPDK Environment Target 110---------------------------------------------------- 111 112Once a target is created, it contains all the libraries 113and header files for the Intel® DPDK environment that are required to build customer applications. 114In addition, the test and testpmd applications are built under the build/app directory, which may be used for testing. 115A kmod directory is also present that contains the kernel modules to install: 116 117.. code-block:: console 118 119 user@host:~/DPDK # ls x86_64-native-bsdapp-gcc 120 app build hostapp include kmod lib Makefile 121 122Loading the Intel® DPDK contigmem Module 123---------------------------------------- 124 125To run any Intel® DPDK application, the contigmem module must be loaded into the running kernel. 126The module is found in the kmod sub-directory of the Intel® DPDK target directory. 127The module can be loaded using kldload (assuming that the current directory is the Intel® DPDK target directory): 128 129.. code-block:: console 130 131 kldload ./kmod/contigmem.ko 132 133It is advisable to include the loading of the contigmem module during the boot process to avoid issues 134with potential memory fragmentation during later system up time. 135This can be achieved by copying the module to the /boot/kernel/ directory and placing the following into /boot/loader.conf: 136 137:: 138 139 contigmem_load="YES" 140 141.. note:: 142 143 The contigmem_load directive should be placed after any definitions of hw.contigmem.num_buffers 144 and hw.contigmem.buffer_size if the default values are not to be used. 145 146An error such as kldload: can't load ./x86_64-native-bsdapp-gcc/kmod/contigmem.ko: Exec format error, 147is generally attributed to not having enough contiguous memory available and can be verified via dmesg or /var/log/messages: 148 149.. code-block:: console 150 151 kernel: contigmalloc failed for buffer <n> 152 153To avoid this error, reduce the number of buffers or the buffer size. 154 155Loading the Intel® DPDK nic_uio Module 156-------------------------------------- 157 158After loading the contigmem module, the nic_uio must also be loaded into the running kernel prior to running any Intel® DPDK application. 159This module must be loaded using the kldload command as shown below (assuming that the current directory is the Intel® DPDK target directory). 160 161.. code-block:: console 162 163 kldload ./kmod/nic_uio.ko 164 165.. note:: 166 167 Currently loaded modules can be seen by using the kldstat command. 168 A module can be removed from the running kernel by using kldunload <module_name>. 169 While the nic_uio module can be loaded during boot, 170 the module load order cannot be guaranteed and in the case where only some ports are bound to nic_uio 171 and others remain in use by the original driver, it is necessary to load nic_uio after booting into the kernel, 172 specifically after the original driver has been loaded. 173 174To load the module during boot, copy the nic_uio module to /boot/kernel and place the following into /boot/loader.conf: 175 176:: 177 178 nic_uio_load="YES" 179 180.. note:: 181 182 nic_uio_load="YES" must appear after the contigmem_load directive, if it exists. 183 184Binding Network Ports to the nic_uio Module 185------------------------------------------- 186 187By default, the nic_uio module will take ownership of network ports if they are recognized Intel® DPDK devices 188and are not owned by another module. 189 190Device ownership can be viewed using the pciconf -l command. 191 192The example below shows four Intel® 82599 network ports under if_ixgbe module ownership. 193 194.. code-block:: console 195 196 user@host:~ # pciconf -l 197 ix0@pci0:1:0:0: class=0x020000 card=0x00038086 chip=0x10fb8086 rev=0x01 hdr=0x00 198 ix1@pci0:1:0:1: class=0x020000 card=0x00038086 chip=0x10fb8086 rev=0x01 hdr=0x00 199 ix2@pci0:2:0:0: class=0x020000 card=0x00038086 chip=0x10fb8086 rev=0x01 hdr=0x00 200 ix3@pci0:2:0:1: class=0x020000 card=0x00038086 chip=0x10fb8086 rev=0x01 hdr=0x00 201 202The first column constitutes three components: 203 204#. Device name: ixN 205 206#. Unit name: pci0 207 208#. Selector (Bus:Device:Function): 1:0:0 209 210Where no driver is associated with a device, the device name will be none. 211 212By default, the FreeBSD* kernel will include built-in drivers for the most common devices; 213a kernel rebuild would normally be required to either remove the drivers or configure them as loadable modules. 214 215To avoid building a custom kernel, the nic_uio module can detach a network port from its current device driver. 216This is achieved by setting the hw.nic_uio.bdfs kernel environment variable prior to loading nic_uio, as follows: 217 218:: 219 220 hw.nic_uio.bdfs="b:d:f,b:d:f,..." 221 222Where a comma separated list of selectors is set, the list must not contain any whitespace. 223 224For example to re-bind ix2@pci0:2:0:0 and ix3@pci0:2:0: to the nic_uio module upon loading, use the following command: 225 226.. code-block:: console 227 228 kenv hw.nic_uio.bdfs="2:0:0,2:0:1" 229 230The variable can also be specified during boot by placing the following into /boot/ loader.conf: 231 232:: 233 234 hw.nic_uio.bdfs="2:0:0,2:0:1" 235 236To restore the original device binding, 237it is necessary to reboot FreeBSD* if the original driver has been compiled into the kernel. 238 239For example to rebind some or all ports to the original driver: 240 241Update or remove the hw.nic_uio.bdfs entry in /boot/loader.conf if specified there for persistency, then; 242 243.. code-block:: console 244 245 reboot 246 247If rebinding to a driver that is a loadable module, the network port binding can be reset without rebooting. 248This requires the unloading of the nic_uio module and the original driver. 249 250Update or remove the hw.nic_uio.bdfs entry from /boot/loader.conf if specified there for persistency. 251 252.. code-block:: console 253 254 kldunload nic_uio 255 256kldunload <original_driver> 257 258.. code-block:: console 259 260 kenv -u hw.nic_uio.bdfs 261 262to remove all network ports from nic_uio and undefined this system variable OR 263 264.. code-block:: console 265 266 kenv hw.nic_uio.bdfs="b:d:f,b:d:f,..." 267 268(to update nic_uio ports) 269 270.. code-block:: console 271 272 kldload <original_driver> 273 kldload nic_uio 274 275(if updating the list of associated network ports) 276