1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright 2015 6WIND S.A.
3 Copyright 2015 Mellanox Technologies, Ltd
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)
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>`__.
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>`__.
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
27 Implementation details
28 ----------------------
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.
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).
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
47 Enabling librte_pmd_mlx5 causes DPDK applications to be linked against
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.
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
70 - Flow API, including :ref:`flow_isolated_mode`.
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.
77 - Statistics query including Basic, Extended and per queue.
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.
89 - For secondary process:
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.
98 - Flow pattern without any specific vlan will match for vlan packets as well:
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::
103 flow create 0 ingress pattern eth / vlan vid is 3 / ipv4 / end ...
105 Will only match vlan packets with vid=3. and the flow rules::
107 flow create 0 ingress pattern eth / ipv4 / end ...
111 flow create 0 ingress pattern eth / vlan / ipv4 / end ...
113 Will match any ipv4 packet (VLAN included).
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.
119 - Flows with a VXLAN Network Identifier equal (or ends to be equal)
120 to 0 are not supported.
122 - VXLAN TSO and checksum offloads are not supported on VM.
124 - L3 VXLAN and VXLAN-GPE tunnels cannot be supported together with MPLSoGRE and MPLSoUDP.
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()``).
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.
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.
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.
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.
152 - E-Switch decapsulation Flow:
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.
158 - E-Switch encapsulation Flow:
160 - can be applied to VF ports only.
161 - must specify PF port action (packet redirection from VF to PF).
163 - ICMP/ICMP6 code/type matching cannot be supported togeter with IP-in-IP tunnel.
168 MLX5 supports various of methods to report statistics:
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.
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.
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.
182 These options can be modified in the ``.config`` file.
184 - ``CONFIG_RTE_LIBRTE_MLX5_PMD`` (default **n**)
186 Toggle compilation of librte_pmd_mlx5 itself.
188 - ``CONFIG_RTE_IBVERBS_LINK_DLOPEN`` (default **n**)
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.
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)``.
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 (``""``).
205 This option has no performance impact.
207 - ``CONFIG_RTE_IBVERBS_LINK_STATIC`` (default **n**)
209 Embed static flavor of the dependencies **libibverbs** and **libmlx5**
210 in the PMD shared library or the executable static binary.
212 - ``CONFIG_RTE_LIBRTE_MLX5_DEBUG`` (default **n**)
214 Toggle debugging code and stricter compilation flags. Enabling this option
215 adds additional run-time checks and debugging messages at the cost of
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.
225 Environment variables
226 ~~~~~~~~~~~~~~~~~~~~~
230 A list of directories in which to search for the rdma-core "glue" plug-in,
231 separated by colons or semi-colons.
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.
237 - ``MLX5_SHUT_UP_BF``
239 Configures HW Tx doorbell register as IO-mapped.
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.
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
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
254 Run-time configuration
255 ~~~~~~~~~~~~~~~~~~~~~~
257 - librte_pmd_mlx5 brings kernel network interfaces up during initialization
258 because it is affected by their state. Forcing them down prevents packets
261 - **ethtool** operations on related kernel interfaces also affect the PMD.
263 - ``rxq_cqe_comp_en`` parameter [int]
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.
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.
273 - ``rxq_cqe_pad_en`` parameter [int]
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.
289 - CPU having 128B cacheline with ConnectX-5 and BlueField.
291 - ``rxq_pkt_pad_en`` parameter [int]
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
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.
304 - ``mprq_en`` parameter [int]
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
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.
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.
324 - ``mprq_log_stride_num`` parameter [int]
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.
332 The size of Rx queue should be bigger than the number of strides.
334 - ``mprq_max_memcpy_len`` parameter [int]
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.
345 - ``rxqs_min_mprq`` parameter [int]
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
351 - ``txq_inline`` parameter [int]
353 Amount of data to be inlined during TX operations. This parameter is
354 deprecated and ignored, kept for compatibility issue.
356 - ``txqs_min_inline`` parameter [int]
358 Enable inline send only when the number of TX queues is greater or equal
361 This option should be used in combination with ``txq_inline`` above.
363 On ConnectX-4, ConnectX-4 LX, ConnectX-5, ConnectX-6 and BlueField without
366 - Disabled by default.
367 - In case ``txq_inline`` is set recommendation is 4.
369 On ConnectX-5, ConnectX-6 and BlueField with Enhanced MPW:
371 - Set to 8 by default.
373 - ``txqs_max_vec`` parameter [int]
375 Enable vectorized Tx only when the number of TX queues is less than or
376 equal to this value. This parameter is deprecated and ignored, kept
377 for compatibility issue to not prevent driver from probing.
379 - ``txq_mpw_en`` parameter [int]
381 A nonzero value enables multi-packet send (MPS) for ConnectX-4 Lx and
382 enhanced multi-packet send (Enhanced MPS) for ConnectX-5, ConnectX-6 and BlueField.
383 MPS allows the TX burst function to pack up multiple packets in a
384 single descriptor session in order to save PCI bandwidth and improve
385 performance at the cost of a slightly higher CPU usage. When
386 ``txq_inline`` is set along with ``txq_mpw_en``, TX burst function tries
387 to copy entire packet data on to TX descriptor instead of including
388 pointer of packet only if there is enough room remained in the
389 descriptor. ``txq_inline`` sets per-descriptor space for either pointers
390 or inlined packets. In addition, Enhanced MPS supports hybrid mode -
391 mixing inlined packets and pointers in the same descriptor.
393 This option cannot be used with certain offloads such as ``DEV_TX_OFFLOAD_TCP_TSO,
394 DEV_TX_OFFLOAD_VXLAN_TNL_TSO, DEV_TX_OFFLOAD_GRE_TNL_TSO, DEV_TX_OFFLOAD_VLAN_INSERT``.
395 When those offloads are requested the MPS send function will not be used.
397 It is currently only supported on the ConnectX-4 Lx, ConnectX-5, ConnectX-6 and BlueField
398 families of adapters.
399 On ConnectX-4 Lx the MPW is considered un-secure hence disabled by default.
400 Users which enable the MPW should be aware that application which provides incorrect
401 mbuf descriptors in the Tx burst can lead to serious errors in the host including, on some cases,
403 On ConnectX-5, ConnectX-6 and BlueField the MPW is secure and enabled by default.
405 - ``txq_mpw_hdr_dseg_en`` parameter [int]
407 A nonzero value enables including two pointers in the first block of TX
408 descriptor. The parameter is deprecated and ignored, kept for compatibility
411 Effective only when Enhanced MPS is supported. Disabled by default.
413 - ``txq_max_inline_len`` parameter [int]
415 Maximum size of packet to be inlined. This limits the size of packet to
416 be inlined. If the size of a packet is larger than configured value, the
417 packet isn't inlined even though there's enough space remained in the
418 descriptor. Instead, the packet is included with pointer. This parameter
421 - ``tx_vec_en`` parameter [int]
423 A nonzero value enables Tx vector on ConnectX-5, ConnectX-6 and BlueField
424 NICs if the number of global Tx queues on the port is less than
425 ``txqs_max_vec``. The parameter is deprecated and ignored.
427 This option cannot be used with certain offloads such as ``DEV_TX_OFFLOAD_TCP_TSO,
428 DEV_TX_OFFLOAD_VXLAN_TNL_TSO, DEV_TX_OFFLOAD_GRE_TNL_TSO, DEV_TX_OFFLOAD_VLAN_INSERT``.
429 When those offloads are requested the MPS send function will not be used.
431 Enabled by default on ConnectX-5, ConnectX-6 and BlueField.
433 - ``rx_vec_en`` parameter [int]
435 A nonzero value enables Rx vector if the port is not configured in
436 multi-segment otherwise this parameter is ignored.
440 - ``vf_nl_en`` parameter [int]
442 A nonzero value enables Netlink requests from the VF to add/remove MAC
443 addresses or/and enable/disable promiscuous/all multicast on the Netdevice.
444 Otherwise the relevant configuration must be run with Linux iproute2 tools.
445 This is a prerequisite to receive this kind of traffic.
447 Enabled by default, valid only on VF devices ignored otherwise.
449 - ``l3_vxlan_en`` parameter [int]
451 A nonzero value allows L3 VXLAN and VXLAN-GPE flow creation. To enable
452 L3 VXLAN or VXLAN-GPE, users has to configure firmware and enable this
453 parameter. This is a prerequisite to receive this kind of traffic.
457 - ``dv_flow_en`` parameter [int]
459 A nonzero value enables the DV flow steering assuming it is supported
464 - ``dv_esw_en`` parameter [int]
466 A nonzero value enables E-Switch using Direct Rules.
468 Enabled by default if supported.
470 - ``mr_ext_memseg_en`` parameter [int]
472 A nonzero value enables extending memseg when registering DMA memory. If
473 enabled, the number of entries in MR (Memory Region) lookup table on datapath
474 is minimized and it benefits performance. On the other hand, it worsens memory
475 utilization because registered memory is pinned by kernel driver. Even if a
476 page in the extended chunk is freed, that doesn't become reusable until the
477 entire memory is freed.
481 - ``representor`` parameter [list]
483 This parameter can be used to instantiate DPDK Ethernet devices from
484 existing port (or VF) representors configured on the device.
486 It is a standard parameter whose format is described in
487 :ref:`ethernet_device_standard_device_arguments`.
489 For instance, to probe port representors 0 through 2::
493 - ``max_dump_files_num`` parameter [int]
495 The maximum number of files per PMD entity that may be created for debug information.
496 The files will be created in /var/log directory or in current directory.
498 set to 128 by default.
500 Firmware configuration
501 ~~~~~~~~~~~~~~~~~~~~~~
503 - L3 VXLAN and VXLAN-GPE destination UDP port
505 .. code-block:: console
507 mlxconfig -d <mst device> set IP_OVER_VXLAN_EN=1
508 mlxconfig -d <mst device> set IP_OVER_VXLAN_PORT=<udp dport>
510 Verify configurations are set:
512 .. code-block:: console
514 mlxconfig -d <mst device> query | grep IP_OVER_VXLAN
515 IP_OVER_VXLAN_EN True(1)
516 IP_OVER_VXLAN_PORT <udp dport>
518 - enable ICMP/ICMP6's code/type field matching
520 .. code-block:: console
522 mlxconfig -d <mst device> set FLEX_PARSER_PROFILE_ENABLE=2
524 Verify configurations are set:
526 .. code-block:: console
528 mlxconfig -d <mst device> query | grep FLEX_PARSER_PROFILE_ENABLE
529 FLEX_PARSER_PROFILE_ENABLE 2
531 - IP-in-IP tunnel enable
533 .. code-block:: console
535 mlxconfig -d <mst device> set FLEX_PARSER_PROFILE_ENABLE=0
537 Verify configurations are set:
539 .. code-block:: console
541 mlxconfig -d <mst device> query | grep FLEX_PARSER_PROFILE_ENABLE
542 FLEX_PARSER_PROFILE_ENABLE 0
547 This driver relies on external libraries and kernel drivers for resources
548 allocations and initialization. The following dependencies are not part of
549 DPDK and must be installed separately:
553 User space Verbs framework used by librte_pmd_mlx5. This library provides
554 a generic interface between the kernel and low-level user space drivers
557 It allows slow and privileged operations (context initialization, hardware
558 resources allocations) to be managed by the kernel and fast operations to
559 never leave user space.
563 Low-level user space driver library for Mellanox
564 ConnectX-4/ConnectX-5/ConnectX-6/BlueField devices, it is automatically loaded
567 This library basically implements send/receive calls to the hardware
572 They provide the kernel-side Verbs API and low level device drivers that
573 manage actual hardware initialization and resources sharing with user
576 Unlike most other PMDs, these modules must remain loaded and bound to
579 - mlx5_core: hardware driver managing Mellanox
580 ConnectX-4/ConnectX-5/ConnectX-6/BlueField devices and related Ethernet kernel
582 - mlx5_ib: InifiniBand device driver.
583 - ib_uverbs: user space driver for Verbs (entry point for libibverbs).
585 - **Firmware update**
587 Mellanox OFED/EN releases include firmware updates for
588 ConnectX-4/ConnectX-5/ConnectX-6/BlueField adapters.
590 Because each release provides new features, these updates must be applied to
591 match the kernel modules and libraries they come with.
595 Both libraries are BSD and GPL licensed. Linux kernel modules are GPL
601 Either RDMA Core library with a recent enough Linux kernel release
602 (recommended) or Mellanox OFED/EN, which provides compatibility with older
605 RDMA Core with Linux Kernel
606 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
608 - Minimal kernel version : v4.14 or the most recent 4.14-rc (see `Linux installation documentation`_)
609 - Minimal rdma-core version: v15+ commit 0c5f5765213a ("Merge pull request #227 from yishaih/tm")
610 (see `RDMA Core installation documentation`_)
611 - When building for i686 use:
613 - rdma-core version 18.0 or above built with 32bit support.
614 - Kernel version 4.14.41 or above.
616 - Starting with rdma-core v21, static libraries can be built::
619 CFLAGS=-fPIC cmake -DIN_PLACE=1 -DENABLE_STATIC=1 -GNinja ..
622 .. _`Linux installation documentation`: https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux-stable.git/plain/Documentation/admin-guide/README.rst
623 .. _`RDMA Core installation documentation`: https://raw.githubusercontent.com/linux-rdma/rdma-core/master/README.md
625 If rdma-core libraries are built but not installed, DPDK makefile can link them,
626 thanks to these environment variables:
628 - ``EXTRA_CFLAGS=-I/path/to/rdma-core/build/include``
629 - ``EXTRA_LDFLAGS=-L/path/to/rdma-core/build/lib``
630 - ``PKG_CONFIG_PATH=/path/to/rdma-core/build/lib/pkgconfig``
635 - Mellanox OFED version: ** 4.5, 4.6** /
636 Mellanox EN version: **4.5, 4.6**
639 - ConnectX-4: **12.21.1000** and above.
640 - ConnectX-4 Lx: **14.21.1000** and above.
641 - ConnectX-5: **16.21.1000** and above.
642 - ConnectX-5 Ex: **16.21.1000** and above.
643 - ConnectX-6: **20.99.5374** and above.
644 - BlueField: **18.25.1010** and above.
646 While these libraries and kernel modules are available on OpenFabrics
647 Alliance's `website <https://www.openfabrics.org/>`__ and provided by package
648 managers on most distributions, this PMD requires Ethernet extensions that
649 may not be supported at the moment (this is a work in progress).
652 <http://www.mellanox.com/page/products_dyn?product_family=26&mtag=linux>`__ and
654 <http://www.mellanox.com/page/products_dyn?product_family=27&mtag=linux>`__
655 include the necessary support and should be used in the meantime. For DPDK,
656 only libibverbs, libmlx5, mlnx-ofed-kernel packages and firmware updates are
657 required from that distribution.
661 Several versions of Mellanox OFED/EN are available. Installing the version
662 this DPDK release was developed and tested against is strongly
663 recommended. Please check the `prerequisites`_.
668 * Mellanox(R) ConnectX(R)-4 10G MCX4111A-XCAT (1x10G)
669 * Mellanox(R) ConnectX(R)-4 10G MCX4121A-XCAT (2x10G)
670 * Mellanox(R) ConnectX(R)-4 25G MCX4111A-ACAT (1x25G)
671 * Mellanox(R) ConnectX(R)-4 25G MCX4121A-ACAT (2x25G)
672 * Mellanox(R) ConnectX(R)-4 40G MCX4131A-BCAT (1x40G)
673 * Mellanox(R) ConnectX(R)-4 40G MCX413A-BCAT (1x40G)
674 * Mellanox(R) ConnectX(R)-4 40G MCX415A-BCAT (1x40G)
675 * Mellanox(R) ConnectX(R)-4 50G MCX4131A-GCAT (1x50G)
676 * Mellanox(R) ConnectX(R)-4 50G MCX413A-GCAT (1x50G)
677 * Mellanox(R) ConnectX(R)-4 50G MCX414A-BCAT (2x50G)
678 * Mellanox(R) ConnectX(R)-4 50G MCX415A-GCAT (2x50G)
679 * Mellanox(R) ConnectX(R)-4 50G MCX416A-BCAT (2x50G)
680 * Mellanox(R) ConnectX(R)-4 50G MCX416A-GCAT (2x50G)
681 * Mellanox(R) ConnectX(R)-4 50G MCX415A-CCAT (1x100G)
682 * Mellanox(R) ConnectX(R)-4 100G MCX416A-CCAT (2x100G)
683 * Mellanox(R) ConnectX(R)-4 Lx 10G MCX4121A-XCAT (2x10G)
684 * Mellanox(R) ConnectX(R)-4 Lx 25G MCX4121A-ACAT (2x25G)
685 * Mellanox(R) ConnectX(R)-5 100G MCX556A-ECAT (2x100G)
686 * Mellanox(R) ConnectX(R)-5 Ex EN 100G MCX516A-CDAT (2x100G)
688 Quick Start Guide on OFED/EN
689 ----------------------------
691 1. Download latest Mellanox OFED/EN. For more info check the `prerequisites`_.
694 2. Install the required libraries and kernel modules either by installing
695 only the required set, or by installing the entire Mellanox OFED/EN:
697 .. code-block:: console
699 ./mlnxofedinstall --upstream-libs --dpdk
701 3. Verify the firmware is the correct one:
703 .. code-block:: console
707 4. Verify all ports links are set to Ethernet:
709 .. code-block:: console
711 mlxconfig -d <mst device> query | grep LINK_TYPE
715 Link types may have to be configured to Ethernet:
717 .. code-block:: console
719 mlxconfig -d <mst device> set LINK_TYPE_P1/2=1/2/3
721 * LINK_TYPE_P1=<1|2|3> , 1=Infiniband 2=Ethernet 3=VPI(auto-sense)
723 For hypervisors verify SR-IOV is enabled on the NIC:
725 .. code-block:: console
727 mlxconfig -d <mst device> query | grep SRIOV_EN
730 If needed, set enable the set the relevant fields:
732 .. code-block:: console
734 mlxconfig -d <mst device> set SRIOV_EN=1 NUM_OF_VFS=16
735 mlxfwreset -d <mst device> reset
737 5. Restart the driver:
739 .. code-block:: console
741 /etc/init.d/openibd restart
745 .. code-block:: console
747 service openibd restart
749 If link type was changed, firmware must be reset as well:
751 .. code-block:: console
753 mlxfwreset -d <mst device> reset
755 For hypervisors, after reset write the sysfs number of virtual functions
758 To dynamically instantiate a given number of virtual functions (VFs):
760 .. code-block:: console
762 echo [num_vfs] > /sys/class/infiniband/mlx5_0/device/sriov_numvfs
764 6. Compile DPDK and you are ready to go. See instructions on
765 :ref:`Development Kit Build System <Development_Kit_Build_System>`
767 Enable switchdev mode
768 ---------------------
770 Switchdev mode is a mode in E-Switch, that binds between representor and VF.
771 Representor is a port in DPDK that is connected to a VF in such a way
772 that assuming there are no offload flows, each packet that is sent from the VF
773 will be received by the corresponding representor. While each packet that is
774 sent to a representor will be received by the VF.
775 This is very useful in case of SRIOV mode, where the first packet that is sent
776 by the VF will be received by the DPDK application which will decide if this
777 flow should be offloaded to the E-Switch. After offloading the flow packet
778 that the VF that are matching the flow will not be received any more by
779 the DPDK application.
781 1. Enable SRIOV mode:
783 .. code-block:: console
785 mlxconfig -d <mst device> set SRIOV_EN=true
787 2. Configure the max number of VFs:
789 .. code-block:: console
791 mlxconfig -d <mst device> set NUM_OF_VFS=<num of vfs>
795 .. code-block:: console
797 mlxfwreset -d <mst device> reset
799 3. Configure the actual number of VFs:
801 .. code-block:: console
803 echo <num of vfs > /sys/class/net/<net device>/device/sriov_numvfs
805 4. Unbind the device (can be rebind after the switchdev mode):
807 .. code-block:: console
809 echo -n "<device pci address" > /sys/bus/pci/drivers/mlx5_core/unbind
811 5. Enbale switchdev mode:
813 .. code-block:: console
815 echo switchdev > /sys/class/net/<net device>/compat/devlink/mode
820 1. Configure aggressive CQE Zipping for maximum performance:
822 .. code-block:: console
824 mlxconfig -d <mst device> s CQE_COMPRESSION=1
826 To set it back to the default CQE Zipping mode use:
828 .. code-block:: console
830 mlxconfig -d <mst device> s CQE_COMPRESSION=0
832 2. In case of virtualization:
834 - Make sure that hypervisor kernel is 3.16 or newer.
835 - Configure boot with ``iommu=pt``.
837 - Make sure to allocate a VM on huge pages.
838 - Make sure to set CPU pinning.
840 3. Use the CPU near local NUMA node to which the PCIe adapter is connected,
841 for better performance. For VMs, verify that the right CPU
842 and NUMA node are pinned according to the above. Run:
844 .. code-block:: console
848 to identify the NUMA node to which the PCIe adapter is connected.
850 4. If more than one adapter is used, and root complex capabilities allow
851 to put both adapters on the same NUMA node without PCI bandwidth degradation,
852 it is recommended to locate both adapters on the same NUMA node.
853 This in order to forward packets from one to the other without
854 NUMA performance penalty.
856 5. Disable pause frames:
858 .. code-block:: console
860 ethtool -A <netdev> rx off tx off
862 6. Verify IO non-posted prefetch is disabled by default. This can be checked
863 via the BIOS configuration. Please contact you server provider for more
864 information about the settings.
868 On some machines, depends on the machine integrator, it is beneficial
869 to set the PCI max read request parameter to 1K. This can be
870 done in the following way:
872 To query the read request size use:
874 .. code-block:: console
876 setpci -s <NIC PCI address> 68.w
878 If the output is different than 3XXX, set it by:
880 .. code-block:: console
882 setpci -s <NIC PCI address> 68.w=3XXX
884 The XXX can be different on different systems. Make sure to configure
885 according to the setpci output.
887 7. To minimize overhead of searching Memory Regions:
889 - '--socket-mem' is recommended to pin memory by predictable amount.
890 - Configure per-lcore cache when creating Mempools for packet buffer.
891 - Refrain from dynamically allocating/freeing memory in run-time.
893 Supported hardware offloads using rte_flow API
894 ----------------------------------------------
896 .. _Supported hardware offloads using rte_flow API:
898 .. table:: Supported hardware offloads using rte_flow API
900 +-----------------------+-----------------+-----------------+
901 | Offload | E-Switch | NIC |
903 +=======================+=================+=================+
904 | Count | | DPDK 19.05 | | DPDK 19.02 |
905 | | | OFED 4.6 | | OFED 4.6 |
906 | | | RDMA-CORE V24 | | RDMA-CORE V23 |
907 | | | ConnectX-5 | | ConnectX-5 |
908 +-----------------------+-----------------+-----------------+
909 | Drop / Queue / RSS | | DPDK 19.05 | | DPDK 18.11 |
910 | | | OFED 4.6 | | OFED 4.5 |
911 | | | RDMA-CORE V24 | | RDMA-CORE V23 |
912 | | | ConnectX-5 | | ConnectX-4 |
913 +-----------------------+-----------------+-----------------+
914 | Encapsulation | | DPDK 19.05 | | DPDK 19.02 |
915 | (VXLAN / NVGRE / RAW) | | OFED 4.6.2 | | OFED 4.6 |
916 | | | RDMA-CORE V24 | | RDMA-CORE V23 |
917 | | | ConnectX-5 | | ConnectX-5 |
918 +-----------------------+-----------------+-----------------+
919 | Header rewrite | | DPDK 19.05 | | DPDK 19.02 |
920 | (set_ipv4_src / | | OFED 4.6.2 | | OFED 4.6.2 |
921 | set_ipv4_dst / | | RDMA-CORE V24 | | RDMA-CORE V23 |
922 | set_ipv6_src / | | ConnectX-5 | | ConnectX-5 |
923 | set_ipv6_dst / | | |
928 | set_mac_src / | | |
930 +-----------------------+-----------------+-----------------+
931 | Jump | | DPDK 19.05 | | DPDK 19.02 |
932 | | | OFED 4.6.2 | | OFED 4.6.2 |
933 | | | RDMA-CORE V24 | | N/A |
934 | | | ConnectX-5 | | ConnectX-5 |
935 +-----------------------+-----------------+-----------------+
936 | Mark / Flag | | DPDK 19.05 | | DPDK 18.11 |
937 | | | OFED 4.6 | | OFED 4.5 |
938 | | | RDMA-CORE V24 | | RDMA-CORE V23 |
939 | | | ConnectX-5 | | ConnectX-4 |
940 +-----------------------+-----------------+-----------------+
941 | Port ID | | DPDK 19.05 | | N/A |
942 | | | OFED 4.6 | | N/A |
943 | | | RDMA-CORE V24 | | N/A |
944 | | | ConnectX-5 | | N/A |
945 +-----------------------+-----------------+-----------------+
947 * Minimum version for each component and nic.
952 Compared to librte_pmd_mlx4 that implements a single RSS configuration per
953 port, librte_pmd_mlx5 supports per-protocol RSS configuration.
955 Since ``testpmd`` defaults to IP RSS mode and there is currently no
956 command-line parameter to enable additional protocols (UDP and TCP as well
957 as IP), the following commands must be entered from its CLI to get the same
958 behavior as librte_pmd_mlx4:
960 .. code-block:: console
963 > port config all rss all
969 This section demonstrates how to launch **testpmd** with Mellanox
970 ConnectX-4/ConnectX-5/ConnectX-6/BlueField devices managed by librte_pmd_mlx5.
972 #. Load the kernel modules:
974 .. code-block:: console
976 modprobe -a ib_uverbs mlx5_core mlx5_ib
978 Alternatively if MLNX_OFED/MLNX_EN is fully installed, the following script
981 .. code-block:: console
983 /etc/init.d/openibd restart
987 User space I/O kernel modules (uio and igb_uio) are not used and do
988 not have to be loaded.
990 #. Make sure Ethernet interfaces are in working order and linked to kernel
991 verbs. Related sysfs entries should be present:
993 .. code-block:: console
995 ls -d /sys/class/net/*/device/infiniband_verbs/uverbs* | cut -d / -f 5
999 .. code-block:: console
1006 #. Optionally, retrieve their PCI bus addresses for whitelisting:
1008 .. code-block:: console
1011 for intf in eth2 eth3 eth4 eth5;
1013 (cd "/sys/class/net/${intf}/device/" && pwd -P);
1016 sed -n 's,.*/\(.*\),-w \1,p'
1020 .. code-block:: console
1027 #. Request huge pages:
1029 .. code-block:: console
1031 echo 1024 > /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages/nr_hugepages
1033 #. Start testpmd with basic parameters:
1035 .. code-block:: console
1037 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
1041 .. code-block:: console
1044 EAL: PCI device 0000:05:00.0 on NUMA socket 0
1045 EAL: probe driver: 15b3:1013 librte_pmd_mlx5
1046 PMD: librte_pmd_mlx5: PCI information matches, using device "mlx5_0" (VF: false)
1047 PMD: librte_pmd_mlx5: 1 port(s) detected
1048 PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:fe
1049 EAL: PCI device 0000:05:00.1 on NUMA socket 0
1050 EAL: probe driver: 15b3:1013 librte_pmd_mlx5
1051 PMD: librte_pmd_mlx5: PCI information matches, using device "mlx5_1" (VF: false)
1052 PMD: librte_pmd_mlx5: 1 port(s) detected
1053 PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:ff
1054 EAL: PCI device 0000:06:00.0 on NUMA socket 0
1055 EAL: probe driver: 15b3:1013 librte_pmd_mlx5
1056 PMD: librte_pmd_mlx5: PCI information matches, using device "mlx5_2" (VF: false)
1057 PMD: librte_pmd_mlx5: 1 port(s) detected
1058 PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:fa
1059 EAL: PCI device 0000:06:00.1 on NUMA socket 0
1060 EAL: probe driver: 15b3:1013 librte_pmd_mlx5
1061 PMD: librte_pmd_mlx5: PCI information matches, using device "mlx5_3" (VF: false)
1062 PMD: librte_pmd_mlx5: 1 port(s) detected
1063 PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:fb
1064 Interactive-mode selected
1065 Configuring Port 0 (socket 0)
1066 PMD: librte_pmd_mlx5: 0x8cba80: TX queues number update: 0 -> 2
1067 PMD: librte_pmd_mlx5: 0x8cba80: RX queues number update: 0 -> 2
1068 Port 0: E4:1D:2D:E7:0C:FE
1069 Configuring Port 1 (socket 0)
1070 PMD: librte_pmd_mlx5: 0x8ccac8: TX queues number update: 0 -> 2
1071 PMD: librte_pmd_mlx5: 0x8ccac8: RX queues number update: 0 -> 2
1072 Port 1: E4:1D:2D:E7:0C:FF
1073 Configuring Port 2 (socket 0)
1074 PMD: librte_pmd_mlx5: 0x8cdb10: TX queues number update: 0 -> 2
1075 PMD: librte_pmd_mlx5: 0x8cdb10: RX queues number update: 0 -> 2
1076 Port 2: E4:1D:2D:E7:0C:FA
1077 Configuring Port 3 (socket 0)
1078 PMD: librte_pmd_mlx5: 0x8ceb58: TX queues number update: 0 -> 2
1079 PMD: librte_pmd_mlx5: 0x8ceb58: RX queues number update: 0 -> 2
1080 Port 3: E4:1D:2D:E7:0C:FB
1081 Checking link statuses...
1082 Port 0 Link Up - speed 40000 Mbps - full-duplex
1083 Port 1 Link Up - speed 40000 Mbps - full-duplex
1084 Port 2 Link Up - speed 10000 Mbps - full-duplex
1085 Port 3 Link Up - speed 10000 Mbps - full-duplex