doc/guides/nics/mlx5.rst

   1 ..  BSD LICENSE
   2     Copyright 2015 6WIND S.A.
   3     Copyright 2015 Mellanox
   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 6WIND S.A. 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 MLX5 poll mode driver
  32 =====================
  33
  34 The MLX5 poll mode driver library (**librte_pmd_mlx5**) provides support
  35 for **Mellanox ConnectX-4**, **Mellanox ConnectX-4 Lx** and **Mellanox
  36 ConnectX-5** families of 10/25/40/50/100 Gb/s adapters as well as their
  37 virtual functions (VF) in SR-IOV context.
  38
  39 Information and documentation about these adapters can be found on the
  40 `Mellanox website <http://www.mellanox.com>`__. Help is also provided by the
  41 `Mellanox community <http://community.mellanox.com/welcome>`__.
  42
  43 There is also a `section dedicated to this poll mode driver
  44 <http://www.mellanox.com/page/products_dyn?product_family=209&mtag=pmd_for_dpdk>`__.
  45
  46 .. note::
  47
  48    Due to external dependencies, this driver is disabled by default. It must
  49    be enabled manually by setting ``CONFIG_RTE_LIBRTE_MLX5_PMD=y`` and
  50    recompiling DPDK.
  51
  52 Implementation details
  53 ----------------------
  54
  55 Besides its dependency on libibverbs (that implies libmlx5 and associated
  56 kernel support), librte_pmd_mlx5 relies heavily on system calls for control
  57 operations such as querying/updating the MTU and flow control parameters.
  58
  59 For security reasons and robustness, this driver only deals with virtual
  60 memory addresses. The way resources allocations are handled by the kernel
  61 combined with hardware specifications that allow it to handle virtual memory
  62 addresses directly ensure that DPDK applications cannot access random
  63 physical memory (or memory that does not belong to the current process).
  64
  65 This capability allows the PMD to coexist with kernel network interfaces
  66 which remain functional, although they stop receiving unicast packets as
  67 long as they share the same MAC address.
  68 This means legacy linux control tools (for example: ethtool, ifconfig and
  69 more) can operate on the same network interfaces that owned by the DPDK
  70 application.
  71
  72 Enabling librte_pmd_mlx5 causes DPDK applications to be linked against
  73 libibverbs.
  74
  75 Features
  76 --------
  77
  78 - Multi arch support: x86_64, POWER8, ARMv8.
  79 - Multiple TX and RX queues.
  80 - Support for scattered TX and RX frames.
  81 - IPv4, IPv6, TCPv4, TCPv6, UDPv4 and UDPv6 RSS on any number of queues.
  82 - Several RSS hash keys, one for each flow type.
  83 - Configurable RETA table.
  84 - Support for multiple MAC addresses.
  85 - VLAN filtering.
  86 - RX VLAN stripping.
  87 - TX VLAN insertion.
  88 - RX CRC stripping configuration.
  89 - Promiscuous mode.
  90 - Multicast promiscuous mode.
  91 - Hardware checksum offloads.
  92 - Flow director (RTE_FDIR_MODE_PERFECT, RTE_FDIR_MODE_PERFECT_MAC_VLAN and
  93   RTE_ETH_FDIR_REJECT).
  94 - Flow API.
  95 - Multiple process.
  96 - KVM and VMware ESX SR-IOV modes are supported.
  97 - RSS hash result is supported.
  98 - Hardware TSO.
  99 - Hardware checksum TX offload for VXLAN and GRE.
 100 - RX interrupts.
 101 - Statistics query including Basic, Extended and per queue.
 102 - Rx HW timestamp.
 103
 104 Limitations
 105 -----------
 106
 107 - Inner RSS for VXLAN frames is not supported yet.
 108 - Hardware checksum RX offloads for VXLAN inner header are not supported yet.
 109 - For secondary process:
 110
 111   - Forked secondary process not supported.
 112   - All mempools must be initialized before rte_eth_dev_start().
 113
 114 - Flow pattern without any specific vlan will match for vlan packets as well:
 115
 116   When VLAN spec is not specified in the pattern, the matching rule will be created with VLAN as a wild card.
 117   Meaning, the flow rule::
 118
 119         flow create 0 ingress pattern eth / vlan vid is 3 / ipv4 / end ...
 120
 121   Will only match vlan packets with vid=3. and the flow rules::
 122
 123         flow create 0 ingress pattern eth / ipv4 / end ...
 124
 125   Or::
 126
 127         flow create 0 ingress pattern eth / vlan / ipv4 / end ...
 128
 129   Will match any ipv4 packet (VLAN included).
 130
 131 - A multi segment packet must have less than 6 segments in case the Tx burst function
 132   is set to multi-packet send or Enhanced multi-packet send. Otherwise it must have
 133   less than 50 segments.
 134 - Count action for RTE flow is **only supported in Mellanox OFED**.
 135 - Flows with a VXLAN Network Identifier equal (or ends to be equal)
 136   to 0 are not supported.
 137 - VXLAN TSO and checksum offloads are not supported on VM.
 138
 139 Statistics
 140 ----------
 141
 142 MLX5 supports various of methods to report statistics:
 143
 144 Port statistics can be queried using ``rte_eth_stats_get()``. The port statistics are through SW only and counts the number of packets received or sent successfully by the PMD.
 145
 146 Extended statistics can be queried using ``rte_eth_xstats_get()``. The extended statistics expose a wider set of counters counted by the device. The extended port statistics counts the number of packets received or sent successfully by the port. As Mellanox NICs are using the :ref:`Bifurcated Linux Driver <linux_gsg_linux_drivers>` those counters counts also packet received or sent by the Linux kernel. The counters with ``_phy`` suffix counts the total events on the physical port, therefore not valid for VF.
 147
 148 Finally per-flow statistics can by queried using ``rte_flow_query`` when attaching a count action for specific flow. The flow counter counts the number of packets received successfully by the port and match the specific flow.
 149
 150 Configuration
 151 -------------
 152
 153 Compilation options
 154 ~~~~~~~~~~~~~~~~~~~
 155
 156 These options can be modified in the ``.config`` file.
 157
 158 - ``CONFIG_RTE_LIBRTE_MLX5_PMD`` (default **n**)
 159
 160   Toggle compilation of librte_pmd_mlx5 itself.
 161
 162 - ``CONFIG_RTE_LIBRTE_MLX5_DLOPEN_DEPS`` (default **n**)
 163
 164   Build PMD with additional code to make it loadable without hard
 165   dependencies on **libibverbs** nor **libmlx5**, which may not be installed
 166   on the target system.
 167
 168   In this mode, their presence is still required for it to run properly,
 169   however their absence won't prevent a DPDK application from starting (with
 170   ``CONFIG_RTE_BUILD_SHARED_LIB`` disabled) and they won't show up as
 171   missing with ``ldd(1)``.
 172
 173   It works by moving these dependencies to a purpose-built rdma-core "glue"
 174   plug-in, which must either be installed in ``CONFIG_RTE_EAL_PMD_PATH`` if
 175   set, or in a standard location for the dynamic linker (e.g. ``/lib``) if
 176   left to the default empty string (``""``).
 177
 178   This option has no performance impact.
 179
 180 - ``CONFIG_RTE_LIBRTE_MLX5_DEBUG`` (default **n**)
 181
 182   Toggle debugging code and stricter compilation flags. Enabling this option
 183   adds additional run-time checks and debugging messages at the cost of
 184   lower performance.
 185
 186 - ``CONFIG_RTE_LIBRTE_MLX5_TX_MP_CACHE`` (default **8**)
 187
 188   Maximum number of cached memory pools (MPs) per TX queue. Each MP from
 189   which buffers are to be transmitted must be associated to memory regions
 190   (MRs). This is a slow operation that must be cached.
 191
 192   This value is always 1 for RX queues since they use a single MP.
 193
 194 Environment variables
 195 ~~~~~~~~~~~~~~~~~~~~~
 196
 197 - ``MLX5_GLUE_PATH``
 198
 199   A list of directories in which to search for the rdma-core "glue" plug-in,
 200   separated by colons or semi-colons.
 201
 202   Only matters when compiled with ``CONFIG_RTE_LIBRTE_MLX5_DLOPEN_DEPS``
 203   enabled and most useful when ``CONFIG_RTE_EAL_PMD_PATH`` is also set,
 204   since ``LD_LIBRARY_PATH`` has no effect in this case.
 205
 206 - ``MLX5_PMD_ENABLE_PADDING``
 207
 208   Enables HW packet padding in PCI bus transactions.
 209
 210   When packet size is cache aligned and CRC stripping is enabled, 4 fewer
 211   bytes are written to the PCI bus. Enabling padding makes such packets
 212   aligned again.
 213
 214   In cases where PCI bandwidth is the bottleneck, padding can improve
 215   performance by 10%.
 216
 217   This is disabled by default since this can also decrease performance for
 218   unaligned packet sizes.
 219
 220 - ``MLX5_SHUT_UP_BF``
 221
 222   Configures HW Tx doorbell register as IO-mapped.
 223
 224   By default, the HW Tx doorbell is configured as a write-combining register.
 225   The register would be flushed to HW usually when the write-combining buffer
 226   becomes full, but it depends on CPU design.
 227
 228   Except for vectorized Tx burst routines, a write memory barrier is enforced
 229   after updating the register so that the update can be immediately visible to
 230   HW.
 231
 232   When vectorized Tx burst is called, the barrier is set only if the burst size
 233   is not aligned to MLX5_VPMD_TX_MAX_BURST. However, setting this environmental
 234   variable will bring better latency even though the maximum throughput can
 235   slightly decline.
 236
 237 Run-time configuration
 238 ~~~~~~~~~~~~~~~~~~~~~~
 239
 240 - librte_pmd_mlx5 brings kernel network interfaces up during initialization
 241   because it is affected by their state. Forcing them down prevents packets
 242   reception.
 243
 244 - **ethtool** operations on related kernel interfaces also affect the PMD.
 245
 246 - ``rxq_cqe_comp_en`` parameter [int]
 247
 248   A nonzero value enables the compression of CQE on RX side. This feature
 249   allows to save PCI bandwidth and improve performance. Enabled by default.
 250
 251   Supported on:
 252
 253   - x86_64 with ConnectX-4, ConnectX-4 LX and ConnectX-5.
 254   - POWER8 and ARMv8 with ConnectX-4 LX and ConnectX-5.
 255
 256 - ``txq_inline`` parameter [int]
 257
 258   Amount of data to be inlined during TX operations. Improves latency.
 259   Can improve PPS performance when PCI back pressure is detected and may be
 260   useful for scenarios involving heavy traffic on many queues.
 261
 262   Because additional software logic is necessary to handle this mode, this
 263   option should be used with care, as it can lower performance when back
 264   pressure is not expected.
 265
 266 - ``txqs_min_inline`` parameter [int]
 267
 268   Enable inline send only when the number of TX queues is greater or equal
 269   to this value.
 270
 271   This option should be used in combination with ``txq_inline`` above.
 272
 273   On ConnectX-4, ConnectX-4 LX and ConnectX-5 without Enhanced MPW:
 274
 275         - Disabled by default.
 276         - In case ``txq_inline`` is set recommendation is 4.
 277
 278   On ConnectX-5 with Enhanced MPW:
 279
 280         - Set to 8 by default.
 281
 282 - ``txq_mpw_en`` parameter [int]
 283
 284   A nonzero value enables multi-packet send (MPS) for ConnectX-4 Lx and
 285   enhanced multi-packet send (Enhanced MPS) for ConnectX-5. MPS allows the
 286   TX burst function to pack up multiple packets in a single descriptor
 287   session in order to save PCI bandwidth and improve performance at the
 288   cost of a slightly higher CPU usage. When ``txq_inline`` is set along
 289   with ``txq_mpw_en``, TX burst function tries to copy entire packet data
 290   on to TX descriptor instead of including pointer of packet only if there
 291   is enough room remained in the descriptor. ``txq_inline`` sets
 292   per-descriptor space for either pointers or inlined packets. In addition,
 293   Enhanced MPS supports hybrid mode - mixing inlined packets and pointers
 294   in the same descriptor.
 295
 296   This option cannot be used with certain offloads such as ``DEV_TX_OFFLOAD_TCP_TSO,
 297   DEV_TX_OFFLOAD_VXLAN_TNL_TSO, DEV_TX_OFFLOAD_GRE_TNL_TSO, DEV_TX_OFFLOAD_VLAN_INSERT``.
 298   When those offloads are requested the MPS send function will not be used.
 299
 300   It is currently only supported on the ConnectX-4 Lx and ConnectX-5
 301   families of adapters. Enabled by default.
 302
 303 - ``txq_mpw_hdr_dseg_en`` parameter [int]
 304
 305   A nonzero value enables including two pointers in the first block of TX
 306   descriptor. This can be used to lessen CPU load for memory copy.
 307
 308   Effective only when Enhanced MPS is supported. Disabled by default.
 309
 310 - ``txq_max_inline_len`` parameter [int]
 311
 312   Maximum size of packet to be inlined. This limits the size of packet to
 313   be inlined. If the size of a packet is larger than configured value, the
 314   packet isn't inlined even though there's enough space remained in the
 315   descriptor. Instead, the packet is included with pointer.
 316
 317   Effective only when Enhanced MPS is supported. The default value is 256.
 318
 319 - ``tx_vec_en`` parameter [int]
 320
 321   A nonzero value enables Tx vector on ConnectX-5 only NIC if the number of
 322   global Tx queues on the port is lesser than MLX5_VPMD_MIN_TXQS.
 323
 324   This option cannot be used with certain offloads such as ``DEV_TX_OFFLOAD_TCP_TSO,
 325   DEV_TX_OFFLOAD_VXLAN_TNL_TSO, DEV_TX_OFFLOAD_GRE_TNL_TSO, DEV_TX_OFFLOAD_VLAN_INSERT``.
 326   When those offloads are requested the MPS send function will not be used.
 327
 328   Enabled by default on ConnectX-5.
 329
 330 - ``rx_vec_en`` parameter [int]
 331
 332   A nonzero value enables Rx vector if the port is not configured in
 333   multi-segment otherwise this parameter is ignored.
 334
 335   Enabled by default.
 336
 337 Prerequisites
 338 -------------
 339
 340 This driver relies on external libraries and kernel drivers for resources
 341 allocations and initialization. The following dependencies are not part of
 342 DPDK and must be installed separately:
 343
 344 - **libibverbs**
 345
 346   User space Verbs framework used by librte_pmd_mlx5. This library provides
 347   a generic interface between the kernel and low-level user space drivers
 348   such as libmlx5.
 349
 350   It allows slow and privileged operations (context initialization, hardware
 351   resources allocations) to be managed by the kernel and fast operations to
 352   never leave user space.
 353
 354 - **libmlx5**
 355
 356   Low-level user space driver library for Mellanox ConnectX-4/ConnectX-5
 357   devices, it is automatically loaded by libibverbs.
 358
 359   This library basically implements send/receive calls to the hardware
 360   queues.
 361
 362 - **Kernel modules**
 363
 364   They provide the kernel-side Verbs API and low level device drivers that
 365   manage actual hardware initialization and resources sharing with user
 366   space processes.
 367
 368   Unlike most other PMDs, these modules must remain loaded and bound to
 369   their devices:
 370
 371   - mlx5_core: hardware driver managing Mellanox ConnectX-4/ConnectX-5
 372     devices and related Ethernet kernel network devices.
 373   - mlx5_ib: InifiniBand device driver.
 374   - ib_uverbs: user space driver for Verbs (entry point for libibverbs).
 375
 376 - **Firmware update**
 377
 378   Mellanox OFED releases include firmware updates for ConnectX-4/ConnectX-5
 379   adapters.
 380
 381   Because each release provides new features, these updates must be applied to
 382   match the kernel modules and libraries they come with.
 383
 384 .. note::
 385
 386    Both libraries are BSD and GPL licensed. Linux kernel modules are GPL
 387    licensed.
 388
 389 Installation
 390 ~~~~~~~~~~~~
 391
 392 Either RDMA Core library with a recent enough Linux kernel release
 393 (recommended) or Mellanox OFED, which provides compatibility with older
 394 releases.
 395
 396 RMDA Core with Linux Kernel
 397 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 398
 399 - Minimal kernel version : v4.14 or the most recent 4.14-rc (see `Linux installation documentation`_)
 400 - Minimal rdma-core version: v15+ commit 0c5f5765213a ("Merge pull request #227 from yishaih/tm")
 401   (see `RDMA Core installation documentation`_)
 402
 403 .. _`Linux installation documentation`: https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux-stable.git/plain/Documentation/admin-guide/README.rst
 404 .. _`RDMA Core installation documentation`: https://raw.githubusercontent.com/linux-rdma/rdma-core/master/README.md
 405
 406 Mellanox OFED
 407 ^^^^^^^^^^^^^
 408
 409 - Mellanox OFED version: **4.2, 4.3**.
 410 - firmware version:
 411
 412   - ConnectX-4: **12.21.1000** and above.
 413   - ConnectX-4 Lx: **14.21.1000** and above.
 414   - ConnectX-5: **16.21.1000** and above.
 415   - ConnectX-5 Ex: **16.21.1000** and above.
 416
 417 While these libraries and kernel modules are available on OpenFabrics
 418 Alliance's `website <https://www.openfabrics.org/>`__ and provided by package
 419 managers on most distributions, this PMD requires Ethernet extensions that
 420 may not be supported at the moment (this is a work in progress).
 421
 422 `Mellanox OFED
 423 <http://www.mellanox.com/page/products_dyn?product_family=26&mtag=linux>`__
 424 includes the necessary support and should be used in the meantime. For DPDK,
 425 only libibverbs, libmlx5, mlnx-ofed-kernel packages and firmware updates are
 426 required from that distribution.
 427
 428 .. note::
 429
 430    Several versions of Mellanox OFED are available. Installing the version
 431    this DPDK release was developed and tested against is strongly
 432    recommended. Please check the `prerequisites`_.
 433
 434 Supported NICs
 435 --------------
 436
 437 * Mellanox(R) ConnectX(R)-4 10G MCX4111A-XCAT (1x10G)
 438 * Mellanox(R) ConnectX(R)-4 10G MCX4121A-XCAT (2x10G)
 439 * Mellanox(R) ConnectX(R)-4 25G MCX4111A-ACAT (1x25G)
 440 * Mellanox(R) ConnectX(R)-4 25G MCX4121A-ACAT (2x25G)
 441 * Mellanox(R) ConnectX(R)-4 40G MCX4131A-BCAT (1x40G)
 442 * Mellanox(R) ConnectX(R)-4 40G MCX413A-BCAT (1x40G)
 443 * Mellanox(R) ConnectX(R)-4 40G MCX415A-BCAT (1x40G)
 444 * Mellanox(R) ConnectX(R)-4 50G MCX4131A-GCAT (1x50G)
 445 * Mellanox(R) ConnectX(R)-4 50G MCX413A-GCAT (1x50G)
 446 * Mellanox(R) ConnectX(R)-4 50G MCX414A-BCAT (2x50G)
 447 * Mellanox(R) ConnectX(R)-4 50G MCX415A-GCAT (2x50G)
 448 * Mellanox(R) ConnectX(R)-4 50G MCX416A-BCAT (2x50G)
 449 * Mellanox(R) ConnectX(R)-4 50G MCX416A-GCAT (2x50G)
 450 * Mellanox(R) ConnectX(R)-4 50G MCX415A-CCAT (1x100G)
 451 * Mellanox(R) ConnectX(R)-4 100G MCX416A-CCAT (2x100G)
 452 * Mellanox(R) ConnectX(R)-4 Lx 10G MCX4121A-XCAT (2x10G)
 453 * Mellanox(R) ConnectX(R)-4 Lx 25G MCX4121A-ACAT (2x25G)
 454 * Mellanox(R) ConnectX(R)-5 100G MCX556A-ECAT (2x100G)
 455 * Mellanox(R) ConnectX(R)-5 Ex EN 100G MCX516A-CDAT (2x100G)
 456
 457 Quick Start Guide on OFED
 458 -------------------------
 459
 460 1. Download latest Mellanox OFED. For more info check the  `prerequisites`_.
 461
 462
 463 2. Install the required libraries and kernel modules either by installing
 464    only the required set, or by installing the entire Mellanox OFED:
 465
 466    .. code-block:: console
 467
 468         ./mlnxofedinstall --upstream-libs --dpdk
 469
 470 3. Verify the firmware is the correct one:
 471
 472    .. code-block:: console
 473
 474         ibv_devinfo
 475
 476 4. Verify all ports links are set to Ethernet:
 477
 478    .. code-block:: console
 479
 480         mlxconfig -d <mst device> query | grep LINK_TYPE
 481         LINK_TYPE_P1                        ETH(2)
 482         LINK_TYPE_P2                        ETH(2)
 483
 484    Link types may have to be configured to Ethernet:
 485
 486    .. code-block:: console
 487
 488         mlxconfig -d <mst device> set LINK_TYPE_P1/2=1/2/3
 489
 490         * LINK_TYPE_P1=<1|2|3> , 1=Infiniband 2=Ethernet 3=VPI(auto-sense)
 491
 492    For hypervisors verify SR-IOV is enabled on the NIC:
 493
 494    .. code-block:: console
 495
 496         mlxconfig -d <mst device> query | grep SRIOV_EN
 497         SRIOV_EN                            True(1)
 498
 499    If needed, set enable the set the relevant fields:
 500
 501    .. code-block:: console
 502
 503         mlxconfig -d <mst device> set SRIOV_EN=1 NUM_OF_VFS=16
 504         mlxfwreset -d <mst device> reset
 505
 506 5. Restart the driver:
 507
 508    .. code-block:: console
 509
 510         /etc/init.d/openibd restart
 511
 512    or:
 513
 514    .. code-block:: console
 515
 516         service openibd restart
 517
 518    If link type was changed, firmware must be reset as well:
 519
 520    .. code-block:: console
 521
 522         mlxfwreset -d <mst device> reset
 523
 524    For hypervisors, after reset write the sysfs number of virtual functions
 525    needed for the PF.
 526
 527    To dynamically instantiate a given number of virtual functions (VFs):
 528
 529    .. code-block:: console
 530
 531         echo [num_vfs] > /sys/class/infiniband/mlx5_0/device/sriov_numvfs
 532
 533 6. Compile DPDK and you are ready to go. See instructions on
 534    :ref:`Development Kit Build System <Development_Kit_Build_System>`
 535
 536 Performance tuning
 537 ------------------
 538
 539 1. Configure aggressive CQE Zipping for maximum performance:
 540
 541   .. code-block:: console
 542
 543         mlxconfig -d <mst device> s CQE_COMPRESSION=1
 544
 545   To set it back to the default CQE Zipping mode use:
 546
 547   .. code-block:: console
 548
 549         mlxconfig -d <mst device> s CQE_COMPRESSION=0
 550
 551 2. In case of virtualization:
 552
 553    - Make sure that hypervisor kernel is 3.16 or newer.
 554    - Configure boot with ``iommu=pt``.
 555    - Use 1G huge pages.
 556    - Make sure to allocate a VM on huge pages.
 557    - Make sure to set CPU pinning.
 558
 559 3. Use the CPU near local NUMA node to which the PCIe adapter is connected,
 560    for better performance. For VMs, verify that the right CPU
 561    and NUMA node are pinned according to the above. Run:
 562
 563    .. code-block:: console
 564
 565         lstopo-no-graphics
 566
 567    to identify the NUMA node to which the PCIe adapter is connected.
 568
 569 4. If more than one adapter is used, and root complex capabilities allow
 570    to put both adapters on the same NUMA node without PCI bandwidth degradation,
 571    it is recommended to locate both adapters on the same NUMA node.
 572    This in order to forward packets from one to the other without
 573    NUMA performance penalty.
 574
 575 5. Disable pause frames:
 576
 577    .. code-block:: console
 578
 579         ethtool -A <netdev> rx off tx off
 580
 581 6. Verify IO non-posted prefetch is disabled by default. This can be checked
 582    via the BIOS configuration. Please contact you server provider for more
 583    information about the settings.
 584
 585 .. note::
 586
 587         On some machines, depends on the machine integrator, it is beneficial
 588         to set the PCI max read request parameter to 1K. This can be
 589         done in the following way:
 590
 591         To query the read request size use:
 592
 593         .. code-block:: console
 594
 595                 setpci -s <NIC PCI address> 68.w
 596
 597         If the output is different than 3XXX, set it by:
 598
 599         .. code-block:: console
 600
 601                 setpci -s <NIC PCI address> 68.w=3XXX
 602
 603         The XXX can be different on different systems. Make sure to configure
 604         according to the setpci output.
 605
 606 Notes for testpmd
 607 -----------------
 608
 609 Compared to librte_pmd_mlx4 that implements a single RSS configuration per
 610 port, librte_pmd_mlx5 supports per-protocol RSS configuration.
 611
 612 Since ``testpmd`` defaults to IP RSS mode and there is currently no
 613 command-line parameter to enable additional protocols (UDP and TCP as well
 614 as IP), the following commands must be entered from its CLI to get the same
 615 behavior as librte_pmd_mlx4:
 616
 617 .. code-block:: console
 618
 619    > port stop all
 620    > port config all rss all
 621    > port start all
 622
 623 Usage example
 624 -------------
 625
 626 This section demonstrates how to launch **testpmd** with Mellanox
 627 ConnectX-4/ConnectX-5 devices managed by librte_pmd_mlx5.
 628
 629 #. Load the kernel modules:
 630
 631    .. code-block:: console
 632
 633       modprobe -a ib_uverbs mlx5_core mlx5_ib
 634
 635    Alternatively if MLNX_OFED is fully installed, the following script can
 636    be run:
 637
 638    .. code-block:: console
 639
 640       /etc/init.d/openibd restart
 641
 642    .. note::
 643
 644       User space I/O kernel modules (uio and igb_uio) are not used and do
 645       not have to be loaded.
 646
 647 #. Make sure Ethernet interfaces are in working order and linked to kernel
 648    verbs. Related sysfs entries should be present:
 649
 650    .. code-block:: console
 651
 652       ls -d /sys/class/net/*/device/infiniband_verbs/uverbs* | cut -d / -f 5
 653
 654    Example output:
 655
 656    .. code-block:: console
 657
 658       eth30
 659       eth31
 660       eth32
 661       eth33
 662
 663 #. Optionally, retrieve their PCI bus addresses for whitelisting:
 664
 665    .. code-block:: console
 666
 667       {
 668           for intf in eth2 eth3 eth4 eth5;
 669           do
 670               (cd "/sys/class/net/${intf}/device/" && pwd -P);
 671           done;
 672       } |
 673       sed -n 's,.*/\(.*\),-w \1,p'
 674
 675    Example output:
 676
 677    .. code-block:: console
 678
 679       -w 0000:05:00.1
 680       -w 0000:06:00.0
 681       -w 0000:06:00.1
 682       -w 0000:05:00.0
 683
 684 #. Request huge pages:
 685
 686    .. code-block:: console
 687
 688       echo 1024 > /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages/nr_hugepages
 689
 690 #. Start testpmd with basic parameters:
 691
 692    .. code-block:: console
 693
 694       testpmd -l 8-15 -n 4 -w 05:00.0 -w 05:00.1 -w 06:00.0 -w 06:00.1 -- --rxq=2 --txq=2 -i
 695
 696    Example output:
 697
 698    .. code-block:: console
 699
 700       [...]
 701       EAL: PCI device 0000:05:00.0 on NUMA socket 0
 702       EAL:   probe driver: 15b3:1013 librte_pmd_mlx5
 703       PMD: librte_pmd_mlx5: PCI information matches, using device "mlx5_0" (VF: false)
 704       PMD: librte_pmd_mlx5: 1 port(s) detected
 705       PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:fe
 706       EAL: PCI device 0000:05:00.1 on NUMA socket 0
 707       EAL:   probe driver: 15b3:1013 librte_pmd_mlx5
 708       PMD: librte_pmd_mlx5: PCI information matches, using device "mlx5_1" (VF: false)
 709       PMD: librte_pmd_mlx5: 1 port(s) detected
 710       PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:ff
 711       EAL: PCI device 0000:06:00.0 on NUMA socket 0
 712       EAL:   probe driver: 15b3:1013 librte_pmd_mlx5
 713       PMD: librte_pmd_mlx5: PCI information matches, using device "mlx5_2" (VF: false)
 714       PMD: librte_pmd_mlx5: 1 port(s) detected
 715       PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:fa
 716       EAL: PCI device 0000:06:00.1 on NUMA socket 0
 717       EAL:   probe driver: 15b3:1013 librte_pmd_mlx5
 718       PMD: librte_pmd_mlx5: PCI information matches, using device "mlx5_3" (VF: false)
 719       PMD: librte_pmd_mlx5: 1 port(s) detected
 720       PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:fb
 721       Interactive-mode selected
 722       Configuring Port 0 (socket 0)
 723       PMD: librte_pmd_mlx5: 0x8cba80: TX queues number update: 0 -> 2
 724       PMD: librte_pmd_mlx5: 0x8cba80: RX queues number update: 0 -> 2
 725       Port 0: E4:1D:2D:E7:0C:FE
 726       Configuring Port 1 (socket 0)
 727       PMD: librte_pmd_mlx5: 0x8ccac8: TX queues number update: 0 -> 2
 728       PMD: librte_pmd_mlx5: 0x8ccac8: RX queues number update: 0 -> 2
 729       Port 1: E4:1D:2D:E7:0C:FF
 730       Configuring Port 2 (socket 0)
 731       PMD: librte_pmd_mlx5: 0x8cdb10: TX queues number update: 0 -> 2
 732       PMD: librte_pmd_mlx5: 0x8cdb10: RX queues number update: 0 -> 2
 733       Port 2: E4:1D:2D:E7:0C:FA
 734       Configuring Port 3 (socket 0)
 735       PMD: librte_pmd_mlx5: 0x8ceb58: TX queues number update: 0 -> 2
 736       PMD: librte_pmd_mlx5: 0x8ceb58: RX queues number update: 0 -> 2
 737       Port 3: E4:1D:2D:E7:0C:FB
 738       Checking link statuses...
 739       Port 0 Link Up - speed 40000 Mbps - full-duplex
 740       Port 1 Link Up - speed 40000 Mbps - full-duplex
 741       Port 2 Link Up - speed 10000 Mbps - full-duplex
 742       Port 3 Link Up - speed 10000 Mbps - full-duplex
 743       Done
 744       testpmd>