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 in default configuration
24 of the "make" build. It can be enabled with ``CONFIG_RTE_LIBRTE_MLX5_PMD=y``
25 or by using "meson" build system which will detect dependencies.
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 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 The PMD can use libibverbs and libmlx5 to access the device firmware
48 or directly the hardware components.
49 There are different levels of objects and bypassing abilities
50 to get the best performances:
52 - Verbs is a complete high-level generic API
53 - Direct Verbs is a device-specific API
54 - DevX allows to access firmware objects
55 - Direct Rules manages flow steering at low-level hardware layer
57 Enabling librte_pmd_mlx5 causes DPDK applications to be linked against
63 - Multi arch support: x86_64, POWER8, ARMv8, i686.
64 - Multiple TX and RX queues.
65 - Support for scattered TX and RX frames.
66 - IPv4, IPv6, TCPv4, TCPv6, UDPv4 and UDPv6 RSS on any number of queues.
67 - Several RSS hash keys, one for each flow type.
68 - Default RSS operation with no hash key specification.
69 - Configurable RETA table.
70 - Link flow control (pause frame).
71 - Support for multiple MAC addresses.
75 - RX CRC stripping configuration.
76 - Promiscuous mode on PF and VF.
77 - Multicast promiscuous mode on PF and VF.
78 - Hardware checksum offloads.
79 - Flow director (RTE_FDIR_MODE_PERFECT, RTE_FDIR_MODE_PERFECT_MAC_VLAN and
81 - Flow API, including :ref:`flow_isolated_mode`.
83 - KVM and VMware ESX SR-IOV modes are supported.
84 - RSS hash result is supported.
85 - Hardware TSO for generic IP or UDP tunnel, including VXLAN and GRE.
86 - Hardware checksum Tx offload for generic IP or UDP tunnel, including VXLAN and GRE.
88 - Statistics query including Basic, Extended and per queue.
90 - Tunnel types: VXLAN, L3 VXLAN, VXLAN-GPE, GRE, MPLSoGRE, MPLSoUDP, IP-in-IP.
91 - Tunnel HW offloads: packet type, inner/outer RSS, IP and UDP checksum verification.
92 - NIC HW offloads: encapsulation (vxlan, gre, mplsoudp, mplsogre), NAT, routing, TTL
93 increment/decrement, count, drop, mark. For details please see :ref:`mlx5_offloads_support`.
94 - Flow insertion rate of more then million flows per second, when using Direct Rules.
95 - Support for multiple rte_flow groups.
101 - For secondary process:
103 - Forked secondary process not supported.
104 - External memory unregistered in EAL memseg list cannot be used for DMA
105 unless such memory has been registered by ``mlx5_mr_update_ext_mp()`` in
106 primary process and remapped to the same virtual address in secondary
107 process. If the external memory is registered by primary process but has
108 different virtual address in secondary process, unexpected error may happen.
110 - Flow pattern without any specific vlan will match for vlan packets as well:
112 When VLAN spec is not specified in the pattern, the matching rule will be created with VLAN as a wild card.
113 Meaning, the flow rule::
115 flow create 0 ingress pattern eth / vlan vid is 3 / ipv4 / end ...
117 Will only match vlan packets with vid=3. and the flow rules::
119 flow create 0 ingress pattern eth / ipv4 / end ...
123 flow create 0 ingress pattern eth / vlan / ipv4 / end ...
125 Will match any ipv4 packet (VLAN included).
127 - VLAN pop offload command:
129 - Flow rules having a VLAN pop offload command as one of their actions and
130 are lacking a match on VLAN as one of their items are not supported.
131 - The command is not supported on egress traffic.
133 - VLAN push offload is not supported on ingress traffic.
135 - VLAN set PCP offload is not supported on existing headers.
137 - A multi segment packet must have not more segments than reported by dev_infos_get()
138 in tx_desc_lim.nb_seg_max field. This value depends on maximal supported Tx descriptor
139 size and ``txq_inline_min`` settings and may be from 2 (worst case forced by maximal
140 inline settings) to 58.
142 - Flows with a VXLAN Network Identifier equal (or ends to be equal)
143 to 0 are not supported.
145 - VXLAN TSO and checksum offloads are not supported on VM.
147 - L3 VXLAN and VXLAN-GPE tunnels cannot be supported together with MPLSoGRE and MPLSoUDP.
149 - VF: flow rules created on VF devices can only match traffic targeted at the
150 configured MAC addresses (see ``rte_eth_dev_mac_addr_add()``).
154 MAC addresses not already present in the bridge table of the associated
155 kernel network device will be added and cleaned up by the PMD when closing
156 the device. In case of ungraceful program termination, some entries may
157 remain present and should be removed manually by other means.
159 - When Multi-Packet Rx queue is configured (``mprq_en``), a Rx packet can be
160 externally attached to a user-provided mbuf with having EXT_ATTACHED_MBUF in
161 ol_flags. As the mempool for the external buffer is managed by PMD, all the
162 Rx mbufs must be freed before the device is closed. Otherwise, the mempool of
163 the external buffers will be freed by PMD and the application which still
164 holds the external buffers may be corrupted.
166 - If Multi-Packet Rx queue is configured (``mprq_en``) and Rx CQE compression is
167 enabled (``rxq_cqe_comp_en``) at the same time, RSS hash result is not fully
168 supported. Some Rx packets may not have PKT_RX_RSS_HASH.
170 - IPv6 Multicast messages are not supported on VM, while promiscuous mode
171 and allmulticast mode are both set to off.
172 To receive IPv6 Multicast messages on VM, explicitly set the relevant
173 MAC address using rte_eth_dev_mac_addr_add() API.
175 - The amount of descriptors in Tx queue may be limited by data inline settings.
176 Inline data require the more descriptor building blocks and overall block
177 amount may exceed the hardware supported limits. The application should
178 reduce the requested Tx size or adjust data inline settings with
179 ``txq_inline_max`` and ``txq_inline_mpw`` devargs keys.
181 - E-Switch decapsulation Flow:
183 - can be applied to PF port only.
184 - must specify VF port action (packet redirection from PF to VF).
185 - optionally may specify tunnel inner source and destination MAC addresses.
187 - E-Switch encapsulation Flow:
189 - can be applied to VF ports only.
190 - must specify PF port action (packet redirection from VF to PF).
192 - ICMP/ICMP6 code/type matching, IP-in-IP and MPLS flow matching are all
193 mutually exclusive features which cannot be supported together
194 (see :ref:`mlx5_firmware_config`).
198 - Requires DevX to be enabled.
199 - KEEP_CRC offload cannot be supported with LRO.
200 - The first mbuf length, without head-room, must be big enough to include the
206 MLX5 supports various methods to report statistics:
208 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.
210 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.
212 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.
220 These options can be modified in the ``.config`` file.
222 - ``CONFIG_RTE_LIBRTE_MLX5_PMD`` (default **n**)
224 Toggle compilation of librte_pmd_mlx5 itself.
226 - ``CONFIG_RTE_IBVERBS_LINK_DLOPEN`` (default **n**)
228 Build PMD with additional code to make it loadable without hard
229 dependencies on **libibverbs** nor **libmlx5**, which may not be installed
230 on the target system.
232 In this mode, their presence is still required for it to run properly,
233 however their absence won't prevent a DPDK application from starting (with
234 ``CONFIG_RTE_BUILD_SHARED_LIB`` disabled) and they won't show up as
235 missing with ``ldd(1)``.
237 It works by moving these dependencies to a purpose-built rdma-core "glue"
238 plug-in which must either be installed in a directory whose name is based
239 on ``CONFIG_RTE_EAL_PMD_PATH`` suffixed with ``-glue`` if set, or in a
240 standard location for the dynamic linker (e.g. ``/lib``) if left to the
241 default empty string (``""``).
243 This option has no performance impact.
245 - ``CONFIG_RTE_IBVERBS_LINK_STATIC`` (default **n**)
247 Embed static flavor of the dependencies **libibverbs** and **libmlx5**
248 in the PMD shared library or the executable static binary.
250 - ``CONFIG_RTE_LIBRTE_MLX5_DEBUG`` (default **n**)
252 Toggle debugging code and stricter compilation flags. Enabling this option
253 adds additional run-time checks and debugging messages at the cost of
258 For BlueField, target should be set to ``arm64-bluefield-linux-gcc``. This
259 will enable ``CONFIG_RTE_LIBRTE_MLX5_PMD`` and set ``RTE_CACHE_LINE_SIZE`` to
260 64. Default armv8a configuration of make build and meson build set it to 128
261 then brings performance degradation.
263 Environment variables
264 ~~~~~~~~~~~~~~~~~~~~~
268 A list of directories in which to search for the rdma-core "glue" plug-in,
269 separated by colons or semi-colons.
271 Only matters when compiled with ``CONFIG_RTE_IBVERBS_LINK_DLOPEN``
272 enabled and most useful when ``CONFIG_RTE_EAL_PMD_PATH`` is also set,
273 since ``LD_LIBRARY_PATH`` has no effect in this case.
275 - ``MLX5_SHUT_UP_BF``
277 Configures HW Tx doorbell register as IO-mapped.
279 By default, the HW Tx doorbell is configured as a write-combining register.
280 The register would be flushed to HW usually when the write-combining buffer
281 becomes full, but it depends on CPU design.
283 Except for vectorized Tx burst routines, a write memory barrier is enforced
284 after updating the register so that the update can be immediately visible to
287 When vectorized Tx burst is called, the barrier is set only if the burst size
288 is not aligned to MLX5_VPMD_TX_MAX_BURST. However, setting this environmental
289 variable will bring better latency even though the maximum throughput can
292 Run-time configuration
293 ~~~~~~~~~~~~~~~~~~~~~~
295 - librte_pmd_mlx5 brings kernel network interfaces up during initialization
296 because it is affected by their state. Forcing them down prevents packets
299 - **ethtool** operations on related kernel interfaces also affect the PMD.
301 - ``rxq_cqe_comp_en`` parameter [int]
303 A nonzero value enables the compression of CQE on RX side. This feature
304 allows to save PCI bandwidth and improve performance. Enabled by default.
308 - x86_64 with ConnectX-4, ConnectX-4 LX, ConnectX-5, ConnectX-6 and BlueField.
309 - POWER9 and ARMv8 with ConnectX-4 LX, ConnectX-5, ConnectX-6 and BlueField.
311 - ``rxq_cqe_pad_en`` parameter [int]
313 A nonzero value enables 128B padding of CQE on RX side. The size of CQE
314 is aligned with the size of a cacheline of the core. If cacheline size is
315 128B, the CQE size is configured to be 128B even though the device writes
316 only 64B data on the cacheline. This is to avoid unnecessary cache
317 invalidation by device's two consecutive writes on to one cacheline.
318 However in some architecture, it is more beneficial to update entire
319 cacheline with padding the rest 64B rather than striding because
320 read-modify-write could drop performance a lot. On the other hand,
321 writing extra data will consume more PCIe bandwidth and could also drop
322 the maximum throughput. It is recommended to empirically set this
323 parameter. Disabled by default.
327 - CPU having 128B cacheline with ConnectX-5 and BlueField.
329 - ``rxq_pkt_pad_en`` parameter [int]
331 A nonzero value enables padding Rx packet to the size of cacheline on PCI
332 transaction. This feature would waste PCI bandwidth but could improve
333 performance by avoiding partial cacheline write which may cause costly
334 read-modify-copy in memory transaction on some architectures. Disabled by
339 - x86_64 with ConnectX-4, ConnectX-4 LX, ConnectX-5, ConnectX-6 and BlueField.
340 - POWER8 and ARMv8 with ConnectX-4 LX, ConnectX-5, ConnectX-6 and BlueField.
342 - ``mprq_en`` parameter [int]
344 A nonzero value enables configuring Multi-Packet Rx queues. Rx queue is
345 configured as Multi-Packet RQ if the total number of Rx queues is
346 ``rxqs_min_mprq`` or more and Rx scatter isn't configured. Disabled by
349 Multi-Packet Rx Queue (MPRQ a.k.a Striding RQ) can further save PCIe bandwidth
350 by posting a single large buffer for multiple packets. Instead of posting a
351 buffers per a packet, one large buffer is posted in order to receive multiple
352 packets on the buffer. A MPRQ buffer consists of multiple fixed-size strides
353 and each stride receives one packet. MPRQ can improve throughput for
354 small-packet traffic.
356 When MPRQ is enabled, max_rx_pkt_len can be larger than the size of
357 user-provided mbuf even if DEV_RX_OFFLOAD_SCATTER isn't enabled. PMD will
358 configure large stride size enough to accommodate max_rx_pkt_len as long as
359 device allows. Note that this can waste system memory compared to enabling Rx
360 scatter and multi-segment packet.
362 - ``mprq_log_stride_num`` parameter [int]
364 Log 2 of the number of strides for Multi-Packet Rx queue. Configuring more
365 strides can reduce PCIe traffic further. If configured value is not in the
366 range of device capability, the default value will be set with a warning
367 message. The default value is 4 which is 16 strides per a buffer, valid only
368 if ``mprq_en`` is set.
370 The size of Rx queue should be bigger than the number of strides.
372 - ``mprq_max_memcpy_len`` parameter [int]
374 The maximum length of packet to memcpy in case of Multi-Packet Rx queue. Rx
375 packet is mem-copied to a user-provided mbuf if the size of Rx packet is less
376 than or equal to this parameter. Otherwise, PMD will attach the Rx packet to
377 the mbuf by external buffer attachment - ``rte_pktmbuf_attach_extbuf()``.
378 A mempool for external buffers will be allocated and managed by PMD. If Rx
379 packet is externally attached, ol_flags field of the mbuf will have
380 EXT_ATTACHED_MBUF and this flag must be preserved. ``RTE_MBUF_HAS_EXTBUF()``
381 checks the flag. The default value is 128, valid only if ``mprq_en`` is set.
383 - ``rxqs_min_mprq`` parameter [int]
385 Configure Rx queues as Multi-Packet RQ if the total number of Rx queues is
386 greater or equal to this value. The default value is 12, valid only if
389 - ``txq_inline`` parameter [int]
391 Amount of data to be inlined during TX operations. This parameter is
392 deprecated and converted to the new parameter ``txq_inline_max`` providing
393 partial compatibility.
395 - ``txqs_min_inline`` parameter [int]
397 Enable inline data send only when the number of TX queues is greater or equal
400 This option should be used in combination with ``txq_inline_max`` and
401 ``txq_inline_mpw`` below and does not affect ``txq_inline_min`` settings above.
403 If this option is not specified the default value 16 is used for BlueField
404 and 8 for other platforms
406 The data inlining consumes the CPU cycles, so this option is intended to
407 auto enable inline data if we have enough Tx queues, which means we have
408 enough CPU cores and PCI bandwidth is getting more critical and CPU
409 is not supposed to be bottleneck anymore.
411 The copying data into WQE improves latency and can improve PPS performance
412 when PCI back pressure is detected and may be useful for scenarios involving
413 heavy traffic on many queues.
415 Because additional software logic is necessary to handle this mode, this
416 option should be used with care, as it may lower performance when back
417 pressure is not expected.
419 If inline data are enabled it may affect the maximal size of Tx queue in
420 descriptors because the inline data increase the descriptor size and
421 queue size limits supported by hardware may be exceeded.
423 - ``txq_inline_min`` parameter [int]
425 Minimal amount of data to be inlined into WQE during Tx operations. NICs
426 may require this minimal data amount to operate correctly. The exact value
427 may depend on NIC operation mode, requested offloads, etc. It is strongly
428 recommended to omit this parameter and use the default values. Anyway,
429 applications using this parameter should take into consideration that
430 specifying an inconsistent value may prevent the NIC from sending packets.
432 If ``txq_inline_min`` key is present the specified value (may be aligned
433 by the driver in order not to exceed the limits and provide better descriptor
434 space utilization) will be used by the driver and it is guaranteed that
435 requested amount of data bytes are inlined into the WQE beside other inline
436 settings. This key also may update ``txq_inline_max`` value (default
437 or specified explicitly in devargs) to reserve the space for inline data.
439 If ``txq_inline_min`` key is not present, the value may be queried by the
440 driver from the NIC via DevX if this feature is available. If there is no DevX
441 enabled/supported the value 18 (supposing L2 header including VLAN) is set
442 for ConnectX-4 and ConnectX-4LX, and 0 is set by default for ConnectX-5
443 and newer NICs. If packet is shorter the ``txq_inline_min`` value, the entire
446 For ConnectX-4 NIC, driver does not allow specifying value below 18
447 (minimal L2 header, including VLAN), error will be raised.
449 For ConnectX-4LX NIC, it is allowed to specify values below 18, but
450 it is not recommended and may prevent NIC from sending packets over
453 Please, note, this minimal data inlining disengages eMPW feature (Enhanced
454 Multi-Packet Write), because last one does not support partial packet inlining.
455 This is not very critical due to minimal data inlining is mostly required
456 by ConnectX-4 and ConnectX-4 Lx, these NICs do not support eMPW feature.
458 - ``txq_inline_max`` parameter [int]
460 Specifies the maximal packet length to be completely inlined into WQE
461 Ethernet Segment for ordinary SEND method. If packet is larger than specified
462 value, the packet data won't be copied by the driver at all, data buffer
463 is addressed with a pointer. If packet length is less or equal all packet
464 data will be copied into WQE. This may improve PCI bandwidth utilization for
465 short packets significantly but requires the extra CPU cycles.
467 The data inline feature is controlled by number of Tx queues, if number of Tx
468 queues is larger than ``txqs_min_inline`` key parameter, the inline feature
469 is engaged, if there are not enough Tx queues (which means not enough CPU cores
470 and CPU resources are scarce), data inline is not performed by the driver.
471 Assigning ``txqs_min_inline`` with zero always enables the data inline.
473 The default ``txq_inline_max`` value is 290. The specified value may be adjusted
474 by the driver in order not to exceed the limit (930 bytes) and to provide better
475 WQE space filling without gaps, the adjustment is reflected in the debug log.
476 Also, the default value (290) may be decreased in run-time if the large transmit
477 queue size is requested and hardware does not support enough descriptor
478 amount, in this case warning is emitted. If ``txq_inline_max`` key is
479 specified and requested inline settings can not be satisfied then error
482 - ``txq_inline_mpw`` parameter [int]
484 Specifies the maximal packet length to be completely inlined into WQE for
485 Enhanced MPW method. If packet is large the specified value, the packet data
486 won't be copied, and data buffer is addressed with pointer. If packet length
487 is less or equal, all packet data will be copied into WQE. This may improve PCI
488 bandwidth utilization for short packets significantly but requires the extra
491 The data inline feature is controlled by number of TX queues, if number of Tx
492 queues is larger than ``txqs_min_inline`` key parameter, the inline feature
493 is engaged, if there are not enough Tx queues (which means not enough CPU cores
494 and CPU resources are scarce), data inline is not performed by the driver.
495 Assigning ``txqs_min_inline`` with zero always enables the data inline.
497 The default ``txq_inline_mpw`` value is 268. The specified value may be adjusted
498 by the driver in order not to exceed the limit (930 bytes) and to provide better
499 WQE space filling without gaps, the adjustment is reflected in the debug log.
500 Due to multiple packets may be included to the same WQE with Enhanced Multi
501 Packet Write Method and overall WQE size is limited it is not recommended to
502 specify large values for the ``txq_inline_mpw``. Also, the default value (268)
503 may be decreased in run-time if the large transmit queue size is requested
504 and hardware does not support enough descriptor amount, in this case warning
505 is emitted. If ``txq_inline_mpw`` key is specified and requested inline
506 settings can not be satisfied then error will be raised.
508 - ``txqs_max_vec`` parameter [int]
510 Enable vectorized Tx only when the number of TX queues is less than or
511 equal to this value. This parameter is deprecated and ignored, kept
512 for compatibility issue to not prevent driver from probing.
514 - ``txq_mpw_hdr_dseg_en`` parameter [int]
516 A nonzero value enables including two pointers in the first block of TX
517 descriptor. The parameter is deprecated and ignored, kept for compatibility
520 - ``txq_max_inline_len`` parameter [int]
522 Maximum size of packet to be inlined. This limits the size of packet to
523 be inlined. If the size of a packet is larger than configured value, the
524 packet isn't inlined even though there's enough space remained in the
525 descriptor. Instead, the packet is included with pointer. This parameter
526 is deprecated and converted directly to ``txq_inline_mpw`` providing full
527 compatibility. Valid only if eMPW feature is engaged.
529 - ``txq_mpw_en`` parameter [int]
531 A nonzero value enables Enhanced Multi-Packet Write (eMPW) for ConnectX-5,
532 ConnectX-6 and BlueField. eMPW allows the TX burst function to pack up multiple
533 packets in a single descriptor session in order to save PCI bandwidth and improve
534 performance at the cost of a slightly higher CPU usage. When ``txq_inline_mpw``
535 is set along with ``txq_mpw_en``, TX burst function copies entire packet
536 data on to TX descriptor instead of including pointer of packet.
538 The Enhanced Multi-Packet Write feature is enabled by default if NIC supports
539 it, can be disabled by explicit specifying 0 value for ``txq_mpw_en`` option.
540 Also, if minimal data inlining is requested by non-zero ``txq_inline_min``
541 option or reported by the NIC, the eMPW feature is disengaged.
543 - ``tx_vec_en`` parameter [int]
545 A nonzero value enables Tx vector on ConnectX-5, ConnectX-6 and BlueField
546 NICs if the number of global Tx queues on the port is less than
547 ``txqs_max_vec``. The parameter is deprecated and ignored.
549 - ``rx_vec_en`` parameter [int]
551 A nonzero value enables Rx vector if the port is not configured in
552 multi-segment otherwise this parameter is ignored.
556 - ``vf_nl_en`` parameter [int]
558 A nonzero value enables Netlink requests from the VF to add/remove MAC
559 addresses or/and enable/disable promiscuous/all multicast on the Netdevice.
560 Otherwise the relevant configuration must be run with Linux iproute2 tools.
561 This is a prerequisite to receive this kind of traffic.
563 Enabled by default, valid only on VF devices ignored otherwise.
565 - ``l3_vxlan_en`` parameter [int]
567 A nonzero value allows L3 VXLAN and VXLAN-GPE flow creation. To enable
568 L3 VXLAN or VXLAN-GPE, users has to configure firmware and enable this
569 parameter. This is a prerequisite to receive this kind of traffic.
573 - ``dv_flow_en`` parameter [int]
575 A nonzero value enables the DV flow steering assuming it is supported
580 - ``dv_esw_en`` parameter [int]
582 A nonzero value enables E-Switch using Direct Rules.
584 Enabled by default if supported.
586 - ``mr_ext_memseg_en`` parameter [int]
588 A nonzero value enables extending memseg when registering DMA memory. If
589 enabled, the number of entries in MR (Memory Region) lookup table on datapath
590 is minimized and it benefits performance. On the other hand, it worsens memory
591 utilization because registered memory is pinned by kernel driver. Even if a
592 page in the extended chunk is freed, that doesn't become reusable until the
593 entire memory is freed.
597 - ``representor`` parameter [list]
599 This parameter can be used to instantiate DPDK Ethernet devices from
600 existing port (or VF) representors configured on the device.
602 It is a standard parameter whose format is described in
603 :ref:`ethernet_device_standard_device_arguments`.
605 For instance, to probe port representors 0 through 2::
609 - ``max_dump_files_num`` parameter [int]
611 The maximum number of files per PMD entity that may be created for debug information.
612 The files will be created in /var/log directory or in current directory.
614 set to 128 by default.
616 - ``lro_timeout_usec`` parameter [int]
618 The maximum allowed duration of an LRO session, in micro-seconds.
619 PMD will set the nearest value supported by HW, which is not bigger than
620 the input ``lro_timeout_usec`` value.
621 If this parameter is not specified, by default PMD will set
622 the smallest value supported by HW.
624 .. _mlx5_firmware_config:
626 Firmware configuration
627 ~~~~~~~~~~~~~~~~~~~~~~
629 Firmware features can be configured as key/value pairs.
631 The command to set a value is::
633 mlxconfig -d <device> set <key>=<value>
635 The command to query a value is::
637 mlxconfig -d <device> query | grep <key>
639 The device name for the command ``mlxconfig`` can be either the PCI address,
640 or the mst device name found with::
644 Below are some firmware configurations listed.
650 value: 1=Infiniband 2=Ethernet 3=VPI(auto-sense)
656 - maximum number of SR-IOV virtual functions::
660 - enable DevX (required by Direct Rules and other features)::
664 - aggressive CQE zipping::
668 - L3 VXLAN and VXLAN-GPE destination UDP port::
671 IP_OVER_VXLAN_PORT=<udp dport>
673 - enable IP-in-IP tunnel flow matching::
675 FLEX_PARSER_PROFILE_ENABLE=0
677 - enable MPLS flow matching::
679 FLEX_PARSER_PROFILE_ENABLE=1
681 - enable ICMP/ICMP6 code/type fields matching::
683 FLEX_PARSER_PROFILE_ENABLE=2
688 This driver relies on external libraries and kernel drivers for resources
689 allocations and initialization. The following dependencies are not part of
690 DPDK and must be installed separately:
694 User space Verbs framework used by librte_pmd_mlx5. This library provides
695 a generic interface between the kernel and low-level user space drivers
698 It allows slow and privileged operations (context initialization, hardware
699 resources allocations) to be managed by the kernel and fast operations to
700 never leave user space.
704 Low-level user space driver library for Mellanox
705 ConnectX-4/ConnectX-5/ConnectX-6/BlueField devices, it is automatically loaded
708 This library basically implements send/receive calls to the hardware
713 They provide the kernel-side Verbs API and low level device drivers that
714 manage actual hardware initialization and resources sharing with user
717 Unlike most other PMDs, these modules must remain loaded and bound to
720 - mlx5_core: hardware driver managing Mellanox
721 ConnectX-4/ConnectX-5/ConnectX-6/BlueField devices and related Ethernet kernel
723 - mlx5_ib: InifiniBand device driver.
724 - ib_uverbs: user space driver for Verbs (entry point for libibverbs).
726 - **Firmware update**
728 Mellanox OFED/EN releases include firmware updates for
729 ConnectX-4/ConnectX-5/ConnectX-6/BlueField adapters.
731 Because each release provides new features, these updates must be applied to
732 match the kernel modules and libraries they come with.
736 Both libraries are BSD and GPL licensed. Linux kernel modules are GPL
742 Either RDMA Core library with a recent enough Linux kernel release
743 (recommended) or Mellanox OFED/EN, which provides compatibility with older
746 RDMA Core with Linux Kernel
747 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
749 - Minimal kernel version : v4.14 or the most recent 4.14-rc (see `Linux installation documentation`_)
750 - Minimal rdma-core version: v15+ commit 0c5f5765213a ("Merge pull request #227 from yishaih/tm")
751 (see `RDMA Core installation documentation`_)
752 - When building for i686 use:
754 - rdma-core version 18.0 or above built with 32bit support.
755 - Kernel version 4.14.41 or above.
757 - Starting with rdma-core v21, static libraries can be built::
760 CFLAGS=-fPIC cmake -DIN_PLACE=1 -DENABLE_STATIC=1 -GNinja ..
763 .. _`Linux installation documentation`: https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux-stable.git/plain/Documentation/admin-guide/README.rst
764 .. _`RDMA Core installation documentation`: https://raw.githubusercontent.com/linux-rdma/rdma-core/master/README.md
766 If rdma-core libraries are built but not installed, DPDK makefile can link them,
767 thanks to these environment variables:
769 - ``EXTRA_CFLAGS=-I/path/to/rdma-core/build/include``
770 - ``EXTRA_LDFLAGS=-L/path/to/rdma-core/build/lib``
771 - ``PKG_CONFIG_PATH=/path/to/rdma-core/build/lib/pkgconfig``
776 - Mellanox OFED version: ** 4.5, 4.6** /
777 Mellanox EN version: **4.5, 4.6**
780 - ConnectX-4: **12.21.1000** and above.
781 - ConnectX-4 Lx: **14.21.1000** and above.
782 - ConnectX-5: **16.21.1000** and above.
783 - ConnectX-5 Ex: **16.21.1000** and above.
784 - ConnectX-6: **20.99.5374** and above.
785 - BlueField: **18.25.1010** and above.
787 While these libraries and kernel modules are available on OpenFabrics
788 Alliance's `website <https://www.openfabrics.org/>`__ and provided by package
789 managers on most distributions, this PMD requires Ethernet extensions that
790 may not be supported at the moment (this is a work in progress).
793 <http://www.mellanox.com/page/products_dyn?product_family=26&mtag=linux>`__ and
795 <http://www.mellanox.com/page/products_dyn?product_family=27&mtag=linux>`__
796 include the necessary support and should be used in the meantime. For DPDK,
797 only libibverbs, libmlx5, mlnx-ofed-kernel packages and firmware updates are
798 required from that distribution.
802 Several versions of Mellanox OFED/EN are available. Installing the version
803 this DPDK release was developed and tested against is strongly
804 recommended. Please check the `prerequisites`_.
809 * Mellanox(R) ConnectX(R)-4 10G MCX4111A-XCAT (1x10G)
810 * Mellanox(R) ConnectX(R)-4 10G MCX4121A-XCAT (2x10G)
811 * Mellanox(R) ConnectX(R)-4 25G MCX4111A-ACAT (1x25G)
812 * Mellanox(R) ConnectX(R)-4 25G MCX4121A-ACAT (2x25G)
813 * Mellanox(R) ConnectX(R)-4 40G MCX4131A-BCAT (1x40G)
814 * Mellanox(R) ConnectX(R)-4 40G MCX413A-BCAT (1x40G)
815 * Mellanox(R) ConnectX(R)-4 40G MCX415A-BCAT (1x40G)
816 * Mellanox(R) ConnectX(R)-4 50G MCX4131A-GCAT (1x50G)
817 * Mellanox(R) ConnectX(R)-4 50G MCX413A-GCAT (1x50G)
818 * Mellanox(R) ConnectX(R)-4 50G MCX414A-BCAT (2x50G)
819 * Mellanox(R) ConnectX(R)-4 50G MCX415A-GCAT (2x50G)
820 * Mellanox(R) ConnectX(R)-4 50G MCX416A-BCAT (2x50G)
821 * Mellanox(R) ConnectX(R)-4 50G MCX416A-GCAT (2x50G)
822 * Mellanox(R) ConnectX(R)-4 50G MCX415A-CCAT (1x100G)
823 * Mellanox(R) ConnectX(R)-4 100G MCX416A-CCAT (2x100G)
824 * Mellanox(R) ConnectX(R)-4 Lx 10G MCX4121A-XCAT (2x10G)
825 * Mellanox(R) ConnectX(R)-4 Lx 25G MCX4121A-ACAT (2x25G)
826 * Mellanox(R) ConnectX(R)-5 100G MCX556A-ECAT (2x100G)
827 * Mellanox(R) ConnectX(R)-5 Ex EN 100G MCX516A-CDAT (2x100G)
829 Quick Start Guide on OFED/EN
830 ----------------------------
832 1. Download latest Mellanox OFED/EN. For more info check the `prerequisites`_.
835 2. Install the required libraries and kernel modules either by installing
836 only the required set, or by installing the entire Mellanox OFED/EN::
838 ./mlnxofedinstall --upstream-libs --dpdk
840 3. Verify the firmware is the correct one::
844 4. Verify all ports links are set to Ethernet::
846 mlxconfig -d <mst device> query | grep LINK_TYPE
850 Link types may have to be configured to Ethernet::
852 mlxconfig -d <mst device> set LINK_TYPE_P1/2=1/2/3
854 * LINK_TYPE_P1=<1|2|3> , 1=Infiniband 2=Ethernet 3=VPI(auto-sense)
856 For hypervisors, verify SR-IOV is enabled on the NIC::
858 mlxconfig -d <mst device> query | grep SRIOV_EN
861 If needed, configure SR-IOV::
863 mlxconfig -d <mst device> set SRIOV_EN=1 NUM_OF_VFS=16
864 mlxfwreset -d <mst device> reset
866 5. Restart the driver::
868 /etc/init.d/openibd restart
872 service openibd restart
874 If link type was changed, firmware must be reset as well::
876 mlxfwreset -d <mst device> reset
878 For hypervisors, after reset write the sysfs number of virtual functions
881 To dynamically instantiate a given number of virtual functions (VFs)::
883 echo [num_vfs] > /sys/class/infiniband/mlx5_0/device/sriov_numvfs
885 6. Compile DPDK and you are ready to go. See instructions on
886 :ref:`Development Kit Build System <Development_Kit_Build_System>`
888 Enable switchdev mode
889 ---------------------
891 Switchdev mode is a mode in E-Switch, that binds between representor and VF.
892 Representor is a port in DPDK that is connected to a VF in such a way
893 that assuming there are no offload flows, each packet that is sent from the VF
894 will be received by the corresponding representor. While each packet that is
895 sent to a representor will be received by the VF.
896 This is very useful in case of SRIOV mode, where the first packet that is sent
897 by the VF will be received by the DPDK application which will decide if this
898 flow should be offloaded to the E-Switch. After offloading the flow packet
899 that the VF that are matching the flow will not be received any more by
900 the DPDK application.
902 1. Enable SRIOV mode::
904 mlxconfig -d <mst device> set SRIOV_EN=true
906 2. Configure the max number of VFs::
908 mlxconfig -d <mst device> set NUM_OF_VFS=<num of vfs>
912 mlxfwreset -d <mst device> reset
914 3. Configure the actual number of VFs::
916 echo <num of vfs > /sys/class/net/<net device>/device/sriov_numvfs
918 4. Unbind the device (can be rebind after the switchdev mode)::
920 echo -n "<device pci address" > /sys/bus/pci/drivers/mlx5_core/unbind
922 5. Enbale switchdev mode::
924 echo switchdev > /sys/class/net/<net device>/compat/devlink/mode
929 1. Configure aggressive CQE Zipping for maximum performance::
931 mlxconfig -d <mst device> s CQE_COMPRESSION=1
933 To set it back to the default CQE Zipping mode use::
935 mlxconfig -d <mst device> s CQE_COMPRESSION=0
937 2. In case of virtualization:
939 - Make sure that hypervisor kernel is 3.16 or newer.
940 - Configure boot with ``iommu=pt``.
942 - Make sure to allocate a VM on huge pages.
943 - Make sure to set CPU pinning.
945 3. Use the CPU near local NUMA node to which the PCIe adapter is connected,
946 for better performance. For VMs, verify that the right CPU
947 and NUMA node are pinned according to the above. Run::
951 to identify the NUMA node to which the PCIe adapter is connected.
953 4. If more than one adapter is used, and root complex capabilities allow
954 to put both adapters on the same NUMA node without PCI bandwidth degradation,
955 it is recommended to locate both adapters on the same NUMA node.
956 This in order to forward packets from one to the other without
957 NUMA performance penalty.
959 5. Disable pause frames::
961 ethtool -A <netdev> rx off tx off
963 6. Verify IO non-posted prefetch is disabled by default. This can be checked
964 via the BIOS configuration. Please contact you server provider for more
965 information about the settings.
969 On some machines, depends on the machine integrator, it is beneficial
970 to set the PCI max read request parameter to 1K. This can be
971 done in the following way:
973 To query the read request size use::
975 setpci -s <NIC PCI address> 68.w
977 If the output is different than 3XXX, set it by::
979 setpci -s <NIC PCI address> 68.w=3XXX
981 The XXX can be different on different systems. Make sure to configure
982 according to the setpci output.
984 7. To minimize overhead of searching Memory Regions:
986 - '--socket-mem' is recommended to pin memory by predictable amount.
987 - Configure per-lcore cache when creating Mempools for packet buffer.
988 - Refrain from dynamically allocating/freeing memory in run-time.
990 .. _mlx5_offloads_support:
992 Supported hardware offloads
993 ---------------------------
995 .. table:: Minimal SW/HW versions for queue offloads
997 ============== ===== ===== ========= ===== ========== ==========
998 Offload DPDK Linux rdma-core OFED firmware hardware
999 ============== ===== ===== ========= ===== ========== ==========
1000 common base 17.11 4.14 16 4.2-1 12.21.1000 ConnectX-4
1001 checksums 17.11 4.14 16 4.2-1 12.21.1000 ConnectX-4
1002 Rx timestamp 17.11 4.14 16 4.2-1 12.21.1000 ConnectX-4
1003 TSO 17.11 4.14 16 4.2-1 12.21.1000 ConnectX-4
1004 LRO 19.08 N/A N/A 4.6-4 16.25.6406 ConnectX-5
1005 ============== ===== ===== ========= ===== ========== ==========
1007 .. table:: Minimal SW/HW versions for rte_flow offloads
1009 +-----------------------+-----------------+-----------------+
1010 | Offload | with E-Switch | with vNIC |
1011 +=======================+=================+=================+
1012 | Count | | DPDK 19.05 | | DPDK 19.02 |
1013 | | | OFED 4.6 | | OFED 4.6 |
1014 | | | rdma-core 24 | | rdma-core 23 |
1015 | | | ConnectX-5 | | ConnectX-5 |
1016 +-----------------------+-----------------+-----------------+
1017 | Drop / Queue / RSS | | DPDK 19.05 | | DPDK 18.11 |
1018 | | | OFED 4.6 | | OFED 4.5 |
1019 | | | rdma-core 24 | | rdma-core 23 |
1020 | | | ConnectX-5 | | ConnectX-4 |
1021 +-----------------------+-----------------+-----------------+
1022 | Encapsulation | | DPDK 19.05 | | DPDK 19.02 |
1023 | (VXLAN / NVGRE / RAW) | | OFED 4.6-2 | | OFED 4.6 |
1024 | | | rdma-core 24 | | rdma-core 23 |
1025 | | | ConnectX-5 | | ConnectX-5 |
1026 +-----------------------+-----------------+-----------------+
1027 | | Header rewrite | | DPDK 19.05 | | DPDK 19.02 |
1028 | | (set_ipv4_src / | | OFED 4.6-2 | | OFED 4.6-2 |
1029 | | set_ipv4_dst / | | rdma-core 24 | | rdma-core 23 |
1030 | | set_ipv6_src / | | ConnectX-5 | | ConnectX-5 |
1031 | | set_ipv6_dst / | | | | |
1032 | | set_tp_src / | | | | |
1033 | | set_tp_dst / | | | | |
1034 | | dec_ttl / | | | | |
1035 | | set_ttl / | | | | |
1036 | | set_mac_src / | | | | |
1037 | | set_mac_dst) | | | | |
1039 | | (of_set_vlan_vid) | | DPDK 19.11 | | DPDK 19.11 |
1040 | | | OFED 4.6-4 | | OFED 4.6-4 |
1041 | | | ConnectX-5 | | ConnectX-5 |
1042 +-----------------------+-----------------+-----------------+
1043 | Jump | | DPDK 19.05 | | DPDK 19.02 |
1044 | | | OFED 4.6-4 | | OFED 4.6-4 |
1045 | | | rdma-core 24 | | N/A |
1046 | | | ConnectX-5 | | ConnectX-5 |
1047 +-----------------------+-----------------+-----------------+
1048 | Mark / Flag | | DPDK 19.05 | | DPDK 18.11 |
1049 | | | OFED 4.6 | | OFED 4.5 |
1050 | | | rdma-core 24 | | rdma-core 23 |
1051 | | | ConnectX-5 | | ConnectX-4 |
1052 +-----------------------+-----------------+-----------------+
1053 | Port ID | | DPDK 19.05 | | N/A |
1054 | | | OFED 4.6 | | N/A |
1055 | | | rdma-core 24 | | N/A |
1056 | | | ConnectX-5 | | N/A |
1057 +-----------------------+-----------------+-----------------+
1058 | | VLAN | | DPDK 19.11 | | DPDK 19.11 |
1059 | | (of_pop_vlan / | | OFED 4.6-4 | | OFED 4.6-4 |
1060 | | of_push_vlan / | | ConnectX-5 | | ConnectX-5 |
1061 | | of_set_vlan_pcp / | | |
1062 | | of_set_vlan_vid) | | |
1063 +-----------------------+-----------------+-----------------+
1068 Compared to librte_pmd_mlx4 that implements a single RSS configuration per
1069 port, librte_pmd_mlx5 supports per-protocol RSS configuration.
1071 Since ``testpmd`` defaults to IP RSS mode and there is currently no
1072 command-line parameter to enable additional protocols (UDP and TCP as well
1073 as IP), the following commands must be entered from its CLI to get the same
1074 behavior as librte_pmd_mlx4::
1077 > port config all rss all
1083 This section demonstrates how to launch **testpmd** with Mellanox
1084 ConnectX-4/ConnectX-5/ConnectX-6/BlueField devices managed by librte_pmd_mlx5.
1086 #. Load the kernel modules::
1088 modprobe -a ib_uverbs mlx5_core mlx5_ib
1090 Alternatively if MLNX_OFED/MLNX_EN is fully installed, the following script
1093 /etc/init.d/openibd restart
1097 User space I/O kernel modules (uio and igb_uio) are not used and do
1098 not have to be loaded.
1100 #. Make sure Ethernet interfaces are in working order and linked to kernel
1101 verbs. Related sysfs entries should be present::
1103 ls -d /sys/class/net/*/device/infiniband_verbs/uverbs* | cut -d / -f 5
1112 #. Optionally, retrieve their PCI bus addresses for whitelisting::
1115 for intf in eth2 eth3 eth4 eth5;
1117 (cd "/sys/class/net/${intf}/device/" && pwd -P);
1120 sed -n 's,.*/\(.*\),-w \1,p'
1129 #. Request huge pages::
1131 echo 1024 > /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages/nr_hugepages
1133 #. Start testpmd with basic parameters::
1135 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
1140 EAL: PCI device 0000:05:00.0 on NUMA socket 0
1141 EAL: probe driver: 15b3:1013 librte_pmd_mlx5
1142 PMD: librte_pmd_mlx5: PCI information matches, using device "mlx5_0" (VF: false)
1143 PMD: librte_pmd_mlx5: 1 port(s) detected
1144 PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:fe
1145 EAL: PCI device 0000:05:00.1 on NUMA socket 0
1146 EAL: probe driver: 15b3:1013 librte_pmd_mlx5
1147 PMD: librte_pmd_mlx5: PCI information matches, using device "mlx5_1" (VF: false)
1148 PMD: librte_pmd_mlx5: 1 port(s) detected
1149 PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:ff
1150 EAL: PCI device 0000:06:00.0 on NUMA socket 0
1151 EAL: probe driver: 15b3:1013 librte_pmd_mlx5
1152 PMD: librte_pmd_mlx5: PCI information matches, using device "mlx5_2" (VF: false)
1153 PMD: librte_pmd_mlx5: 1 port(s) detected
1154 PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:fa
1155 EAL: PCI device 0000:06:00.1 on NUMA socket 0
1156 EAL: probe driver: 15b3:1013 librte_pmd_mlx5
1157 PMD: librte_pmd_mlx5: PCI information matches, using device "mlx5_3" (VF: false)
1158 PMD: librte_pmd_mlx5: 1 port(s) detected
1159 PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:fb
1160 Interactive-mode selected
1161 Configuring Port 0 (socket 0)
1162 PMD: librte_pmd_mlx5: 0x8cba80: TX queues number update: 0 -> 2
1163 PMD: librte_pmd_mlx5: 0x8cba80: RX queues number update: 0 -> 2
1164 Port 0: E4:1D:2D:E7:0C:FE
1165 Configuring Port 1 (socket 0)
1166 PMD: librte_pmd_mlx5: 0x8ccac8: TX queues number update: 0 -> 2
1167 PMD: librte_pmd_mlx5: 0x8ccac8: RX queues number update: 0 -> 2
1168 Port 1: E4:1D:2D:E7:0C:FF
1169 Configuring Port 2 (socket 0)
1170 PMD: librte_pmd_mlx5: 0x8cdb10: TX queues number update: 0 -> 2
1171 PMD: librte_pmd_mlx5: 0x8cdb10: RX queues number update: 0 -> 2
1172 Port 2: E4:1D:2D:E7:0C:FA
1173 Configuring Port 3 (socket 0)
1174 PMD: librte_pmd_mlx5: 0x8ceb58: TX queues number update: 0 -> 2
1175 PMD: librte_pmd_mlx5: 0x8ceb58: RX queues number update: 0 -> 2
1176 Port 3: E4:1D:2D:E7:0C:FB
1177 Checking link statuses...
1178 Port 0 Link Up - speed 40000 Mbps - full-duplex
1179 Port 1 Link Up - speed 40000 Mbps - full-duplex
1180 Port 2 Link Up - speed 10000 Mbps - full-duplex
1181 Port 3 Link Up - speed 10000 Mbps - full-duplex