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**, **Mellanox ConnectX-6** and **Mellanox BlueField** families
  11 of 10/25/40/50/100/200 Gb/s adapters as well as their virtual functions (VF)
  12 in SR-IOV context.
  13
  14 Information and documentation about these adapters can be found on the
  15 `Mellanox website <http://www.mellanox.com>`__. Help is also provided by the
  16 `Mellanox community <http://community.mellanox.com/welcome>`__.
  17
  18 There is also a `section dedicated to this poll mode driver
  19 <http://www.mellanox.com/page/products_dyn?product_family=209&mtag=pmd_for_dpdk>`__.
  20
  21 .. note::
  22
  23    Due to external dependencies, this driver is disabled by default. It must
  24    be enabled manually by setting ``CONFIG_RTE_LIBRTE_MLX5_PMD=y`` and
  25    recompiling DPDK.
  26
  27 Implementation details
  28 ----------------------
  29
  30 Besides its dependency on libibverbs (that implies libmlx5 and associated
  31 kernel support), librte_pmd_mlx5 relies heavily on system calls for control
  32 operations such as querying/updating the MTU and flow control parameters.
  33
  34 For security reasons and robustness, this driver only deals with virtual
  35 memory addresses. The way resources allocations are handled by the kernel
  36 combined with hardware specifications that allow it to handle virtual memory
  37 addresses directly ensure that DPDK applications cannot access random
  38 physical memory (or memory that does not belong to the current process).
  39
  40 This capability allows the PMD to coexist with kernel network interfaces
  41 which remain functional, although they stop receiving unicast packets as
  42 long as they share the same MAC address.
  43 This means legacy linux control tools (for example: ethtool, ifconfig and
  44 more) can operate on the same network interfaces that owned by the DPDK
  45 application.
  46
  47 Enabling librte_pmd_mlx5 causes DPDK applications to be linked against
  48 libibverbs.
  49
  50 Features
  51 --------
  52
  53 - Multi arch support: x86_64, POWER8, ARMv8, i686.
  54 - Multiple TX and RX queues.
  55 - Support for scattered TX and RX frames.
  56 - IPv4, IPv6, TCPv4, TCPv6, UDPv4 and UDPv6 RSS on any number of queues.
  57 - Several RSS hash keys, one for each flow type.
  58 - Default RSS operation with no hash key specification.
  59 - Configurable RETA table.
  60 - Support for multiple MAC addresses.
  61 - VLAN filtering.
  62 - RX VLAN stripping.
  63 - TX VLAN insertion.
  64 - RX CRC stripping configuration.
  65 - Promiscuous mode on PF and VF.
  66 - Multicast promiscuous mode on PF and VF.
  67 - Hardware checksum offloads.
  68 - Flow director (RTE_FDIR_MODE_PERFECT, RTE_FDIR_MODE_PERFECT_MAC_VLAN and
  69   RTE_ETH_FDIR_REJECT).
  70 - Flow API, including :ref:`flow_isolated_mode`.
  71 - Multiple process.
  72 - KVM and VMware ESX SR-IOV modes are supported.
  73 - RSS hash result is supported.
  74 - Hardware TSO for generic IP or UDP tunnel, including VXLAN and GRE.
  75 - Hardware checksum Tx offload for generic IP or UDP tunnel, including VXLAN and GRE.
  76 - RX interrupts.
  77 - Statistics query including Basic, Extended and per queue.
  78 - Rx HW timestamp.
  79 - Tunnel types: VXLAN, L3 VXLAN, VXLAN-GPE, GRE, MPLSoGRE, MPLSoUDP, IP-in-IP.
  80 - Tunnel HW offloads: packet type, inner/outer RSS, IP and UDP checksum verification.
  81 - NIC HW offloads: encapsulation (vxlan, gre, mplsoudp, mplsogre), NAT, routing, TTL
  82   increment/decrement, count, drop, mark. For details please see :ref:`Supported hardware offloads using rte_flow API`.
  83 - Flow insertion rate of more then million flows per second, when using Direct Rules.
  84 - Support for multiple rte_flow groups.
  85
  86 Limitations
  87 -----------
  88
  89 - For secondary process:
  90
  91   - Forked secondary process not supported.
  92   - External memory unregistered in EAL memseg list cannot be used for DMA
  93     unless such memory has been registered by ``mlx5_mr_update_ext_mp()`` in
  94     primary process and remapped to the same virtual address in secondary
  95     process. If the external memory is registered by primary process but has
  96     different virtual address in secondary process, unexpected error may happen.
  97
  98 - Flow pattern without any specific vlan will match for vlan packets as well:
  99
 100   When VLAN spec is not specified in the pattern, the matching rule will be created with VLAN as a wild card.
 101   Meaning, the flow rule::
 102
 103         flow create 0 ingress pattern eth / vlan vid is 3 / ipv4 / end ...
 104
 105   Will only match vlan packets with vid=3. and the flow rules::
 106
 107         flow create 0 ingress pattern eth / ipv4 / end ...
 108
 109   Or::
 110
 111         flow create 0 ingress pattern eth / vlan / ipv4 / end ...
 112
 113   Will match any ipv4 packet (VLAN included).
 114
 115 - A multi segment packet must have less than 6 segments in case the Tx burst function
 116   is set to multi-packet send or Enhanced multi-packet send. Otherwise it must have
 117   less than 50 segments.
 118
 119 - Flows with a VXLAN Network Identifier equal (or ends to be equal)
 120   to 0 are not supported.
 121
 122 - VXLAN TSO and checksum offloads are not supported on VM.
 123
 124 - L3 VXLAN and VXLAN-GPE tunnels cannot be supported together with MPLSoGRE and MPLSoUDP.
 125
 126 - VF: flow rules created on VF devices can only match traffic targeted at the
 127   configured MAC addresses (see ``rte_eth_dev_mac_addr_add()``).
 128
 129 .. note::
 130
 131    MAC addresses not already present in the bridge table of the associated
 132    kernel network device will be added and cleaned up by the PMD when closing
 133    the device. In case of ungraceful program termination, some entries may
 134    remain present and should be removed manually by other means.
 135
 136 - When Multi-Packet Rx queue is configured (``mprq_en``), a Rx packet can be
 137   externally attached to a user-provided mbuf with having EXT_ATTACHED_MBUF in
 138   ol_flags. As the mempool for the external buffer is managed by PMD, all the
 139   Rx mbufs must be freed before the device is closed. Otherwise, the mempool of
 140   the external buffers will be freed by PMD and the application which still
 141   holds the external buffers may be corrupted.
 142
 143 - If Multi-Packet Rx queue is configured (``mprq_en``) and Rx CQE compression is
 144   enabled (``rxq_cqe_comp_en``) at the same time, RSS hash result is not fully
 145   supported. Some Rx packets may not have PKT_RX_RSS_HASH.
 146
 147 - IPv6 Multicast messages are not supported on VM, while promiscuous mode
 148   and allmulticast mode are both set to off.
 149   To receive IPv6 Multicast messages on VM, explicitly set the relevant
 150   MAC address using rte_eth_dev_mac_addr_add() API.
 151
 152 - E-Switch decapsulation Flow:
 153
 154   - can be applied to PF port only.
 155   - must specify VF port action (packet redirection from PF to VF).
 156   - optionally may specify tunnel inner source and destination MAC addresses.
 157
 158 - E-Switch  encapsulation Flow:
 159
 160   - can be applied to VF ports only.
 161   - must specify PF port action (packet redirection from VF to PF).
 162
 163 - ICMP/ICMP6 code/type matching cannot be supported togeter with IP-in-IP tunnel.
 164
 165 Statistics
 166 ----------
 167
 168 MLX5 supports various of methods to report statistics:
 169
 170 Port statistics can be queried using ``rte_eth_stats_get()``. The received and sent statistics are through SW only and counts the number of packets received or sent successfully by the PMD. The imissed counter is the amount of packets that could not be delivered to SW because a queue was full. Packets not received due to congestion in the bus or on the NIC can be queried via the rx_discards_phy xstats counter.
 171
 172 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.
 173
 174 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.
 175
 176 Configuration
 177 -------------
 178
 179 Compilation options
 180 ~~~~~~~~~~~~~~~~~~~
 181
 182 These options can be modified in the ``.config`` file.
 183
 184 - ``CONFIG_RTE_LIBRTE_MLX5_PMD`` (default **n**)
 185
 186   Toggle compilation of librte_pmd_mlx5 itself.
 187
 188 - ``CONFIG_RTE_IBVERBS_LINK_DLOPEN`` (default **n**)
 189
 190   Build PMD with additional code to make it loadable without hard
 191   dependencies on **libibverbs** nor **libmlx5**, which may not be installed
 192   on the target system.
 193
 194   In this mode, their presence is still required for it to run properly,
 195   however their absence won't prevent a DPDK application from starting (with
 196   ``CONFIG_RTE_BUILD_SHARED_LIB`` disabled) and they won't show up as
 197   missing with ``ldd(1)``.
 198
 199   It works by moving these dependencies to a purpose-built rdma-core "glue"
 200   plug-in which must either be installed in a directory whose name is based
 201   on ``CONFIG_RTE_EAL_PMD_PATH`` suffixed with ``-glue`` if set, or in a
 202   standard location for the dynamic linker (e.g. ``/lib``) if left to the
 203   default empty string (``""``).
 204
 205   This option has no performance impact.
 206
 207 - ``CONFIG_RTE_IBVERBS_LINK_STATIC`` (default **n**)
 208
 209   Embed static flavor of the dependencies **libibverbs** and **libmlx5**
 210   in the PMD shared library or the executable static binary.
 211
 212 - ``CONFIG_RTE_LIBRTE_MLX5_DEBUG`` (default **n**)
 213
 214   Toggle debugging code and stricter compilation flags. Enabling this option
 215   adds additional run-time checks and debugging messages at the cost of
 216   lower performance.
 217
 218 .. note::
 219
 220    For BlueField, target should be set to ``arm64-bluefield-linux-gcc``. This
 221    will enable ``CONFIG_RTE_LIBRTE_MLX5_PMD`` and set ``RTE_CACHE_LINE_SIZE`` to
 222    64. Default armv8a configuration of make build and meson build set it to 128
 223    then brings performance degradation.
 224
 225 Environment variables
 226 ~~~~~~~~~~~~~~~~~~~~~
 227
 228 - ``MLX5_GLUE_PATH``
 229
 230   A list of directories in which to search for the rdma-core "glue" plug-in,
 231   separated by colons or semi-colons.
 232
 233   Only matters when compiled with ``CONFIG_RTE_IBVERBS_LINK_DLOPEN``
 234   enabled and most useful when ``CONFIG_RTE_EAL_PMD_PATH`` is also set,
 235   since ``LD_LIBRARY_PATH`` has no effect in this case.
 236
 237 - ``MLX5_SHUT_UP_BF``
 238
 239   Configures HW Tx doorbell register as IO-mapped.
 240
 241   By default, the HW Tx doorbell is configured as a write-combining register.
 242   The register would be flushed to HW usually when the write-combining buffer
 243   becomes full, but it depends on CPU design.
 244
 245   Except for vectorized Tx burst routines, a write memory barrier is enforced
 246   after updating the register so that the update can be immediately visible to
 247   HW.
 248
 249   When vectorized Tx burst is called, the barrier is set only if the burst size
 250   is not aligned to MLX5_VPMD_TX_MAX_BURST. However, setting this environmental
 251   variable will bring better latency even though the maximum throughput can
 252   slightly decline.
 253
 254 Run-time configuration
 255 ~~~~~~~~~~~~~~~~~~~~~~
 256
 257 - librte_pmd_mlx5 brings kernel network interfaces up during initialization
 258   because it is affected by their state. Forcing them down prevents packets
 259   reception.
 260
 261 - **ethtool** operations on related kernel interfaces also affect the PMD.
 262
 263 - ``rxq_cqe_comp_en`` parameter [int]
 264
 265   A nonzero value enables the compression of CQE on RX side. This feature
 266   allows to save PCI bandwidth and improve performance. Enabled by default.
 267
 268   Supported on:
 269
 270   - x86_64 with ConnectX-4, ConnectX-4 LX, ConnectX-5, ConnectX-6 and BlueField.
 271   - POWER9 and ARMv8 with ConnectX-4 LX, ConnectX-5, ConnectX-6 and BlueField.
 272
 273 - ``rxq_cqe_pad_en`` parameter [int]
 274
 275   A nonzero value enables 128B padding of CQE on RX side. The size of CQE
 276   is aligned with the size of a cacheline of the core. If cacheline size is
 277   128B, the CQE size is configured to be 128B even though the device writes
 278   only 64B data on the cacheline. This is to avoid unnecessary cache
 279   invalidation by device's two consecutive writes on to one cacheline.
 280   However in some architecture, it is more beneficial to update entire
 281   cacheline with padding the rest 64B rather than striding because
 282   read-modify-write could drop performance a lot. On the other hand,
 283   writing extra data will consume more PCIe bandwidth and could also drop
 284   the maximum throughput. It is recommended to empirically set this
 285   parameter. Disabled by default.
 286
 287   Supported on:
 288
 289   - CPU having 128B cacheline with ConnectX-5 and BlueField.
 290
 291 - ``rxq_pkt_pad_en`` parameter [int]
 292
 293   A nonzero value enables padding Rx packet to the size of cacheline on PCI
 294   transaction. This feature would waste PCI bandwidth but could improve
 295   performance by avoiding partial cacheline write which may cause costly
 296   read-modify-copy in memory transaction on some architectures. Disabled by
 297   default.
 298
 299   Supported on:
 300
 301   - x86_64 with ConnectX-4, ConnectX-4 LX, ConnectX-5, ConnectX-6 and BlueField.
 302   - POWER8 and ARMv8 with ConnectX-4 LX, ConnectX-5, ConnectX-6 and BlueField.
 303
 304 - ``mprq_en`` parameter [int]
 305
 306   A nonzero value enables configuring Multi-Packet Rx queues. Rx queue is
 307   configured as Multi-Packet RQ if the total number of Rx queues is
 308   ``rxqs_min_mprq`` or more and Rx scatter isn't configured. Disabled by
 309   default.
 310
 311   Multi-Packet Rx Queue (MPRQ a.k.a Striding RQ) can further save PCIe bandwidth
 312   by posting a single large buffer for multiple packets. Instead of posting a
 313   buffers per a packet, one large buffer is posted in order to receive multiple
 314   packets on the buffer. A MPRQ buffer consists of multiple fixed-size strides
 315   and each stride receives one packet. MPRQ can improve throughput for
 316   small-packet traffic.
 317
 318   When MPRQ is enabled, max_rx_pkt_len can be larger than the size of
 319   user-provided mbuf even if DEV_RX_OFFLOAD_SCATTER isn't enabled. PMD will
 320   configure large stride size enough to accommodate max_rx_pkt_len as long as
 321   device allows. Note that this can waste system memory compared to enabling Rx
 322   scatter and multi-segment packet.
 323
 324 - ``mprq_log_stride_num`` parameter [int]
 325
 326   Log 2 of the number of strides for Multi-Packet Rx queue. Configuring more
 327   strides can reduce PCIe traffic further. If configured value is not in the
 328   range of device capability, the default value will be set with a warning
 329   message. The default value is 4 which is 16 strides per a buffer, valid only
 330   if ``mprq_en`` is set.
 331
 332   The size of Rx queue should be bigger than the number of strides.
 333
 334 - ``mprq_max_memcpy_len`` parameter [int]
 335
 336   The maximum length of packet to memcpy in case of Multi-Packet Rx queue. Rx
 337   packet is mem-copied to a user-provided mbuf if the size of Rx packet is less
 338   than or equal to this parameter. Otherwise, PMD will attach the Rx packet to
 339   the mbuf by external buffer attachment - ``rte_pktmbuf_attach_extbuf()``.
 340   A mempool for external buffers will be allocated and managed by PMD. If Rx
 341   packet is externally attached, ol_flags field of the mbuf will have
 342   EXT_ATTACHED_MBUF and this flag must be preserved. ``RTE_MBUF_HAS_EXTBUF()``
 343   checks the flag. The default value is 128, valid only if ``mprq_en`` is set.
 344
 345 - ``rxqs_min_mprq`` parameter [int]
 346
 347   Configure Rx queues as Multi-Packet RQ if the total number of Rx queues is
 348   greater or equal to this value. The default value is 12, valid only if
 349   ``mprq_en`` is set.
 350
 351 - ``txq_inline`` parameter [int]
 352
 353   Amount of data to be inlined during TX operations. Improves latency.
 354   Can improve PPS performance when PCI back pressure is detected and may be
 355   useful for scenarios involving heavy traffic on many queues.
 356
 357   Because additional software logic is necessary to handle this mode, this
 358   option should be used with care, as it can lower performance when back
 359   pressure is not expected.
 360
 361 - ``txqs_min_inline`` parameter [int]
 362
 363   Enable inline send only when the number of TX queues is greater or equal
 364   to this value.
 365
 366   This option should be used in combination with ``txq_inline`` above.
 367
 368   On ConnectX-4, ConnectX-4 LX, ConnectX-5, ConnectX-6 and BlueField without
 369   Enhanced MPW:
 370
 371         - Disabled by default.
 372         - In case ``txq_inline`` is set recommendation is 4.
 373
 374   On ConnectX-5, ConnectX-6 and BlueField with Enhanced MPW:
 375
 376         - Set to 8 by default.
 377
 378 - ``txqs_max_vec`` parameter [int]
 379
 380   Enable vectorized Tx only when the number of TX queues is less than or
 381   equal to this value. Effective only when ``tx_vec_en`` is enabled.
 382
 383   On ConnectX-5:
 384
 385         - Set to 8 by default on ARMv8.
 386         - Set to 4 by default otherwise.
 387
 388   On BlueField
 389
 390         - Set to 16 by default.
 391
 392 - ``txq_mpw_en`` parameter [int]
 393
 394   A nonzero value enables multi-packet send (MPS) for ConnectX-4 Lx and
 395   enhanced multi-packet send (Enhanced MPS) for ConnectX-5, ConnectX-6 and BlueField.
 396   MPS allows the TX burst function to pack up multiple packets in a
 397   single descriptor session in order to save PCI bandwidth and improve
 398   performance at the cost of a slightly higher CPU usage. When
 399   ``txq_inline`` is set along with ``txq_mpw_en``, TX burst function tries
 400   to copy entire packet data on to TX descriptor instead of including
 401   pointer of packet only if there is enough room remained in the
 402   descriptor. ``txq_inline`` sets per-descriptor space for either pointers
 403   or inlined packets. In addition, Enhanced MPS supports hybrid mode -
 404   mixing inlined packets and pointers in the same descriptor.
 405
 406   This option cannot be used with certain offloads such as ``DEV_TX_OFFLOAD_TCP_TSO,
 407   DEV_TX_OFFLOAD_VXLAN_TNL_TSO, DEV_TX_OFFLOAD_GRE_TNL_TSO, DEV_TX_OFFLOAD_VLAN_INSERT``.
 408   When those offloads are requested the MPS send function will not be used.
 409
 410   It is currently only supported on the ConnectX-4 Lx, ConnectX-5, ConnectX-6 and BlueField
 411   families of adapters.
 412   On ConnectX-4 Lx the MPW is considered un-secure hence disabled by default.
 413   Users which enable the MPW should be aware that application which provides incorrect
 414   mbuf descriptors in the Tx burst can lead to serious errors in the host including, on some cases,
 415   NIC to get stuck.
 416   On ConnectX-5, ConnectX-6 and BlueField the MPW is secure and enabled by default.
 417
 418 - ``txq_mpw_hdr_dseg_en`` parameter [int]
 419
 420   A nonzero value enables including two pointers in the first block of TX
 421   descriptor. This can be used to lessen CPU load for memory copy.
 422
 423   Effective only when Enhanced MPS is supported. Disabled by default.
 424
 425 - ``txq_max_inline_len`` parameter [int]
 426
 427   Maximum size of packet to be inlined. This limits the size of packet to
 428   be inlined. If the size of a packet is larger than configured value, the
 429   packet isn't inlined even though there's enough space remained in the
 430   descriptor. Instead, the packet is included with pointer.
 431
 432   Effective only when Enhanced MPS is supported. The default value is 256.
 433
 434 - ``tx_vec_en`` parameter [int]
 435
 436   A nonzero value enables Tx vector on ConnectX-5, ConnectX-6 and BlueField NICs if the number of
 437   global Tx queues on the port is less than ``txqs_max_vec``.
 438
 439   This option cannot be used with certain offloads such as ``DEV_TX_OFFLOAD_TCP_TSO,
 440   DEV_TX_OFFLOAD_VXLAN_TNL_TSO, DEV_TX_OFFLOAD_GRE_TNL_TSO, DEV_TX_OFFLOAD_VLAN_INSERT``.
 441   When those offloads are requested the MPS send function will not be used.
 442
 443   Enabled by default on ConnectX-5, ConnectX-6 and BlueField.
 444
 445 - ``rx_vec_en`` parameter [int]
 446
 447   A nonzero value enables Rx vector if the port is not configured in
 448   multi-segment otherwise this parameter is ignored.
 449
 450   Enabled by default.
 451
 452 - ``vf_nl_en`` parameter [int]
 453
 454   A nonzero value enables Netlink requests from the VF to add/remove MAC
 455   addresses or/and enable/disable promiscuous/all multicast on the Netdevice.
 456   Otherwise the relevant configuration must be run with Linux iproute2 tools.
 457   This is a prerequisite to receive this kind of traffic.
 458
 459   Enabled by default, valid only on VF devices ignored otherwise.
 460
 461 - ``l3_vxlan_en`` parameter [int]
 462
 463   A nonzero value allows L3 VXLAN and VXLAN-GPE flow creation. To enable
 464   L3 VXLAN or VXLAN-GPE, users has to configure firmware and enable this
 465   parameter. This is a prerequisite to receive this kind of traffic.
 466
 467   Disabled by default.
 468
 469 - ``dv_flow_en`` parameter [int]
 470
 471   A nonzero value enables the DV flow steering assuming it is supported
 472   by the driver.
 473
 474   Disabled by default.
 475
 476 - ``dv_esw_en`` parameter [int]
 477
 478   A nonzero value enables E-Switch using Direct Rules.
 479
 480   Enabled by default if supported.
 481
 482 - ``mr_ext_memseg_en`` parameter [int]
 483
 484   A nonzero value enables extending memseg when registering DMA memory. If
 485   enabled, the number of entries in MR (Memory Region) lookup table on datapath
 486   is minimized and it benefits performance. On the other hand, it worsens memory
 487   utilization because registered memory is pinned by kernel driver. Even if a
 488   page in the extended chunk is freed, that doesn't become reusable until the
 489   entire memory is freed.
 490
 491   Enabled by default.
 492
 493 - ``representor`` parameter [list]
 494
 495   This parameter can be used to instantiate DPDK Ethernet devices from
 496   existing port (or VF) representors configured on the device.
 497
 498   It is a standard parameter whose format is described in
 499   :ref:`ethernet_device_standard_device_arguments`.
 500
 501   For instance, to probe port representors 0 through 2::
 502
 503     representor=[0-2]
 504
 505 - ``max_dump_files_num`` parameter [int]
 506
 507   The maximum number of files per PMD entity that may be created for debug information.
 508   The files will be created in /var/log directory or in current directory.
 509
 510   set to 128 by default.
 511
 512 Firmware configuration
 513 ~~~~~~~~~~~~~~~~~~~~~~
 514
 515 - L3 VXLAN and VXLAN-GPE destination UDP port
 516
 517    .. code-block:: console
 518
 519      mlxconfig -d <mst device> set IP_OVER_VXLAN_EN=1
 520      mlxconfig -d <mst device> set IP_OVER_VXLAN_PORT=<udp dport>
 521
 522   Verify configurations are set:
 523
 524    .. code-block:: console
 525
 526      mlxconfig -d <mst device> query | grep IP_OVER_VXLAN
 527      IP_OVER_VXLAN_EN                    True(1)
 528      IP_OVER_VXLAN_PORT                  <udp dport>
 529
 530 - enable ICMP/ICMP6's code/type field matching
 531
 532    .. code-block:: console
 533
 534      mlxconfig -d <mst device> set FLEX_PARSER_PROFILE_ENABLE=2
 535
 536   Verify configurations are set:
 537
 538    .. code-block:: console
 539
 540      mlxconfig -d <mst device> query | grep FLEX_PARSER_PROFILE_ENABLE
 541      FLEX_PARSER_PROFILE_ENABLE         2
 542
 543 - IP-in-IP tunnel enable
 544
 545    .. code-block:: console
 546
 547      mlxconfig -d <mst device> set FLEX_PARSER_PROFILE_ENABLE=0
 548
 549   Verify configurations are set:
 550
 551    .. code-block:: console
 552
 553      mlxconfig -d <mst device> query | grep FLEX_PARSER_PROFILE_ENABLE
 554      FLEX_PARSER_PROFILE_ENABLE          0
 555
 556 Prerequisites
 557 -------------
 558
 559 This driver relies on external libraries and kernel drivers for resources
 560 allocations and initialization. The following dependencies are not part of
 561 DPDK and must be installed separately:
 562
 563 - **libibverbs**
 564
 565   User space Verbs framework used by librte_pmd_mlx5. This library provides
 566   a generic interface between the kernel and low-level user space drivers
 567   such as libmlx5.
 568
 569   It allows slow and privileged operations (context initialization, hardware
 570   resources allocations) to be managed by the kernel and fast operations to
 571   never leave user space.
 572
 573 - **libmlx5**
 574
 575   Low-level user space driver library for Mellanox
 576   ConnectX-4/ConnectX-5/ConnectX-6/BlueField devices, it is automatically loaded
 577   by libibverbs.
 578
 579   This library basically implements send/receive calls to the hardware
 580   queues.
 581
 582 - **Kernel modules**
 583
 584   They provide the kernel-side Verbs API and low level device drivers that
 585   manage actual hardware initialization and resources sharing with user
 586   space processes.
 587
 588   Unlike most other PMDs, these modules must remain loaded and bound to
 589   their devices:
 590
 591   - mlx5_core: hardware driver managing Mellanox
 592     ConnectX-4/ConnectX-5/ConnectX-6/BlueField devices and related Ethernet kernel
 593     network devices.
 594   - mlx5_ib: InifiniBand device driver.
 595   - ib_uverbs: user space driver for Verbs (entry point for libibverbs).
 596
 597 - **Firmware update**
 598
 599   Mellanox OFED/EN releases include firmware updates for
 600   ConnectX-4/ConnectX-5/ConnectX-6/BlueField adapters.
 601
 602   Because each release provides new features, these updates must be applied to
 603   match the kernel modules and libraries they come with.
 604
 605 .. note::
 606
 607    Both libraries are BSD and GPL licensed. Linux kernel modules are GPL
 608    licensed.
 609
 610 Installation
 611 ~~~~~~~~~~~~
 612
 613 Either RDMA Core library with a recent enough Linux kernel release
 614 (recommended) or Mellanox OFED/EN, which provides compatibility with older
 615 releases.
 616
 617 RDMA Core with Linux Kernel
 618 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 619
 620 - Minimal kernel version : v4.14 or the most recent 4.14-rc (see `Linux installation documentation`_)
 621 - Minimal rdma-core version: v15+ commit 0c5f5765213a ("Merge pull request #227 from yishaih/tm")
 622   (see `RDMA Core installation documentation`_)
 623 - When building for i686 use:
 624
 625   - rdma-core version 18.0 or above built with 32bit support.
 626   - Kernel version 4.14.41 or above.
 627
 628 - Starting with rdma-core v21, static libraries can be built::
 629
 630     cd build
 631     CFLAGS=-fPIC cmake -DIN_PLACE=1 -DENABLE_STATIC=1 -GNinja ..
 632     ninja
 633
 634 .. _`Linux installation documentation`: https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux-stable.git/plain/Documentation/admin-guide/README.rst
 635 .. _`RDMA Core installation documentation`: https://raw.githubusercontent.com/linux-rdma/rdma-core/master/README.md
 636
 637 If rdma-core libraries are built but not installed, DPDK makefile can link them,
 638 thanks to these environment variables:
 639
 640    - ``EXTRA_CFLAGS=-I/path/to/rdma-core/build/include``
 641    - ``EXTRA_LDFLAGS=-L/path/to/rdma-core/build/lib``
 642    - ``PKG_CONFIG_PATH=/path/to/rdma-core/build/lib/pkgconfig``
 643
 644 Mellanox OFED/EN
 645 ^^^^^^^^^^^^^^^^
 646
 647 - Mellanox OFED version: ** 4.5, 4.6** /
 648   Mellanox EN version: **4.5, 4.6**
 649 - firmware version:
 650
 651   - ConnectX-4: **12.21.1000** and above.
 652   - ConnectX-4 Lx: **14.21.1000** and above.
 653   - ConnectX-5: **16.21.1000** and above.
 654   - ConnectX-5 Ex: **16.21.1000** and above.
 655   - ConnectX-6: **20.99.5374** and above.
 656   - BlueField: **18.25.1010** and above.
 657
 658 While these libraries and kernel modules are available on OpenFabrics
 659 Alliance's `website <https://www.openfabrics.org/>`__ and provided by package
 660 managers on most distributions, this PMD requires Ethernet extensions that
 661 may not be supported at the moment (this is a work in progress).
 662
 663 `Mellanox OFED
 664 <http://www.mellanox.com/page/products_dyn?product_family=26&mtag=linux>`__ and
 665 `Mellanox EN
 666 <http://www.mellanox.com/page/products_dyn?product_family=27&mtag=linux>`__
 667 include the necessary support and should be used in the meantime. For DPDK,
 668 only libibverbs, libmlx5, mlnx-ofed-kernel packages and firmware updates are
 669 required from that distribution.
 670
 671 .. note::
 672
 673    Several versions of Mellanox OFED/EN are available. Installing the version
 674    this DPDK release was developed and tested against is strongly
 675    recommended. Please check the `prerequisites`_.
 676
 677 Supported NICs
 678 --------------
 679
 680 * Mellanox(R) ConnectX(R)-4 10G MCX4111A-XCAT (1x10G)
 681 * Mellanox(R) ConnectX(R)-4 10G MCX4121A-XCAT (2x10G)
 682 * Mellanox(R) ConnectX(R)-4 25G MCX4111A-ACAT (1x25G)
 683 * Mellanox(R) ConnectX(R)-4 25G MCX4121A-ACAT (2x25G)
 684 * Mellanox(R) ConnectX(R)-4 40G MCX4131A-BCAT (1x40G)
 685 * Mellanox(R) ConnectX(R)-4 40G MCX413A-BCAT (1x40G)
 686 * Mellanox(R) ConnectX(R)-4 40G MCX415A-BCAT (1x40G)
 687 * Mellanox(R) ConnectX(R)-4 50G MCX4131A-GCAT (1x50G)
 688 * Mellanox(R) ConnectX(R)-4 50G MCX413A-GCAT (1x50G)
 689 * Mellanox(R) ConnectX(R)-4 50G MCX414A-BCAT (2x50G)
 690 * Mellanox(R) ConnectX(R)-4 50G MCX415A-GCAT (2x50G)
 691 * Mellanox(R) ConnectX(R)-4 50G MCX416A-BCAT (2x50G)
 692 * Mellanox(R) ConnectX(R)-4 50G MCX416A-GCAT (2x50G)
 693 * Mellanox(R) ConnectX(R)-4 50G MCX415A-CCAT (1x100G)
 694 * Mellanox(R) ConnectX(R)-4 100G MCX416A-CCAT (2x100G)
 695 * Mellanox(R) ConnectX(R)-4 Lx 10G MCX4121A-XCAT (2x10G)
 696 * Mellanox(R) ConnectX(R)-4 Lx 25G MCX4121A-ACAT (2x25G)
 697 * Mellanox(R) ConnectX(R)-5 100G MCX556A-ECAT (2x100G)
 698 * Mellanox(R) ConnectX(R)-5 Ex EN 100G MCX516A-CDAT (2x100G)
 699
 700 Quick Start Guide on OFED/EN
 701 ----------------------------
 702
 703 1. Download latest Mellanox OFED/EN. For more info check the  `prerequisites`_.
 704
 705
 706 2. Install the required libraries and kernel modules either by installing
 707    only the required set, or by installing the entire Mellanox OFED/EN:
 708
 709    .. code-block:: console
 710
 711         ./mlnxofedinstall --upstream-libs --dpdk
 712
 713 3. Verify the firmware is the correct one:
 714
 715    .. code-block:: console
 716
 717         ibv_devinfo
 718
 719 4. Verify all ports links are set to Ethernet:
 720
 721    .. code-block:: console
 722
 723         mlxconfig -d <mst device> query | grep LINK_TYPE
 724         LINK_TYPE_P1                        ETH(2)
 725         LINK_TYPE_P2                        ETH(2)
 726
 727    Link types may have to be configured to Ethernet:
 728
 729    .. code-block:: console
 730
 731         mlxconfig -d <mst device> set LINK_TYPE_P1/2=1/2/3
 732
 733         * LINK_TYPE_P1=<1|2|3> , 1=Infiniband 2=Ethernet 3=VPI(auto-sense)
 734
 735    For hypervisors verify SR-IOV is enabled on the NIC:
 736
 737    .. code-block:: console
 738
 739         mlxconfig -d <mst device> query | grep SRIOV_EN
 740         SRIOV_EN                            True(1)
 741
 742    If needed, set enable the set the relevant fields:
 743
 744    .. code-block:: console
 745
 746         mlxconfig -d <mst device> set SRIOV_EN=1 NUM_OF_VFS=16
 747         mlxfwreset -d <mst device> reset
 748
 749 5. Restart the driver:
 750
 751    .. code-block:: console
 752
 753         /etc/init.d/openibd restart
 754
 755    or:
 756
 757    .. code-block:: console
 758
 759         service openibd restart
 760
 761    If link type was changed, firmware must be reset as well:
 762
 763    .. code-block:: console
 764
 765         mlxfwreset -d <mst device> reset
 766
 767    For hypervisors, after reset write the sysfs number of virtual functions
 768    needed for the PF.
 769
 770    To dynamically instantiate a given number of virtual functions (VFs):
 771
 772    .. code-block:: console
 773
 774         echo [num_vfs] > /sys/class/infiniband/mlx5_0/device/sriov_numvfs
 775
 776 6. Compile DPDK and you are ready to go. See instructions on
 777    :ref:`Development Kit Build System <Development_Kit_Build_System>`
 778
 779 Enable switchdev mode
 780 ---------------------
 781
 782 Switchdev mode is a mode in E-Switch, that binds between representor and VF.
 783 Representor is a port in DPDK that is connected to a VF in such a way
 784 that assuming there are no offload flows, each packet that is sent from the VF
 785 will be received by the corresponding representor. While each packet that is
 786 sent to a representor will be received by the VF.
 787 This is very useful in case of SRIOV mode, where the first packet that is sent
 788 by the VF will be received by the DPDK application which will decide if this
 789 flow should be offloaded to the E-Switch. After offloading the flow packet
 790 that the VF that are matching the flow will not be received any more by
 791 the DPDK application.
 792
 793 1. Enable SRIOV mode:
 794
 795   .. code-block:: console
 796
 797         mlxconfig -d <mst device> set SRIOV_EN=true
 798
 799 2. Configure the max number of VFs:
 800
 801   .. code-block:: console
 802
 803         mlxconfig -d <mst device> set NUM_OF_VFS=<num of vfs>
 804
 805 3. Reset the FW:
 806
 807   .. code-block:: console
 808
 809         mlxfwreset -d <mst device> reset
 810
 811 3. Configure the actual number of VFs:
 812
 813   .. code-block:: console
 814
 815         echo <num of vfs > /sys/class/net/<net device>/device/sriov_numvfs
 816
 817 4. Unbind the device (can be rebind after the switchdev mode):
 818
 819   .. code-block:: console
 820
 821         echo -n "<device pci address" > /sys/bus/pci/drivers/mlx5_core/unbind
 822
 823 5. Enbale switchdev mode:
 824
 825   .. code-block:: console
 826
 827         echo switchdev > /sys/class/net/<net device>/compat/devlink/mode
 828
 829 Performance tuning
 830 ------------------
 831
 832 1. Configure aggressive CQE Zipping for maximum performance:
 833
 834   .. code-block:: console
 835
 836         mlxconfig -d <mst device> s CQE_COMPRESSION=1
 837
 838   To set it back to the default CQE Zipping mode use:
 839
 840   .. code-block:: console
 841
 842         mlxconfig -d <mst device> s CQE_COMPRESSION=0
 843
 844 2. In case of virtualization:
 845
 846    - Make sure that hypervisor kernel is 3.16 or newer.
 847    - Configure boot with ``iommu=pt``.
 848    - Use 1G huge pages.
 849    - Make sure to allocate a VM on huge pages.
 850    - Make sure to set CPU pinning.
 851
 852 3. Use the CPU near local NUMA node to which the PCIe adapter is connected,
 853    for better performance. For VMs, verify that the right CPU
 854    and NUMA node are pinned according to the above. Run:
 855
 856    .. code-block:: console
 857
 858         lstopo-no-graphics
 859
 860    to identify the NUMA node to which the PCIe adapter is connected.
 861
 862 4. If more than one adapter is used, and root complex capabilities allow
 863    to put both adapters on the same NUMA node without PCI bandwidth degradation,
 864    it is recommended to locate both adapters on the same NUMA node.
 865    This in order to forward packets from one to the other without
 866    NUMA performance penalty.
 867
 868 5. Disable pause frames:
 869
 870    .. code-block:: console
 871
 872         ethtool -A <netdev> rx off tx off
 873
 874 6. Verify IO non-posted prefetch is disabled by default. This can be checked
 875    via the BIOS configuration. Please contact you server provider for more
 876    information about the settings.
 877
 878 .. note::
 879
 880         On some machines, depends on the machine integrator, it is beneficial
 881         to set the PCI max read request parameter to 1K. This can be
 882         done in the following way:
 883
 884         To query the read request size use:
 885
 886         .. code-block:: console
 887
 888                 setpci -s <NIC PCI address> 68.w
 889
 890         If the output is different than 3XXX, set it by:
 891
 892         .. code-block:: console
 893
 894                 setpci -s <NIC PCI address> 68.w=3XXX
 895
 896         The XXX can be different on different systems. Make sure to configure
 897         according to the setpci output.
 898
 899 7. To minimize overhead of searching Memory Regions:
 900
 901    - '--socket-mem' is recommended to pin memory by predictable amount.
 902    - Configure per-lcore cache when creating Mempools for packet buffer.
 903    - Refrain from dynamically allocating/freeing memory in run-time.
 904
 905 Supported hardware offloads using rte_flow API
 906 ----------------------------------------------
 907
 908 .. _Supported hardware offloads using rte_flow API:
 909
 910 .. table:: Supported hardware offloads using rte_flow API
 911
 912    +-----------------------+-----------------+-----------------+
 913    | Offload               | E-Switch        | NIC             |
 914    |                       |                 |                 |
 915    +=======================+=================+=================+
 916    | Count                 | | DPDK 19.05    | | DPDK 19.02    |
 917    |                       | | OFED 4.6      | | OFED 4.6      |
 918    |                       | | RDMA-CORE V24 | | RDMA-CORE V23 |
 919    |                       | | ConnectX-5    | | ConnectX-5    |
 920    +-----------------------+-----------------+-----------------+
 921    | Drop / Queue / RSS    | | DPDK 19.05    | | DPDK 18.11    |
 922    |                       | | OFED 4.6      | | OFED 4.5      |
 923    |                       | | RDMA-CORE V24 | | RDMA-CORE V23 |
 924    |                       | | ConnectX-5    | | ConnectX-4    |
 925    +-----------------------+-----------------+-----------------+
 926    | Encapsulation         | | DPDK 19.05    | | DPDK 19.02    |
 927    | (VXLAN / NVGRE / RAW) | | OFED 4.6.2    | | OFED 4.6      |
 928    |                       | | RDMA-CORE V24 | | RDMA-CORE V23 |
 929    |                       | | ConnectX-5    | | ConnectX-5    |
 930    +-----------------------+-----------------+-----------------+
 931    | Header rewrite        | | DPDK 19.05    | | DPDK 19.02    |
 932    | (set_ipv4_src /       | | OFED 4.6.2    | | OFED 4.6.2    |
 933    | set_ipv4_dst /        | | RDMA-CORE V24 | | RDMA-CORE V23 |
 934    | set_ipv6_src /        | | ConnectX-5    | | ConnectX-5    |
 935    | set_ipv6_dst /        |                 |                 |
 936    | set_tp_src /          |                 |                 |
 937    | set_tp_dst /          |                 |                 |
 938    | dec_ttl /             |                 |                 |
 939    | set_ttl /             |                 |                 |
 940    | set_mac_src /         |                 |                 |
 941    | set_mac_dst)          |                 |                 |
 942    +-----------------------+-----------------+-----------------+
 943    | Jump                  | | DPDK 19.05    | | DPDK 19.02    |
 944    |                       | | OFED 4.6.2    | | OFED 4.6.2    |
 945    |                       | | RDMA-CORE V24 | | N/A           |
 946    |                       | | ConnectX-5    | | ConnectX-5    |
 947    +-----------------------+-----------------+-----------------+
 948    | Mark / Flag           | | DPDK 19.05    | | DPDK 18.11    |
 949    |                       | | OFED 4.6      | | OFED 4.5      |
 950    |                       | | RDMA-CORE V24 | | RDMA-CORE V23 |
 951    |                       | | ConnectX-5    | | ConnectX-4    |
 952    +-----------------------+-----------------+-----------------+
 953    | Port ID               | | DPDK 19.05    |     | N/A       |
 954    |                       | | OFED 4.6      |     | N/A       |
 955    |                       | | RDMA-CORE V24 |     | N/A       |
 956    |                       | | ConnectX-5    |     | N/A       |
 957    +-----------------------+-----------------+-----------------+
 958
 959 * Minimum version for each component and nic.
 960
 961 Notes for testpmd
 962 -----------------
 963
 964 Compared to librte_pmd_mlx4 that implements a single RSS configuration per
 965 port, librte_pmd_mlx5 supports per-protocol RSS configuration.
 966
 967 Since ``testpmd`` defaults to IP RSS mode and there is currently no
 968 command-line parameter to enable additional protocols (UDP and TCP as well
 969 as IP), the following commands must be entered from its CLI to get the same
 970 behavior as librte_pmd_mlx4:
 971
 972 .. code-block:: console
 973
 974    > port stop all
 975    > port config all rss all
 976    > port start all
 977
 978 Usage example
 979 -------------
 980
 981 This section demonstrates how to launch **testpmd** with Mellanox
 982 ConnectX-4/ConnectX-5/ConnectX-6/BlueField devices managed by librte_pmd_mlx5.
 983
 984 #. Load the kernel modules:
 985
 986    .. code-block:: console
 987
 988       modprobe -a ib_uverbs mlx5_core mlx5_ib
 989
 990    Alternatively if MLNX_OFED/MLNX_EN is fully installed, the following script
 991    can be run:
 992
 993    .. code-block:: console
 994
 995       /etc/init.d/openibd restart
 996
 997    .. note::
 998
 999       User space I/O kernel modules (uio and igb_uio) are not used and do
