doc/guides/nics/mlx5.rst

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