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