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**, **Mellanox ConnectX-6DX** and
11 **Mellanox BlueField** families of 10/25/40/50/100/200 Gb/s adapters
12 as well as their virtual functions (VF) in SR-IOV context.
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 - RSS using different combinations of fields: L3 only, L4 only or both,
68 and source only, destination only or both.
69 - Several RSS hash keys, one for each flow type.
70 - Default RSS operation with no hash key specification.
71 - Configurable RETA table.
72 - Link flow control (pause frame).
73 - Support for multiple MAC addresses.
77 - RX CRC stripping configuration.
78 - Promiscuous mode on PF and VF.
79 - Multicast promiscuous mode on PF and VF.
80 - Hardware checksum offloads.
81 - Flow director (RTE_FDIR_MODE_PERFECT, RTE_FDIR_MODE_PERFECT_MAC_VLAN and
83 - Flow API, including :ref:`flow_isolated_mode`.
85 - KVM and VMware ESX SR-IOV modes are supported.
86 - RSS hash result is supported.
87 - Hardware TSO for generic IP or UDP tunnel, including VXLAN and GRE.
88 - Hardware checksum Tx offload for generic IP or UDP tunnel, including VXLAN and GRE.
90 - Statistics query including Basic, Extended and per queue.
92 - Tunnel types: VXLAN, L3 VXLAN, VXLAN-GPE, GRE, MPLSoGRE, MPLSoUDP, IP-in-IP, Geneve.
93 - Tunnel types: VXLAN, L3 VXLAN, VXLAN-GPE, GRE, MPLSoGRE, MPLSoUDP, IP-in-IP, Geneve, GTP.
94 - Tunnel HW offloads: packet type, inner/outer RSS, IP and UDP checksum verification.
95 - NIC HW offloads: encapsulation (vxlan, gre, mplsoudp, mplsogre), NAT, routing, TTL
96 increment/decrement, count, drop, mark. For details please see :ref:`mlx5_offloads_support`.
97 - Flow insertion rate of more then million flows per second, when using Direct Rules.
98 - Support for multiple rte_flow groups.
104 - For secondary process:
106 - Forked secondary process not supported.
107 - External memory unregistered in EAL memseg list cannot be used for DMA
108 unless such memory has been registered by ``mlx5_mr_update_ext_mp()`` in
109 primary process and remapped to the same virtual address in secondary
110 process. If the external memory is registered by primary process but has
111 different virtual address in secondary process, unexpected error may happen.
113 - When using Verbs flow engine (``dv_flow_en`` = 0), flow pattern without any
114 specific VLAN will match for VLAN packets as well:
116 When VLAN spec is not specified in the pattern, the matching rule will be created with VLAN as a wild card.
117 Meaning, the flow rule::
119 flow create 0 ingress pattern eth / vlan vid is 3 / ipv4 / end ...
121 Will only match vlan packets with vid=3. and the flow rule::
123 flow create 0 ingress pattern eth / 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 - Match on Geneve header supports the following fields only:
155 Currently, the only supported options length value is 0.
157 - VF: flow rules created on VF devices can only match traffic targeted at the
158 configured MAC addresses (see ``rte_eth_dev_mac_addr_add()``).
160 - Match on GTP tunnel header item supports the following fields only:
165 - No Tx metadata go to the E-Switch steering domain for the Flow group 0.
166 The flows within group 0 and set metadata action are rejected by hardware.
170 MAC addresses not already present in the bridge table of the associated
171 kernel network device will be added and cleaned up by the PMD when closing
172 the device. In case of ungraceful program termination, some entries may
173 remain present and should be removed manually by other means.
175 - When Multi-Packet Rx queue is configured (``mprq_en``), a Rx packet can be
176 externally attached to a user-provided mbuf with having EXT_ATTACHED_MBUF in
177 ol_flags. As the mempool for the external buffer is managed by PMD, all the
178 Rx mbufs must be freed before the device is closed. Otherwise, the mempool of
179 the external buffers will be freed by PMD and the application which still
180 holds the external buffers may be corrupted.
182 - If Multi-Packet Rx queue is configured (``mprq_en``) and Rx CQE compression is
183 enabled (``rxq_cqe_comp_en``) at the same time, RSS hash result is not fully
184 supported. Some Rx packets may not have PKT_RX_RSS_HASH.
186 - IPv6 Multicast messages are not supported on VM, while promiscuous mode
187 and allmulticast mode are both set to off.
188 To receive IPv6 Multicast messages on VM, explicitly set the relevant
189 MAC address using rte_eth_dev_mac_addr_add() API.
191 - The amount of descriptors in Tx queue may be limited by data inline settings.
192 Inline data require the more descriptor building blocks and overall block
193 amount may exceed the hardware supported limits. The application should
194 reduce the requested Tx size or adjust data inline settings with
195 ``txq_inline_max`` and ``txq_inline_mpw`` devargs keys.
197 - E-Switch decapsulation Flow:
199 - can be applied to PF port only.
200 - must specify VF port action (packet redirection from PF to VF).
201 - optionally may specify tunnel inner source and destination MAC addresses.
203 - E-Switch encapsulation Flow:
205 - can be applied to VF ports only.
206 - must specify PF port action (packet redirection from VF to PF).
210 - The input buffer, used as outer header, is not validated.
214 - The decapsulation is always done up to the outermost tunnel detected by the HW.
215 - The input buffer, providing the removal size, is not validated.
216 - The buffer size must match the length of the headers to be removed.
218 - ICMP/ICMP6 code/type matching, IP-in-IP and MPLS flow matching are all
219 mutually exclusive features which cannot be supported together
220 (see :ref:`mlx5_firmware_config`).
224 - Requires DevX and DV flow to be enabled.
225 - KEEP_CRC offload cannot be supported with LRO.
226 - The first mbuf length, without head-room, must be big enough to include the
228 - Rx queue with LRO offload enabled, receiving a non-LRO packet, can forward
229 it with size limited to max LRO size, not to max RX packet length.
234 MLX5 supports various methods to report statistics:
236 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.
238 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.
240 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.
248 These options can be modified in the ``.config`` file.
250 - ``CONFIG_RTE_LIBRTE_MLX5_PMD`` (default **n**)
252 Toggle compilation of librte_pmd_mlx5 itself.
254 - ``CONFIG_RTE_IBVERBS_LINK_DLOPEN`` (default **n**)
256 Build PMD with additional code to make it loadable without hard
257 dependencies on **libibverbs** nor **libmlx5**, which may not be installed
258 on the target system.
260 In this mode, their presence is still required for it to run properly,
261 however their absence won't prevent a DPDK application from starting (with
262 ``CONFIG_RTE_BUILD_SHARED_LIB`` disabled) and they won't show up as
263 missing with ``ldd(1)``.
265 It works by moving these dependencies to a purpose-built rdma-core "glue"
266 plug-in which must either be installed in a directory whose name is based
267 on ``CONFIG_RTE_EAL_PMD_PATH`` suffixed with ``-glue`` if set, or in a
268 standard location for the dynamic linker (e.g. ``/lib``) if left to the
269 default empty string (``""``).
271 This option has no performance impact.
273 - ``CONFIG_RTE_IBVERBS_LINK_STATIC`` (default **n**)
275 Embed static flavor of the dependencies **libibverbs** and **libmlx5**
276 in the PMD shared library or the executable static binary.
278 - ``CONFIG_RTE_LIBRTE_MLX5_DEBUG`` (default **n**)
280 Toggle debugging code and stricter compilation flags. Enabling this option
281 adds additional run-time checks and debugging messages at the cost of
286 For BlueField, target should be set to ``arm64-bluefield-linux-gcc``. This
287 will enable ``CONFIG_RTE_LIBRTE_MLX5_PMD`` and set ``RTE_CACHE_LINE_SIZE`` to
288 64. Default armv8a configuration of make build and meson build set it to 128
289 then brings performance degradation.
291 This option is available in meson:
293 - ``ibverbs_link`` can be ``static``, ``shared``, or ``dlopen``.
295 Environment variables
296 ~~~~~~~~~~~~~~~~~~~~~
300 A list of directories in which to search for the rdma-core "glue" plug-in,
301 separated by colons or semi-colons.
303 Only matters when compiled with ``CONFIG_RTE_IBVERBS_LINK_DLOPEN``
304 enabled and most useful when ``CONFIG_RTE_EAL_PMD_PATH`` is also set,
305 since ``LD_LIBRARY_PATH`` has no effect in this case.
307 - ``MLX5_SHUT_UP_BF``
309 Configures HW Tx doorbell register as IO-mapped.
311 By default, the HW Tx doorbell is configured as a write-combining register.
312 The register would be flushed to HW usually when the write-combining buffer
313 becomes full, but it depends on CPU design.
315 Except for vectorized Tx burst routines, a write memory barrier is enforced
316 after updating the register so that the update can be immediately visible to
319 When vectorized Tx burst is called, the barrier is set only if the burst size
320 is not aligned to MLX5_VPMD_TX_MAX_BURST. However, setting this environmental
321 variable will bring better latency even though the maximum throughput can
324 Run-time configuration
325 ~~~~~~~~~~~~~~~~~~~~~~
327 - librte_pmd_mlx5 brings kernel network interfaces up during initialization
328 because it is affected by their state. Forcing them down prevents packets
331 - **ethtool** operations on related kernel interfaces also affect the PMD.
333 - ``rxq_cqe_comp_en`` parameter [int]
335 A nonzero value enables the compression of CQE on RX side. This feature
336 allows to save PCI bandwidth and improve performance. Enabled by default.
340 - x86_64 with ConnectX-4, ConnectX-4 LX, ConnectX-5, ConnectX-6, ConnectX-6 DX
342 - POWER9 and ARMv8 with ConnectX-4 LX, ConnectX-5, ConnectX-6, ConnectX-6 DX
345 - ``rxq_cqe_pad_en`` parameter [int]
347 A nonzero value enables 128B padding of CQE on RX side. The size of CQE
348 is aligned with the size of a cacheline of the core. If cacheline size is
349 128B, the CQE size is configured to be 128B even though the device writes
350 only 64B data on the cacheline. This is to avoid unnecessary cache
351 invalidation by device's two consecutive writes on to one cacheline.
352 However in some architecture, it is more beneficial to update entire
353 cacheline with padding the rest 64B rather than striding because
354 read-modify-write could drop performance a lot. On the other hand,
355 writing extra data will consume more PCIe bandwidth and could also drop
356 the maximum throughput. It is recommended to empirically set this
357 parameter. Disabled by default.
361 - CPU having 128B cacheline with ConnectX-5 and BlueField.
363 - ``rxq_pkt_pad_en`` parameter [int]
365 A nonzero value enables padding Rx packet to the size of cacheline on PCI
366 transaction. This feature would waste PCI bandwidth but could improve
367 performance by avoiding partial cacheline write which may cause costly
368 read-modify-copy in memory transaction on some architectures. Disabled by
373 - x86_64 with ConnectX-4, ConnectX-4 LX, ConnectX-5, ConnectX-6, ConnectX-6 DX
375 - POWER8 and ARMv8 with ConnectX-4 LX, ConnectX-5, ConnectX-6, ConnectX-6 DX
378 - ``mprq_en`` parameter [int]
380 A nonzero value enables configuring Multi-Packet Rx queues. Rx queue is
381 configured as Multi-Packet RQ if the total number of Rx queues is
382 ``rxqs_min_mprq`` or more and Rx scatter isn't configured. Disabled by
385 Multi-Packet Rx Queue (MPRQ a.k.a Striding RQ) can further save PCIe bandwidth
386 by posting a single large buffer for multiple packets. Instead of posting a
387 buffers per a packet, one large buffer is posted in order to receive multiple
388 packets on the buffer. A MPRQ buffer consists of multiple fixed-size strides
389 and each stride receives one packet. MPRQ can improve throughput for
390 small-packet traffic.
392 When MPRQ is enabled, max_rx_pkt_len can be larger than the size of
393 user-provided mbuf even if DEV_RX_OFFLOAD_SCATTER isn't enabled. PMD will
394 configure large stride size enough to accommodate max_rx_pkt_len as long as
395 device allows. Note that this can waste system memory compared to enabling Rx
396 scatter and multi-segment packet.
398 - ``mprq_log_stride_num`` parameter [int]
400 Log 2 of the number of strides for Multi-Packet Rx queue. Configuring more
401 strides can reduce PCIe traffic further. If configured value is not in the
402 range of device capability, the default value will be set with a warning
403 message. The default value is 4 which is 16 strides per a buffer, valid only
404 if ``mprq_en`` is set.
406 The size of Rx queue should be bigger than the number of strides.
408 - ``mprq_max_memcpy_len`` parameter [int]
410 The maximum length of packet to memcpy in case of Multi-Packet Rx queue. Rx
411 packet is mem-copied to a user-provided mbuf if the size of Rx packet is less
412 than or equal to this parameter. Otherwise, PMD will attach the Rx packet to
413 the mbuf by external buffer attachment - ``rte_pktmbuf_attach_extbuf()``.
414 A mempool for external buffers will be allocated and managed by PMD. If Rx
415 packet is externally attached, ol_flags field of the mbuf will have
416 EXT_ATTACHED_MBUF and this flag must be preserved. ``RTE_MBUF_HAS_EXTBUF()``
417 checks the flag. The default value is 128, valid only if ``mprq_en`` is set.
419 - ``rxqs_min_mprq`` parameter [int]
421 Configure Rx queues as Multi-Packet RQ if the total number of Rx queues is
422 greater or equal to this value. The default value is 12, valid only if
425 - ``txq_inline`` parameter [int]
427 Amount of data to be inlined during TX operations. This parameter is
428 deprecated and converted to the new parameter ``txq_inline_max`` providing
429 partial compatibility.
431 - ``txqs_min_inline`` parameter [int]
433 Enable inline data send only when the number of TX queues is greater or equal
436 This option should be used in combination with ``txq_inline_max`` and
437 ``txq_inline_mpw`` below and does not affect ``txq_inline_min`` settings above.
439 If this option is not specified the default value 16 is used for BlueField
440 and 8 for other platforms
442 The data inlining consumes the CPU cycles, so this option is intended to
443 auto enable inline data if we have enough Tx queues, which means we have
444 enough CPU cores and PCI bandwidth is getting more critical and CPU
445 is not supposed to be bottleneck anymore.
447 The copying data into WQE improves latency and can improve PPS performance
448 when PCI back pressure is detected and may be useful for scenarios involving
449 heavy traffic on many queues.
451 Because additional software logic is necessary to handle this mode, this
452 option should be used with care, as it may lower performance when back
453 pressure is not expected.
455 If inline data are enabled it may affect the maximal size of Tx queue in
456 descriptors because the inline data increase the descriptor size and
457 queue size limits supported by hardware may be exceeded.
459 - ``txq_inline_min`` parameter [int]
461 Minimal amount of data to be inlined into WQE during Tx operations. NICs
462 may require this minimal data amount to operate correctly. The exact value
463 may depend on NIC operation mode, requested offloads, etc. It is strongly
464 recommended to omit this parameter and use the default values. Anyway,
465 applications using this parameter should take into consideration that
466 specifying an inconsistent value may prevent the NIC from sending packets.
468 If ``txq_inline_min`` key is present the specified value (may be aligned
469 by the driver in order not to exceed the limits and provide better descriptor
470 space utilization) will be used by the driver and it is guaranteed that
471 requested amount of data bytes are inlined into the WQE beside other inline
472 settings. This key also may update ``txq_inline_max`` value (default
473 or specified explicitly in devargs) to reserve the space for inline data.
475 If ``txq_inline_min`` key is not present, the value may be queried by the
476 driver from the NIC via DevX if this feature is available. If there is no DevX
477 enabled/supported the value 18 (supposing L2 header including VLAN) is set
478 for ConnectX-4 and ConnectX-4LX, and 0 is set by default for ConnectX-5
479 and newer NICs. If packet is shorter the ``txq_inline_min`` value, the entire
482 For ConnectX-4 NIC, driver does not allow specifying value below 18
483 (minimal L2 header, including VLAN), error will be raised.
485 For ConnectX-4LX NIC, it is allowed to specify values below 18, but
486 it is not recommended and may prevent NIC from sending packets over
489 Please, note, this minimal data inlining disengages eMPW feature (Enhanced
490 Multi-Packet Write), because last one does not support partial packet inlining.
491 This is not very critical due to minimal data inlining is mostly required
492 by ConnectX-4 and ConnectX-4 Lx, these NICs do not support eMPW feature.
494 - ``txq_inline_max`` parameter [int]
496 Specifies the maximal packet length to be completely inlined into WQE
497 Ethernet Segment for ordinary SEND method. If packet is larger than specified
498 value, the packet data won't be copied by the driver at all, data buffer
499 is addressed with a pointer. If packet length is less or equal all packet
500 data will be copied into WQE. This may improve PCI bandwidth utilization for
501 short packets significantly but requires the extra CPU cycles.
503 The data inline feature is controlled by number of Tx queues, if number of Tx
504 queues is larger than ``txqs_min_inline`` key parameter, the inline feature
505 is engaged, if there are not enough Tx queues (which means not enough CPU cores
506 and CPU resources are scarce), data inline is not performed by the driver.
507 Assigning ``txqs_min_inline`` with zero always enables the data inline.
509 The default ``txq_inline_max`` value is 290. The specified value may be adjusted
510 by the driver in order not to exceed the limit (930 bytes) and to provide better
511 WQE space filling without gaps, the adjustment is reflected in the debug log.
512 Also, the default value (290) may be decreased in run-time if the large transmit
513 queue size is requested and hardware does not support enough descriptor
514 amount, in this case warning is emitted. If ``txq_inline_max`` key is
515 specified and requested inline settings can not be satisfied then error
518 - ``txq_inline_mpw`` parameter [int]
520 Specifies the maximal packet length to be completely inlined into WQE for
521 Enhanced MPW method. If packet is large the specified value, the packet data
522 won't be copied, and data buffer is addressed with pointer. If packet length
523 is less or equal, all packet data will be copied into WQE. This may improve PCI
524 bandwidth utilization for short packets significantly but requires the extra
527 The data inline feature is controlled by number of TX queues, if number of Tx
528 queues is larger than ``txqs_min_inline`` key parameter, the inline feature
529 is engaged, if there are not enough Tx queues (which means not enough CPU cores
530 and CPU resources are scarce), data inline is not performed by the driver.
531 Assigning ``txqs_min_inline`` with zero always enables the data inline.
533 The default ``txq_inline_mpw`` value is 268. The specified value may be adjusted
534 by the driver in order not to exceed the limit (930 bytes) and to provide better
535 WQE space filling without gaps, the adjustment is reflected in the debug log.
536 Due to multiple packets may be included to the same WQE with Enhanced Multi
537 Packet Write Method and overall WQE size is limited it is not recommended to
538 specify large values for the ``txq_inline_mpw``. Also, the default value (268)
539 may be decreased in run-time if the large transmit queue size is requested
540 and hardware does not support enough descriptor amount, in this case warning
541 is emitted. If ``txq_inline_mpw`` key is specified and requested inline
542 settings can not be satisfied then error will be raised.
544 - ``txqs_max_vec`` parameter [int]
546 Enable vectorized Tx only when the number of TX queues is less than or
547 equal to this value. This parameter is deprecated and ignored, kept
548 for compatibility issue to not prevent driver from probing.
550 - ``txq_mpw_hdr_dseg_en`` parameter [int]
552 A nonzero value enables including two pointers in the first block of TX
553 descriptor. The parameter is deprecated and ignored, kept for compatibility
556 - ``txq_max_inline_len`` parameter [int]
558 Maximum size of packet to be inlined. This limits the size of packet to
559 be inlined. If the size of a packet is larger than configured value, the
560 packet isn't inlined even though there's enough space remained in the
561 descriptor. Instead, the packet is included with pointer. This parameter
562 is deprecated and converted directly to ``txq_inline_mpw`` providing full
563 compatibility. Valid only if eMPW feature is engaged.
565 - ``txq_mpw_en`` parameter [int]
567 A nonzero value enables Enhanced Multi-Packet Write (eMPW) for ConnectX-5,
568 ConnectX-6, ConnectX-6 DX and BlueField. eMPW allows the TX burst function to pack
569 up multiple packets in a single descriptor session in order to save PCI bandwidth
570 and improve performance at the cost of a slightly higher CPU usage. When
571 ``txq_inline_mpw`` is set along with ``txq_mpw_en``, TX burst function copies
572 entire packet data on to TX descriptor instead of including pointer of packet.
574 The Enhanced Multi-Packet Write feature is enabled by default if NIC supports
575 it, can be disabled by explicit specifying 0 value for ``txq_mpw_en`` option.
576 Also, if minimal data inlining is requested by non-zero ``txq_inline_min``
577 option or reported by the NIC, the eMPW feature is disengaged.
579 - ``tx_db_nc`` parameter [int]
581 The rdma core library can map doorbell register in two ways, depending on the
582 environment variable "MLX5_SHUT_UP_BF":
584 - As regular cached memory (usually with write combining attribute), if the
585 variable is either missing or set to zero.
586 - As non-cached memory, if the variable is present and set to not "0" value.
588 The type of mapping may slightly affect the Tx performance, the optimal choice
589 is strongly relied on the host architecture and should be deduced practically.
591 If ``tx_db_nc`` is set to zero, the doorbell is forced to be mapped to regular
592 memory (with write combining), the PMD will perform the extra write memory barrier
593 after writing to doorbell, it might increase the needed CPU clocks per packet
594 to send, but latency might be improved.
596 If ``tx_db_nc`` is set to one, the doorbell is forced to be mapped to non
597 cached memory, the PMD will not perform the extra write memory barrier
598 after writing to doorbell, on some architectures it might improve the
601 If ``tx_db_nc`` is set to two, the doorbell is forced to be mapped to regular
602 memory, the PMD will use heuristics to decide whether write memory barrier
603 should be performed. For bursts with size multiple of recommended one (64 pkts)
604 it is supposed the next burst is coming and no need to issue the extra memory
605 barrier (it is supposed to be issued in the next coming burst, at least after
606 descriptor writing). It might increase latency (on some hosts till next
607 packets transmit) and should be used with care.
609 If ``tx_db_nc`` is omitted or set to zero, the preset (if any) environment
610 variable "MLX5_SHUT_UP_BF" value is used. If there is no "MLX5_SHUT_UP_BF",
611 the default ``tx_db_nc`` value is zero for ARM64 hosts and one for others.
613 - ``tx_vec_en`` parameter [int]
615 A nonzero value enables Tx vector on ConnectX-5, ConnectX-6, ConnectX-6 DX
616 and BlueField NICs if the number of global Tx queues on the port is less than
617 ``txqs_max_vec``. The parameter is deprecated and ignored.
619 - ``rx_vec_en`` parameter [int]
621 A nonzero value enables Rx vector if the port is not configured in
622 multi-segment otherwise this parameter is ignored.
626 - ``vf_nl_en`` parameter [int]
628 A nonzero value enables Netlink requests from the VF to add/remove MAC
629 addresses or/and enable/disable promiscuous/all multicast on the Netdevice.
630 Otherwise the relevant configuration must be run with Linux iproute2 tools.
631 This is a prerequisite to receive this kind of traffic.
633 Enabled by default, valid only on VF devices ignored otherwise.
635 - ``l3_vxlan_en`` parameter [int]
637 A nonzero value allows L3 VXLAN and VXLAN-GPE flow creation. To enable
638 L3 VXLAN or VXLAN-GPE, users has to configure firmware and enable this
639 parameter. This is a prerequisite to receive this kind of traffic.
643 - ``dv_xmeta_en`` parameter [int]
645 A nonzero value enables extensive flow metadata support if device is
646 capable and driver supports it. This can enable extensive support of
647 ``MARK`` and ``META`` item of ``rte_flow``. The newly introduced
648 ``SET_TAG`` and ``SET_META`` actions do not depend on ``dv_xmeta_en``.
650 There are some possible configurations, depending on parameter value:
652 - 0, this is default value, defines the legacy mode, the ``MARK`` and
653 ``META`` related actions and items operate only within NIC Tx and
654 NIC Rx steering domains, no ``MARK`` and ``META`` information crosses
655 the domain boundaries. The ``MARK`` item is 24 bits wide, the ``META``
656 item is 32 bits wide and match supported on egress only.
658 - 1, this engages extensive metadata mode, the ``MARK`` and ``META``
659 related actions and items operate within all supported steering domains,
660 including FDB, ``MARK`` and ``META`` information may cross the domain
661 boundaries. The ``MARK`` item is 24 bits wide, the ``META`` item width
662 depends on kernel and firmware configurations and might be 0, 16 or
663 32 bits. Within NIC Tx domain ``META`` data width is 32 bits for
664 compatibility, the actual width of data transferred to the FDB domain
665 depends on kernel configuration and may be vary. The actual supported
666 width can be retrieved in runtime by series of rte_flow_validate()
669 - 2, this engages extensive metadata mode, the ``MARK`` and ``META``
670 related actions and items operate within all supported steering domains,
671 including FDB, ``MARK`` and ``META`` information may cross the domain
672 boundaries. The ``META`` item is 32 bits wide, the ``MARK`` item width
673 depends on kernel and firmware configurations and might be 0, 16 or
674 24 bits. The actual supported width can be retrieved in runtime by
675 series of rte_flow_validate() trials.
677 +------+-----------+-----------+-------------+-------------+
678 | Mode | ``MARK`` | ``META`` | ``META`` Tx | FDB/Through |
679 +======+===========+===========+=============+=============+
680 | 0 | 24 bits | 32 bits | 32 bits | no |
681 +------+-----------+-----------+-------------+-------------+
682 | 1 | 24 bits | vary 0-32 | 32 bits | yes |
683 +------+-----------+-----------+-------------+-------------+
684 | 2 | vary 0-32 | 32 bits | 32 bits | yes |
685 +------+-----------+-----------+-------------+-------------+
687 If there is no E-Switch configuration the ``dv_xmeta_en`` parameter is
688 ignored and the device is configured to operate in legacy mode (0).
690 Disabled by default (set to 0).
692 The Direct Verbs/Rules (engaged with ``dv_flow_en`` = 1) supports all
693 of the extensive metadata features. The legacy Verbs supports FLAG and
694 MARK metadata actions over NIC Rx steering domain only.
696 - ``dv_flow_en`` parameter [int]
698 A nonzero value enables the DV flow steering assuming it is supported
699 by the driver (RDMA Core library version is rdma-core-24.0 or higher).
701 Enabled by default if supported.
703 - ``dv_esw_en`` parameter [int]
705 A nonzero value enables E-Switch using Direct Rules.
707 Enabled by default if supported.
709 - ``mr_ext_memseg_en`` parameter [int]
711 A nonzero value enables extending memseg when registering DMA memory. If
712 enabled, the number of entries in MR (Memory Region) lookup table on datapath
713 is minimized and it benefits performance. On the other hand, it worsens memory
714 utilization because registered memory is pinned by kernel driver. Even if a
715 page in the extended chunk is freed, that doesn't become reusable until the
716 entire memory is freed.
720 - ``representor`` parameter [list]
722 This parameter can be used to instantiate DPDK Ethernet devices from
723 existing port (or VF) representors configured on the device.
725 It is a standard parameter whose format is described in
726 :ref:`ethernet_device_standard_device_arguments`.
728 For instance, to probe port representors 0 through 2::
732 - ``max_dump_files_num`` parameter [int]
734 The maximum number of files per PMD entity that may be created for debug information.
735 The files will be created in /var/log directory or in current directory.
737 set to 128 by default.
739 - ``lro_timeout_usec`` parameter [int]
741 The maximum allowed duration of an LRO session, in micro-seconds.
742 PMD will set the nearest value supported by HW, which is not bigger than
743 the input ``lro_timeout_usec`` value.
744 If this parameter is not specified, by default PMD will set
745 the smallest value supported by HW.
747 .. _mlx5_firmware_config:
749 Firmware configuration
750 ~~~~~~~~~~~~~~~~~~~~~~
752 Firmware features can be configured as key/value pairs.
754 The command to set a value is::
756 mlxconfig -d <device> set <key>=<value>
758 The command to query a value is::
760 mlxconfig -d <device> query | grep <key>
762 The device name for the command ``mlxconfig`` can be either the PCI address,
763 or the mst device name found with::
767 Below are some firmware configurations listed.
773 value: 1=Infiniband 2=Ethernet 3=VPI(auto-sense)
779 - maximum number of SR-IOV virtual functions::
783 - enable DevX (required by Direct Rules and other features)::
787 - aggressive CQE zipping::
791 - L3 VXLAN and VXLAN-GPE destination UDP port::
794 IP_OVER_VXLAN_PORT=<udp dport>
796 - enable IP-in-IP tunnel flow matching::
798 FLEX_PARSER_PROFILE_ENABLE=0
800 - enable MPLS flow matching::
802 FLEX_PARSER_PROFILE_ENABLE=1
804 - enable ICMP/ICMP6 code/type fields matching::
806 FLEX_PARSER_PROFILE_ENABLE=2
808 - enable Geneve flow matching::
810 FLEX_PARSER_PROFILE_ENABLE=0
812 - enable GTP flow matching::
814 FLEX_PARSER_PROFILE_ENABLE=3
819 This driver relies on external libraries and kernel drivers for resources
820 allocations and initialization. The following dependencies are not part of
821 DPDK and must be installed separately:
825 User space Verbs framework used by librte_pmd_mlx5. This library provides
826 a generic interface between the kernel and low-level user space drivers
829 It allows slow and privileged operations (context initialization, hardware
830 resources allocations) to be managed by the kernel and fast operations to
831 never leave user space.
835 Low-level user space driver library for Mellanox
836 ConnectX-4/ConnectX-5/ConnectX-6/BlueField devices, it is automatically loaded
839 This library basically implements send/receive calls to the hardware
844 They provide the kernel-side Verbs API and low level device drivers that
845 manage actual hardware initialization and resources sharing with user
848 Unlike most other PMDs, these modules must remain loaded and bound to
851 - mlx5_core: hardware driver managing Mellanox
852 ConnectX-4/ConnectX-5/ConnectX-6/BlueField devices and related Ethernet kernel
854 - mlx5_ib: InifiniBand device driver.
855 - ib_uverbs: user space driver for Verbs (entry point for libibverbs).
857 - **Firmware update**
859 Mellanox OFED/EN releases include firmware updates for
860 ConnectX-4/ConnectX-5/ConnectX-6/BlueField adapters.
862 Because each release provides new features, these updates must be applied to
863 match the kernel modules and libraries they come with.
867 Both libraries are BSD and GPL licensed. Linux kernel modules are GPL
873 Either RDMA Core library with a recent enough Linux kernel release
874 (recommended) or Mellanox OFED/EN, which provides compatibility with older
877 RDMA Core with Linux Kernel
878 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
880 - Minimal kernel version : v4.14 or the most recent 4.14-rc (see `Linux installation documentation`_)
881 - Minimal rdma-core version: v15+ commit 0c5f5765213a ("Merge pull request #227 from yishaih/tm")
882 (see `RDMA Core installation documentation`_)
883 - When building for i686 use:
885 - rdma-core version 18.0 or above built with 32bit support.
886 - Kernel version 4.14.41 or above.
888 - Starting with rdma-core v21, static libraries can be built::
891 CFLAGS=-fPIC cmake -DIN_PLACE=1 -DENABLE_STATIC=1 -GNinja ..
894 .. _`Linux installation documentation`: https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux-stable.git/plain/Documentation/admin-guide/README.rst
895 .. _`RDMA Core installation documentation`: https://raw.githubusercontent.com/linux-rdma/rdma-core/master/README.md
897 If rdma-core libraries are built but not installed, DPDK makefile can link them,
898 thanks to these environment variables:
900 - ``EXTRA_CFLAGS=-I/path/to/rdma-core/build/include``
901 - ``EXTRA_LDFLAGS=-L/path/to/rdma-core/build/lib``
902 - ``PKG_CONFIG_PATH=/path/to/rdma-core/build/lib/pkgconfig``
907 - Mellanox OFED version: ** 4.5, 4.6** /
908 Mellanox EN version: **4.5, 4.6**
911 - ConnectX-4: **12.21.1000** and above.
912 - ConnectX-4 Lx: **14.21.1000** and above.
913 - ConnectX-5: **16.21.1000** and above.
914 - ConnectX-5 Ex: **16.21.1000** and above.
915 - ConnectX-6: **20.99.5374** and above.
916 - ConnectX-6 DX: **22.27.0090** and above.
917 - BlueField: **18.25.1010** and above.
919 While these libraries and kernel modules are available on OpenFabrics
920 Alliance's `website <https://www.openfabrics.org/>`__ and provided by package
921 managers on most distributions, this PMD requires Ethernet extensions that
922 may not be supported at the moment (this is a work in progress).
925 <http://www.mellanox.com/page/products_dyn?product_family=26&mtag=linux>`__ and
927 <http://www.mellanox.com/page/products_dyn?product_family=27&mtag=linux>`__
928 include the necessary support and should be used in the meantime. For DPDK,
929 only libibverbs, libmlx5, mlnx-ofed-kernel packages and firmware updates are
930 required from that distribution.
934 Several versions of Mellanox OFED/EN are available. Installing the version
935 this DPDK release was developed and tested against is strongly
936 recommended. Please check the `prerequisites`_.
941 * Mellanox(R) ConnectX(R)-4 10G MCX4111A-XCAT (1x10G)
942 * Mellanox(R) ConnectX(R)-4 10G MCX4121A-XCAT (2x10G)
943 * Mellanox(R) ConnectX(R)-4 25G MCX4111A-ACAT (1x25G)
944 * Mellanox(R) ConnectX(R)-4 25G MCX4121A-ACAT (2x25G)
945 * Mellanox(R) ConnectX(R)-4 40G MCX4131A-BCAT (1x40G)
946 * Mellanox(R) ConnectX(R)-4 40G MCX413A-BCAT (1x40G)
947 * Mellanox(R) ConnectX(R)-4 40G MCX415A-BCAT (1x40G)
948 * Mellanox(R) ConnectX(R)-4 50G MCX4131A-GCAT (1x50G)
949 * Mellanox(R) ConnectX(R)-4 50G MCX413A-GCAT (1x50G)
950 * Mellanox(R) ConnectX(R)-4 50G MCX414A-BCAT (2x50G)
951 * Mellanox(R) ConnectX(R)-4 50G MCX415A-GCAT (2x50G)
952 * Mellanox(R) ConnectX(R)-4 50G MCX416A-BCAT (2x50G)
953 * Mellanox(R) ConnectX(R)-4 50G MCX416A-GCAT (2x50G)
954 * Mellanox(R) ConnectX(R)-4 50G MCX415A-CCAT (1x100G)
955 * Mellanox(R) ConnectX(R)-4 100G MCX416A-CCAT (2x100G)
956 * Mellanox(R) ConnectX(R)-4 Lx 10G MCX4121A-XCAT (2x10G)
957 * Mellanox(R) ConnectX(R)-4 Lx 25G MCX4121A-ACAT (2x25G)
958 * Mellanox(R) ConnectX(R)-5 100G MCX556A-ECAT (2x100G)
959 * Mellanox(R) ConnectX(R)-5 Ex EN 100G MCX516A-CDAT (2x100G)
960 * Mellanox(R) ConnectX(R)-6 200G MCX654106A-HCAT (4x200G)
961 * Mellanox(R) ConnectX(R)-6DX EN 100G MCX623106AN-CDAT (2*100g)
962 * Mellanox(R) ConnectX(R)-6DX EN 200G MCX623105AN-VDAT (1*200g)
964 Quick Start Guide on OFED/EN
965 ----------------------------
967 1. Download latest Mellanox OFED/EN. For more info check the `prerequisites`_.
970 2. Install the required libraries and kernel modules either by installing
971 only the required set, or by installing the entire Mellanox OFED/EN::
973 ./mlnxofedinstall --upstream-libs --dpdk
975 3. Verify the firmware is the correct one::
979 4. Verify all ports links are set to Ethernet::
981 mlxconfig -d <mst device> query | grep LINK_TYPE
985 Link types may have to be configured to Ethernet::
987 mlxconfig -d <mst device> set LINK_TYPE_P1/2=1/2/3
989 * LINK_TYPE_P1=<1|2|3> , 1=Infiniband 2=Ethernet 3=VPI(auto-sense)
991 For hypervisors, verify SR-IOV is enabled on the NIC::
993 mlxconfig -d <mst device> query | grep SRIOV_EN
996 If needed, configure SR-IOV::
998 mlxconfig -d <mst device> set SRIOV_EN=1 NUM_OF_VFS=16
999 mlxfwreset -d <mst device> reset
1001 5. Restart the driver::
1003 /etc/init.d/openibd restart
1007 service openibd restart
1009 If link type was changed, firmware must be reset as well::
1011 mlxfwreset -d <mst device> reset
1013 For hypervisors, after reset write the sysfs number of virtual functions
1016 To dynamically instantiate a given number of virtual functions (VFs)::
1018 echo [num_vfs] > /sys/class/infiniband/mlx5_0/device/sriov_numvfs
1020 6. Compile DPDK and you are ready to go. See instructions on
1021 :ref:`Development Kit Build System <Development_Kit_Build_System>`
1023 Enable switchdev mode
1024 ---------------------
1026 Switchdev mode is a mode in E-Switch, that binds between representor and VF.
1027 Representor is a port in DPDK that is connected to a VF in such a way
1028 that assuming there are no offload flows, each packet that is sent from the VF
1029 will be received by the corresponding representor. While each packet that is
1030 sent to a representor will be received by the VF.
1031 This is very useful in case of SRIOV mode, where the first packet that is sent
1032 by the VF will be received by the DPDK application which will decide if this
1033 flow should be offloaded to the E-Switch. After offloading the flow packet
1034 that the VF that are matching the flow will not be received any more by
1035 the DPDK application.
1037 1. Enable SRIOV mode::
1039 mlxconfig -d <mst device> set SRIOV_EN=true
1041 2. Configure the max number of VFs::
1043 mlxconfig -d <mst device> set NUM_OF_VFS=<num of vfs>
1047 mlxfwreset -d <mst device> reset
1049 3. Configure the actual number of VFs::
1051 echo <num of vfs > /sys/class/net/<net device>/device/sriov_numvfs
1053 4. Unbind the device (can be rebind after the switchdev mode)::
1055 echo -n "<device pci address" > /sys/bus/pci/drivers/mlx5_core/unbind
1057 5. Enbale switchdev mode::
1059 echo switchdev > /sys/class/net/<net device>/compat/devlink/mode
1064 1. Configure aggressive CQE Zipping for maximum performance::
1066 mlxconfig -d <mst device> s CQE_COMPRESSION=1
1068 To set it back to the default CQE Zipping mode use::
1070 mlxconfig -d <mst device> s CQE_COMPRESSION=0
1072 2. In case of virtualization:
1074 - Make sure that hypervisor kernel is 3.16 or newer.
1075 - Configure boot with ``iommu=pt``.
1076 - Use 1G huge pages.
1077 - Make sure to allocate a VM on huge pages.
1078 - Make sure to set CPU pinning.
1080 3. Use the CPU near local NUMA node to which the PCIe adapter is connected,
1081 for better performance. For VMs, verify that the right CPU
1082 and NUMA node are pinned according to the above. Run::
1086 to identify the NUMA node to which the PCIe adapter is connected.
1088 4. If more than one adapter is used, and root complex capabilities allow
1089 to put both adapters on the same NUMA node without PCI bandwidth degradation,
1090 it is recommended to locate both adapters on the same NUMA node.
1091 This in order to forward packets from one to the other without
1092 NUMA performance penalty.
1094 5. Disable pause frames::
1096 ethtool -A <netdev> rx off tx off
1098 6. Verify IO non-posted prefetch is disabled by default. This can be checked
1099 via the BIOS configuration. Please contact you server provider for more
1100 information about the settings.
1104 On some machines, depends on the machine integrator, it is beneficial
1105 to set the PCI max read request parameter to 1K. This can be
1106 done in the following way:
1108 To query the read request size use::
1110 setpci -s <NIC PCI address> 68.w
1112 If the output is different than 3XXX, set it by::
1114 setpci -s <NIC PCI address> 68.w=3XXX
1116 The XXX can be different on different systems. Make sure to configure
1117 according to the setpci output.
1119 7. To minimize overhead of searching Memory Regions:
1121 - '--socket-mem' is recommended to pin memory by predictable amount.
1122 - Configure per-lcore cache when creating Mempools for packet buffer.
1123 - Refrain from dynamically allocating/freeing memory in run-time.
1125 .. _mlx5_offloads_support:
1127 Supported hardware offloads
1128 ---------------------------
1130 .. table:: Minimal SW/HW versions for queue offloads
1132 ============== ===== ===== ========= ===== ========== ==========
1133 Offload DPDK Linux rdma-core OFED firmware hardware
1134 ============== ===== ===== ========= ===== ========== ==========
1135 common base 17.11 4.14 16 4.2-1 12.21.1000 ConnectX-4
1136 checksums 17.11 4.14 16 4.2-1 12.21.1000 ConnectX-4
1137 Rx timestamp 17.11 4.14 16 4.2-1 12.21.1000 ConnectX-4
1138 TSO 17.11 4.14 16 4.2-1 12.21.1000 ConnectX-4
1139 LRO 19.08 N/A N/A 4.6-4 16.25.6406 ConnectX-5
1140 ============== ===== ===== ========= ===== ========== ==========
1142 .. table:: Minimal SW/HW versions for rte_flow offloads
1144 +-----------------------+-----------------+-----------------+
1145 | Offload | with E-Switch | with NIC |
1146 +=======================+=================+=================+
1147 | Count | | DPDK 19.05 | | DPDK 19.02 |
1148 | | | OFED 4.6 | | OFED 4.6 |
1149 | | | rdma-core 24 | | rdma-core 23 |
1150 | | | ConnectX-5 | | ConnectX-5 |
1151 +-----------------------+-----------------+-----------------+
1152 | Drop | | DPDK 19.05 | | DPDK 18.11 |
1153 | | | OFED 4.6 | | OFED 4.5 |
1154 | | | rdma-core 24 | | rdma-core 23 |
1155 | | | ConnectX-5 | | ConnectX-4 |
1156 +-----------------------+-----------------+-----------------+
1157 | Queue / RSS | | | | DPDK 18.11 |
1158 | | | N/A | | OFED 4.5 |
1159 | | | | | rdma-core 23 |
1160 | | | | | ConnectX-4 |
1161 +-----------------------+-----------------+-----------------+
1162 | Encapsulation | | DPDK 19.05 | | DPDK 19.02 |
1163 | (VXLAN / NVGRE / RAW) | | OFED 4.7-1 | | OFED 4.6 |
1164 | | | rdma-core 24 | | rdma-core 23 |
1165 | | | ConnectX-5 | | ConnectX-5 |
1166 +-----------------------+-----------------+-----------------+
1167 | Encapsulation | | DPDK 19.11 | | DPDK 19.11 |
1168 | GENEVE | | OFED 4.7-3 | | OFED 4.7-3 |
1169 | | | rdma-core 27 | | rdma-core 27 |
1170 | | | ConnectX-5 | | ConnectX-5 |
1171 +-----------------------+-----------------+-----------------+
1172 | | Header rewrite | | DPDK 19.05 | | DPDK 19.02 |
1173 | | (set_ipv4_src / | | OFED 4.7-1 | | OFED 4.7-1 |
1174 | | set_ipv4_dst / | | rdma-core 24 | | rdma-core 24 |
1175 | | set_ipv6_src / | | ConnectX-5 | | ConnectX-5 |
1176 | | set_ipv6_dst / | | | | |
1177 | | set_tp_src / | | | | |
1178 | | set_tp_dst / | | | | |
1179 | | dec_ttl / | | | | |
1180 | | set_ttl / | | | | |
1181 | | set_mac_src / | | | | |
1182 | | set_mac_dst) | | | | |
1183 +-----------------------+-----------------+-----------------+
1184 | | Header rewrite | | DPDK 20.02 | | DPDK 20.02 |
1185 | | (set_dscp) | | OFED 5.0 | | OFED 5.0 |
1186 | | | | rdma-core 24 | | rdma-core 24 |
1187 | | | | ConnectX-5 | | ConnectX-5 |
1188 +-----------------------+-----------------+-----------------+
1189 | Jump | | DPDK 19.05 | | DPDK 19.02 |
1190 | | | OFED 4.7-1 | | OFED 4.7-1 |
1191 | | | rdma-core 24 | | N/A |
1192 | | | ConnectX-5 | | ConnectX-5 |
1193 +-----------------------+-----------------+-----------------+
1194 | Mark / Flag | | DPDK 19.05 | | DPDK 18.11 |
1195 | | | OFED 4.6 | | OFED 4.5 |
1196 | | | rdma-core 24 | | rdma-core 23 |
1197 | | | ConnectX-5 | | ConnectX-4 |
1198 +-----------------------+-----------------+-----------------+
1199 | Port ID | | DPDK 19.05 | | N/A |
1200 | | | OFED 4.7-1 | | N/A |
1201 | | | rdma-core 24 | | N/A |
1202 | | | ConnectX-5 | | N/A |
1203 +-----------------------+-----------------+-----------------+
1204 | | VLAN | | DPDK 19.11 | | DPDK 19.11 |
1205 | | (of_pop_vlan / | | OFED 4.7-1 | | OFED 4.7-1 |
1206 | | of_push_vlan / | | ConnectX-5 | | ConnectX-5 |
1207 | | of_set_vlan_pcp / | | | | |
1208 | | of_set_vlan_vid) | | | | |
1209 +-----------------------+-----------------+-----------------+
1210 | Hairpin | | | | DPDK 19.11 |
1211 | | | N/A | | OFED 4.7-3 |
1212 | | | | | rdma-core 26 |
1213 | | | | | ConnectX-5 |
1214 +-----------------------+-----------------+-----------------+
1215 | Meta data | | DPDK 19.11 | | DPDK 19.11 |
1216 | | | OFED 4.7-3 | | OFED 4.7-3 |
1217 | | | rdma-core 26 | | rdma-core 26 |
1218 | | | ConnectX-5 | | ConnectX-5 |
1219 +-----------------------+-----------------+-----------------+
1220 | Metering | | DPDK 19.11 | | DPDK 19.11 |
1221 | | | OFED 4.7-3 | | OFED 4.7-3 |
1222 | | | rdma-core 26 | | rdma-core 26 |
1223 | | | ConnectX-5 | | ConnectX-5 |
1224 +-----------------------+-----------------+-----------------+
1229 Compared to librte_pmd_mlx4 that implements a single RSS configuration per
1230 port, librte_pmd_mlx5 supports per-protocol RSS configuration.
1232 Since ``testpmd`` defaults to IP RSS mode and there is currently no
1233 command-line parameter to enable additional protocols (UDP and TCP as well
1234 as IP), the following commands must be entered from its CLI to get the same
1235 behavior as librte_pmd_mlx4::
1238 > port config all rss all
1244 This section demonstrates how to launch **testpmd** with Mellanox
1245 ConnectX-4/ConnectX-5/ConnectX-6/BlueField devices managed by librte_pmd_mlx5.
1247 #. Load the kernel modules::
1249 modprobe -a ib_uverbs mlx5_core mlx5_ib
1251 Alternatively if MLNX_OFED/MLNX_EN is fully installed, the following script
1254 /etc/init.d/openibd restart
1258 User space I/O kernel modules (uio and igb_uio) are not used and do
1259 not have to be loaded.
1261 #. Make sure Ethernet interfaces are in working order and linked to kernel
1262 verbs. Related sysfs entries should be present::
1264 ls -d /sys/class/net/*/device/infiniband_verbs/uverbs* | cut -d / -f 5
1273 #. Optionally, retrieve their PCI bus addresses for whitelisting::
1276 for intf in eth2 eth3 eth4 eth5;
1278 (cd "/sys/class/net/${intf}/device/" && pwd -P);
1281 sed -n 's,.*/\(.*\),-w \1,p'
1290 #. Request huge pages::
1292 echo 1024 > /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages/nr_hugepages
1294 #. Start testpmd with basic parameters::
1296 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
1301 EAL: PCI device 0000:05:00.0 on NUMA socket 0
1302 EAL: probe driver: 15b3:1013 librte_pmd_mlx5
1303 PMD: librte_pmd_mlx5: PCI information matches, using device "mlx5_0" (VF: false)
1304 PMD: librte_pmd_mlx5: 1 port(s) detected
1305 PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:fe
1306 EAL: PCI device 0000:05:00.1 on NUMA socket 0
1307 EAL: probe driver: 15b3:1013 librte_pmd_mlx5
1308 PMD: librte_pmd_mlx5: PCI information matches, using device "mlx5_1" (VF: false)
1309 PMD: librte_pmd_mlx5: 1 port(s) detected
1310 PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:ff
1311 EAL: PCI device 0000:06:00.0 on NUMA socket 0
1312 EAL: probe driver: 15b3:1013 librte_pmd_mlx5
1313 PMD: librte_pmd_mlx5: PCI information matches, using device "mlx5_2" (VF: false)
1314 PMD: librte_pmd_mlx5: 1 port(s) detected
1315 PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:fa
1316 EAL: PCI device 0000:06:00.1 on NUMA socket 0
1317 EAL: probe driver: 15b3:1013 librte_pmd_mlx5
1318 PMD: librte_pmd_mlx5: PCI information matches, using device "mlx5_3" (VF: false)
1319 PMD: librte_pmd_mlx5: 1 port(s) detected
1320 PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:fb
1321 Interactive-mode selected
1322 Configuring Port 0 (socket 0)
1323 PMD: librte_pmd_mlx5: 0x8cba80: TX queues number update: 0 -> 2
1324 PMD: librte_pmd_mlx5: 0x8cba80: RX queues number update: 0 -> 2
1325 Port 0: E4:1D:2D:E7:0C:FE
1326 Configuring Port 1 (socket 0)
1327 PMD: librte_pmd_mlx5: 0x8ccac8: TX queues number update: 0 -> 2
1328 PMD: librte_pmd_mlx5: 0x8ccac8: RX queues number update: 0 -> 2
1329 Port 1: E4:1D:2D:E7:0C:FF
1330 Configuring Port 2 (socket 0)
1331 PMD: librte_pmd_mlx5: 0x8cdb10: TX queues number update: 0 -> 2
1332 PMD: librte_pmd_mlx5: 0x8cdb10: RX queues number update: 0 -> 2
1333 Port 2: E4:1D:2D:E7:0C:FA
1334 Configuring Port 3 (socket 0)
1335 PMD: librte_pmd_mlx5: 0x8ceb58: TX queues number update: 0 -> 2
1336 PMD: librte_pmd_mlx5: 0x8ceb58: RX queues number update: 0 -> 2
1337 Port 3: E4:1D:2D:E7:0C:FB
1338 Checking link statuses...
1339 Port 0 Link Up - speed 40000 Mbps - full-duplex
1340 Port 1 Link Up - speed 40000 Mbps - full-duplex
1341 Port 2 Link Up - speed 10000 Mbps - full-duplex
1342 Port 3 Link Up - speed 10000 Mbps - full-duplex
1349 This section demonstrates how to dump flows. Currently, it's possible to dump
1350 all flows with assistance of external tools.
1352 #. 2 ways to get flow raw file:
1354 - Using testpmd CLI:
1356 .. code-block:: console
1358 testpmd> flow dump <port> <output_file>
1360 - call rte_flow_dev_dump api:
1362 .. code-block:: console
1364 rte_flow_dev_dump(port, file, NULL);
1366 #. Dump human-readable flows from raw file:
1368 Get flow parsing tool from: https://github.com/Mellanox/mlx_steering_dump
1370 .. code-block:: console
1372 mlx_steering_dump.py -f <output_file>