1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright 2015 6WIND S.A.
3 Copyright 2015 Mellanox Technologies, Ltd
5 .. include:: <isonum.txt>
10 The MLX5 poll mode driver library (**librte_net_mlx5**) provides support
11 for **Mellanox ConnectX-4**, **Mellanox ConnectX-4 Lx** , **Mellanox
12 ConnectX-5**, **Mellanox ConnectX-6**, **Mellanox ConnectX-6 Dx**, **Mellanox
13 ConnectX-6 Lx**, **Mellanox BlueField** and **Mellanox BlueField-2** families
14 of 10/25/40/50/100/200 Gb/s adapters as well as their virtual functions (VF)
17 Information and documentation about these adapters can be found on the
18 `Mellanox website <http://www.mellanox.com>`__. Help is also provided by the
19 `Mellanox community <http://community.mellanox.com/welcome>`__.
21 There is also a `section dedicated to this poll mode driver
22 <http://www.mellanox.com/page/products_dyn?product_family=209&mtag=pmd_for_dpdk>`__.
28 Besides its dependency on libibverbs (that implies libmlx5 and associated
29 kernel support), librte_net_mlx5 relies heavily on system calls for control
30 operations such as querying/updating the MTU and flow control parameters.
32 For security reasons and robustness, this driver only deals with virtual
33 memory addresses. The way resources allocations are handled by the kernel,
34 combined with hardware specifications that allow to handle virtual memory
35 addresses directly, ensure that DPDK applications cannot access random
36 physical memory (or memory that does not belong to the current process).
38 This capability allows the PMD to coexist with kernel network interfaces
39 which remain functional, although they stop receiving unicast packets as
40 long as they share the same MAC address.
41 This means legacy linux control tools (for example: ethtool, ifconfig and
42 more) can operate on the same network interfaces that owned by the DPDK
45 The PMD can use libibverbs and libmlx5 to access the device firmware
46 or directly the hardware components.
47 There are different levels of objects and bypassing abilities
48 to get the best performances:
50 - Verbs is a complete high-level generic API
51 - Direct Verbs is a device-specific API
52 - DevX allows to access firmware objects
53 - Direct Rules manages flow steering at low-level hardware layer
55 Enabling librte_net_mlx5 causes DPDK applications to be linked against
61 - Multi arch support: x86_64, POWER8, ARMv8, i686.
62 - Multiple TX and RX queues.
63 - Support for scattered TX frames.
64 - Advanced support for scattered Rx frames with tunable buffer attributes.
65 - IPv4, IPv6, TCPv4, TCPv6, UDPv4 and UDPv6 RSS on any number of queues.
66 - RSS using different combinations of fields: L3 only, L4 only or both,
67 and source only, destination only or both.
68 - Several RSS hash keys, one for each flow type.
69 - Default RSS operation with no hash key specification.
70 - Configurable RETA table.
71 - Link flow control (pause frame).
72 - Support for multiple MAC addresses.
76 - RX CRC stripping configuration.
77 - TX mbuf fast free offload.
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, GTP.
93 - Tunnel HW offloads: packet type, inner/outer RSS, IP and UDP checksum verification.
94 - NIC HW offloads: encapsulation (vxlan, gre, mplsoudp, mplsogre), NAT, routing, TTL
95 increment/decrement, count, drop, mark. For details please see :ref:`mlx5_offloads_support`.
96 - Flow insertion rate of more then million flows per second, when using Direct Rules.
97 - Support for multiple rte_flow groups.
98 - Per packet no-inline hint flag to disable packet data copying into Tx descriptors.
101 - Multiple-thread flow insertion.
102 - Matching on GTP extension header with raw encap/decap action.
103 - Matching on Geneve TLV option header with raw encap/decap action.
104 - RSS support in sample action.
105 - E-Switch mirroring and jump.
106 - E-Switch mirroring and modify.
107 - 21844 flow priorities for ingress or egress flow groups greater than 0 and for any transfer
115 On Windows, the features are limited:
117 - Promiscuous mode is not supported
118 - The following rules are supported:
120 - IPv4/UDP with CVLAN filtering
121 - Unicast MAC filtering
123 - For secondary process:
125 - Forked secondary process not supported.
126 - External memory unregistered in EAL memseg list cannot be used for DMA
127 unless such memory has been registered by ``mlx5_mr_update_ext_mp()`` in
128 primary process and remapped to the same virtual address in secondary
129 process. If the external memory is registered by primary process but has
130 different virtual address in secondary process, unexpected error may happen.
132 - When using Verbs flow engine (``dv_flow_en`` = 0), flow pattern without any
133 specific VLAN will match for VLAN packets as well:
135 When VLAN spec is not specified in the pattern, the matching rule will be created with VLAN as a wild card.
136 Meaning, the flow rule::
138 flow create 0 ingress pattern eth / vlan vid is 3 / ipv4 / end ...
140 Will only match vlan packets with vid=3. and the flow rule::
142 flow create 0 ingress pattern eth / ipv4 / end ...
144 Will match any ipv4 packet (VLAN included).
146 - When using Verbs flow engine (``dv_flow_en`` = 0), multi-tagged(QinQ) match is not supported.
148 - When using DV flow engine (``dv_flow_en`` = 1), flow pattern with any VLAN specification will match only single-tagged packets unless the ETH item ``type`` field is 0x88A8 or the VLAN item ``has_more_vlan`` field is 1.
151 flow create 0 ingress pattern eth / ipv4 / end ...
153 Will match any ipv4 packet.
156 flow create 0 ingress pattern eth / vlan / end ...
157 flow create 0 ingress pattern eth has_vlan is 1 / end ...
158 flow create 0 ingress pattern eth type is 0x8100 / end ...
160 Will match single-tagged packets only, with any VLAN ID value.
163 flow create 0 ingress pattern eth type is 0x88A8 / end ...
164 flow create 0 ingress pattern eth / vlan has_more_vlan is 1 / end ...
166 Will match multi-tagged packets only, with any VLAN ID value.
168 - A flow pattern with 2 sequential VLAN items is not supported.
170 - VLAN pop offload command:
172 - Flow rules having a VLAN pop offload command as one of their actions and
173 are lacking a match on VLAN as one of their items are not supported.
174 - The command is not supported on egress traffic in NIC mode.
176 - VLAN push offload is not supported on ingress traffic in NIC mode.
178 - VLAN set PCP offload is not supported on existing headers.
180 - A multi segment packet must have not more segments than reported by dev_infos_get()
181 in tx_desc_lim.nb_seg_max field. This value depends on maximal supported Tx descriptor
182 size and ``txq_inline_min`` settings and may be from 2 (worst case forced by maximal
183 inline settings) to 58.
185 - Flows with a VXLAN Network Identifier equal (or ends to be equal)
186 to 0 are not supported.
188 - L3 VXLAN and VXLAN-GPE tunnels cannot be supported together with MPLSoGRE and MPLSoUDP.
190 - Match on Geneve header supports the following fields only:
197 - Match on Geneve TLV option is supported on the following fields:
204 Only one Class/Type/Length Geneve TLV option is supported per shared device.
205 Class/Type/Length fields must be specified as well as masks.
206 Class/Type/Length specified masks must be full.
207 Matching Geneve TLV option without specifying data is not supported.
208 Matching Geneve TLV option with ``data & mask == 0`` is not supported.
210 - VF: flow rules created on VF devices can only match traffic targeted at the
211 configured MAC addresses (see ``rte_eth_dev_mac_addr_add()``).
213 - Match on GTP tunnel header item supports the following fields only:
215 - v_pt_rsv_flags: E flag, S flag, PN flag
219 - Match on GTP extension header only for GTP PDU session container (next
220 extension header type = 0x85).
221 - Match on GTP extension header is not supported in group 0.
223 - No Tx metadata go to the E-Switch steering domain for the Flow group 0.
224 The flows within group 0 and set metadata action are rejected by hardware.
228 MAC addresses not already present in the bridge table of the associated
229 kernel network device will be added and cleaned up by the PMD when closing
230 the device. In case of ungraceful program termination, some entries may
231 remain present and should be removed manually by other means.
233 - Buffer split offload is supported with regular Rx burst routine only,
234 no MPRQ feature or vectorized code can be engaged.
236 - When Multi-Packet Rx queue is configured (``mprq_en``), a Rx packet can be
237 externally attached to a user-provided mbuf with having EXT_ATTACHED_MBUF in
238 ol_flags. As the mempool for the external buffer is managed by PMD, all the
239 Rx mbufs must be freed before the device is closed. Otherwise, the mempool of
240 the external buffers will be freed by PMD and the application which still
241 holds the external buffers may be corrupted.
243 - If Multi-Packet Rx queue is configured (``mprq_en``) and Rx CQE compression is
244 enabled (``rxq_cqe_comp_en``) at the same time, RSS hash result is not fully
245 supported. Some Rx packets may not have PKT_RX_RSS_HASH.
247 - IPv6 Multicast messages are not supported on VM, while promiscuous mode
248 and allmulticast mode are both set to off.
249 To receive IPv6 Multicast messages on VM, explicitly set the relevant
250 MAC address using rte_eth_dev_mac_addr_add() API.
252 - To support a mixed traffic pattern (some buffers from local host memory, some
253 buffers from other devices) with high bandwidth, a mbuf flag is used.
255 An application hints the PMD whether or not it should try to inline the
256 given mbuf data buffer. PMD should do the best effort to act upon this request.
258 The hint flag ``RTE_PMD_MLX5_FINE_GRANULARITY_INLINE`` is dynamic,
259 registered by application with rte_mbuf_dynflag_register(). This flag is
260 purely driver-specific and declared in PMD specific header ``rte_pmd_mlx5.h``,
261 which is intended to be used by the application.
263 To query the supported specific flags in runtime,
264 the function ``rte_pmd_mlx5_get_dyn_flag_names`` returns the array of
265 currently (over present hardware and configuration) supported specific flags.
266 The "not inline hint" feature operating flow is the following one:
269 - probe the devices, ports are created
270 - query the port capabilities
271 - if port supporting the feature is found
272 - register dynamic flag ``RTE_PMD_MLX5_FINE_GRANULARITY_INLINE``
273 - application starts the ports
274 - on ``dev_start()`` PMD checks whether the feature flag is registered and
275 enables the feature support in datapath
276 - application might set the registered flag bit in ``ol_flags`` field
277 of mbuf being sent and PMD will handle ones appropriately.
279 - The amount of descriptors in Tx queue may be limited by data inline settings.
280 Inline data require the more descriptor building blocks and overall block
281 amount may exceed the hardware supported limits. The application should
282 reduce the requested Tx size or adjust data inline settings with
283 ``txq_inline_max`` and ``txq_inline_mpw`` devargs keys.
285 - To provide the packet send scheduling on mbuf timestamps the ``tx_pp``
286 parameter should be specified.
287 When PMD sees the RTE_MBUF_DYNFLAG_TX_TIMESTAMP_NAME set on the packet
288 being sent it tries to synchronize the time of packet appearing on
289 the wire with the specified packet timestamp. It the specified one
290 is in the past it should be ignored, if one is in the distant future
291 it should be capped with some reasonable value (in range of seconds).
292 These specific cases ("too late" and "distant future") can be optionally
293 reported via device xstats to assist applications to detect the
294 time-related problems.
296 The timestamp upper "too-distant-future" limit
297 at the moment of invoking the Tx burst routine
298 can be estimated as ``tx_pp`` option (in nanoseconds) multiplied by 2^23.
299 Please note, for the testpmd txonly mode,
300 the limit is deduced from the expression::
302 (n_tx_descriptors / burst_size + 1) * inter_burst_gap
304 There is no any packet reordering according timestamps is supposed,
305 neither within packet burst, nor between packets, it is an entirely
306 application responsibility to generate packets and its timestamps
307 in desired order. The timestamps can be put only in the first packet
308 in the burst providing the entire burst scheduling.
310 - E-Switch decapsulation Flow:
312 - can be applied to PF port only.
313 - must specify VF port action (packet redirection from PF to VF).
314 - optionally may specify tunnel inner source and destination MAC addresses.
316 - E-Switch encapsulation Flow:
318 - can be applied to VF ports only.
319 - must specify PF port action (packet redirection from VF to PF).
323 - The input buffer, used as outer header, is not validated.
327 - The decapsulation is always done up to the outermost tunnel detected by the HW.
328 - The input buffer, providing the removal size, is not validated.
329 - The buffer size must match the length of the headers to be removed.
331 - ICMP(code/type/identifier/sequence number) / ICMP6(code/type) matching, IP-in-IP and MPLS flow matching are all
332 mutually exclusive features which cannot be supported together
333 (see :ref:`mlx5_firmware_config`).
337 - Requires DevX and DV flow to be enabled.
338 - KEEP_CRC offload cannot be supported with LRO.
339 - The first mbuf length, without head-room, must be big enough to include the
341 - Rx queue with LRO offload enabled, receiving a non-LRO packet, can forward
342 it with size limited to max LRO size, not to max RX packet length.
343 - LRO can be used with outer header of TCP packets of the standard format:
344 eth (with or without vlan) / ipv4 or ipv6 / tcp / payload
346 Other TCP packets (e.g. with MPLS label) received on Rx queue with LRO enabled, will be received with bad checksum.
347 - LRO packet aggregation is performed by HW only for packet size larger than
348 ``lro_min_mss_size``. This value is reported on device start, when debug
353 - ``DEV_RX_OFFLOAD_KEEP_CRC`` cannot be supported with decapsulation
354 for some NICs (such as ConnectX-6 Dx, ConnectX-6 Lx, and BlueField-2).
355 The capability bit ``scatter_fcs_w_decap_disable`` shows NIC support.
359 - fast free offload assumes the all mbufs being sent are originated from the
360 same memory pool and there is no any extra references to the mbufs (the
361 reference counter for each mbuf is equal 1 on tx_burst call). The latter
362 means there should be no any externally attached buffers in mbufs. It is
363 an application responsibility to provide the correct mbufs if the fast
364 free offload is engaged. The mlx5 PMD implicitly produces the mbufs with
365 externally attached buffers if MPRQ option is enabled, hence, the fast
366 free offload is neither supported nor advertised if there is MPRQ enabled.
370 - Supports ``RTE_FLOW_ACTION_TYPE_SAMPLE`` action only within NIC Rx and
371 E-Switch steering domain.
372 - For E-Switch Sampling flow with sample ratio > 1, additional actions are not
373 supported in the sample actions list.
374 - For ConnectX-5, the ``RTE_FLOW_ACTION_TYPE_SAMPLE`` is typically used as
375 first action in the E-Switch egress flow if with header modify or
376 encapsulation actions.
377 - For NIC Rx flow, supports ``MARK``, ``COUNT``, ``QUEUE``, ``RSS`` in the
379 - For E-Switch mirroring flow, supports ``RAW ENCAP``, ``Port ID``,
380 ``VXLAN ENCAP``, ``NVGRE ENCAP`` in the sample actions list.
384 - Supports the 'set' operation only for ``RTE_FLOW_ACTION_TYPE_MODIFY_FIELD`` action.
385 - Modification of an arbitrary place in a packet via the special ``RTE_FLOW_FIELD_START`` Field ID is not supported.
386 - Modification of the 802.1Q Tag, VXLAN Network or GENEVE Network ID's is not supported.
387 - Encapsulation levels are not supported, can modify outermost header fields only.
388 - Offsets must be 32-bits aligned, cannot skip past the boundary of a field.
390 - IPv6 header item 'proto' field, indicating the next header protocol, should
391 not be set as extension header.
392 In case the next header is an extension header, it should not be specified in
393 IPv6 header item 'proto' field.
394 The last extension header item 'next header' field can specify the following
395 header protocol type.
399 - Hairpin between two ports could only manual binding and explicit Tx flow mode. For single port hairpin, all the combinations of auto/manual binding and explicit/implicit Tx flow mode could be supported.
400 - Hairpin in switchdev SR-IOV mode is not supported till now.
403 - All the meter colors with drop action will be counted only by the global drop statistics.
404 - Green color is not supported with drop action.
405 - Yellow detection is not supported.
406 - Red color must be with drop action.
411 MLX5 supports various methods to report statistics:
413 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.
415 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.
417 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.
425 The ibverbs libraries can be linked with this PMD in a number of ways,
426 configured by the ``ibverbs_link`` build option:
428 - ``shared`` (default): the PMD depends on some .so files.
430 - ``dlopen``: Split the dependencies glue in a separate library
431 loaded when needed by dlopen.
432 It make dependencies on libibverbs and libmlx4 optional,
433 and has no performance impact.
435 - ``static``: Embed static flavor of the dependencies libibverbs and libmlx4
436 in the PMD shared library or the executable static binary.
438 Environment variables
439 ~~~~~~~~~~~~~~~~~~~~~
443 A list of directories in which to search for the rdma-core "glue" plug-in,
444 separated by colons or semi-colons.
446 - ``MLX5_SHUT_UP_BF``
448 Configures HW Tx doorbell register as IO-mapped.
450 By default, the HW Tx doorbell is configured as a write-combining register.
451 The register would be flushed to HW usually when the write-combining buffer
452 becomes full, but it depends on CPU design.
454 Except for vectorized Tx burst routines, a write memory barrier is enforced
455 after updating the register so that the update can be immediately visible to
458 When vectorized Tx burst is called, the barrier is set only if the burst size
459 is not aligned to MLX5_VPMD_TX_MAX_BURST. However, setting this environmental
460 variable will bring better latency even though the maximum throughput can
463 Run-time configuration
464 ~~~~~~~~~~~~~~~~~~~~~~
466 - librte_net_mlx5 brings kernel network interfaces up during initialization
467 because it is affected by their state. Forcing them down prevents packets
470 - **ethtool** operations on related kernel interfaces also affect the PMD.
475 In order to run as a non-root user,
476 some capabilities must be granted to the application::
478 setcap cap_sys_admin,cap_net_admin,cap_net_raw,cap_ipc_lock+ep <dpdk-app>
480 Below are the reasons of the need for each capability:
483 When using physical addresses (PA mode), with Linux >= 4.0,
484 for access to ``/proc/self/pagemap``.
487 For device configuration.
490 For raw ethernet queue allocation through kernel driver.
493 For DMA memory pinning.
498 - ``rxq_cqe_comp_en`` parameter [int]
500 A nonzero value enables the compression of CQE on RX side. This feature
501 allows to save PCI bandwidth and improve performance. Enabled by default.
502 Different compression formats are supported in order to achieve the best
503 performance for different traffic patterns. Default format depends on
504 Multi-Packet Rx queue configuration: Hash RSS format is used in case
505 MPRQ is disabled, Checksum format is used in case MPRQ is enabled.
507 Specifying 2 as a ``rxq_cqe_comp_en`` value selects Flow Tag format for
508 better compression rate in case of RTE Flow Mark traffic.
509 Specifying 3 as a ``rxq_cqe_comp_en`` value selects Checksum format.
510 Specifying 4 as a ``rxq_cqe_comp_en`` value selects L3/L4 Header format for
511 better compression rate in case of mixed TCP/UDP and IPv4/IPv6 traffic.
512 CQE compression format selection requires DevX to be enabled. If there is
513 no DevX enabled/supported the value is reset to 1 by default.
517 - x86_64 with ConnectX-4, ConnectX-4 Lx, ConnectX-5, ConnectX-6, ConnectX-6 Dx,
518 ConnectX-6 Lx, BlueField and BlueField-2.
519 - POWER9 and ARMv8 with ConnectX-4 Lx, ConnectX-5, ConnectX-6, ConnectX-6 Dx,
520 ConnectX-6 Lx, BlueField and BlueField-2.
522 - ``rxq_pkt_pad_en`` parameter [int]
524 A nonzero value enables padding Rx packet to the size of cacheline on PCI
525 transaction. This feature would waste PCI bandwidth but could improve
526 performance by avoiding partial cacheline write which may cause costly
527 read-modify-copy in memory transaction on some architectures. Disabled by
532 - x86_64 with ConnectX-4, ConnectX-4 Lx, ConnectX-5, ConnectX-6, ConnectX-6 Dx,
533 ConnectX-6 Lx, BlueField and BlueField-2.
534 - POWER8 and ARMv8 with ConnectX-4 Lx, ConnectX-5, ConnectX-6, ConnectX-6 Dx,
535 ConnectX-6 Lx, BlueField and BlueField-2.
537 - ``mprq_en`` parameter [int]
539 A nonzero value enables configuring Multi-Packet Rx queues. Rx queue is
540 configured as Multi-Packet RQ if the total number of Rx queues is
541 ``rxqs_min_mprq`` or more. Disabled by default.
543 Multi-Packet Rx Queue (MPRQ a.k.a Striding RQ) can further save PCIe bandwidth
544 by posting a single large buffer for multiple packets. Instead of posting a
545 buffers per a packet, one large buffer is posted in order to receive multiple
546 packets on the buffer. A MPRQ buffer consists of multiple fixed-size strides
547 and each stride receives one packet. MPRQ can improve throughput for
548 small-packet traffic.
550 When MPRQ is enabled, max_rx_pkt_len can be larger than the size of
551 user-provided mbuf even if DEV_RX_OFFLOAD_SCATTER isn't enabled. PMD will
552 configure large stride size enough to accommodate max_rx_pkt_len as long as
553 device allows. Note that this can waste system memory compared to enabling Rx
554 scatter and multi-segment packet.
556 - ``mprq_log_stride_num`` parameter [int]
558 Log 2 of the number of strides for Multi-Packet Rx queue. Configuring more
559 strides can reduce PCIe traffic further. If configured value is not in the
560 range of device capability, the default value will be set with a warning
561 message. The default value is 4 which is 16 strides per a buffer, valid only
562 if ``mprq_en`` is set.
564 The size of Rx queue should be bigger than the number of strides.
566 - ``mprq_log_stride_size`` parameter [int]
568 Log 2 of the size of a stride for Multi-Packet Rx queue. Configuring a smaller
569 stride size can save some memory and reduce probability of a depletion of all
570 available strides due to unreleased packets by an application. If configured
571 value is not in the range of device capability, the default value will be set
572 with a warning message. The default value is 11 which is 2048 bytes per a
573 stride, valid only if ``mprq_en`` is set. With ``mprq_log_stride_size`` set
574 it is possible for a packet to span across multiple strides. This mode allows
575 support of jumbo frames (9K) with MPRQ. The memcopy of some packets (or part
576 of a packet if Rx scatter is configured) may be required in case there is no
577 space left for a head room at the end of a stride which incurs some
580 - ``mprq_max_memcpy_len`` parameter [int]
582 The maximum length of packet to memcpy in case of Multi-Packet Rx queue. Rx
583 packet is mem-copied to a user-provided mbuf if the size of Rx packet is less
584 than or equal to this parameter. Otherwise, PMD will attach the Rx packet to
585 the mbuf by external buffer attachment - ``rte_pktmbuf_attach_extbuf()``.
586 A mempool for external buffers will be allocated and managed by PMD. If Rx
587 packet is externally attached, ol_flags field of the mbuf will have
588 EXT_ATTACHED_MBUF and this flag must be preserved. ``RTE_MBUF_HAS_EXTBUF()``
589 checks the flag. The default value is 128, valid only if ``mprq_en`` is set.
591 - ``rxqs_min_mprq`` parameter [int]
593 Configure Rx queues as Multi-Packet RQ if the total number of Rx queues is
594 greater or equal to this value. The default value is 12, valid only if
597 - ``txq_inline`` parameter [int]
599 Amount of data to be inlined during TX operations. This parameter is
600 deprecated and converted to the new parameter ``txq_inline_max`` providing
601 partial compatibility.
603 - ``txqs_min_inline`` parameter [int]
605 Enable inline data send only when the number of TX queues is greater or equal
608 This option should be used in combination with ``txq_inline_max`` and
609 ``txq_inline_mpw`` below and does not affect ``txq_inline_min`` settings above.
611 If this option is not specified the default value 16 is used for BlueField
612 and 8 for other platforms
614 The data inlining consumes the CPU cycles, so this option is intended to
615 auto enable inline data if we have enough Tx queues, which means we have
616 enough CPU cores and PCI bandwidth is getting more critical and CPU
617 is not supposed to be bottleneck anymore.
619 The copying data into WQE improves latency and can improve PPS performance
620 when PCI back pressure is detected and may be useful for scenarios involving
621 heavy traffic on many queues.
623 Because additional software logic is necessary to handle this mode, this
624 option should be used with care, as it may lower performance when back
625 pressure is not expected.
627 If inline data are enabled it may affect the maximal size of Tx queue in
628 descriptors because the inline data increase the descriptor size and
629 queue size limits supported by hardware may be exceeded.
631 - ``txq_inline_min`` parameter [int]
633 Minimal amount of data to be inlined into WQE during Tx operations. NICs
634 may require this minimal data amount to operate correctly. The exact value
635 may depend on NIC operation mode, requested offloads, etc. It is strongly
636 recommended to omit this parameter and use the default values. Anyway,
637 applications using this parameter should take into consideration that
638 specifying an inconsistent value may prevent the NIC from sending packets.
640 If ``txq_inline_min`` key is present the specified value (may be aligned
641 by the driver in order not to exceed the limits and provide better descriptor
642 space utilization) will be used by the driver and it is guaranteed that
643 requested amount of data bytes are inlined into the WQE beside other inline
644 settings. This key also may update ``txq_inline_max`` value (default
645 or specified explicitly in devargs) to reserve the space for inline data.
647 If ``txq_inline_min`` key is not present, the value may be queried by the
648 driver from the NIC via DevX if this feature is available. If there is no DevX
649 enabled/supported the value 18 (supposing L2 header including VLAN) is set
650 for ConnectX-4 and ConnectX-4 Lx, and 0 is set by default for ConnectX-5
651 and newer NICs. If packet is shorter the ``txq_inline_min`` value, the entire
654 For ConnectX-4 NIC, driver does not allow specifying value below 18
655 (minimal L2 header, including VLAN), error will be raised.
657 For ConnectX-4 Lx NIC, it is allowed to specify values below 18, but
658 it is not recommended and may prevent NIC from sending packets over
661 Please, note, this minimal data inlining disengages eMPW feature (Enhanced
662 Multi-Packet Write), because last one does not support partial packet inlining.
663 This is not very critical due to minimal data inlining is mostly required
664 by ConnectX-4 and ConnectX-4 Lx, these NICs do not support eMPW feature.
666 - ``txq_inline_max`` parameter [int]
668 Specifies the maximal packet length to be completely inlined into WQE
669 Ethernet Segment for ordinary SEND method. If packet is larger than specified
670 value, the packet data won't be copied by the driver at all, data buffer
671 is addressed with a pointer. If packet length is less or equal all packet
672 data will be copied into WQE. This may improve PCI bandwidth utilization for
673 short packets significantly but requires the extra CPU cycles.
675 The data inline feature is controlled by number of Tx queues, if number of Tx
676 queues is larger than ``txqs_min_inline`` key parameter, the inline feature
677 is engaged, if there are not enough Tx queues (which means not enough CPU cores
678 and CPU resources are scarce), data inline is not performed by the driver.
679 Assigning ``txqs_min_inline`` with zero always enables the data inline.
681 The default ``txq_inline_max`` value is 290. The specified value may be adjusted
682 by the driver in order not to exceed the limit (930 bytes) and to provide better
683 WQE space filling without gaps, the adjustment is reflected in the debug log.
684 Also, the default value (290) may be decreased in run-time if the large transmit
685 queue size is requested and hardware does not support enough descriptor
686 amount, in this case warning is emitted. If ``txq_inline_max`` key is
687 specified and requested inline settings can not be satisfied then error
690 - ``txq_inline_mpw`` parameter [int]
692 Specifies the maximal packet length to be completely inlined into WQE for
693 Enhanced MPW method. If packet is large the specified value, the packet data
694 won't be copied, and data buffer is addressed with pointer. If packet length
695 is less or equal, all packet data will be copied into WQE. This may improve PCI
696 bandwidth utilization for short packets significantly but requires the extra
699 The data inline feature is controlled by number of TX queues, if number of Tx
700 queues is larger than ``txqs_min_inline`` key parameter, the inline feature
701 is engaged, if there are not enough Tx queues (which means not enough CPU cores
702 and CPU resources are scarce), data inline is not performed by the driver.
703 Assigning ``txqs_min_inline`` with zero always enables the data inline.
705 The default ``txq_inline_mpw`` value is 268. The specified value may be adjusted
706 by the driver in order not to exceed the limit (930 bytes) and to provide better
707 WQE space filling without gaps, the adjustment is reflected in the debug log.
708 Due to multiple packets may be included to the same WQE with Enhanced Multi
709 Packet Write Method and overall WQE size is limited it is not recommended to
710 specify large values for the ``txq_inline_mpw``. Also, the default value (268)
711 may be decreased in run-time if the large transmit queue size is requested
712 and hardware does not support enough descriptor amount, in this case warning
713 is emitted. If ``txq_inline_mpw`` key is specified and requested inline
714 settings can not be satisfied then error will be raised.
716 - ``txqs_max_vec`` parameter [int]
718 Enable vectorized Tx only when the number of TX queues is less than or
719 equal to this value. This parameter is deprecated and ignored, kept
720 for compatibility issue to not prevent driver from probing.
722 - ``txq_mpw_hdr_dseg_en`` parameter [int]
724 A nonzero value enables including two pointers in the first block of TX
725 descriptor. The parameter is deprecated and ignored, kept for compatibility
728 - ``txq_max_inline_len`` parameter [int]
730 Maximum size of packet to be inlined. This limits the size of packet to
731 be inlined. If the size of a packet is larger than configured value, the
732 packet isn't inlined even though there's enough space remained in the
733 descriptor. Instead, the packet is included with pointer. This parameter
734 is deprecated and converted directly to ``txq_inline_mpw`` providing full
735 compatibility. Valid only if eMPW feature is engaged.
737 - ``txq_mpw_en`` parameter [int]
739 A nonzero value enables Enhanced Multi-Packet Write (eMPW) for ConnectX-5,
740 ConnectX-6, ConnectX-6 Dx, ConnectX-6 Lx, BlueField, BlueField-2.
741 eMPW allows the Tx burst function to pack up multiple packets
742 in a single descriptor session in order to save PCI bandwidth
743 and improve performance at the cost of a slightly higher CPU usage.
744 When ``txq_inline_mpw`` is set along with ``txq_mpw_en``,
745 Tx burst function copies entire packet data on to Tx descriptor
746 instead of including pointer of packet.
748 The Enhanced Multi-Packet Write feature is enabled by default if NIC supports
749 it, can be disabled by explicit specifying 0 value for ``txq_mpw_en`` option.
750 Also, if minimal data inlining is requested by non-zero ``txq_inline_min``
751 option or reported by the NIC, the eMPW feature is disengaged.
753 - ``tx_db_nc`` parameter [int]
755 The rdma core library can map doorbell register in two ways, depending on the
756 environment variable "MLX5_SHUT_UP_BF":
758 - As regular cached memory (usually with write combining attribute), if the
759 variable is either missing or set to zero.
760 - As non-cached memory, if the variable is present and set to not "0" value.
762 The type of mapping may slightly affect the Tx performance, the optimal choice
763 is strongly relied on the host architecture and should be deduced practically.
765 If ``tx_db_nc`` is set to zero, the doorbell is forced to be mapped to regular
766 memory (with write combining), the PMD will perform the extra write memory barrier
767 after writing to doorbell, it might increase the needed CPU clocks per packet
768 to send, but latency might be improved.
770 If ``tx_db_nc`` is set to one, the doorbell is forced to be mapped to non
771 cached memory, the PMD will not perform the extra write memory barrier
772 after writing to doorbell, on some architectures it might improve the
775 If ``tx_db_nc`` is set to two, the doorbell is forced to be mapped to regular
776 memory, the PMD will use heuristics to decide whether write memory barrier
777 should be performed. For bursts with size multiple of recommended one (64 pkts)
778 it is supposed the next burst is coming and no need to issue the extra memory
779 barrier (it is supposed to be issued in the next coming burst, at least after
780 descriptor writing). It might increase latency (on some hosts till next
781 packets transmit) and should be used with care.
783 If ``tx_db_nc`` is omitted or set to zero, the preset (if any) environment
784 variable "MLX5_SHUT_UP_BF" value is used. If there is no "MLX5_SHUT_UP_BF",
785 the default ``tx_db_nc`` value is zero for ARM64 hosts and one for others.
787 - ``tx_pp`` parameter [int]
789 If a nonzero value is specified the driver creates all necessary internal
790 objects to provide accurate packet send scheduling on mbuf timestamps.
791 The positive value specifies the scheduling granularity in nanoseconds,
792 the packet send will be accurate up to specified digits. The allowed range is
793 from 500 to 1 million of nanoseconds. The negative value specifies the module
794 of granularity and engages the special test mode the check the schedule rate.
795 By default (if the ``tx_pp`` is not specified) send scheduling on timestamps
798 - ``tx_skew`` parameter [int]
800 The parameter adjusts the send packet scheduling on timestamps and represents
801 the average delay between beginning of the transmitting descriptor processing
802 by the hardware and appearance of actual packet data on the wire. The value
803 should be provided in nanoseconds and is valid only if ``tx_pp`` parameter is
804 specified. The default value is zero.
806 - ``tx_vec_en`` parameter [int]
808 A nonzero value enables Tx vector on ConnectX-5, ConnectX-6, ConnectX-6 Dx,
809 ConnectX-6 Lx, BlueField and BlueField-2 NICs
810 if the number of global Tx queues on the port is less than ``txqs_max_vec``.
811 The parameter is deprecated and ignored.
813 - ``rx_vec_en`` parameter [int]
815 A nonzero value enables Rx vector if the port is not configured in
816 multi-segment otherwise this parameter is ignored.
820 - ``vf_nl_en`` parameter [int]
822 A nonzero value enables Netlink requests from the VF to add/remove MAC
823 addresses or/and enable/disable promiscuous/all multicast on the Netdevice.
824 Otherwise the relevant configuration must be run with Linux iproute2 tools.
825 This is a prerequisite to receive this kind of traffic.
827 Enabled by default, valid only on VF devices ignored otherwise.
829 - ``l3_vxlan_en`` parameter [int]
831 A nonzero value allows L3 VXLAN and VXLAN-GPE flow creation. To enable
832 L3 VXLAN or VXLAN-GPE, users has to configure firmware and enable this
833 parameter. This is a prerequisite to receive this kind of traffic.
837 - ``dv_xmeta_en`` parameter [int]
839 A nonzero value enables extensive flow metadata support if device is
840 capable and driver supports it. This can enable extensive support of
841 ``MARK`` and ``META`` item of ``rte_flow``. The newly introduced
842 ``SET_TAG`` and ``SET_META`` actions do not depend on ``dv_xmeta_en``.
844 There are some possible configurations, depending on parameter value:
846 - 0, this is default value, defines the legacy mode, the ``MARK`` and
847 ``META`` related actions and items operate only within NIC Tx and
848 NIC Rx steering domains, no ``MARK`` and ``META`` information crosses
849 the domain boundaries. The ``MARK`` item is 24 bits wide, the ``META``
850 item is 32 bits wide and match supported on egress only.
852 - 1, this engages extensive metadata mode, the ``MARK`` and ``META``
853 related actions and items operate within all supported steering domains,
854 including FDB, ``MARK`` and ``META`` information may cross the domain
855 boundaries. The ``MARK`` item is 24 bits wide, the ``META`` item width
856 depends on kernel and firmware configurations and might be 0, 16 or
857 32 bits. Within NIC Tx domain ``META`` data width is 32 bits for
858 compatibility, the actual width of data transferred to the FDB domain
859 depends on kernel configuration and may be vary. The actual supported
860 width can be retrieved in runtime by series of rte_flow_validate()
863 - 2, this engages extensive metadata mode, the ``MARK`` and ``META``
864 related actions and items operate within all supported steering domains,
865 including FDB, ``MARK`` and ``META`` information may cross the domain
866 boundaries. The ``META`` item is 32 bits wide, the ``MARK`` item width
867 depends on kernel and firmware configurations and might be 0, 16 or
868 24 bits. The actual supported width can be retrieved in runtime by
869 series of rte_flow_validate() trials.
871 - 3, this engages tunnel offload mode. In E-Switch configuration, that
872 mode implicitly activates ``dv_xmeta_en=1``.
874 +------+-----------+-----------+-------------+-------------+
875 | Mode | ``MARK`` | ``META`` | ``META`` Tx | FDB/Through |
876 +======+===========+===========+=============+=============+
877 | 0 | 24 bits | 32 bits | 32 bits | no |
878 +------+-----------+-----------+-------------+-------------+
879 | 1 | 24 bits | vary 0-32 | 32 bits | yes |
880 +------+-----------+-----------+-------------+-------------+
881 | 2 | vary 0-24 | 32 bits | 32 bits | yes |
882 +------+-----------+-----------+-------------+-------------+
884 If there is no E-Switch configuration the ``dv_xmeta_en`` parameter is
885 ignored and the device is configured to operate in legacy mode (0).
887 Disabled by default (set to 0).
889 The Direct Verbs/Rules (engaged with ``dv_flow_en`` = 1) supports all
890 of the extensive metadata features. The legacy Verbs supports FLAG and
891 MARK metadata actions over NIC Rx steering domain only.
893 Setting META value to zero in flow action means there is no item provided
894 and receiving datapath will not report in mbufs the metadata are present.
895 Setting MARK value to zero in flow action means the zero FDIR ID value
896 will be reported on packet receiving.
898 For the MARK action the last 16 values in the full range are reserved for
899 internal PMD purposes (to emulate FLAG action). The valid range for the
900 MARK action values is 0-0xFFEF for the 16-bit mode and 0-xFFFFEF
901 for the 24-bit mode, the flows with the MARK action value outside
902 the specified range will be rejected.
904 - ``dv_flow_en`` parameter [int]
906 A nonzero value enables the DV flow steering assuming it is supported
907 by the driver (RDMA Core library version is rdma-core-24.0 or higher).
909 Enabled by default if supported.
911 - ``dv_esw_en`` parameter [int]
913 A nonzero value enables E-Switch using Direct Rules.
915 Enabled by default if supported.
917 - ``lacp_by_user`` parameter [int]
919 A nonzero value enables the control of LACP traffic by the user application.
920 When a bond exists in the driver, by default it should be managed by the
921 kernel and therefore LACP traffic should be steered to the kernel.
922 If this devarg is set to 1 it will allow the user to manage the bond by
923 itself and not steer LACP traffic to the kernel.
925 Disabled by default (set to 0).
927 - ``mr_ext_memseg_en`` parameter [int]
929 A nonzero value enables extending memseg when registering DMA memory. If
930 enabled, the number of entries in MR (Memory Region) lookup table on datapath
931 is minimized and it benefits performance. On the other hand, it worsens memory
932 utilization because registered memory is pinned by kernel driver. Even if a
933 page in the extended chunk is freed, that doesn't become reusable until the
934 entire memory is freed.
938 - ``representor`` parameter [list]
940 This parameter can be used to instantiate DPDK Ethernet devices from
941 existing port (PF, VF or SF) representors configured on the device.
943 It is a standard parameter whose format is described in
944 :ref:`ethernet_device_standard_device_arguments`.
946 For instance, to probe VF port representors 0 through 2::
948 <PCI_BDF>,representor=vf[0-2]
950 To probe SF port representors 0 through 2::
952 <PCI_BDF>,representor=sf[0-2]
954 To probe VF port representors 0 through 2 on both PFs of bonding device::
956 <Primary_PCI_BDF>,representor=pf[0,1]vf[0-2]
958 - ``max_dump_files_num`` parameter [int]
960 The maximum number of files per PMD entity that may be created for debug information.
961 The files will be created in /var/log directory or in current directory.
963 set to 128 by default.
965 - ``lro_timeout_usec`` parameter [int]
967 The maximum allowed duration of an LRO session, in micro-seconds.
968 PMD will set the nearest value supported by HW, which is not bigger than
969 the input ``lro_timeout_usec`` value.
970 If this parameter is not specified, by default PMD will set
971 the smallest value supported by HW.
973 - ``hp_buf_log_sz`` parameter [int]
975 The total data buffer size of a hairpin queue (logarithmic form), in bytes.
976 PMD will set the data buffer size to 2 ** ``hp_buf_log_sz``, both for RX & TX.
977 The capacity of the value is specified by the firmware and the initialization
978 will get a failure if it is out of scope.
979 The range of the value is from 11 to 19 right now, and the supported frame
980 size of a single packet for hairpin is from 512B to 128KB. It might change if
981 different firmware release is being used. By using a small value, it could
982 reduce memory consumption but not work with a large frame. If the value is
983 too large, the memory consumption will be high and some potential performance
984 degradation will be introduced.
985 By default, the PMD will set this value to 16, which means that 9KB jumbo
986 frames will be supported.
988 - ``reclaim_mem_mode`` parameter [int]
990 Cache some resources in flow destroy will help flow recreation more efficient.
991 While some systems may require the all the resources can be reclaimed after
993 The parameter ``reclaim_mem_mode`` provides the option for user to configure
994 if the resource cache is needed or not.
996 There are three options to choose:
998 - 0. It means the flow resources will be cached as usual. The resources will
999 be cached, helpful with flow insertion rate.
1001 - 1. It will only enable the DPDK PMD level resources reclaim.
1003 - 2. Both DPDK PMD level and rdma-core low level will be configured as
1006 By default, the PMD will set this value to 0.
1008 - ``sys_mem_en`` parameter [int]
1010 A non-zero value enables the PMD memory management allocating memory
1011 from system by default, without explicit rte memory flag.
1013 By default, the PMD will set this value to 0.
1015 - ``decap_en`` parameter [int]
1017 Some devices do not support FCS (frame checksum) scattering for
1018 tunnel-decapsulated packets.
1019 If set to 0, this option forces the FCS feature and rejects tunnel
1020 decapsulation in the flow engine for such devices.
1022 By default, the PMD will set this value to 1.
1024 .. _mlx5_firmware_config:
1026 Firmware configuration
1027 ~~~~~~~~~~~~~~~~~~~~~~
1029 Firmware features can be configured as key/value pairs.
1031 The command to set a value is::
1033 mlxconfig -d <device> set <key>=<value>
1035 The command to query a value is::
1037 mlxconfig -d <device> query | grep <key>
1039 The device name for the command ``mlxconfig`` can be either the PCI address,
1040 or the mst device name found with::
1044 Below are some firmware configurations listed.
1050 value: 1=Infiniband 2=Ethernet 3=VPI(auto-sense)
1056 - maximum number of SR-IOV virtual functions::
1060 - enable DevX (required by Direct Rules and other features)::
1064 - aggressive CQE zipping::
1068 - L3 VXLAN and VXLAN-GPE destination UDP port::
1071 IP_OVER_VXLAN_PORT=<udp dport>
1073 - enable VXLAN-GPE tunnel flow matching::
1075 FLEX_PARSER_PROFILE_ENABLE=0
1077 FLEX_PARSER_PROFILE_ENABLE=2
1079 - enable IP-in-IP tunnel flow matching::
1081 FLEX_PARSER_PROFILE_ENABLE=0
1083 - enable MPLS flow matching::
1085 FLEX_PARSER_PROFILE_ENABLE=1
1087 - enable ICMP(code/type/identifier/sequence number) / ICMP6(code/type) fields matching::
1089 FLEX_PARSER_PROFILE_ENABLE=2
1091 - enable Geneve flow matching::
1093 FLEX_PARSER_PROFILE_ENABLE=0
1095 FLEX_PARSER_PROFILE_ENABLE=1
1097 - enable Geneve TLV option flow matching::
1099 FLEX_PARSER_PROFILE_ENABLE=0
1101 - enable GTP flow matching::
1103 FLEX_PARSER_PROFILE_ENABLE=3
1105 - enable eCPRI flow matching::
1107 FLEX_PARSER_PROFILE_ENABLE=4
1113 This driver relies on external libraries and kernel drivers for resources
1114 allocations and initialization. The following dependencies are not part of
1115 DPDK and must be installed separately:
1119 User space Verbs framework used by librte_net_mlx5. This library provides
1120 a generic interface between the kernel and low-level user space drivers
1123 It allows slow and privileged operations (context initialization, hardware
1124 resources allocations) to be managed by the kernel and fast operations to
1125 never leave user space.
1129 Low-level user space driver library for Mellanox
1130 ConnectX-4/ConnectX-5/ConnectX-6/BlueField devices, it is automatically loaded
1133 This library basically implements send/receive calls to the hardware
1136 - **Kernel modules**
1138 They provide the kernel-side Verbs API and low level device drivers that
1139 manage actual hardware initialization and resources sharing with user
1142 Unlike most other PMDs, these modules must remain loaded and bound to
1145 - mlx5_core: hardware driver managing Mellanox
1146 ConnectX-4/ConnectX-5/ConnectX-6/BlueField devices and related Ethernet kernel
1148 - mlx5_ib: InifiniBand device driver.
1149 - ib_uverbs: user space driver for Verbs (entry point for libibverbs).
1151 - **Firmware update**
1153 Mellanox OFED/EN releases include firmware updates for
1154 ConnectX-4/ConnectX-5/ConnectX-6/BlueField adapters.
1156 Because each release provides new features, these updates must be applied to
1157 match the kernel modules and libraries they come with.
1161 Both libraries are BSD and GPL licensed. Linux kernel modules are GPL
1167 Either RDMA Core library with a recent enough Linux kernel release
1168 (recommended) or Mellanox OFED/EN, which provides compatibility with older
1171 RDMA Core with Linux Kernel
1172 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1174 - Minimal kernel version : v4.14 or the most recent 4.14-rc (see `Linux installation documentation`_)
1175 - Minimal rdma-core version: v15+ commit 0c5f5765213a ("Merge pull request #227 from yishaih/tm")
1176 (see `RDMA Core installation documentation`_)
1177 - When building for i686 use:
1179 - rdma-core version 18.0 or above built with 32bit support.
1180 - Kernel version 4.14.41 or above.
1182 - Starting with rdma-core v21, static libraries can be built::
1185 CFLAGS=-fPIC cmake -DIN_PLACE=1 -DENABLE_STATIC=1 -GNinja ..
1188 .. _`Linux installation documentation`: https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux-stable.git/plain/Documentation/admin-guide/README.rst
1189 .. _`RDMA Core installation documentation`: https://raw.githubusercontent.com/linux-rdma/rdma-core/master/README.md
1195 - Mellanox OFED version: **4.5** and above /
1196 Mellanox EN version: **4.5** and above
1199 - ConnectX-4: **12.21.1000** and above.
1200 - ConnectX-4 Lx: **14.21.1000** and above.
1201 - ConnectX-5: **16.21.1000** and above.
1202 - ConnectX-5 Ex: **16.21.1000** and above.
1203 - ConnectX-6: **20.27.0090** and above.
1204 - ConnectX-6 Dx: **22.27.0090** and above.
1205 - BlueField: **18.25.1010** and above.
1207 While these libraries and kernel modules are available on OpenFabrics
1208 Alliance's `website <https://www.openfabrics.org/>`__ and provided by package
1209 managers on most distributions, this PMD requires Ethernet extensions that
1210 may not be supported at the moment (this is a work in progress).
1213 <http://www.mellanox.com/page/products_dyn?product_family=26&mtag=linux>`__ and
1215 <http://www.mellanox.com/page/products_dyn?product_family=27&mtag=linux>`__
1216 include the necessary support and should be used in the meantime. For DPDK,
1217 only libibverbs, libmlx5, mlnx-ofed-kernel packages and firmware updates are
1218 required from that distribution.
1222 Several versions of Mellanox OFED/EN are available. Installing the version
1223 this DPDK release was developed and tested against is strongly
1224 recommended. Please check the `linux prerequisites`_.
1226 Windows Prerequisites
1227 ---------------------
1229 This driver relies on external libraries and kernel drivers for resources
1230 allocations and initialization. The dependencies in the following sub-sections
1231 are not part of DPDK, and must be installed separately.
1233 Compilation Prerequisites
1234 ~~~~~~~~~~~~~~~~~~~~~~~~~
1236 DevX SDK installation
1237 ^^^^^^^^^^^^^^^^^^^^^
1239 The DevX SDK must be installed on the machine building the Windows PMD.
1240 Additional information can be found at
1241 `How to Integrate Windows DevX in Your Development Environment
1242 <https://docs.mellanox.com/display/winof2v250/RShim+Drivers+and+Usage#RShimDriversandUsage-DevXInterface>`__.
1244 Runtime Prerequisites
1245 ~~~~~~~~~~~~~~~~~~~~~
1247 WinOF2 version 2.60 or higher must be installed on the machine.
1252 The driver can be downloaded from the following site:
1254 <https://www.mellanox.com/products/adapter-software/ethernet/windows/winof-2>`__
1259 DevX for Windows must be enabled in the Windows registry.
1260 The keys ``DevxEnabled`` and ``DevxFsRules`` must be set.
1261 Additional information can be found in the WinOF2 user manual.
1266 The following Mellanox device families are supported by the same mlx5 driver:
1278 Below are detailed device names:
1280 * Mellanox\ |reg| ConnectX\ |reg|-4 10G MCX4111A-XCAT (1x10G)
1281 * Mellanox\ |reg| ConnectX\ |reg|-4 10G MCX412A-XCAT (2x10G)
1282 * Mellanox\ |reg| ConnectX\ |reg|-4 25G MCX4111A-ACAT (1x25G)
1283 * Mellanox\ |reg| ConnectX\ |reg|-4 25G MCX412A-ACAT (2x25G)
1284 * Mellanox\ |reg| ConnectX\ |reg|-4 40G MCX413A-BCAT (1x40G)
1285 * Mellanox\ |reg| ConnectX\ |reg|-4 40G MCX4131A-BCAT (1x40G)
1286 * Mellanox\ |reg| ConnectX\ |reg|-4 40G MCX415A-BCAT (1x40G)
1287 * Mellanox\ |reg| ConnectX\ |reg|-4 50G MCX413A-GCAT (1x50G)
1288 * Mellanox\ |reg| ConnectX\ |reg|-4 50G MCX4131A-GCAT (1x50G)
1289 * Mellanox\ |reg| ConnectX\ |reg|-4 50G MCX414A-BCAT (2x50G)
1290 * Mellanox\ |reg| ConnectX\ |reg|-4 50G MCX415A-GCAT (1x50G)
1291 * Mellanox\ |reg| ConnectX\ |reg|-4 50G MCX416A-BCAT (2x50G)
1292 * Mellanox\ |reg| ConnectX\ |reg|-4 50G MCX416A-GCAT (2x50G)
1293 * Mellanox\ |reg| ConnectX\ |reg|-4 50G MCX415A-CCAT (1x100G)
1294 * Mellanox\ |reg| ConnectX\ |reg|-4 100G MCX416A-CCAT (2x100G)
1295 * Mellanox\ |reg| ConnectX\ |reg|-4 Lx 10G MCX4111A-XCAT (1x10G)
1296 * Mellanox\ |reg| ConnectX\ |reg|-4 Lx 10G MCX4121A-XCAT (2x10G)
1297 * Mellanox\ |reg| ConnectX\ |reg|-4 Lx 25G MCX4111A-ACAT (1x25G)
1298 * Mellanox\ |reg| ConnectX\ |reg|-4 Lx 25G MCX4121A-ACAT (2x25G)
1299 * Mellanox\ |reg| ConnectX\ |reg|-4 Lx 40G MCX4131A-BCAT (1x40G)
1300 * Mellanox\ |reg| ConnectX\ |reg|-5 100G MCX556A-ECAT (2x100G)
1301 * Mellanox\ |reg| ConnectX\ |reg|-5 Ex EN 100G MCX516A-CDAT (2x100G)
1302 * Mellanox\ |reg| ConnectX\ |reg|-6 200G MCX654106A-HCAT (2x200G)
1303 * Mellanox\ |reg| ConnectX\ |reg|-6 Dx EN 100G MCX623106AN-CDAT (2x100G)
1304 * Mellanox\ |reg| ConnectX\ |reg|-6 Dx EN 200G MCX623105AN-VDAT (1x200G)
1305 * Mellanox\ |reg| ConnectX\ |reg|-6 Lx EN 25G MCX631102AN-ADAT (2x25G)
1307 Quick Start Guide on OFED/EN
1308 ----------------------------
1310 1. Download latest Mellanox OFED/EN. For more info check the `linux prerequisites`_.
1313 2. Install the required libraries and kernel modules either by installing
1314 only the required set, or by installing the entire Mellanox OFED/EN::
1316 ./mlnxofedinstall --upstream-libs --dpdk
1318 3. Verify the firmware is the correct one::
1322 4. Verify all ports links are set to Ethernet::
1324 mlxconfig -d <mst device> query | grep LINK_TYPE
1328 Link types may have to be configured to Ethernet::
1330 mlxconfig -d <mst device> set LINK_TYPE_P1/2=1/2/3
1332 * LINK_TYPE_P1=<1|2|3> , 1=Infiniband 2=Ethernet 3=VPI(auto-sense)
1334 For hypervisors, verify SR-IOV is enabled on the NIC::
1336 mlxconfig -d <mst device> query | grep SRIOV_EN
1339 If needed, configure SR-IOV::
1341 mlxconfig -d <mst device> set SRIOV_EN=1 NUM_OF_VFS=16
1342 mlxfwreset -d <mst device> reset
1344 5. Restart the driver::
1346 /etc/init.d/openibd restart
1350 service openibd restart
1352 If link type was changed, firmware must be reset as well::
1354 mlxfwreset -d <mst device> reset
1356 For hypervisors, after reset write the sysfs number of virtual functions
1359 To dynamically instantiate a given number of virtual functions (VFs)::
1361 echo [num_vfs] > /sys/class/infiniband/mlx5_0/device/sriov_numvfs
1363 6. Install DPDK and you are ready to go.
1364 See :doc:`compilation instructions <../linux_gsg/build_dpdk>`.
1366 Enable switchdev mode
1367 ---------------------
1369 Switchdev mode is a mode in E-Switch, that binds between representor and VF or SF.
1370 Representor is a port in DPDK that is connected to a VF or SF in such a way
1371 that assuming there are no offload flows, each packet that is sent from the VF or SF
1372 will be received by the corresponding representor. While each packet that is or SF
1373 sent to a representor will be received by the VF or SF.
1374 This is very useful in case of SRIOV mode, where the first packet that is sent
1375 by the VF or SF will be received by the DPDK application which will decide if this
1376 flow should be offloaded to the E-Switch. After offloading the flow packet
1377 that the VF or SF that are matching the flow will not be received any more by
1378 the DPDK application.
1380 1. Enable SRIOV mode::
1382 mlxconfig -d <mst device> set SRIOV_EN=true
1384 2. Configure the max number of VFs::
1386 mlxconfig -d <mst device> set NUM_OF_VFS=<num of vfs>
1390 mlxfwreset -d <mst device> reset
1392 3. Configure the actual number of VFs::
1394 echo <num of vfs > /sys/class/net/<net device>/device/sriov_numvfs
1396 4. Unbind the device (can be rebind after the switchdev mode)::
1398 echo -n "<device pci address" > /sys/bus/pci/drivers/mlx5_core/unbind
1400 5. Enbale switchdev mode::
1402 echo switchdev > /sys/class/net/<net device>/compat/devlink/mode
1404 SubFunction representor support
1405 -------------------------------
1406 SubFunction is a portion of the PCI device, a SF netdev has its own
1407 dedicated queues(txq, rxq). A SF netdev supports E-Switch representation
1408 offload similar to existing PF and VF representors. A SF shares PCI
1409 level resources with other SFs and/or with its parent PCI function.
1411 1. Configure SF feature::
1413 mlxconfig -d <mst device> set PF_BAR2_SIZE=<0/1/2/3> PF_BAR2_ENABLE=1
1415 Value of PF_BAR2_SIZE:
1424 mlxfwreset -d <mst device> reset
1426 3. Enable switchdev mode::
1428 echo switchdev > /sys/class/net/<net device>/compat/devlink/mode
1432 mlnx-sf -d <PCI_BDF> -a create
1434 5. Probe SF representor::
1436 testpmd> port attach <PCI_BDF>,representor=sf0,dv_flow_en=1
1441 1. Configure aggressive CQE Zipping for maximum performance::
1443 mlxconfig -d <mst device> s CQE_COMPRESSION=1
1445 To set it back to the default CQE Zipping mode use::
1447 mlxconfig -d <mst device> s CQE_COMPRESSION=0
1449 2. In case of virtualization:
1451 - Make sure that hypervisor kernel is 3.16 or newer.
1452 - Configure boot with ``iommu=pt``.
1453 - Use 1G huge pages.
1454 - Make sure to allocate a VM on huge pages.
1455 - Make sure to set CPU pinning.
1457 3. Use the CPU near local NUMA node to which the PCIe adapter is connected,
1458 for better performance. For VMs, verify that the right CPU
1459 and NUMA node are pinned according to the above. Run::
1463 to identify the NUMA node to which the PCIe adapter is connected.
1465 4. If more than one adapter is used, and root complex capabilities allow
1466 to put both adapters on the same NUMA node without PCI bandwidth degradation,
1467 it is recommended to locate both adapters on the same NUMA node.
1468 This in order to forward packets from one to the other without
1469 NUMA performance penalty.
1471 5. Disable pause frames::
1473 ethtool -A <netdev> rx off tx off
1475 6. Verify IO non-posted prefetch is disabled by default. This can be checked
1476 via the BIOS configuration. Please contact you server provider for more
1477 information about the settings.
1481 On some machines, depends on the machine integrator, it is beneficial
1482 to set the PCI max read request parameter to 1K. This can be
1483 done in the following way:
1485 To query the read request size use::
1487 setpci -s <NIC PCI address> 68.w
1489 If the output is different than 3XXX, set it by::
1491 setpci -s <NIC PCI address> 68.w=3XXX
1493 The XXX can be different on different systems. Make sure to configure
1494 according to the setpci output.
1496 7. To minimize overhead of searching Memory Regions:
1498 - '--socket-mem' is recommended to pin memory by predictable amount.
1499 - Configure per-lcore cache when creating Mempools for packet buffer.
1500 - Refrain from dynamically allocating/freeing memory in run-time.
1505 There are multiple Rx burst functions with different advantages and limitations.
1507 .. table:: Rx burst functions
1509 +-------------------+------------------------+---------+-----------------+------+-------+
1510 || Function Name || Enabler || Scatter|| Error Recovery || CQE || Large|
1511 | | | | || comp|| MTU |
1512 +===================+========================+=========+=================+======+=======+
1513 | rx_burst | rx_vec_en=0 | Yes | Yes | Yes | Yes |
1514 +-------------------+------------------------+---------+-----------------+------+-------+
1515 | rx_burst_vec | rx_vec_en=1 (default) | No | if CQE comp off | Yes | No |
1516 +-------------------+------------------------+---------+-----------------+------+-------+
1517 | rx_burst_mprq || mprq_en=1 | No | Yes | Yes | Yes |
1518 | || RxQs >= rxqs_min_mprq | | | | |
1519 +-------------------+------------------------+---------+-----------------+------+-------+
1520 | rx_burst_mprq_vec || rx_vec_en=1 (default) | No | if CQE comp off | Yes | Yes |
1521 | || mprq_en=1 | | | | |
1522 | || RxQs >= rxqs_min_mprq | | | | |
1523 +-------------------+------------------------+---------+-----------------+------+-------+
1525 .. _mlx5_offloads_support:
1527 Supported hardware offloads
1528 ---------------------------
1530 .. table:: Minimal SW/HW versions for queue offloads
1532 ============== ===== ===== ========= ===== ========== =============
1533 Offload DPDK Linux rdma-core OFED firmware hardware
1534 ============== ===== ===== ========= ===== ========== =============
1535 common base 17.11 4.14 16 4.2-1 12.21.1000 ConnectX-4
1536 checksums 17.11 4.14 16 4.2-1 12.21.1000 ConnectX-4
1537 Rx timestamp 17.11 4.14 16 4.2-1 12.21.1000 ConnectX-4
1538 TSO 17.11 4.14 16 4.2-1 12.21.1000 ConnectX-4
1539 LRO 19.08 N/A N/A 4.6-4 16.25.6406 ConnectX-5
1540 Tx scheduling 20.08 N/A N/A 5.1-2 22.28.2006 ConnectX-6 Dx
1541 Buffer Split 20.11 N/A N/A 5.1-2 16.28.2006 ConnectX-5
1542 ============== ===== ===== ========= ===== ========== =============
1544 .. table:: Minimal SW/HW versions for rte_flow offloads
1546 +-----------------------+-----------------+-----------------+
1547 | Offload | with E-Switch | with NIC |
1548 +=======================+=================+=================+
1549 | Count | | DPDK 19.05 | | DPDK 19.02 |
1550 | | | OFED 4.6 | | OFED 4.6 |
1551 | | | rdma-core 24 | | rdma-core 23 |
1552 | | | ConnectX-5 | | ConnectX-5 |
1553 +-----------------------+-----------------+-----------------+
1554 | Drop | | DPDK 19.05 | | DPDK 18.11 |
1555 | | | OFED 4.6 | | OFED 4.5 |
1556 | | | rdma-core 24 | | rdma-core 23 |
1557 | | | ConnectX-5 | | ConnectX-4 |
1558 +-----------------------+-----------------+-----------------+
1559 | Queue / RSS | | | | DPDK 18.11 |
1560 | | | N/A | | OFED 4.5 |
1561 | | | | | rdma-core 23 |
1562 | | | | | ConnectX-4 |
1563 +-----------------------+-----------------+-----------------+
1564 | Shared action | | | | |
1565 | | | :numref:`sact`| | :numref:`sact`|
1568 +-----------------------+-----------------+-----------------+
1569 | | VLAN | | DPDK 19.11 | | DPDK 19.11 |
1570 | | (of_pop_vlan / | | OFED 4.7-1 | | OFED 4.7-1 |
1571 | | of_push_vlan / | | ConnectX-5 | | ConnectX-5 |
1572 | | of_set_vlan_pcp / | | | | |
1573 | | of_set_vlan_vid) | | | | |
1574 +-----------------------+-----------------+-----------------+
1575 | | VLAN | | DPDK 21.05 | | |
1576 | | ingress and / | | OFED 5.3 | | N/A |
1577 | | of_push_vlan / | | ConnectX-6 Dx | | |
1578 +-----------------------+-----------------+-----------------+
1579 | | VLAN | | DPDK 21.05 | | |
1580 | | egress and / | | OFED 5.3 | | N/A |
1581 | | of_pop_vlan / | | ConnectX-6 Dx | | |
1582 +-----------------------+-----------------+-----------------+
1583 | Encapsulation | | DPDK 19.05 | | DPDK 19.02 |
1584 | (VXLAN / NVGRE / RAW) | | OFED 4.7-1 | | OFED 4.6 |
1585 | | | rdma-core 24 | | rdma-core 23 |
1586 | | | ConnectX-5 | | ConnectX-5 |
1587 +-----------------------+-----------------+-----------------+
1588 | Encapsulation | | DPDK 19.11 | | DPDK 19.11 |
1589 | GENEVE | | OFED 4.7-3 | | OFED 4.7-3 |
1590 | | | rdma-core 27 | | rdma-core 27 |
1591 | | | ConnectX-5 | | ConnectX-5 |
1592 +-----------------------+-----------------+-----------------+
1593 | Tunnel Offload | | DPDK 20.11 | | DPDK 20.11 |
1594 | | | OFED 5.1-2 | | OFED 5.1-2 |
1595 | | | rdma-core 32 | | N/A |
1596 | | | ConnectX-5 | | ConnectX-5 |
1597 +-----------------------+-----------------+-----------------+
1598 | | Header rewrite | | DPDK 19.05 | | DPDK 19.02 |
1599 | | (set_ipv4_src / | | OFED 4.7-1 | | OFED 4.7-1 |
1600 | | set_ipv4_dst / | | rdma-core 24 | | rdma-core 24 |
1601 | | set_ipv6_src / | | ConnectX-5 | | ConnectX-5 |
1602 | | set_ipv6_dst / | | | | |
1603 | | set_tp_src / | | | | |
1604 | | set_tp_dst / | | | | |
1605 | | dec_ttl / | | | | |
1606 | | set_ttl / | | | | |
1607 | | set_mac_src / | | | | |
1608 | | set_mac_dst) | | | | |
1609 +-----------------------+-----------------+-----------------+
1610 | | Header rewrite | | DPDK 20.02 | | DPDK 20.02 |
1611 | | (set_dscp) | | OFED 5.0 | | OFED 5.0 |
1612 | | | | rdma-core 24 | | rdma-core 24 |
1613 | | | | ConnectX-5 | | ConnectX-5 |
1614 +-----------------------+-----------------+-----------------+
1615 | Jump | | DPDK 19.05 | | DPDK 19.02 |
1616 | | | OFED 4.7-1 | | OFED 4.7-1 |
1617 | | | rdma-core 24 | | N/A |
1618 | | | ConnectX-5 | | ConnectX-5 |
1619 +-----------------------+-----------------+-----------------+
1620 | Mark / Flag | | DPDK 19.05 | | DPDK 18.11 |
1621 | | | OFED 4.6 | | OFED 4.5 |
1622 | | | rdma-core 24 | | rdma-core 23 |
1623 | | | ConnectX-5 | | ConnectX-4 |
1624 +-----------------------+-----------------+-----------------+
1625 | Meta data | | DPDK 19.11 | | DPDK 19.11 |
1626 | | | OFED 4.7-3 | | OFED 4.7-3 |
1627 | | | rdma-core 26 | | rdma-core 26 |
1628 | | | ConnectX-5 | | ConnectX-5 |
1629 +-----------------------+-----------------+-----------------+
1630 | Port ID | | DPDK 19.05 | | N/A |
1631 | | | OFED 4.7-1 | | N/A |
1632 | | | rdma-core 24 | | N/A |
1633 | | | ConnectX-5 | | N/A |
1634 +-----------------------+-----------------+-----------------+
1635 | Hairpin | | | | DPDK 19.11 |
1636 | | | N/A | | OFED 4.7-3 |
1637 | | | | | rdma-core 26 |
1638 | | | | | ConnectX-5 |
1639 +-----------------------+-----------------+-----------------+
1640 | 2-port Hairpin | | | | DPDK 20.11 |
1641 | | | N/A | | OFED 5.1-2 |
1643 | | | | | ConnectX-5 |
1644 +-----------------------+-----------------+-----------------+
1645 | Metering | | DPDK 19.11 | | DPDK 19.11 |
1646 | | | OFED 4.7-3 | | OFED 4.7-3 |
1647 | | | rdma-core 26 | | rdma-core 26 |
1648 | | | ConnectX-5 | | ConnectX-5 |
1649 +-----------------------+-----------------+-----------------+
1650 | Sampling | | DPDK 20.11 | | DPDK 20.11 |
1651 | | | OFED 5.1-2 | | OFED 5.1-2 |
1652 | | | rdma-core 32 | | N/A |
1653 | | | ConnectX-5 | | ConnectX-5 |
1654 +-----------------------+-----------------+-----------------+
1655 | Encapsulation | | DPDK 21.02 | | DPDK 21.02 |
1656 | GTP PSC | | OFED 5.2 | | OFED 5.2 |
1657 | | | rdma-core 35 | | rdma-core 35 |
1658 | | | ConnectX-6 Dx| | ConnectX-6 Dx |
1659 +-----------------------+-----------------+-----------------+
1660 | Encapsulation | | DPDK 21.02 | | DPDK 21.02 |
1661 | GENEVE TLV option | | OFED 5.2 | | OFED 5.2 |
1662 | | | rdma-core 34 | | rdma-core 34 |
1663 | | | ConnectX-6 Dx | | ConnectX-6 Dx |
1664 +-----------------------+-----------------+-----------------+
1665 | Modify Field | | DPDK 21.02 | | DPDK 21.02 |
1666 | | | OFED 5.2 | | OFED 5.2 |
1667 | | | rdma-core 35 | | rdma-core 35 |
1668 | | | ConnectX-5 | | ConnectX-5 |
1669 +-----------------------+-----------------+-----------------+
1671 .. table:: Minimal SW/HW versions for shared action offload
1674 +-----------------------+-----------------+-----------------+
1675 | Shared Action | with E-Switch | with NIC |
1676 +=======================+=================+=================+
1677 | RSS | | | | DPDK 20.11 |
1678 | | | N/A | | OFED 5.2 |
1679 | | | | | rdma-core 33 |
1680 | | | | | ConnectX-5 |
1681 +-----------------------+-----------------+-----------------+
1682 | Age | | DPDK 20.11 | | DPDK 20.11 |
1683 | | | OFED 5.2 | | OFED 5.2 |
1684 | | | rdma-core 32 | | rdma-core 32 |
1685 | | | ConnectX-6 Dx| | ConnectX-6 Dx |
1686 +-----------------------+-----------------+-----------------+
1691 MARK and META items are interrelated with datapath - they might move from/to
1692 the applications in mbuf fields. Hence, zero value for these items has the
1693 special meaning - it means "no metadata are provided", not zero values are
1694 treated by applications and PMD as valid ones.
1696 Moreover in the flow engine domain the value zero is acceptable to match and
1697 set, and we should allow to specify zero values as rte_flow parameters for the
1698 META and MARK items and actions. In the same time zero mask has no meaning and
1699 should be rejected on validation stage.
1704 Flows are not cached in the driver.
1705 When stopping a device port, all the flows created on this port from the
1706 application will be flushed automatically in the background.
1707 After stopping the device port, all flows on this port become invalid and
1708 not represented in the system.
1709 All references to these flows held by the application should be discarded
1710 directly but neither destroyed nor flushed.
1712 The application should re-create the flows as required after the port restart.
1717 Compared to librte_net_mlx4 that implements a single RSS configuration per
1718 port, librte_net_mlx5 supports per-protocol RSS configuration.
1720 Since ``testpmd`` defaults to IP RSS mode and there is currently no
1721 command-line parameter to enable additional protocols (UDP and TCP as well
1722 as IP), the following commands must be entered from its CLI to get the same
1723 behavior as librte_net_mlx4::
1726 > port config all rss all
1732 This section demonstrates how to launch **testpmd** with Mellanox
1733 ConnectX-4/ConnectX-5/ConnectX-6/BlueField devices managed by librte_net_mlx5.
1735 #. Load the kernel modules::
1737 modprobe -a ib_uverbs mlx5_core mlx5_ib
1739 Alternatively if MLNX_OFED/MLNX_EN is fully installed, the following script
1742 /etc/init.d/openibd restart
1746 User space I/O kernel modules (uio and igb_uio) are not used and do
1747 not have to be loaded.
1749 #. Make sure Ethernet interfaces are in working order and linked to kernel
1750 verbs. Related sysfs entries should be present::
1752 ls -d /sys/class/net/*/device/infiniband_verbs/uverbs* | cut -d / -f 5
1761 #. Optionally, retrieve their PCI bus addresses for to be used with the allow list::
1764 for intf in eth2 eth3 eth4 eth5;
1766 (cd "/sys/class/net/${intf}/device/" && pwd -P);
1769 sed -n 's,.*/\(.*\),-a \1,p'
1778 #. Request huge pages::
1780 dpdk-hugepages.py --setup 2G
1782 #. Start testpmd with basic parameters::
1784 dpdk-testpmd -l 8-15 -n 4 -a 05:00.0 -a 05:00.1 -a 06:00.0 -a 06:00.1 -- --rxq=2 --txq=2 -i
1789 EAL: PCI device 0000:05:00.0 on NUMA socket 0
1790 EAL: probe driver: 15b3:1013 librte_net_mlx5
1791 PMD: librte_net_mlx5: PCI information matches, using device "mlx5_0" (VF: false)
1792 PMD: librte_net_mlx5: 1 port(s) detected
1793 PMD: librte_net_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:fe
1794 EAL: PCI device 0000:05:00.1 on NUMA socket 0
1795 EAL: probe driver: 15b3:1013 librte_net_mlx5
1796 PMD: librte_net_mlx5: PCI information matches, using device "mlx5_1" (VF: false)
1797 PMD: librte_net_mlx5: 1 port(s) detected
1798 PMD: librte_net_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:ff
1799 EAL: PCI device 0000:06:00.0 on NUMA socket 0
1800 EAL: probe driver: 15b3:1013 librte_net_mlx5
1801 PMD: librte_net_mlx5: PCI information matches, using device "mlx5_2" (VF: false)
1802 PMD: librte_net_mlx5: 1 port(s) detected
1803 PMD: librte_net_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:fa
1804 EAL: PCI device 0000:06:00.1 on NUMA socket 0
1805 EAL: probe driver: 15b3:1013 librte_net_mlx5
1806 PMD: librte_net_mlx5: PCI information matches, using device "mlx5_3" (VF: false)
1807 PMD: librte_net_mlx5: 1 port(s) detected
1808 PMD: librte_net_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:fb
1809 Interactive-mode selected
1810 Configuring Port 0 (socket 0)
1811 PMD: librte_net_mlx5: 0x8cba80: TX queues number update: 0 -> 2
1812 PMD: librte_net_mlx5: 0x8cba80: RX queues number update: 0 -> 2
1813 Port 0: E4:1D:2D:E7:0C:FE
1814 Configuring Port 1 (socket 0)
1815 PMD: librte_net_mlx5: 0x8ccac8: TX queues number update: 0 -> 2
1816 PMD: librte_net_mlx5: 0x8ccac8: RX queues number update: 0 -> 2
1817 Port 1: E4:1D:2D:E7:0C:FF
1818 Configuring Port 2 (socket 0)
1819 PMD: librte_net_mlx5: 0x8cdb10: TX queues number update: 0 -> 2
1820 PMD: librte_net_mlx5: 0x8cdb10: RX queues number update: 0 -> 2
1821 Port 2: E4:1D:2D:E7:0C:FA
1822 Configuring Port 3 (socket 0)
1823 PMD: librte_net_mlx5: 0x8ceb58: TX queues number update: 0 -> 2
1824 PMD: librte_net_mlx5: 0x8ceb58: RX queues number update: 0 -> 2
1825 Port 3: E4:1D:2D:E7:0C:FB
1826 Checking link statuses...
1827 Port 0 Link Up - speed 40000 Mbps - full-duplex
1828 Port 1 Link Up - speed 40000 Mbps - full-duplex
1829 Port 2 Link Up - speed 10000 Mbps - full-duplex
1830 Port 3 Link Up - speed 10000 Mbps - full-duplex
1837 This section demonstrates how to dump flows. Currently, it's possible to dump
1838 all flows with assistance of external tools.
1840 #. 2 ways to get flow raw file:
1842 - Using testpmd CLI:
1844 .. code-block:: console
1847 testpmd> flow dump <port> all <output_file>
1849 testpmd> flow dump <port> rule <rule_id> <output_file>
1851 - call rte_flow_dev_dump api:
1853 .. code-block:: console
1855 rte_flow_dev_dump(port, flow, file, NULL);
1857 #. Dump human-readable flows from raw file:
1859 Get flow parsing tool from: https://github.com/Mellanox/mlx_steering_dump
1861 .. code-block:: console
1863 mlx_steering_dump.py -f <output_file> -flowptr <flow_ptr>