doc/guides/linux_gsg/linux_drivers.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright(c) 2010-2015 Intel Corporation.
   3     Copyright 2017 Mellanox Technologies, Ltd
   4     All rights reserved.
   5
   6 .. _linux_gsg_linux_drivers:
   7
   8 Linux Drivers
   9 =============
  10
  11 Different PMDs may require different kernel drivers in order to work properly.
  12 Depends on the PMD being used, a corresponding kernel driver should be load
  13 and bind to the network ports.
  14
  15 UIO
  16 ---
  17
  18 A small kernel module to set up the device, map device memory to user-space and register interrupts.
  19 In many cases, the standard ``uio_pci_generic`` module included in the Linux kernel
  20 can provide the uio capability. This module can be loaded using the command:
  21
  22 .. code-block:: console
  23
  24     sudo modprobe uio_pci_generic
  25
  26 .. note::
  27
  28     ``uio_pci_generic`` module doesn't support the creation of virtual functions.
  29
  30 As an alternative to the ``uio_pci_generic``, the DPDK also includes the igb_uio
  31 module which can be found in the kmod subdirectory referred to above. It can
  32 be loaded as shown below:
  33
  34 .. code-block:: console
  35
  36     sudo modprobe uio
  37     sudo insmod kmod/igb_uio.ko
  38
  39 .. note::
  40
  41    ``igb_uio`` module is disabled by default starting from ``DPDK v20.02``.
  42    To build it, the config option ``CONFIG_RTE_EAL_IGB_UIO`` should be enabled.
  43    It is planned to move ``igb_uio`` module to a different git repository.
  44
  45 .. note::
  46
  47     For some devices which lack support for legacy interrupts, e.g. virtual function
  48     (VF) devices, the ``igb_uio`` module may be needed in place of ``uio_pci_generic``.
  49
  50 .. note::
  51
  52    If UEFI secure boot is enabled, the Linux kernel may disallow the use of
  53    UIO on the system. Therefore, devices for use by DPDK should be bound to the
  54    ``vfio-pci`` kernel module rather than ``igb_uio`` or ``uio_pci_generic``.
  55    For more details see :ref:`linux_gsg_binding_kernel` below.
  56
  57 .. note::
  58
  59    If the devices used for DPDK are bound to the ``uio_pci_generic`` kernel module,
  60    please make sure that the IOMMU is disabled or passthrough. One can add
  61    ``intel_iommu=off`` or ``amd_iommu=off`` or ``intel_iommu=on iommu=pt`` in GRUB
  62    command line on x86_64 systems, or add ``iommu.passthrough=1`` on aarch64 system.
  63
  64 Since DPDK release 1.7 onward provides VFIO support, use of UIO is optional
  65 for platforms that support using VFIO.
  66
  67 VFIO
  68 ----
  69
  70 A more robust and secure driver in compare to the ``UIO``, relying on IOMMU protection.
  71 To make use of VFIO, the ``vfio-pci`` module must be loaded:
  72
  73 .. code-block:: console
  74
  75     sudo modprobe vfio-pci
  76
  77 Note that in order to use VFIO, your kernel must support it.
  78 VFIO kernel modules have been included in the Linux kernel since version 3.6.0 and are usually present by default,
  79 however please consult your distributions documentation to make sure that is the case.
  80
  81 The ``vfio-pci`` module since Linux version 5.7 supports the creation of virtual
  82 functions. After the PF is bound to vfio-pci module, the user can create the VFs
  83 by sysfs interface, and these VFs are bound to vfio-pci module automatically.
  84
  85 When the PF is bound to vfio-pci, it has initial VF token generated by random. For
  86 security reason, this token is write only, the user can't read it from the kernel
  87 directly. To access the VF, the user needs to start the PF with token parameter to
  88 setup a VF token in UUID format, then the VF can be accessed with this new token.
  89
  90 Since the ``vfio-pci`` module uses the VF token as internal data to provide the
  91 collaboration between SR-IOV PF and VFs, so DPDK can use the same VF token for all
  92 PF devices which bound to one application. This VF token can be specified by the EAL
  93 parameter ``--vfio-vf-token``.
  94
  95 .. code-block:: console
  96
  97     1. Generate the VF token by uuid command
  98         14d63f20-8445-11ea-8900-1f9ce7d5650d
  99
 100     2. sudo modprobe vfio-pci enable_sriov=1
 101
 102     2. ./usertools/dpdk-devbind.py -b vfio-pci 0000:86:00.0
 103
 104     3. echo 2 > /sys/bus/pci/devices/0000:86:00.0/sriov_numvfs
 105
 106     4. Start the PF:
 107         ./x86_64-native-linux-gcc/app/testpmd -l 22-25 -n 4 -w 86:00.0 \
 108          --vfio-vf-token=14d63f20-8445-11ea-8900-1f9ce7d5650d --file-prefix=pf -- -i
 109
 110     5. Start the VF:
 111         ./x86_64-native-linux-gcc/app/testpmd -l 26-29 -n 4 -w 86:02.0 \
 112          --vfio-vf-token=14d63f20-8445-11ea-8900-1f9ce7d5650d --file-prefix=vf0 -- -i
 113
 114 Also, to use VFIO, both kernel and BIOS must support and be configured to use IO virtualization (such as Intel® VT-d).
 115
 116 .. note::
 117
 118     ``vfio-pci`` module doesn't support the creation of virtual functions before Linux version 5.7.
 119
 120 For proper operation of VFIO when running DPDK applications as a non-privileged user, correct permissions should also be set up.
 121 This can be done by using the DPDK setup script (called dpdk-setup.sh and located in the usertools directory).
 122
 123 .. note::
 124
 125     VFIO can be used without IOMMU. While this is just as unsafe as using UIO, it does make it possible for the user to keep the degree of device access and programming that VFIO has, in situations where IOMMU is not available.
 126
 127 .. _bifurcated_driver:
 128
 129 Bifurcated Driver
 130 -----------------
 131
 132 PMDs which use the bifurcated driver co-exists with the device kernel driver.
 133 On such model the NIC is controlled by the kernel, while the data
 134 path is performed by the PMD directly on top of the device.
 135
 136 Such model has the following benefits:
 137
 138  - It is secure and robust, as the memory management and isolation
 139    is done by the kernel.
 140  - It enables the user to use legacy linux tools such as ``ethtool`` or
 141    ``ifconfig`` while running DPDK application on the same network ports.
 142  - It enables the DPDK application to filter only part of the traffic,
 143    while the rest will be directed and handled by the kernel driver.
 144    The flow bifurcation is performed by the NIC hardware.
 145    As an example, using :ref:`flow_isolated_mode` allows to choose
 146    strictly what is received in DPDK.
 147
 148 More about the bifurcated driver can be found in
 149 `Mellanox Bifurcated DPDK PMD
 150 <https://www.dpdk.org/wp-content/uploads/sites/35/2016/10/Day02-Session04-RonyEfraim-Userspace2016.pdf>`__.
 151
 152 .. _linux_gsg_binding_kernel:
 153
 154 Binding and Unbinding Network Ports to/from the Kernel Modules
 155 --------------------------------------------------------------
 156
 157 .. note::
 158
 159     PMDs Which use the bifurcated driver should not be unbind from their kernel drivers. this section is for PMDs which use the UIO or VFIO drivers.
 160
 161 As of release 1.4, DPDK applications no longer automatically unbind all supported network ports from the kernel driver in use.
 162 Instead, in case the PMD being used use the UIO or VFIO drivers, all ports that are to be used by an DPDK application must be bound to the
 163 ``uio_pci_generic``, ``igb_uio`` or ``vfio-pci`` module before the application is run.
 164 For such PMDs, any network ports under Linux* control will be ignored and cannot be used by the application.
 165
 166 To bind ports to the ``uio_pci_generic``, ``igb_uio`` or ``vfio-pci`` module for DPDK use,
 167 and then subsequently return ports to Linux* control,
 168 a utility script called dpdk-devbind.py is provided in the usertools subdirectory.
 169 This utility can be used to provide a view of the current state of the network ports on the system,
 170 and to bind and unbind those ports from the different kernel modules, including the uio and vfio modules.
 171 The following are some examples of how the script can be used.
 172 A full description of the script and its parameters can be obtained by calling the script with the ``--help`` or ``--usage`` options.
 173 Note that the uio or vfio kernel modules to be used, should be loaded into the kernel before
 174 running the ``dpdk-devbind.py`` script.
 175
 176 .. warning::
 177
 178     Due to the way VFIO works, there are certain limitations to which devices can be used with VFIO.
 179     Mainly it comes down to how IOMMU groups work.
 180     Any Virtual Function device can be used with VFIO on its own, but physical devices will require either all ports bound to VFIO,
 181     or some of them bound to VFIO while others not being bound to anything at all.
 182
 183     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.
 184     Therefore, the bridge driver should also be unbound from the bridge PCI device for VFIO to work with devices behind the bridge.
 185
 186 .. warning::
 187
 188     While any user can run the dpdk-devbind.py script to view the status of the network ports,
 189     binding or unbinding network ports requires root privileges.
 190
 191 To see the status of all network ports on the system:
 192
 193 .. code-block:: console
 194
 195     ./usertools/dpdk-devbind.py --status
 196
 197     Network devices using DPDK-compatible driver
 198     ============================================
 199     0000:82:00.0 '82599EB 10-GbE NIC' drv=uio_pci_generic unused=ixgbe
 200     0000:82:00.1 '82599EB 10-GbE NIC' drv=uio_pci_generic unused=ixgbe
 201
 202     Network devices using kernel driver
 203     ===================================
 204     0000:04:00.0 'I350 1-GbE NIC' if=em0  drv=igb unused=uio_pci_generic *Active*
 205     0000:04:00.1 'I350 1-GbE NIC' if=eth1 drv=igb unused=uio_pci_generic
 206     0000:04:00.2 'I350 1-GbE NIC' if=eth2 drv=igb unused=uio_pci_generic
 207     0000:04:00.3 'I350 1-GbE NIC' if=eth3 drv=igb unused=uio_pci_generic
 208
 209     Other network devices
 210     =====================
 211     <none>
 212
 213 To bind device ``eth1``,``04:00.1``, to the ``uio_pci_generic`` driver:
 214
 215 .. code-block:: console
 216
 217     ./usertools/dpdk-devbind.py --bind=uio_pci_generic 04:00.1
 218
 219 or, alternatively,
 220
 221 .. code-block:: console
 222
 223     ./usertools/dpdk-devbind.py --bind=uio_pci_generic eth1
 224
 225 To restore device ``82:00.0`` to its original kernel binding:
 226
 227 .. code-block:: console
 228
 229     ./usertools/dpdk-devbind.py --bind=ixgbe 82:00.0