1000       not have to be loaded.
1001
1002 #. Make sure Ethernet interfaces are in working order and linked to kernel
1003    verbs. Related sysfs entries should be present:
1004
1005    .. code-block:: console
1006
1007       ls -d /sys/class/net/*/device/infiniband_verbs/uverbs* | cut -d / -f 5
1008
1009    Example output:
1010
1011    .. code-block:: console
1012
1013       eth30
1014       eth31
1015       eth32
1016       eth33
1017
1018 #. Optionally, retrieve their PCI bus addresses for whitelisting:
1019
1020    .. code-block:: console
1021
1022       {
1023           for intf in eth2 eth3 eth4 eth5;
1024           do
1025               (cd "/sys/class/net/${intf}/device/" && pwd -P);
1026           done;
1027       } |
1028       sed -n 's,.*/\(.*\),-w \1,p'
1029
1030    Example output:
1031
1032    .. code-block:: console
1033
1034       -w 0000:05:00.1
1035       -w 0000:06:00.0
1036       -w 0000:06:00.1
1037       -w 0000:05:00.0
1038
1039 #. Request huge pages:
1040
1041    .. code-block:: console
1042
1043       echo 1024 > /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages/nr_hugepages
1044
1045 #. Start testpmd with basic parameters:
1046
1047    .. code-block:: console
1048
1049       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
1050
1051    Example output:
1052
1053    .. code-block:: console
1054
1055       [...]
1056       EAL: PCI device 0000:05:00.0 on NUMA socket 0
1057       EAL:   probe driver: 15b3:1013 librte_pmd_mlx5
1058       PMD: librte_pmd_mlx5: PCI information matches, using device "mlx5_0" (VF: false)
1059       PMD: librte_pmd_mlx5: 1 port(s) detected
1060       PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:fe
1061       EAL: PCI device 0000:05:00.1 on NUMA socket 0
1062       EAL:   probe driver: 15b3:1013 librte_pmd_mlx5
1063       PMD: librte_pmd_mlx5: PCI information matches, using device "mlx5_1" (VF: false)
1064       PMD: librte_pmd_mlx5: 1 port(s) detected
1065       PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:ff
1066       EAL: PCI device 0000:06:00.0 on NUMA socket 0
1067       EAL:   probe driver: 15b3:1013 librte_pmd_mlx5
1068       PMD: librte_pmd_mlx5: PCI information matches, using device "mlx5_2" (VF: false)
1069       PMD: librte_pmd_mlx5: 1 port(s) detected
1070       PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:fa
1071       EAL: PCI device 0000:06:00.1 on NUMA socket 0
1072       EAL:   probe driver: 15b3:1013 librte_pmd_mlx5
1073       PMD: librte_pmd_mlx5: PCI information matches, using device "mlx5_3" (VF: false)
1074       PMD: librte_pmd_mlx5: 1 port(s) detected
1075       PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:fb
1076       Interactive-mode selected
1077       Configuring Port 0 (socket 0)
1078       PMD: librte_pmd_mlx5: 0x8cba80: TX queues number update: 0 -> 2
1079       PMD: librte_pmd_mlx5: 0x8cba80: RX queues number update: 0 -> 2
1080       Port 0: E4:1D:2D:E7:0C:FE
1081       Configuring Port 1 (socket 0)
1082       PMD: librte_pmd_mlx5: 0x8ccac8: TX queues number update: 0 -> 2
1083       PMD: librte_pmd_mlx5: 0x8ccac8: RX queues number update: 0 -> 2
1084       Port 1: E4:1D:2D:E7:0C:FF
1085       Configuring Port 2 (socket 0)
1086       PMD: librte_pmd_mlx5: 0x8cdb10: TX queues number update: 0 -> 2
1087       PMD: librte_pmd_mlx5: 0x8cdb10: RX queues number update: 0 -> 2
1088       Port 2: E4:1D:2D:E7:0C:FA
1089       Configuring Port 3 (socket 0)
1090       PMD: librte_pmd_mlx5: 0x8ceb58: TX queues number update: 0 -> 2
1091       PMD: librte_pmd_mlx5: 0x8ceb58: RX queues number update: 0 -> 2
1092       Port 3: E4:1D:2D:E7:0C:FB
1093       Checking link statuses...
1094       Port 0 Link Up - speed 40000 Mbps - full-duplex
1095       Port 1 Link Up - speed 40000 Mbps - full-duplex
1096       Port 2 Link Up - speed 10000 Mbps - full-duplex
1097       Port 3 Link Up - speed 10000 Mbps - full-duplex
1098       Done
1099       testpmd>