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