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