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
74 directory in the form of:
78 defconfig_ARCH-MACHINE-EXECENV-TOOLCHAIN
82 Configuration files are provided with the RTE_MACHINE optimization level set.
83 Within the configuration files, the RTE_MACHINE configuration value is set
84 to native, which means that the compiled software is tuned for the platform
85 on which it is built. For more information on this setting, and its
86 possible values, see the *Intel® DPDK Programmers Guide*.
88 To install and make the target, use gmake install T=<target> CC=gcc48.
90 For example to compile for FreeBSD* use:
92 .. code-block:: console
94 gmake install T=x86_64-native-bsdapp-gcc CC=gcc48
96 To prepare a target without building it, for example, if the configuration
97 changes need to be made before compilation, 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 and header files for the
113 Intel® DPDK environment that are required to build customer applications.
114 In addition, the test and testpmd applications are built under the build/app
115 directory, which may be used for testing. A kmod directory is also present that
116 contains the kernel modules to install:
118 .. code-block:: console
120 user@host:~/DPDK # ls x86_64-native-bsdapp-gcc
121 app build hostapp include kmod lib Makefile
123 Loading the Intel® DPDK contigmem Module
124 ----------------------------------------
126 To run any Intel® DPDK application, the contigmem module must be loaded into the
127 running kernel. The module is found in the kmod sub-directory of the Intel® DPDK
128 target directory. The module can be loaded using kldload (assuming that the
129 current directory is the Intel® DPDK target directory):
131 .. code-block:: console
133 kldload ./kmod/contigmem.ko
135 It is advisable to include the loading of the contigmem module during the boot
136 process to avoid issues with potential memory fragmentation during later system
137 up time. This can be achieved by copying the module to the /boot/kernel/
138 directory and placing the following into /boot/loader.conf:
146 The contigmem_load directive should be placed after any definitions of
147 hw.contigmem.num_buffers and hw.contigmem.buffer_size if the default values
150 An error such as kldload: can't load ./x86_64-native-bsdapp-gcc/kmod/contigmem.ko:
151 Exec format error, is generally attributed to not having enough contiguous memory
152 available and can be verified via dmesg or /var/log/messages:
154 .. code-block:: console
156 kernel: contigmalloc failed for buffer <n>
158 To avoid this error, reduce the number of buffers or the buffer size.
160 Loading the Intel® DPDK nic_uio Module
161 --------------------------------------
163 After loading the contigmem module, the nic_uio must also be loaded into the
164 running kernel prior to running any Intel® DPDK application. This module must
165 be loaded using the kldload command as shown below (assuming that the current
166 directory is the Intel® DPDK target directory).
168 .. code-block:: console
170 kldload ./kmod/nic_uio.ko
174 Currently loaded modules can be seen by using the kldstat command. A module
175 can be removed from the running kernel by using kldunload <module_name>.
176 While the nic_uio module can be loaded during boot, the module load order
177 cannot be guaranteed and in the case where only some ports are bound to
178 nic_uio and others remain in use by the original driver, it is necessary to
179 load nic_uio after booting into the kernel, specifically after the original
180 driver has been loaded.
182 To load the module during boot, copy the nic_uio module to /boot/kernel and place the following into /boot/loader.conf:
190 nic_uio_load="YES" must appear after the contigmem_load directive, if it exists.
192 Binding Network Ports to the nic_uio Module
193 -------------------------------------------
195 By default, the nic_uio module will take ownership of network ports if they are
196 recognized Intel® DPDK devices and are not owned by another module.
198 Device ownership can be viewed using the pciconf -l command.
200 The example below shows four Intel® 82599 network ports under if_ixgbe module ownership.
202 .. code-block:: console
204 user@host:~ # pciconf -l
205 ix0@pci0:1:0:0: class=0x020000 card=0x00038086 chip=0x10fb8086 rev=0x01 hdr=0x00
206 ix1@pci0:1:0:1: class=0x020000 card=0x00038086 chip=0x10fb8086 rev=0x01 hdr=0x00
207 ix2@pci0:2:0:0: class=0x020000 card=0x00038086 chip=0x10fb8086 rev=0x01 hdr=0x00
208 ix3@pci0:2:0:1: class=0x020000 card=0x00038086 chip=0x10fb8086 rev=0x01 hdr=0x00
210 The first column constitutes three components:
216 #. Selector (Bus:Device:Function): 1:0:0
218 Where no driver is associated with a device, the device name will be none.
220 By default, the FreeBSD* kernel will include built-in drivers for the most common
221 devices; a kernel rebuild would normally be required to either remove the drivers
222 or configure them as loadable modules.
224 To avoid building a custom kernel, the nic_uio module can detach a network port
225 from its current device driver. This is achieved by setting the hw.nic_uio.bdfs
226 kernel environment variable prior to loading nic_uio, as follows:
230 hw.nic_uio.bdfs="b:d:f,b:d:f,..."
232 Where a comma separated list of selectors is set, the list must not contain any
235 For example to re-bind ix2@pci0:2:0:0 and ix3@pci0:2:0: to the nic_uio module
236 upon loading, use the following command:
238 .. code-block:: console
240 kenv hw.nic_uio.bdfs="2:0:0,2:0:1"
242 The variable can also be specified during boot by placing the following into
247 hw.nic_uio.bdfs="2:0:0,2:0:1"
249 To restore the original device binding, it is necessary to reboot FreeBSD* if the
250 original driver has been compiled into the kernel.
252 For example to rebind some or all ports to the original driver:
254 Update or remove the hw.nic_uio.bdfs entry in /boot/loader.conf if specified there
255 for persistency, then;
257 .. code-block:: console
261 If rebinding to a driver that is a loadable module, the network port binding can
262 be reset without rebooting. This requires the unloading of the nic_uio module
263 and the original driver.
265 Update or remove the hw.nic_uio.bdfs entry from /boot/loader.conf if specified
266 there for persistency.
268 .. code-block:: console
272 kldunload <original_driver>
274 .. code-block:: console
276 kenv -u hw.nic_uio.bdfs
278 to remove all network ports from nic_uio and undefined this system variable OR
280 .. code-block:: console
282 kenv hw.nic_uio.bdfs="b:d:f,b:d:f,..."
284 (to update nic_uio ports)
286 .. code-block:: console
288 kldload <original_driver>
291 (if updating the list of associated network ports)