doc/guides/nics/mlx4.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright 2012 6WIND S.A.
   3     Copyright 2015 Mellanox Technologies, Ltd
   4
   5 MLX4 poll mode driver library
   6 =============================
   7
   8 The MLX4 poll mode driver library (**librte_pmd_mlx4**) implements support
   9 for **Mellanox ConnectX-3** and **Mellanox ConnectX-3 Pro** 10/40 Gbps adapters
  10 as well as their virtual functions (VF) in SR-IOV context.
  11
  12 Information and documentation about this family of adapters can be found on
  13 the `Mellanox website <http://www.mellanox.com>`_. Help is also provided by
  14 the `Mellanox community <http://community.mellanox.com/welcome>`_.
  15
  16 There is also a `section dedicated to this poll mode driver
  17 <http://www.mellanox.com/page/products_dyn?product_family=209&mtag=pmd_for_dpdk>`_.
  18
  19 .. note::
  20
  21    Due to external dependencies, this driver is disabled by default. It must
  22    be enabled manually by setting ``CONFIG_RTE_LIBRTE_MLX4_PMD=y`` and
  23    recompiling DPDK.
  24
  25 Implementation details
  26 ----------------------
  27
  28 Most Mellanox ConnectX-3 devices provide two ports but expose a single PCI
  29 bus address, thus unlike most drivers, librte_pmd_mlx4 registers itself as a
  30 PCI driver that allocates one Ethernet device per detected port.
  31
  32 For this reason, one cannot white/blacklist a single port without also
  33 white/blacklisting the others on the same device.
  34
  35 Besides its dependency on libibverbs (that implies libmlx4 and associated
  36 kernel support), librte_pmd_mlx4 relies heavily on system calls for control
  37 operations such as querying/updating the MTU and flow control parameters.
  38
  39 For security reasons and robustness, this driver only deals with virtual
  40 memory addresses. The way resources allocations are handled by the kernel
  41 combined with hardware specifications that allow it to handle virtual memory
  42 addresses directly ensure that DPDK applications cannot access random
  43 physical memory (or memory that does not belong to the current process).
  44
  45 This capability allows the PMD to coexist with kernel network interfaces
  46 which remain functional, although they stop receiving unicast packets as
  47 long as they share the same MAC address.
  48
  49 The :ref:`flow_isolated_mode` is supported.
  50
  51 Compiling librte_pmd_mlx4 causes DPDK to be linked against libibverbs.
  52
  53 Configuration
  54 -------------
  55
  56 Compilation options
  57 ~~~~~~~~~~~~~~~~~~~
  58
  59 These options can be modified in the ``.config`` file.
  60
  61 - ``CONFIG_RTE_LIBRTE_MLX4_PMD`` (default **n**)
  62
  63   Toggle compilation of librte_pmd_mlx4 itself.
  64
  65 - ``CONFIG_RTE_IBVERBS_LINK_DLOPEN`` (default **n**)
  66
  67   Build PMD with additional code to make it loadable without hard
  68   dependencies on **libibverbs** nor **libmlx4**, which may not be installed
  69   on the target system.
  70
  71   In this mode, their presence is still required for it to run properly,
  72   however their absence won't prevent a DPDK application from starting (with
  73   ``CONFIG_RTE_BUILD_SHARED_LIB`` disabled) and they won't show up as
  74   missing with ``ldd(1)``.
  75
  76   It works by moving these dependencies to a purpose-built rdma-core "glue"
  77   plug-in which must either be installed in a directory whose name is based
  78   on ``CONFIG_RTE_EAL_PMD_PATH`` suffixed with ``-glue`` if set, or in a
  79   standard location for the dynamic linker (e.g. ``/lib``) if left to the
  80   default empty string (``""``).
  81
  82   This option has no performance impact.
  83
  84 - ``CONFIG_RTE_IBVERBS_LINK_STATIC`` (default **n**)
  85
  86   Embed static flavour of the dependencies **libibverbs** and **libmlx4**
  87   in the PMD shared library or the executable static binary.
  88
  89 - ``CONFIG_RTE_LIBRTE_MLX4_DEBUG`` (default **n**)
  90
  91   Toggle debugging code and stricter compilation flags. Enabling this option
  92   adds additional run-time checks and debugging messages at the cost of
  93   lower performance.
  94
  95 Environment variables
  96 ~~~~~~~~~~~~~~~~~~~~~
  97
  98 - ``MLX4_GLUE_PATH``
  99
 100   A list of directories in which to search for the rdma-core "glue" plug-in,
 101   separated by colons or semi-colons.
 102
 103   Only matters when compiled with ``CONFIG_RTE_IBVERBS_LINK_DLOPEN``
 104   enabled and most useful when ``CONFIG_RTE_EAL_PMD_PATH`` is also set,
 105   since ``LD_LIBRARY_PATH`` has no effect in this case.
 106
 107 Run-time configuration
 108 ~~~~~~~~~~~~~~~~~~~~~~
 109
 110 - librte_pmd_mlx4 brings kernel network interfaces up during initialization
 111   because it is affected by their state. Forcing them down prevents packets
 112   reception.
 113
 114 - **ethtool** operations on related kernel interfaces also affect the PMD.
 115
 116 - ``port`` parameter [int]
 117
 118   This parameter provides a physical port to probe and can be specified multiple
 119   times for additional ports. All ports are probed by default if left
 120   unspecified.
 121
 122 Kernel module parameters
 123 ~~~~~~~~~~~~~~~~~~~~~~~~
 124
 125 The **mlx4_core** kernel module has several parameters that affect the
 126 behavior and/or the performance of librte_pmd_mlx4. Some of them are described
 127 below.
 128
 129 - **num_vfs** (integer or triplet, optionally prefixed by device address
 130   strings)
 131
 132   Create the given number of VFs on the specified devices.
 133
 134 - **log_num_mgm_entry_size** (integer)
 135
 136   Device-managed flow steering (DMFS) is required by DPDK applications. It is
 137   enabled by using a negative value, the last four bits of which have a
 138   special meaning.
 139
 140   - **-1**: force device-managed flow steering (DMFS).
 141   - **-7**: configure optimized steering mode to improve performance with the
 142     following limitation: VLAN filtering is not supported with this mode.
 143     This is the recommended mode in case VLAN filter is not needed.
 144
 145 Limitations
 146 -----------
 147
 148 - For secondary process:
 149
 150   - Forked secondary process not supported.
 151   - All mempools must be initialized before rte_eth_dev_start().
 152   - External memory unregistered in EAL memseg list cannot be used for DMA
 153     unless such memory has been registered by ``mlx4_mr_update_ext_mp()`` in
 154     primary process and remapped to the same virtual address in secondary
 155     process. If the external memory is registered by primary process but has
 156     different virtual address in secondary process, unexpected error may happen.
 157
 158 - CRC stripping is supported by default and always reported as "true".
 159   The ability to enable/disable CRC stripping requires OFED version
 160   4.3-1.5.0.0 and above  or rdma-core version v18 and above.
 161
 162 - TSO (Transmit Segmentation Offload) is supported in OFED version
 163   4.4 and above.
 164
 165 Prerequisites
 166 -------------
 167
 168 This driver relies on external libraries and kernel drivers for resources
 169 allocations and initialization. The following dependencies are not part of
 170 DPDK and must be installed separately:
 171
 172 - **libibverbs** (provided by rdma-core package)
 173
 174   User space verbs framework used by librte_pmd_mlx4. This library provides
 175   a generic interface between the kernel and low-level user space drivers
 176   such as libmlx4.
 177
 178   It allows slow and privileged operations (context initialization, hardware
 179   resources allocations) to be managed by the kernel and fast operations to
 180   never leave user space.
 181
 182 - **libmlx4** (provided by rdma-core package)
 183
 184   Low-level user space driver library for Mellanox ConnectX-3 devices,
 185   it is automatically loaded by libibverbs.
 186
 187   This library basically implements send/receive calls to the hardware
 188   queues.
 189
 190 - **Kernel modules**
 191
 192   They provide the kernel-side verbs API and low level device drivers that
 193   manage actual hardware initialization and resources sharing with user
 194   space processes.
 195
 196   Unlike most other PMDs, these modules must remain loaded and bound to
 197   their devices:
 198
 199   - mlx4_core: hardware driver managing Mellanox ConnectX-3 devices.
 200   - mlx4_en: Ethernet device driver that provides kernel network interfaces.
 201   - mlx4_ib: InifiniBand device driver.
 202   - ib_uverbs: user space driver for verbs (entry point for libibverbs).
 203
 204 - **Firmware update**
 205
 206   Mellanox OFED releases include firmware updates for ConnectX-3 adapters.
 207
 208   Because each release provides new features, these updates must be applied to
 209   match the kernel modules and libraries they come with.
 210
 211 .. note::
 212
 213    Both libraries are BSD and GPL licensed. Linux kernel modules are GPL
 214    licensed.
 215
 216 Depending on system constraints and user preferences either RDMA core library
 217 with a recent enough Linux kernel release (recommended) or Mellanox OFED,
 218 which provides compatibility with older releases.
 219
 220 Current RDMA core package and Linux kernel (recommended)
 221 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 222
 223 - Minimal Linux kernel version: 4.14.
 224 - Minimal RDMA core version: v15 (see `RDMA core installation documentation`_).
 225
 226 - Starting with rdma-core v21, static libraries can be built::
 227
 228     cd build
 229     CFLAGS=-fPIC cmake -DIN_PLACE=1 -DENABLE_STATIC=1 -GNinja ..
 230     ninja
 231
 232 .. _`RDMA core installation documentation`: https://raw.githubusercontent.com/linux-rdma/rdma-core/master/README.md
 233
 234 If rdma-core libraries are built but not installed, DPDK makefile can link them,
 235 thanks to these environment variables:
 236
 237    - ``EXTRA_CFLAGS=-I/path/to/rdma-core/build/include``
 238    - ``EXTRA_LDFLAGS=-L/path/to/rdma-core/build/lib``
 239    - ``PKG_CONFIG_PATH=/path/to/rdma-core/build/lib/pkgconfig``
 240
 241 .. _Mellanox_OFED_as_a_fallback:
 242
 243 Mellanox OFED as a fallback
 244 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 245
 246 - `Mellanox OFED`_ version: **4.4, 4.5**.
 247 - firmware version: **2.42.5000** and above.
 248
 249 .. _`Mellanox OFED`: http://www.mellanox.com/page/products_dyn?product_family=26&mtag=linux_sw_drivers
 250
 251 .. note::
 252
 253    Several versions of Mellanox OFED are available. Installing the version
 254    this DPDK release was developed and tested against is strongly
 255    recommended. Please check the `prerequisites`_.
 256
 257 Installing Mellanox OFED
 258 ^^^^^^^^^^^^^^^^^^^^^^^^
 259
 260 1. Download latest Mellanox OFED.
 261
 262 2. Install the required libraries and kernel modules either by installing
 263    only the required set, or by installing the entire Mellanox OFED:
 264
 265    For bare metal use:
 266
 267    .. code-block:: console
 268
 269         ./mlnxofedinstall --dpdk --upstream-libs
 270
 271    For SR-IOV hypervisors use:
 272
 273    .. code-block:: console
 274
 275         ./mlnxofedinstall --dpdk --upstream-libs --enable-sriov --hypervisor
 276
 277    For SR-IOV virtual machine use:
 278
 279    .. code-block:: console
 280
 281         ./mlnxofedinstall --dpdk --upstream-libs --guest
 282
 283 3. Verify the firmware is the correct one:
 284
 285    .. code-block:: console
 286
 287         ibv_devinfo
 288
 289 4. Set all ports links to Ethernet, follow instructions on the screen:
 290
 291    .. code-block:: console
 292
 293         connectx_port_config
 294
 295 5. Continue with :ref:`section 2 of the Quick Start Guide <QSG_2>`.
 296
 297 Supported NICs
 298 --------------
 299
 300 * Mellanox(R) ConnectX(R)-3 Pro 40G MCX354A-FCC_Ax (2*40G)
 301
 302 .. _qsg:
 303
 304 Quick Start Guide
 305 -----------------
 306
 307 1. Set all ports links to Ethernet
 308
 309    .. code-block:: console
 310
 311         PCI=<NIC PCI address>
 312         echo eth > "/sys/bus/pci/devices/$PCI/mlx4_port0"
 313         echo eth > "/sys/bus/pci/devices/$PCI/mlx4_port1"
 314
 315    .. note::
 316
 317         If using Mellanox OFED one can permanently set the port link
 318         to Ethernet using connectx_port_config tool provided by it.
 319         :ref:`Mellanox_OFED_as_a_fallback`:
 320
 321 .. _QSG_2:
 322
 323 2. In case of bare metal or hypervisor, configure optimized steering mode
 324    by adding the following line to ``/etc/modprobe.d/mlx4_core.conf``:
 325
 326    .. code-block:: console
 327
 328         options mlx4_core log_num_mgm_entry_size=-7
 329
 330    .. note::
 331
 332         If VLAN filtering is used, set log_num_mgm_entry_size=-1.
 333         Performance degradation can occur on this case.
 334
 335 3. Restart the driver:
 336
 337    .. code-block:: console
 338
 339         /etc/init.d/openibd restart
 340
 341    or:
 342
 343    .. code-block:: console
 344
 345         service openibd restart
 346
 347 4. Compile DPDK and you are ready to go. See instructions on
 348    :ref:`Development Kit Build System <Development_Kit_Build_System>`
 349
 350 Performance tuning
 351 ------------------
 352
 353 1. Verify the optimized steering mode is configured:
 354
 355   .. code-block:: console
 356
 357         cat /sys/module/mlx4_core/parameters/log_num_mgm_entry_size
 358
 359 2. Use the CPU near local NUMA node to which the PCIe adapter is connected,
 360    for better performance. For VMs, verify that the right CPU
 361    and NUMA node are pinned according to the above. Run:
 362
 363    .. code-block:: console
 364
 365         lstopo-no-graphics
 366
 367    to identify the NUMA node to which the PCIe adapter is connected.
 368
 369 3. If more than one adapter is used, and root complex capabilities allow
 370    to put both adapters on the same NUMA node without PCI bandwidth degradation,
 371    it is recommended to locate both adapters on the same NUMA node.
 372    This in order to forward packets from one to the other without
 373    NUMA performance penalty.
 374
 375 4. Disable pause frames:
 376
 377    .. code-block:: console
 378
 379         ethtool -A <netdev> rx off tx off
 380
 381 5. Verify IO non-posted prefetch is disabled by default. This can be checked
 382    via the BIOS configuration. Please contact you server provider for more
 383    information about the settings.
 384
 385 .. note::
 386
 387         On some machines, depends on the machine integrator, it is beneficial
 388         to set the PCI max read request parameter to 1K. This can be
 389         done in the following way:
 390
 391         To query the read request size use:
 392
 393         .. code-block:: console
 394
 395                 setpci -s <NIC PCI address> 68.w
 396
 397         If the output is different than 3XXX, set it by:
 398
 399         .. code-block:: console
 400
 401                 setpci -s <NIC PCI address> 68.w=3XXX
 402
 403         The XXX can be different on different systems. Make sure to configure
 404         according to the setpci output.
 405
 406 6. To minimize overhead of searching Memory Regions:
 407
 408    - '--socket-mem' is recommended to pin memory by predictable amount.
 409    - Configure per-lcore cache when creating Mempools for packet buffer.
 410    - Refrain from dynamically allocating/freeing memory in run-time.
 411
 412 Usage example
 413 -------------
 414
 415 This section demonstrates how to launch **testpmd** with Mellanox ConnectX-3
 416 devices managed by librte_pmd_mlx4.
 417
 418 #. Load the kernel modules:
 419
 420    .. code-block:: console
 421
 422       modprobe -a ib_uverbs mlx4_en mlx4_core mlx4_ib
 423
 424    Alternatively if MLNX_OFED is fully installed, the following script can
 425    be run:
 426
 427    .. code-block:: console
 428
 429       /etc/init.d/openibd restart
 430
 431    .. note::
 432
 433       User space I/O kernel modules (uio and igb_uio) are not used and do
 434       not have to be loaded.
 435
 436 #. Make sure Ethernet interfaces are in working order and linked to kernel
 437    verbs. Related sysfs entries should be present:
 438
 439    .. code-block:: console
 440
 441       ls -d /sys/class/net/*/device/infiniband_verbs/uverbs* | cut -d / -f 5
 442
 443    Example output:
 444
 445    .. code-block:: console
 446
 447       eth2
 448       eth3
 449       eth4
 450       eth5
 451
 452 #. Optionally, retrieve their PCI bus addresses for whitelisting:
 453
 454    .. code-block:: console
 455
 456       {
 457           for intf in eth2 eth3 eth4 eth5;
 458           do
 459               (cd "/sys/class/net/${intf}/device/" && pwd -P);
 460           done;
 461       } |
 462       sed -n 's,.*/\(.*\),-w \1,p'
 463
 464    Example output:
 465
 466    .. code-block:: console
 467
 468       -w 0000:83:00.0
 469       -w 0000:83:00.0
 470       -w 0000:84:00.0
 471       -w 0000:84:00.0
 472
 473    .. note::
 474
 475       There are only two distinct PCI bus addresses because the Mellanox
 476       ConnectX-3 adapters installed on this system are dual port.
 477
 478 #. Request huge pages:
 479
 480    .. code-block:: console
 481
 482       echo 1024 > /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages/nr_hugepages
 483
 484 #. Start testpmd with basic parameters:
 485
 486    .. code-block:: console
 487
 488       testpmd -l 8-15 -n 4 -w 0000:83:00.0 -w 0000:84:00.0 -- --rxq=2 --txq=2 -i
 489
 490    Example output:
 491
 492    .. code-block:: console
 493
 494       [...]
 495       EAL: PCI device 0000:83:00.0 on NUMA socket 1
 496       EAL:   probe driver: 15b3:1007 librte_pmd_mlx4
 497       PMD: librte_pmd_mlx4: PCI information matches, using device "mlx4_0" (VF: false)
 498       PMD: librte_pmd_mlx4: 2 port(s) detected
 499       PMD: librte_pmd_mlx4: port 1 MAC address is 00:02:c9:b5:b7:50
 500       PMD: librte_pmd_mlx4: port 2 MAC address is 00:02:c9:b5:b7:51
 501       EAL: PCI device 0000:84:00.0 on NUMA socket 1
 502       EAL:   probe driver: 15b3:1007 librte_pmd_mlx4
 503       PMD: librte_pmd_mlx4: PCI information matches, using device "mlx4_1" (VF: false)
 504       PMD: librte_pmd_mlx4: 2 port(s) detected
 505       PMD: librte_pmd_mlx4: port 1 MAC address is 00:02:c9:b5:ba:b0
 506       PMD: librte_pmd_mlx4: port 2 MAC address is 00:02:c9:b5:ba:b1
 507       Interactive-mode selected
 508       Configuring Port 0 (socket 0)
 509       PMD: librte_pmd_mlx4: 0x867d60: TX queues number update: 0 -> 2
 510       PMD: librte_pmd_mlx4: 0x867d60: RX queues number update: 0 -> 2
 511       Port 0: 00:02:C9:B5:B7:50
 512       Configuring Port 1 (socket 0)
 513       PMD: librte_pmd_mlx4: 0x867da0: TX queues number update: 0 -> 2
 514       PMD: librte_pmd_mlx4: 0x867da0: RX queues number update: 0 -> 2
 515       Port 1: 00:02:C9:B5:B7:51
 516       Configuring Port 2 (socket 0)
 517       PMD: librte_pmd_mlx4: 0x867de0: TX queues number update: 0 -> 2
 518       PMD: librte_pmd_mlx4: 0x867de0: RX queues number update: 0 -> 2
 519       Port 2: 00:02:C9:B5:BA:B0
 520       Configuring Port 3 (socket 0)
 521       PMD: librte_pmd_mlx4: 0x867e20: TX queues number update: 0 -> 2
 522       PMD: librte_pmd_mlx4: 0x867e20: RX queues number update: 0 -> 2
 523       Port 3: 00:02:C9:B5:BA:B1
 524       Checking link statuses...
 525       Port 0 Link Up - speed 10000 Mbps - full-duplex
 526       Port 1 Link Up - speed 40000 Mbps - full-duplex
 527       Port 2 Link Up - speed 10000 Mbps - full-duplex
 528       Port 3 Link Up - speed 40000 Mbps - full-duplex
 529       Done
 530       testpmd>