2 Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
5 Redistribution and use in source and binary forms, with or without
6 modification, are permitted provided that the following conditions
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
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.
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.
31 Compiling the Intel® DPDK Target from Source
32 ============================================
34 Install the Intel® DPDK and Browse Sources
35 ------------------------------------------
37 First, uncompress the archive and move to the Intel® DPDK source directory:
39 .. code-block:: console
41 user@host:~ # unzip DPDK-<version>zip
42 user@host:~ # cd DPDK-<version>
44 app/ config/ examples/ lib/ LICENSE.GPL LICENSE.LGPL Makefile mk/ scripts/ tools/
46 The Intel® DPDK is composed of several directories:
48 * lib: Source code of Intel® DPDK libraries
50 * app: Source code of Intel® DPDK applications (automatic tests)
52 * examples: Source code of Intel® DPDK applications
54 * config, tools, scripts, mk: Framework-related makefiles, scripts and configuration
56 Installation of the Intel® DPDK Target Environments
57 ---------------------------------------------------
59 The format of an Intel® DPDK target is:
61 ARCH-MACHINE-EXECENV-TOOLCHAIN
73 The configuration files for the Intel® DPDK targets can be found in the DPDK/config directory in the form of:
77 defconfig_ARCH-MACHINE-EXECENV-TOOLCHAIN
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*.
87 To install and make the target, use gmake install T=<target> CC=gcc48.
89 For example to compile for FreeBSD* use:
91 .. code-block:: console
93 gmake install T=x86_64-native-bsdapp-gcc CC=gcc48
95 To prepare a target without building it, for example,
96 if the configuration changes need to be made before compilation,
97 use the gmake config T=<target> command:
99 .. code-block:: console
101 gmake config T=x86_64-native-bsdapp-gcc CC=gcc48
103 To build after configuration, change directory to ./x86_64-native-bsdapp-gcc and use:
105 .. code-block:: console
109 Browsing the Installed Intel®DPDK Environment Target
110 ----------------------------------------------------
112 Once a target is created, it contains all the libraries
113 and header files for the Intel® DPDK environment that are required to build customer applications.
114 In addition, the test and testpmd applications are built under the build/app directory, which may be used for testing.
115 A kmod directory is also present that contains the kernel modules to install:
117 .. code-block:: console
119 user@host:~/DPDK # ls x86_64-native-bsdapp-gcc
120 app build hostapp include kmod lib Makefile
122 Loading the Intel® DPDK contigmem Module
123 ----------------------------------------
125 To run any Intel® DPDK application, the contigmem module must be loaded into the running kernel.
126 The module is found in the kmod sub-directory of the Intel® DPDK target directory.
127 The module can be loaded using kldload (assuming that the current directory is the Intel® DPDK target directory):
129 .. code-block:: console
131 kldload ./kmod/contigmem.ko
133 It is advisable to include the loading of the contigmem module during the boot process to avoid issues
134 with potential memory fragmentation during later system up time.
135 This can be achieved by copying the module to the /boot/kernel/ directory and placing the following into /boot/loader.conf:
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.
146 An error such as kldload: can't load ./x86_64-native-bsdapp-gcc/kmod/contigmem.ko: Exec format error,
147 is generally attributed to not having enough contiguous memory available and can be verified via dmesg or /var/log/messages:
149 .. code-block:: console
151 kernel: contigmalloc failed for buffer <n>
153 To avoid this error, reduce the number of buffers or the buffer size.
155 Loading the Intel® DPDK nic_uio Module
156 --------------------------------------
158 After loading the contigmem module, the nic_uio must also be loaded into the running kernel prior to running any Intel® DPDK application.
159 This module must be loaded using the kldload command as shown below (assuming that the current directory is the Intel® DPDK target directory).
161 .. code-block:: console
163 kldload ./kmod/nic_uio.ko
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.
174 To load the module during boot, copy the nic_uio module to /boot/kernel and place the following into /boot/loader.conf:
182 nic_uio_load="YES" must appear after the contigmem_load directive, if it exists.
184 Binding Network Ports to the nic_uio Module
185 -------------------------------------------
187 By default, the nic_uio module will take ownership of network ports if they are recognized Intel® DPDK devices
188 and are not owned by another module.
190 Device ownership can be viewed using the pciconf -l command.
192 The example below shows four Intel® 82599 network ports under if_ixgbe module ownership.
194 .. code-block:: console
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
202 The first column constitutes three components:
208 #. Selector (Bus:Device:Function): 1:0:0
210 Where no driver is associated with a device, the device name will be none.
212 By default, the FreeBSD* kernel will include built-in drivers for the most common devices;
213 a kernel rebuild would normally be required to either remove the drivers or configure them as loadable modules.
215 To avoid building a custom kernel, the nic_uio module can detach a network port from its current device driver.
216 This is achieved by setting the hw.nic_uio.bdfs kernel environment variable prior to loading nic_uio, as follows:
220 hw.nic_uio.bdfs="b:d:f,b:d:f,..."
222 Where a comma separated list of selectors is set, the list must not contain any whitespace.
224 For 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:
226 .. code-block:: console
228 kenv hw.nic_uio.bdfs="2:0:0,2:0:1"
230 The variable can also be specified during boot by placing the following into /boot/ loader.conf:
234 hw.nic_uio.bdfs="2:0:0,2:0:1"
236 To restore the original device binding,
237 it is necessary to reboot FreeBSD* if the original driver has been compiled into the kernel.
239 For example to rebind some or all ports to the original driver:
241 Update or remove the hw.nic_uio.bdfs entry in /boot/loader.conf if specified there for persistency, then;
243 .. code-block:: console
247 If rebinding to a driver that is a loadable module, the network port binding can be reset without rebooting.
248 This requires the unloading of the nic_uio module and the original driver.
250 Update or remove the hw.nic_uio.bdfs entry from /boot/loader.conf if specified there for persistency.
252 .. code-block:: console
256 kldunload <original_driver>
258 .. code-block:: console
260 kenv -u hw.nic_uio.bdfs
262 to remove all network ports from nic_uio and undefined this system variable OR
264 .. code-block:: console
266 kenv hw.nic_uio.bdfs="b:d:f,b:d:f,..."
268 (to update nic_uio ports)
270 .. code-block:: console
272 kldload <original_driver>
275 (if updating the list of associated network ports)