1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright 2015 6WIND S.A.
3 Copyright 2015 Mellanox Technologies, Ltd
5 .. include:: <isonum.txt>
7 MLX5 Ethernet Poll Mode Driver
8 ==============================
10 The mlx5 Ethernet 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)
21 Besides its dependency on libibverbs (that implies libmlx5 and associated
22 kernel support), librte_net_mlx5 relies heavily on system calls for control
23 operations such as querying/updating the MTU and flow control parameters.
25 This capability allows the PMD to coexist with kernel network interfaces
26 which remain functional, although they stop receiving unicast packets as
27 long as they share the same MAC address.
28 This means legacy linux control tools (for example: ethtool, ifconfig and
29 more) can operate on the same network interfaces that owned by the DPDK
32 See :doc:`../../platform/mlx5` guide for more design details.
37 - Multi arch support: x86_64, POWER8, ARMv8, i686.
38 - Multiple TX and RX queues.
40 - Rx queue delay drop.
41 - Support for scattered TX frames.
42 - Advanced support for scattered Rx frames with tunable buffer attributes.
43 - IPv4, IPv6, TCPv4, TCPv6, UDPv4 and UDPv6 RSS on any number of queues.
44 - RSS using different combinations of fields: L3 only, L4 only or both,
45 and source only, destination only or both.
46 - Several RSS hash keys, one for each flow type.
47 - Default RSS operation with no hash key specification.
48 - Configurable RETA table.
49 - Link flow control (pause frame).
50 - Support for multiple MAC addresses.
54 - RX CRC stripping configuration.
55 - TX mbuf fast free offload.
56 - Promiscuous mode on PF and VF.
57 - Multicast promiscuous mode on PF and VF.
58 - Hardware checksum offloads.
59 - Flow director (RTE_FDIR_MODE_PERFECT, RTE_FDIR_MODE_PERFECT_MAC_VLAN and
61 - Flow API, including :ref:`flow_isolated_mode`.
63 - KVM and VMware ESX SR-IOV modes are supported.
64 - RSS hash result is supported.
65 - Hardware TSO for generic IP or UDP tunnel, including VXLAN and GRE.
66 - Hardware checksum Tx offload for generic IP or UDP tunnel, including VXLAN and GRE.
68 - Statistics query including Basic, Extended and per queue.
70 - Tunnel types: VXLAN, L3 VXLAN, VXLAN-GPE, GRE, MPLSoGRE, MPLSoUDP, IP-in-IP, Geneve, GTP.
71 - Tunnel HW offloads: packet type, inner/outer RSS, IP and UDP checksum verification.
72 - NIC HW offloads: encapsulation (vxlan, gre, mplsoudp, mplsogre), NAT, routing, TTL
73 increment/decrement, count, drop, mark. For details please see :ref:`mlx5_offloads_support`.
74 - Flow insertion rate of more then million flows per second, when using Direct Rules.
75 - Support for multiple rte_flow groups.
76 - Per packet no-inline hint flag to disable packet data copying into Tx descriptors.
79 - Multiple-thread flow insertion.
80 - Matching on IPv4 Internet Header Length (IHL).
81 - Matching on GTP extension header with raw encap/decap action.
82 - Matching on Geneve TLV option header with raw encap/decap action.
83 - RSS support in sample action.
84 - E-Switch mirroring and jump.
85 - E-Switch mirroring and modify.
86 - 21844 flow priorities for ingress or egress flow groups greater than 0 and for any transfer
88 - Flow metering, including meter policy API.
89 - Flow meter hierarchy.
90 - Flow integrity offload API.
91 - Connection tracking.
92 - Sub-Function representors.
101 On Windows, the features are limited:
103 - Promiscuous mode is not supported
104 - The following rules are supported:
106 - IPv4/UDP with CVLAN filtering
107 - Unicast MAC filtering
109 - Additional rules are supported from WinOF2 version 2.70:
111 - IPv4/TCP with CVLAN filtering
112 - L4 steering rules for port RSS of UDP, TCP and IP
114 - For secondary process:
116 - Forked secondary process not supported.
117 - MPRQ is not supported. Callback to free externally attached MPRQ buffer is set
118 in a primary process, but has a different virtual address in a secondary process.
119 Calling a function at the wrong address leads to a segmentation fault.
120 - External memory unregistered in EAL memseg list cannot be used for DMA
121 unless such memory has been registered by ``mlx5_mr_update_ext_mp()`` in
122 primary process and remapped to the same virtual address in secondary
123 process. If the external memory is registered by primary process but has
124 different virtual address in secondary process, unexpected error may happen.
128 - Counters of received packets and bytes number of devices in same share group are same.
129 - Counters of received packets and bytes number of queues in same group and queue ID are same.
131 - When using Verbs flow engine (``dv_flow_en`` = 0), flow pattern without any
132 specific VLAN will match for VLAN packets as well:
134 When VLAN spec is not specified in the pattern, the matching rule will be created with VLAN as a wild card.
135 Meaning, the flow rule::
137 flow create 0 ingress pattern eth / vlan vid is 3 / ipv4 / end ...
139 Will only match vlan packets with vid=3. and the flow rule::
141 flow create 0 ingress pattern eth / ipv4 / end ...
143 Will match any ipv4 packet (VLAN included).
145 - When using Verbs flow engine (``dv_flow_en`` = 0), multi-tagged(QinQ) match is not supported.
147 - 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.
150 flow create 0 ingress pattern eth / ipv4 / end ...
152 Will match any ipv4 packet.
155 flow create 0 ingress pattern eth / vlan / end ...
156 flow create 0 ingress pattern eth has_vlan is 1 / end ...
157 flow create 0 ingress pattern eth type is 0x8100 / end ...
159 Will match single-tagged packets only, with any VLAN ID value.
162 flow create 0 ingress pattern eth type is 0x88A8 / end ...
163 flow create 0 ingress pattern eth / vlan has_more_vlan is 1 / end ...
165 Will match multi-tagged packets only, with any VLAN ID value.
167 - A flow pattern with 2 sequential VLAN items is not supported.
169 - VLAN pop offload command:
171 - Flow rules having a VLAN pop offload command as one of their actions and
172 are lacking a match on VLAN as one of their items are not supported.
173 - The command is not supported on egress traffic in NIC mode.
175 - VLAN push offload is not supported on ingress traffic in NIC mode.
177 - VLAN set PCP offload is not supported on existing headers.
179 - A multi segment packet must have not more segments than reported by dev_infos_get()
180 in tx_desc_lim.nb_seg_max field. This value depends on maximal supported Tx descriptor
181 size and ``txq_inline_min`` settings and may be from 2 (worst case forced by maximal
182 inline settings) to 58.
184 - Match on VXLAN supports the following fields only:
187 - Last reserved 8-bits
189 Last reserved 8-bits matching is only supported When using DV flow
190 engine (``dv_flow_en`` = 1).
191 For ConnectX-5, the UDP destination port must be the standard one (4789).
192 Group zero's behavior may differ which depends on FW.
193 Matching value equals 0 (value & mask) is not supported.
195 - L3 VXLAN and VXLAN-GPE tunnels cannot be supported together with MPLSoGRE and MPLSoUDP.
197 - Match on Geneve header supports the following fields only:
204 - Match on Geneve TLV option is supported on the following fields:
211 Only one Class/Type/Length Geneve TLV option is supported per shared device.
212 Class/Type/Length fields must be specified as well as masks.
213 Class/Type/Length specified masks must be full.
214 Matching Geneve TLV option without specifying data is not supported.
215 Matching Geneve TLV option with ``data & mask == 0`` is not supported.
217 - VF: flow rules created on VF devices can only match traffic targeted at the
218 configured MAC addresses (see ``rte_eth_dev_mac_addr_add()``).
220 - Match on GTP tunnel header item supports the following fields only:
222 - v_pt_rsv_flags: E flag, S flag, PN flag
226 - Match on GTP extension header only for GTP PDU session container (next
227 extension header type = 0x85).
228 - Match on GTP extension header is not supported in group 0.
232 - Hardware support: BlueField-2.
233 - Flex item is supported on PF only.
234 - Hardware limits ``header_length_mask_width`` up to 6 bits.
235 - Firmware supports 8 global sample fields.
236 Each flex item allocates non-shared sample fields from that pool.
237 - Supported flex item can have 1 input link - ``eth`` or ``udp``
238 and up to 2 output links - ``ipv4`` or ``ipv6``.
239 - Flex item fields (``next_header``, ``next_protocol``, ``samples``)
240 do not participate in RSS hash functions.
241 - In flex item configuration, ``next_header.field_base`` value
242 must be byte aligned (multiple of 8).
244 - No Tx metadata go to the E-Switch steering domain for the Flow group 0.
245 The flows within group 0 and set metadata action are rejected by hardware.
249 MAC addresses not already present in the bridge table of the associated
250 kernel network device will be added and cleaned up by the PMD when closing
251 the device. In case of ungraceful program termination, some entries may
252 remain present and should be removed manually by other means.
254 - Buffer split offload is supported with regular Rx burst routine only,
255 no MPRQ feature or vectorized code can be engaged.
257 - When Multi-Packet Rx queue is configured (``mprq_en``), a Rx packet can be
258 externally attached to a user-provided mbuf with having RTE_MBUF_F_EXTERNAL in
259 ol_flags. As the mempool for the external buffer is managed by PMD, all the
260 Rx mbufs must be freed before the device is closed. Otherwise, the mempool of
261 the external buffers will be freed by PMD and the application which still
262 holds the external buffers may be corrupted.
264 - If Multi-Packet Rx queue is configured (``mprq_en``) and Rx CQE compression is
265 enabled (``rxq_cqe_comp_en``) at the same time, RSS hash result is not fully
266 supported. Some Rx packets may not have RTE_MBUF_F_RX_RSS_HASH.
268 - IPv6 Multicast messages are not supported on VM, while promiscuous mode
269 and allmulticast mode are both set to off.
270 To receive IPv6 Multicast messages on VM, explicitly set the relevant
271 MAC address using rte_eth_dev_mac_addr_add() API.
273 - To support a mixed traffic pattern (some buffers from local host memory, some
274 buffers from other devices) with high bandwidth, a mbuf flag is used.
276 An application hints the PMD whether or not it should try to inline the
277 given mbuf data buffer. PMD should do the best effort to act upon this request.
279 The hint flag ``RTE_PMD_MLX5_FINE_GRANULARITY_INLINE`` is dynamic,
280 registered by application with rte_mbuf_dynflag_register(). This flag is
281 purely driver-specific and declared in PMD specific header ``rte_pmd_mlx5.h``,
282 which is intended to be used by the application.
284 To query the supported specific flags in runtime,
285 the function ``rte_pmd_mlx5_get_dyn_flag_names`` returns the array of
286 currently (over present hardware and configuration) supported specific flags.
287 The "not inline hint" feature operating flow is the following one:
290 - probe the devices, ports are created
291 - query the port capabilities
292 - if port supporting the feature is found
293 - register dynamic flag ``RTE_PMD_MLX5_FINE_GRANULARITY_INLINE``
294 - application starts the ports
295 - on ``dev_start()`` PMD checks whether the feature flag is registered and
296 enables the feature support in datapath
297 - application might set the registered flag bit in ``ol_flags`` field
298 of mbuf being sent and PMD will handle ones appropriately.
300 - The amount of descriptors in Tx queue may be limited by data inline settings.
301 Inline data require the more descriptor building blocks and overall block
302 amount may exceed the hardware supported limits. The application should
303 reduce the requested Tx size or adjust data inline settings with
304 ``txq_inline_max`` and ``txq_inline_mpw`` devargs keys.
306 - To provide the packet send scheduling on mbuf timestamps the ``tx_pp``
307 parameter should be specified.
308 When PMD sees the RTE_MBUF_DYNFLAG_TX_TIMESTAMP_NAME set on the packet
309 being sent it tries to synchronize the time of packet appearing on
310 the wire with the specified packet timestamp. It the specified one
311 is in the past it should be ignored, if one is in the distant future
312 it should be capped with some reasonable value (in range of seconds).
313 These specific cases ("too late" and "distant future") can be optionally
314 reported via device xstats to assist applications to detect the
315 time-related problems.
317 The timestamp upper "too-distant-future" limit
318 at the moment of invoking the Tx burst routine
319 can be estimated as ``tx_pp`` option (in nanoseconds) multiplied by 2^23.
320 Please note, for the testpmd txonly mode,
321 the limit is deduced from the expression::
323 (n_tx_descriptors / burst_size + 1) * inter_burst_gap
325 There is no any packet reordering according timestamps is supposed,
326 neither within packet burst, nor between packets, it is an entirely
327 application responsibility to generate packets and its timestamps
328 in desired order. The timestamps can be put only in the first packet
329 in the burst providing the entire burst scheduling.
331 - E-Switch decapsulation Flow:
333 - can be applied to PF port only.
334 - must specify VF port action (packet redirection from PF to VF).
335 - optionally may specify tunnel inner source and destination MAC addresses.
337 - E-Switch encapsulation Flow:
339 - can be applied to VF ports only.
340 - must specify PF port action (packet redirection from VF to PF).
344 - The input buffer, used as outer header, is not validated.
348 - The decapsulation is always done up to the outermost tunnel detected by the HW.
349 - The input buffer, providing the removal size, is not validated.
350 - The buffer size must match the length of the headers to be removed.
352 - ICMP(code/type/identifier/sequence number) / ICMP6(code/type) matching, IP-in-IP and MPLS flow matching are all
353 mutually exclusive features which cannot be supported together
354 (see :ref:`mlx5_firmware_config`).
358 - Requires DevX and DV flow to be enabled.
359 - KEEP_CRC offload cannot be supported with LRO.
360 - The first mbuf length, without head-room, must be big enough to include the
362 - Rx queue with LRO offload enabled, receiving a non-LRO packet, can forward
363 it with size limited to max LRO size, not to max RX packet length.
364 - LRO can be used with outer header of TCP packets of the standard format:
365 eth (with or without vlan) / ipv4 or ipv6 / tcp / payload
367 Other TCP packets (e.g. with MPLS label) received on Rx queue with LRO enabled, will be received with bad checksum.
368 - LRO packet aggregation is performed by HW only for packet size larger than
369 ``lro_min_mss_size``. This value is reported on device start, when debug
374 - ``RTE_ETH_RX_OFFLOAD_KEEP_CRC`` cannot be supported with decapsulation
375 for some NICs (such as ConnectX-6 Dx, ConnectX-6 Lx, and BlueField-2).
376 The capability bit ``scatter_fcs_w_decap_disable`` shows NIC support.
380 - fast free offload assumes the all mbufs being sent are originated from the
381 same memory pool and there is no any extra references to the mbufs (the
382 reference counter for each mbuf is equal 1 on tx_burst call). The latter
383 means there should be no any externally attached buffers in mbufs. It is
384 an application responsibility to provide the correct mbufs if the fast
385 free offload is engaged. The mlx5 PMD implicitly produces the mbufs with
386 externally attached buffers if MPRQ option is enabled, hence, the fast
387 free offload is neither supported nor advertised if there is MPRQ enabled.
391 - Supports ``RTE_FLOW_ACTION_TYPE_SAMPLE`` action only within NIC Rx and
392 E-Switch steering domain.
393 - For E-Switch Sampling flow with sample ratio > 1, additional actions are not
394 supported in the sample actions list.
395 - For ConnectX-5, the ``RTE_FLOW_ACTION_TYPE_SAMPLE`` is typically used as
396 first action in the E-Switch egress flow if with header modify or
397 encapsulation actions.
398 - For NIC Rx flow, supports ``MARK``, ``COUNT``, ``QUEUE``, ``RSS`` in the
400 - For E-Switch mirroring flow, supports ``RAW ENCAP``, ``Port ID``,
401 ``VXLAN ENCAP``, ``NVGRE ENCAP`` in the sample actions list.
405 - Supports the 'set' operation only for ``RTE_FLOW_ACTION_TYPE_MODIFY_FIELD`` action.
406 - Modification of an arbitrary place in a packet via the special ``RTE_FLOW_FIELD_START`` Field ID is not supported.
407 - Modification of the 802.1Q Tag, VXLAN Network or GENEVE Network ID's is not supported.
408 - Encapsulation levels are not supported, can modify outermost header fields only.
409 - Offsets must be 32-bits aligned, cannot skip past the boundary of a field.
411 - IPv6 header item 'proto' field, indicating the next header protocol, should
412 not be set as extension header.
413 In case the next header is an extension header, it should not be specified in
414 IPv6 header item 'proto' field.
415 The last extension header item 'next header' field can specify the following
416 header protocol type.
420 - 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.
421 - Hairpin in switchdev SR-IOV mode is not supported till now.
425 - All the meter colors with drop action will be counted only by the global drop statistics.
426 - Yellow detection is only supported with ASO metering.
427 - Red color must be with drop action.
428 - Meter statistics are supported only for drop case.
429 - A meter action created with pre-defined policy must be the last action in the flow except single case where the policy actions are:
430 - green: NULL or END.
431 - yellow: NULL or END.
433 - The only supported meter policy actions:
434 - green: QUEUE, RSS, PORT_ID, REPRESENTED_PORT, JUMP, DROP, MARK and SET_TAG.
435 - yellow: QUEUE, RSS, PORT_ID, REPRESENTED_PORT, JUMP, DROP, MARK and SET_TAG.
437 - Policy actions of RSS for green and yellow should have the same configuration except queues.
438 - Policy with RSS/queue action is not supported when ``dv_xmeta_en`` enabled.
439 - meter profile packet mode is supported.
440 - meter profiles of RFC2697, RFC2698 and RFC4115 are supported.
444 - Integrity offload is enabled for **ConnectX-6** family.
445 - Verification bits provided by the hardware are ``l3_ok``, ``ipv4_csum_ok``, ``l4_ok``, ``l4_csum_ok``.
446 - ``level`` value 0 references outer headers.
447 - Multiple integrity items not supported in a single flow rule.
448 - Flow rule items supplied by application must explicitly specify network headers referred by integrity item.
449 For example, if integrity item mask sets ``l4_ok`` or ``l4_csum_ok`` bits, reference to L4 network header,
450 TCP or UDP, must be in the rule pattern as well::
452 flow create 0 ingress pattern integrity level is 0 value mask l3_ok value spec l3_ok / eth / ipv6 / end …
454 flow create 0 ingress pattern integrity level is 0 value mask l4_ok value spec 0 / eth / ipv4 proto is udp / end …
456 - Connection tracking:
458 - Cannot co-exist with ASO meter, ASO age action in a single flow rule.
459 - Flow rules insertion rate and memory consumption need more optimization.
461 - 4M connections maximum.
463 - Multi-thread flow insertion:
465 - In order to achieve best insertion rate, application should manage the flows per lcore.
466 - Better to disable memory reclaim by setting ``reclaim_mem_mode`` to 0 to accelerate the flow object allocation and release with cache.
470 - TXQ affinity subjects to HW hash once enabled.
472 - Bonding under socket direct mode
478 - CQE timestamp field width is limited by hardware to 63 bits, MSB is zero.
479 - In the free-running mode the timestamp counter is reset on power on
480 and 63-bit value provides over 1800 years of uptime till overflow.
481 - In the real-time mode
482 (configurable with ``REAL_TIME_CLOCK_ENABLE`` firmware settings),
483 the timestamp presents the nanoseconds elapsed since 01-Jan-1970,
484 hardware timestamp overflow will happen on 19-Jan-2038
485 (0x80000000 seconds since 01-Jan-1970).
486 - The send scheduling is based on timestamps
487 from the reference "Clock Queue" completions,
488 the scheduled send timestamps should not be specified with non-zero MSB.
492 - WQE based high scaling and safer flow insertion/destruction.
493 - Set ``dv_flow_en`` to 2 in order to enable HW steering.
494 - Async queue-based ``rte_flow_q`` APIs supported only.
499 MLX5 supports various methods to report statistics:
501 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.
503 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.
505 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.
511 See :ref:`mlx5 common compilation <mlx5_common_compilation>`.
517 Environment Configuration
518 ~~~~~~~~~~~~~~~~~~~~~~~~~
520 See :ref:`mlx5 common configuration <mlx5_common_env>`.
522 Firmware configuration
523 ~~~~~~~~~~~~~~~~~~~~~~
525 See :ref:`mlx5_firmware_config` guide.
530 Please refer to :ref:`mlx5 common options <mlx5_common_driver_options>`
531 for an additional list of options shared with other mlx5 drivers.
533 - ``rxq_cqe_comp_en`` parameter [int]
535 A nonzero value enables the compression of CQE on RX side. This feature
536 allows to save PCI bandwidth and improve performance. Enabled by default.
537 Different compression formats are supported in order to achieve the best
538 performance for different traffic patterns. Default format depends on
539 Multi-Packet Rx queue configuration: Hash RSS format is used in case
540 MPRQ is disabled, Checksum format is used in case MPRQ is enabled.
542 Specifying 2 as a ``rxq_cqe_comp_en`` value selects Flow Tag format for
543 better compression rate in case of RTE Flow Mark traffic.
544 Specifying 3 as a ``rxq_cqe_comp_en`` value selects Checksum format.
545 Specifying 4 as a ``rxq_cqe_comp_en`` value selects L3/L4 Header format for
546 better compression rate in case of mixed TCP/UDP and IPv4/IPv6 traffic.
547 CQE compression format selection requires DevX to be enabled. If there is
548 no DevX enabled/supported the value is reset to 1 by default.
552 - x86_64 with ConnectX-4, ConnectX-4 Lx, ConnectX-5, ConnectX-6, ConnectX-6 Dx,
553 ConnectX-6 Lx, BlueField and BlueField-2.
554 - POWER9 and ARMv8 with ConnectX-4 Lx, ConnectX-5, ConnectX-6, ConnectX-6 Dx,
555 ConnectX-6 Lx, BlueField and BlueField-2.
557 - ``rxq_pkt_pad_en`` parameter [int]
559 A nonzero value enables padding Rx packet to the size of cacheline on PCI
560 transaction. This feature would waste PCI bandwidth but could improve
561 performance by avoiding partial cacheline write which may cause costly
562 read-modify-copy in memory transaction on some architectures. Disabled by
567 - x86_64 with ConnectX-4, ConnectX-4 Lx, ConnectX-5, ConnectX-6, ConnectX-6 Dx,
568 ConnectX-6 Lx, BlueField and BlueField-2.
569 - POWER8 and ARMv8 with ConnectX-4 Lx, ConnectX-5, ConnectX-6, ConnectX-6 Dx,
570 ConnectX-6 Lx, BlueField and BlueField-2.
572 - ``delay_drop`` parameter [int]
574 Bitmask value for the Rx queue delay drop attribute. Bit 0 is used for the
575 standard Rx queue and bit 1 is used for the hairpin Rx queue. By default, the
576 delay drop is disabled for all Rx queues. It will be ignored if the port does
577 not support the attribute even if it is enabled explicitly.
579 The packets being received will not be dropped immediately when the WQEs are
580 exhausted in a Rx queue with delay drop enabled.
582 A timeout value is set in the driver to control the waiting time before
583 dropping a packet. Once the timer is expired, the delay drop will be
584 deactivated for all the Rx queues with this feature enable. To re-activate
585 it, a rearming is needed and it is part of the kernel driver starting from
588 To enable / disable the delay drop rearming, the private flag ``dropless_rq``
589 can be set and queried via ethtool:
591 - ethtool --set-priv-flags <netdev> dropless_rq on (/ off)
592 - ethtool --show-priv-flags <netdev>
594 The configuration flag is global per PF and can only be set on the PF, once
595 it is on, all the VFs', SFs' and representors' Rx queues will share the timer
598 - ``mprq_en`` parameter [int]
600 A nonzero value enables configuring Multi-Packet Rx queues. Rx queue is
601 configured as Multi-Packet RQ if the total number of Rx queues is
602 ``rxqs_min_mprq`` or more. Disabled by default.
604 Multi-Packet Rx Queue (MPRQ a.k.a Striding RQ) can further save PCIe bandwidth
605 by posting a single large buffer for multiple packets. Instead of posting a
606 buffers per a packet, one large buffer is posted in order to receive multiple
607 packets on the buffer. A MPRQ buffer consists of multiple fixed-size strides
608 and each stride receives one packet. MPRQ can improve throughput for
609 small-packet traffic.
611 When MPRQ is enabled, MTU can be larger than the size of
612 user-provided mbuf even if RTE_ETH_RX_OFFLOAD_SCATTER isn't enabled. PMD will
613 configure large stride size enough to accommodate MTU as long as
614 device allows. Note that this can waste system memory compared to enabling Rx
615 scatter and multi-segment packet.
617 - ``mprq_log_stride_num`` parameter [int]
619 Log 2 of the number of strides for Multi-Packet Rx queue. Configuring more
620 strides can reduce PCIe traffic further. If configured value is not in the
621 range of device capability, the default value will be set with a warning
622 message. The default value is 4 which is 16 strides per a buffer, valid only
623 if ``mprq_en`` is set.
625 The size of Rx queue should be bigger than the number of strides.
627 - ``mprq_log_stride_size`` parameter [int]
629 Log 2 of the size of a stride for Multi-Packet Rx queue. Configuring a smaller
630 stride size can save some memory and reduce probability of a depletion of all
631 available strides due to unreleased packets by an application. If configured
632 value is not in the range of device capability, the default value will be set
633 with a warning message. The default value is 11 which is 2048 bytes per a
634 stride, valid only if ``mprq_en`` is set. With ``mprq_log_stride_size`` set
635 it is possible for a packet to span across multiple strides. This mode allows
636 support of jumbo frames (9K) with MPRQ. The memcopy of some packets (or part
637 of a packet if Rx scatter is configured) may be required in case there is no
638 space left for a head room at the end of a stride which incurs some
641 - ``mprq_max_memcpy_len`` parameter [int]
643 The maximum length of packet to memcpy in case of Multi-Packet Rx queue. Rx
644 packet is mem-copied to a user-provided mbuf if the size of Rx packet is less
645 than or equal to this parameter. Otherwise, PMD will attach the Rx packet to
646 the mbuf by external buffer attachment - ``rte_pktmbuf_attach_extbuf()``.
647 A mempool for external buffers will be allocated and managed by PMD. If Rx
648 packet is externally attached, ol_flags field of the mbuf will have
649 RTE_MBUF_F_EXTERNAL and this flag must be preserved. ``RTE_MBUF_HAS_EXTBUF()``
650 checks the flag. The default value is 128, valid only if ``mprq_en`` is set.
652 - ``rxqs_min_mprq`` parameter [int]
654 Configure Rx queues as Multi-Packet RQ if the total number of Rx queues is
655 greater or equal to this value. The default value is 12, valid only if
658 - ``txq_inline`` parameter [int]
660 Amount of data to be inlined during TX operations. This parameter is
661 deprecated and converted to the new parameter ``txq_inline_max`` providing
662 partial compatibility.
664 - ``txqs_min_inline`` parameter [int]
666 Enable inline data send only when the number of TX queues is greater or equal
669 This option should be used in combination with ``txq_inline_max`` and
670 ``txq_inline_mpw`` below and does not affect ``txq_inline_min`` settings above.
672 If this option is not specified the default value 16 is used for BlueField
673 and 8 for other platforms
675 The data inlining consumes the CPU cycles, so this option is intended to
676 auto enable inline data if we have enough Tx queues, which means we have
677 enough CPU cores and PCI bandwidth is getting more critical and CPU
678 is not supposed to be bottleneck anymore.
680 The copying data into WQE improves latency and can improve PPS performance
681 when PCI back pressure is detected and may be useful for scenarios involving
682 heavy traffic on many queues.
684 Because additional software logic is necessary to handle this mode, this
685 option should be used with care, as it may lower performance when back
686 pressure is not expected.
688 If inline data are enabled it may affect the maximal size of Tx queue in
689 descriptors because the inline data increase the descriptor size and
690 queue size limits supported by hardware may be exceeded.
692 - ``txq_inline_min`` parameter [int]
694 Minimal amount of data to be inlined into WQE during Tx operations. NICs
695 may require this minimal data amount to operate correctly. The exact value
696 may depend on NIC operation mode, requested offloads, etc. It is strongly
697 recommended to omit this parameter and use the default values. Anyway,
698 applications using this parameter should take into consideration that
699 specifying an inconsistent value may prevent the NIC from sending packets.
701 If ``txq_inline_min`` key is present the specified value (may be aligned
702 by the driver in order not to exceed the limits and provide better descriptor
703 space utilization) will be used by the driver and it is guaranteed that
704 requested amount of data bytes are inlined into the WQE beside other inline
705 settings. This key also may update ``txq_inline_max`` value (default
706 or specified explicitly in devargs) to reserve the space for inline data.
708 If ``txq_inline_min`` key is not present, the value may be queried by the
709 driver from the NIC via DevX if this feature is available. If there is no DevX
710 enabled/supported the value 18 (supposing L2 header including VLAN) is set
711 for ConnectX-4 and ConnectX-4 Lx, and 0 is set by default for ConnectX-5
712 and newer NICs. If packet is shorter the ``txq_inline_min`` value, the entire
715 For ConnectX-4 NIC, driver does not allow specifying value below 18
716 (minimal L2 header, including VLAN), error will be raised.
718 For ConnectX-4 Lx NIC, it is allowed to specify values below 18, but
719 it is not recommended and may prevent NIC from sending packets over
722 For ConnectX-4 and ConnectX-4 Lx NICs, automatically configured value
723 is insufficient for some traffic, because they require at least all L2 headers
724 to be inlined. For example, Q-in-Q adds 4 bytes to default 18 bytes
725 of Ethernet and VLAN, thus ``txq_inline_min`` must be set to 22.
726 MPLS would add 4 bytes per label. Final value must account for all possible
727 L2 encapsulation headers used in particular environment.
729 Please, note, this minimal data inlining disengages eMPW feature (Enhanced
730 Multi-Packet Write), because last one does not support partial packet inlining.
731 This is not very critical due to minimal data inlining is mostly required
732 by ConnectX-4 and ConnectX-4 Lx, these NICs do not support eMPW feature.
734 - ``txq_inline_max`` parameter [int]
736 Specifies the maximal packet length to be completely inlined into WQE
737 Ethernet Segment for ordinary SEND method. If packet is larger than specified
738 value, the packet data won't be copied by the driver at all, data buffer
739 is addressed with a pointer. If packet length is less or equal all packet
740 data will be copied into WQE. This may improve PCI bandwidth utilization for
741 short packets significantly but requires the extra CPU cycles.
743 The data inline feature is controlled by number of Tx queues, if number of Tx
744 queues is larger than ``txqs_min_inline`` key parameter, the inline feature
745 is engaged, if there are not enough Tx queues (which means not enough CPU cores
746 and CPU resources are scarce), data inline is not performed by the driver.
747 Assigning ``txqs_min_inline`` with zero always enables the data inline.
749 The default ``txq_inline_max`` value is 290. The specified value may be adjusted
750 by the driver in order not to exceed the limit (930 bytes) and to provide better
751 WQE space filling without gaps, the adjustment is reflected in the debug log.
752 Also, the default value (290) may be decreased in run-time if the large transmit
753 queue size is requested and hardware does not support enough descriptor
754 amount, in this case warning is emitted. If ``txq_inline_max`` key is
755 specified and requested inline settings can not be satisfied then error
758 - ``txq_inline_mpw`` parameter [int]
760 Specifies the maximal packet length to be completely inlined into WQE for
761 Enhanced MPW method. If packet is large the specified value, the packet data
762 won't be copied, and data buffer is addressed with pointer. If packet length
763 is less or equal, all packet data will be copied into WQE. This may improve PCI
764 bandwidth utilization for short packets significantly but requires the extra
767 The data inline feature is controlled by number of TX queues, if number of Tx
768 queues is larger than ``txqs_min_inline`` key parameter, the inline feature
769 is engaged, if there are not enough Tx queues (which means not enough CPU cores
770 and CPU resources are scarce), data inline is not performed by the driver.
771 Assigning ``txqs_min_inline`` with zero always enables the data inline.
773 The default ``txq_inline_mpw`` value is 268. The specified value may be adjusted
774 by the driver in order not to exceed the limit (930 bytes) and to provide better
775 WQE space filling without gaps, the adjustment is reflected in the debug log.
776 Due to multiple packets may be included to the same WQE with Enhanced Multi
777 Packet Write Method and overall WQE size is limited it is not recommended to
778 specify large values for the ``txq_inline_mpw``. Also, the default value (268)
779 may be decreased in run-time if the large transmit queue size is requested
780 and hardware does not support enough descriptor amount, in this case warning
781 is emitted. If ``txq_inline_mpw`` key is specified and requested inline
782 settings can not be satisfied then error will be raised.
784 - ``txqs_max_vec`` parameter [int]
786 Enable vectorized Tx only when the number of TX queues is less than or
787 equal to this value. This parameter is deprecated and ignored, kept
788 for compatibility issue to not prevent driver from probing.
790 - ``txq_mpw_hdr_dseg_en`` parameter [int]
792 A nonzero value enables including two pointers in the first block of TX
793 descriptor. The parameter is deprecated and ignored, kept for compatibility
796 - ``txq_max_inline_len`` parameter [int]
798 Maximum size of packet to be inlined. This limits the size of packet to
799 be inlined. If the size of a packet is larger than configured value, the
800 packet isn't inlined even though there's enough space remained in the
801 descriptor. Instead, the packet is included with pointer. This parameter
802 is deprecated and converted directly to ``txq_inline_mpw`` providing full
803 compatibility. Valid only if eMPW feature is engaged.
805 - ``txq_mpw_en`` parameter [int]
807 A nonzero value enables Enhanced Multi-Packet Write (eMPW) for ConnectX-5,
808 ConnectX-6, ConnectX-6 Dx, ConnectX-6 Lx, BlueField, BlueField-2.
809 eMPW allows the Tx burst function to pack up multiple packets
810 in a single descriptor session in order to save PCI bandwidth
811 and improve performance at the cost of a slightly higher CPU usage.
812 When ``txq_inline_mpw`` is set along with ``txq_mpw_en``,
813 Tx burst function copies entire packet data on to Tx descriptor
814 instead of including pointer of packet.
816 The Enhanced Multi-Packet Write feature is enabled by default if NIC supports
817 it, can be disabled by explicit specifying 0 value for ``txq_mpw_en`` option.
818 Also, if minimal data inlining is requested by non-zero ``txq_inline_min``
819 option or reported by the NIC, the eMPW feature is disengaged.
821 - ``tx_db_nc`` parameter [int]
823 This parameter name is deprecated and ignored.
824 The new name for this parameter is ``sq_db_nc``.
825 See :ref:`common driver options <mlx5_common_driver_options>`.
827 - ``tx_pp`` parameter [int]
829 If a nonzero value is specified the driver creates all necessary internal
830 objects to provide accurate packet send scheduling on mbuf timestamps.
831 The positive value specifies the scheduling granularity in nanoseconds,
832 the packet send will be accurate up to specified digits. The allowed range is
833 from 500 to 1 million of nanoseconds. The negative value specifies the module
834 of granularity and engages the special test mode the check the schedule rate.
835 By default (if the ``tx_pp`` is not specified) send scheduling on timestamps
838 Starting with ConnectX-7 the capability to schedule traffic directly
839 on timestamp specified in descriptor is provided,
840 no extra objects are needed anymore and scheduling capability
841 is advertised and handled regardless ``tx_pp`` parameter presence.
843 - ``tx_skew`` parameter [int]
845 The parameter adjusts the send packet scheduling on timestamps and represents
846 the average delay between beginning of the transmitting descriptor processing
847 by the hardware and appearance of actual packet data on the wire. The value
848 should be provided in nanoseconds and is valid only if ``tx_pp`` parameter is
849 specified. The default value is zero.
851 - ``tx_vec_en`` parameter [int]
853 A nonzero value enables Tx vector on ConnectX-5, ConnectX-6, ConnectX-6 Dx,
854 ConnectX-6 Lx, BlueField and BlueField-2 NICs
855 if the number of global Tx queues on the port is less than ``txqs_max_vec``.
856 The parameter is deprecated and ignored.
858 - ``rx_vec_en`` parameter [int]
860 A nonzero value enables Rx vector if the port is not configured in
861 multi-segment otherwise this parameter is ignored.
865 - ``vf_nl_en`` parameter [int]
867 A nonzero value enables Netlink requests from the VF to add/remove MAC
868 addresses or/and enable/disable promiscuous/all multicast on the Netdevice.
869 Otherwise the relevant configuration must be run with Linux iproute2 tools.
870 This is a prerequisite to receive this kind of traffic.
872 Enabled by default, valid only on VF devices ignored otherwise.
874 - ``l3_vxlan_en`` parameter [int]
876 A nonzero value allows L3 VXLAN and VXLAN-GPE flow creation. To enable
877 L3 VXLAN or VXLAN-GPE, users has to configure firmware and enable this
878 parameter. This is a prerequisite to receive this kind of traffic.
882 - ``dv_xmeta_en`` parameter [int]
884 A nonzero value enables extensive flow metadata support if device is
885 capable and driver supports it. This can enable extensive support of
886 ``MARK`` and ``META`` item of ``rte_flow``. The newly introduced
887 ``SET_TAG`` and ``SET_META`` actions do not depend on ``dv_xmeta_en``.
889 There are some possible configurations, depending on parameter value:
891 - 0, this is default value, defines the legacy mode, the ``MARK`` and
892 ``META`` related actions and items operate only within NIC Tx and
893 NIC Rx steering domains, no ``MARK`` and ``META`` information crosses
894 the domain boundaries. The ``MARK`` item is 24 bits wide, the ``META``
895 item is 32 bits wide and match supported on egress only.
897 - 1, this engages extensive metadata mode, the ``MARK`` and ``META``
898 related actions and items operate within all supported steering domains,
899 including FDB, ``MARK`` and ``META`` information may cross the domain
900 boundaries. The ``MARK`` item is 24 bits wide, the ``META`` item width
901 depends on kernel and firmware configurations and might be 0, 16 or
902 32 bits. Within NIC Tx domain ``META`` data width is 32 bits for
903 compatibility, the actual width of data transferred to the FDB domain
904 depends on kernel configuration and may be vary. The actual supported
905 width can be retrieved in runtime by series of rte_flow_validate()
908 - 2, this engages extensive metadata mode, the ``MARK`` and ``META``
909 related actions and items operate within all supported steering domains,
910 including FDB, ``MARK`` and ``META`` information may cross the domain
911 boundaries. The ``META`` item is 32 bits wide, the ``MARK`` item width
912 depends on kernel and firmware configurations and might be 0, 16 or
913 24 bits. The actual supported width can be retrieved in runtime by
914 series of rte_flow_validate() trials.
916 - 3, this engages tunnel offload mode. In E-Switch configuration, that
917 mode implicitly activates ``dv_xmeta_en=1``.
919 +------+-----------+-----------+-------------+-------------+
920 | Mode | ``MARK`` | ``META`` | ``META`` Tx | FDB/Through |
921 +======+===========+===========+=============+=============+
922 | 0 | 24 bits | 32 bits | 32 bits | no |
923 +------+-----------+-----------+-------------+-------------+
924 | 1 | 24 bits | vary 0-32 | 32 bits | yes |
925 +------+-----------+-----------+-------------+-------------+
926 | 2 | vary 0-24 | 32 bits | 32 bits | yes |
927 +------+-----------+-----------+-------------+-------------+
929 If there is no E-Switch configuration the ``dv_xmeta_en`` parameter is
930 ignored and the device is configured to operate in legacy mode (0).
932 Disabled by default (set to 0).
934 The Direct Verbs/Rules (engaged with ``dv_flow_en`` = 1) supports all
935 of the extensive metadata features. The legacy Verbs supports FLAG and
936 MARK metadata actions over NIC Rx steering domain only.
938 Setting META value to zero in flow action means there is no item provided
939 and receiving datapath will not report in mbufs the metadata are present.
940 Setting MARK value to zero in flow action means the zero FDIR ID value
941 will be reported on packet receiving.
943 For the MARK action the last 16 values in the full range are reserved for
944 internal PMD purposes (to emulate FLAG action). The valid range for the
945 MARK action values is 0-0xFFEF for the 16-bit mode and 0-0xFFFFEF
946 for the 24-bit mode, the flows with the MARK action value outside
947 the specified range will be rejected.
949 - ``dv_flow_en`` parameter [int]
951 Value 0 means legacy Verbs flow offloading.
953 Value 1 enables the DV flow steering assuming it is supported by the
954 driver (requires rdma-core 24 or higher).
956 Value 2 enables the WQE based hardware steering.
957 In this mode, only queue-based flow management is supported.
959 It is configured by default to 1 (DV flow steering) if supported.
960 Otherwise, the value is 0 which indicates legacy Verbs flow offloading.
962 - ``dv_esw_en`` parameter [int]
964 A nonzero value enables E-Switch using Direct Rules.
966 Enabled by default if supported.
968 - ``lacp_by_user`` parameter [int]
970 A nonzero value enables the control of LACP traffic by the user application.
971 When a bond exists in the driver, by default it should be managed by the
972 kernel and therefore LACP traffic should be steered to the kernel.
973 If this devarg is set to 1 it will allow the user to manage the bond by
974 itself and not steer LACP traffic to the kernel.
976 Disabled by default (set to 0).
978 - ``representor`` parameter [list]
980 This parameter can be used to instantiate DPDK Ethernet devices from
981 existing port (PF, VF or SF) representors configured on the device.
983 It is a standard parameter whose format is described in
984 :ref:`ethernet_device_standard_device_arguments`.
986 For instance, to probe VF port representors 0 through 2::
988 <PCI_BDF>,representor=vf[0-2]
990 To probe SF port representors 0 through 2::
992 <PCI_BDF>,representor=sf[0-2]
994 To probe VF port representors 0 through 2 on both PFs of bonding device::
996 <Primary_PCI_BDF>,representor=pf[0,1]vf[0-2]
998 - ``max_dump_files_num`` parameter [int]
1000 The maximum number of files per PMD entity that may be created for debug information.
1001 The files will be created in /var/log directory or in current directory.
1003 set to 128 by default.
1005 - ``lro_timeout_usec`` parameter [int]
1007 The maximum allowed duration of an LRO session, in micro-seconds.
1008 PMD will set the nearest value supported by HW, which is not bigger than
1009 the input ``lro_timeout_usec`` value.
1010 If this parameter is not specified, by default PMD will set
1011 the smallest value supported by HW.
1013 - ``hp_buf_log_sz`` parameter [int]
1015 The total data buffer size of a hairpin queue (logarithmic form), in bytes.
1016 PMD will set the data buffer size to 2 ** ``hp_buf_log_sz``, both for RX & TX.
1017 The capacity of the value is specified by the firmware and the initialization
1018 will get a failure if it is out of scope.
1019 The range of the value is from 11 to 19 right now, and the supported frame
1020 size of a single packet for hairpin is from 512B to 128KB. It might change if
1021 different firmware release is being used. By using a small value, it could
1022 reduce memory consumption but not work with a large frame. If the value is
1023 too large, the memory consumption will be high and some potential performance
1024 degradation will be introduced.
1025 By default, the PMD will set this value to 16, which means that 9KB jumbo
1026 frames will be supported.
1028 - ``reclaim_mem_mode`` parameter [int]
1030 Cache some resources in flow destroy will help flow recreation more efficient.
1031 While some systems may require the all the resources can be reclaimed after
1033 The parameter ``reclaim_mem_mode`` provides the option for user to configure
1034 if the resource cache is needed or not.
1036 There are three options to choose:
1038 - 0. It means the flow resources will be cached as usual. The resources will
1039 be cached, helpful with flow insertion rate.
1041 - 1. It will only enable the DPDK PMD level resources reclaim.
1043 - 2. Both DPDK PMD level and rdma-core low level will be configured as
1046 By default, the PMD will set this value to 0.
1048 - ``decap_en`` parameter [int]
1050 Some devices do not support FCS (frame checksum) scattering for
1051 tunnel-decapsulated packets.
1052 If set to 0, this option forces the FCS feature and rejects tunnel
1053 decapsulation in the flow engine for such devices.
1055 By default, the PMD will set this value to 1.
1057 - ``allow_duplicate_pattern`` parameter [int]
1059 There are two options to choose:
1061 - 0. Prevent insertion of rules with the same pattern items on non-root table.
1062 In this case, only the first rule is inserted and the following rules are
1063 rejected and error code EEXIST is returned.
1065 - 1. Allow insertion of rules with the same pattern items.
1066 In this case, all rules are inserted but only the first rule takes effect,
1067 the next rule takes effect only if the previous rules are deleted.
1069 By default, the PMD will set this value to 1.
1075 The following Mellanox device families are supported by the same mlx5 driver:
1087 Below are detailed device names:
1089 * Mellanox\ |reg| ConnectX\ |reg|-4 10G MCX4111A-XCAT (1x10G)
1090 * Mellanox\ |reg| ConnectX\ |reg|-4 10G MCX412A-XCAT (2x10G)
1091 * Mellanox\ |reg| ConnectX\ |reg|-4 25G MCX4111A-ACAT (1x25G)
1092 * Mellanox\ |reg| ConnectX\ |reg|-4 25G MCX412A-ACAT (2x25G)
1093 * Mellanox\ |reg| ConnectX\ |reg|-4 40G MCX413A-BCAT (1x40G)
1094 * Mellanox\ |reg| ConnectX\ |reg|-4 40G MCX4131A-BCAT (1x40G)
1095 * Mellanox\ |reg| ConnectX\ |reg|-4 40G MCX415A-BCAT (1x40G)
1096 * Mellanox\ |reg| ConnectX\ |reg|-4 50G MCX413A-GCAT (1x50G)
1097 * Mellanox\ |reg| ConnectX\ |reg|-4 50G MCX4131A-GCAT (1x50G)
1098 * Mellanox\ |reg| ConnectX\ |reg|-4 50G MCX414A-BCAT (2x50G)
1099 * Mellanox\ |reg| ConnectX\ |reg|-4 50G MCX415A-GCAT (1x50G)
1100 * Mellanox\ |reg| ConnectX\ |reg|-4 50G MCX416A-BCAT (2x50G)
1101 * Mellanox\ |reg| ConnectX\ |reg|-4 50G MCX416A-GCAT (2x50G)
1102 * Mellanox\ |reg| ConnectX\ |reg|-4 50G MCX415A-CCAT (1x100G)
1103 * Mellanox\ |reg| ConnectX\ |reg|-4 100G MCX416A-CCAT (2x100G)
1104 * Mellanox\ |reg| ConnectX\ |reg|-4 Lx 10G MCX4111A-XCAT (1x10G)
1105 * Mellanox\ |reg| ConnectX\ |reg|-4 Lx 10G MCX4121A-XCAT (2x10G)
1106 * Mellanox\ |reg| ConnectX\ |reg|-4 Lx 25G MCX4111A-ACAT (1x25G)
1107 * Mellanox\ |reg| ConnectX\ |reg|-4 Lx 25G MCX4121A-ACAT (2x25G)
1108 * Mellanox\ |reg| ConnectX\ |reg|-4 Lx 40G MCX4131A-BCAT (1x40G)
1109 * Mellanox\ |reg| ConnectX\ |reg|-5 100G MCX556A-ECAT (2x100G)
1110 * Mellanox\ |reg| ConnectX\ |reg|-5 Ex EN 100G MCX516A-CDAT (2x100G)
1111 * Mellanox\ |reg| ConnectX\ |reg|-6 200G MCX654106A-HCAT (2x200G)
1112 * Mellanox\ |reg| ConnectX\ |reg|-6 Dx EN 100G MCX623106AN-CDAT (2x100G)
1113 * Mellanox\ |reg| ConnectX\ |reg|-6 Dx EN 200G MCX623105AN-VDAT (1x200G)
1114 * Mellanox\ |reg| ConnectX\ |reg|-6 Lx EN 25G MCX631102AN-ADAT (2x25G)
1120 See :ref:`mlx5_sub_function`.
1122 Sub-Function representor support
1123 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1125 A SF netdev supports E-Switch representation offload
1126 similar to PF and VF representors.
1127 Use <sfnum> to probe SF representor::
1129 testpmd> port attach <PCI_BDF>,representor=sf<sfnum>,dv_flow_en=1
1135 1. Configure aggressive CQE Zipping for maximum performance::
1137 mlxconfig -d <mst device> s CQE_COMPRESSION=1
1139 To set it back to the default CQE Zipping mode use::
1141 mlxconfig -d <mst device> s CQE_COMPRESSION=0
1143 2. In case of virtualization:
1145 - Make sure that hypervisor kernel is 3.16 or newer.
1146 - Configure boot with ``iommu=pt``.
1147 - Use 1G huge pages.
1148 - Make sure to allocate a VM on huge pages.
1149 - Make sure to set CPU pinning.
1151 3. Use the CPU near local NUMA node to which the PCIe adapter is connected,
1152 for better performance. For VMs, verify that the right CPU
1153 and NUMA node are pinned according to the above. Run::
1155 lstopo-no-graphics --merge
1157 to identify the NUMA node to which the PCIe adapter is connected.
1159 4. If more than one adapter is used, and root complex capabilities allow
1160 to put both adapters on the same NUMA node without PCI bandwidth degradation,
1161 it is recommended to locate both adapters on the same NUMA node.
1162 This in order to forward packets from one to the other without
1163 NUMA performance penalty.
1165 5. Disable pause frames::
1167 ethtool -A <netdev> rx off tx off
1169 6. Verify IO non-posted prefetch is disabled by default. This can be checked
1170 via the BIOS configuration. Please contact you server provider for more
1171 information about the settings.
1175 On some machines, depends on the machine integrator, it is beneficial
1176 to set the PCI max read request parameter to 1K. This can be
1177 done in the following way:
1179 To query the read request size use::
1181 setpci -s <NIC PCI address> 68.w
1183 If the output is different than 3XXX, set it by::
1185 setpci -s <NIC PCI address> 68.w=3XXX
1187 The XXX can be different on different systems. Make sure to configure
1188 according to the setpci output.
1190 7. To minimize overhead of searching Memory Regions:
1192 - '--socket-mem' is recommended to pin memory by predictable amount.
1193 - Configure per-lcore cache when creating Mempools for packet buffer.
1194 - Refrain from dynamically allocating/freeing memory in run-time.
1199 There are multiple Rx burst functions with different advantages and limitations.
1201 .. table:: Rx burst functions
1203 +-------------------+------------------------+---------+-----------------+------+-------+
1204 || Function Name || Enabler || Scatter|| Error Recovery || CQE || Large|
1205 | | | | || comp|| MTU |
1206 +===================+========================+=========+=================+======+=======+
1207 | rx_burst | rx_vec_en=0 | Yes | Yes | Yes | Yes |
1208 +-------------------+------------------------+---------+-----------------+------+-------+
1209 | rx_burst_vec | rx_vec_en=1 (default) | No | if CQE comp off | Yes | No |
1210 +-------------------+------------------------+---------+-----------------+------+-------+
1211 | rx_burst_mprq || mprq_en=1 | No | Yes | Yes | Yes |
1212 | || RxQs >= rxqs_min_mprq | | | | |
1213 +-------------------+------------------------+---------+-----------------+------+-------+
1214 | rx_burst_mprq_vec || rx_vec_en=1 (default) | No | if CQE comp off | Yes | Yes |
1215 | || mprq_en=1 | | | | |
1216 | || RxQs >= rxqs_min_mprq | | | | |
1217 +-------------------+------------------------+---------+-----------------+------+-------+
1219 .. _mlx5_offloads_support:
1221 Supported hardware offloads
1222 ---------------------------
1224 .. table:: Minimal SW/HW versions for queue offloads
1226 ============== ===== ===== ========= ===== ========== =============
1227 Offload DPDK Linux rdma-core OFED firmware hardware
1228 ============== ===== ===== ========= ===== ========== =============
1229 common base 17.11 4.14 16 4.2-1 12.21.1000 ConnectX-4
1230 checksums 17.11 4.14 16 4.2-1 12.21.1000 ConnectX-4
1231 Rx timestamp 17.11 4.14 16 4.2-1 12.21.1000 ConnectX-4
1232 TSO 17.11 4.14 16 4.2-1 12.21.1000 ConnectX-4
1233 LRO 19.08 N/A N/A 4.6-4 16.25.6406 ConnectX-5
1234 Tx scheduling 20.08 N/A N/A 5.1-2 22.28.2006 ConnectX-6 Dx
1235 Buffer Split 20.11 N/A N/A 5.1-2 16.28.2006 ConnectX-5
1236 ============== ===== ===== ========= ===== ========== =============
1238 .. table:: Minimal SW/HW versions for rte_flow offloads
1240 +-----------------------+-----------------+-----------------+
1241 | Offload | with E-Switch | with NIC |
1242 +=======================+=================+=================+
1243 | Count | | DPDK 19.05 | | DPDK 19.02 |
1244 | | | OFED 4.6 | | OFED 4.6 |
1245 | | | rdma-core 24 | | rdma-core 23 |
1246 | | | ConnectX-5 | | ConnectX-5 |
1247 +-----------------------+-----------------+-----------------+
1248 | Drop | | DPDK 19.05 | | DPDK 18.11 |
1249 | | | OFED 4.6 | | OFED 4.5 |
1250 | | | rdma-core 24 | | rdma-core 23 |
1251 | | | ConnectX-5 | | ConnectX-4 |
1252 +-----------------------+-----------------+-----------------+
1253 | Queue / RSS | | | | DPDK 18.11 |
1254 | | | N/A | | OFED 4.5 |
1255 | | | | | rdma-core 23 |
1256 | | | | | ConnectX-4 |
1257 +-----------------------+-----------------+-----------------+
1258 | Shared action | | | | |
1259 | | | :numref:`sact`| | :numref:`sact`|
1262 +-----------------------+-----------------+-----------------+
1263 | | VLAN | | DPDK 19.11 | | DPDK 19.11 |
1264 | | (of_pop_vlan / | | OFED 4.7-1 | | OFED 4.7-1 |
1265 | | of_push_vlan / | | ConnectX-5 | | ConnectX-5 |
1266 | | of_set_vlan_pcp / | | | | |
1267 | | of_set_vlan_vid) | | | | |
1268 +-----------------------+-----------------+-----------------+
1269 | | VLAN | | DPDK 21.05 | | |
1270 | | ingress and / | | OFED 5.3 | | N/A |
1271 | | of_push_vlan / | | ConnectX-6 Dx | | |
1272 +-----------------------+-----------------+-----------------+
1273 | | VLAN | | DPDK 21.05 | | |
1274 | | egress and / | | OFED 5.3 | | N/A |
1275 | | of_pop_vlan / | | ConnectX-6 Dx | | |
1276 +-----------------------+-----------------+-----------------+
1277 | Encapsulation | | DPDK 19.05 | | DPDK 19.02 |
1278 | (VXLAN / NVGRE / RAW) | | OFED 4.7-1 | | OFED 4.6 |
1279 | | | rdma-core 24 | | rdma-core 23 |
1280 | | | ConnectX-5 | | ConnectX-5 |
1281 +-----------------------+-----------------+-----------------+
1282 | Encapsulation | | DPDK 19.11 | | DPDK 19.11 |
1283 | GENEVE | | OFED 4.7-3 | | OFED 4.7-3 |
1284 | | | rdma-core 27 | | rdma-core 27 |
1285 | | | ConnectX-5 | | ConnectX-5 |
1286 +-----------------------+-----------------+-----------------+
1287 | Tunnel Offload | | DPDK 20.11 | | DPDK 20.11 |
1288 | | | OFED 5.1-2 | | OFED 5.1-2 |
1289 | | | rdma-core 32 | | N/A |
1290 | | | ConnectX-5 | | ConnectX-5 |
1291 +-----------------------+-----------------+-----------------+
1292 | | Header rewrite | | DPDK 19.05 | | DPDK 19.02 |
1293 | | (set_ipv4_src / | | OFED 4.7-1 | | OFED 4.7-1 |
1294 | | set_ipv4_dst / | | rdma-core 24 | | rdma-core 24 |
1295 | | set_ipv6_src / | | ConnectX-5 | | ConnectX-5 |
1296 | | set_ipv6_dst / | | | | |
1297 | | set_tp_src / | | | | |
1298 | | set_tp_dst / | | | | |
1299 | | dec_ttl / | | | | |
1300 | | set_ttl / | | | | |
1301 | | set_mac_src / | | | | |
1302 | | set_mac_dst) | | | | |
1303 +-----------------------+-----------------+-----------------+
1304 | | Header rewrite | | DPDK 20.02 | | DPDK 20.02 |
1305 | | (set_dscp) | | OFED 5.0 | | OFED 5.0 |
1306 | | | | rdma-core 24 | | rdma-core 24 |
1307 | | | | ConnectX-5 | | ConnectX-5 |
1308 +-----------------------+-----------------+-----------------+
1309 | Jump | | DPDK 19.05 | | DPDK 19.02 |
1310 | | | OFED 4.7-1 | | OFED 4.7-1 |
1311 | | | rdma-core 24 | | N/A |
1312 | | | ConnectX-5 | | ConnectX-5 |
1313 +-----------------------+-----------------+-----------------+
1314 | Mark / Flag | | DPDK 19.05 | | DPDK 18.11 |
1315 | | | OFED 4.6 | | OFED 4.5 |
1316 | | | rdma-core 24 | | rdma-core 23 |
1317 | | | ConnectX-5 | | ConnectX-4 |
1318 +-----------------------+-----------------+-----------------+
1319 | Meta data | | DPDK 19.11 | | DPDK 19.11 |
1320 | | | OFED 4.7-3 | | OFED 4.7-3 |
1321 | | | rdma-core 26 | | rdma-core 26 |
1322 | | | ConnectX-5 | | ConnectX-5 |
1323 +-----------------------+-----------------+-----------------+
1324 | Port ID | | DPDK 19.05 | | N/A |
1325 | | | OFED 4.7-1 | | N/A |
1326 | | | rdma-core 24 | | N/A |
1327 | | | ConnectX-5 | | N/A |
1328 +-----------------------+-----------------+-----------------+
1329 | Hairpin | | | | DPDK 19.11 |
1330 | | | N/A | | OFED 4.7-3 |
1331 | | | | | rdma-core 26 |
1332 | | | | | ConnectX-5 |
1333 +-----------------------+-----------------+-----------------+
1334 | 2-port Hairpin | | | | DPDK 20.11 |
1335 | | | N/A | | OFED 5.1-2 |
1337 | | | | | ConnectX-5 |
1338 +-----------------------+-----------------+-----------------+
1339 | Metering | | DPDK 19.11 | | DPDK 19.11 |
1340 | | | OFED 4.7-3 | | OFED 4.7-3 |
1341 | | | rdma-core 26 | | rdma-core 26 |
1342 | | | ConnectX-5 | | ConnectX-5 |
1343 +-----------------------+-----------------+-----------------+
1344 | ASO Metering | | DPDK 21.05 | | DPDK 21.05 |
1345 | | | OFED 5.3 | | OFED 5.3 |
1346 | | | rdma-core 33 | | rdma-core 33 |
1347 | | | ConnectX-6 Dx| | ConnectX-6 Dx |
1348 +-----------------------+-----------------+-----------------+
1349 | Metering Hierarchy | | DPDK 21.08 | | DPDK 21.08 |
1350 | | | OFED 5.3 | | OFED 5.3 |
1352 | | | ConnectX-6 Dx| | ConnectX-6 Dx |
1353 +-----------------------+-----------------+-----------------+
1354 | Sampling | | DPDK 20.11 | | DPDK 20.11 |
1355 | | | OFED 5.1-2 | | OFED 5.1-2 |
1356 | | | rdma-core 32 | | N/A |
1357 | | | ConnectX-5 | | ConnectX-5 |
1358 +-----------------------+-----------------+-----------------+
1359 | Encapsulation | | DPDK 21.02 | | DPDK 21.02 |
1360 | GTP PSC | | OFED 5.2 | | OFED 5.2 |
1361 | | | rdma-core 35 | | rdma-core 35 |
1362 | | | ConnectX-6 Dx| | ConnectX-6 Dx |
1363 +-----------------------+-----------------+-----------------+
1364 | Encapsulation | | DPDK 21.02 | | DPDK 21.02 |
1365 | GENEVE TLV option | | OFED 5.2 | | OFED 5.2 |
1366 | | | rdma-core 34 | | rdma-core 34 |
1367 | | | ConnectX-6 Dx | | ConnectX-6 Dx |
1368 +-----------------------+-----------------+-----------------+
1369 | Modify Field | | DPDK 21.02 | | DPDK 21.02 |
1370 | | | OFED 5.2 | | OFED 5.2 |
1371 | | | rdma-core 35 | | rdma-core 35 |
1372 | | | ConnectX-5 | | ConnectX-5 |
1373 +-----------------------+-----------------+-----------------+
1374 | Connection tracking | | | | DPDK 21.05 |
1375 | | | N/A | | OFED 5.3 |
1376 | | | | | rdma-core 35 |
1377 | | | | | ConnectX-6 Dx |
1378 +-----------------------+-----------------+-----------------+
1380 .. table:: Minimal SW/HW versions for shared action offload
1383 +-----------------------+-----------------+-----------------+
1384 | Shared Action | with E-Switch | with NIC |
1385 +=======================+=================+=================+
1386 | RSS | | | | DPDK 20.11 |
1387 | | | N/A | | OFED 5.2 |
1388 | | | | | rdma-core 33 |
1389 | | | | | ConnectX-5 |
1390 +-----------------------+-----------------+-----------------+
1391 | Age | | DPDK 20.11 | | DPDK 20.11 |
1392 | | | OFED 5.2 | | OFED 5.2 |
1393 | | | rdma-core 32 | | rdma-core 32 |
1394 | | | ConnectX-6 Dx | | ConnectX-6 Dx |
1395 +-----------------------+-----------------+-----------------+
1396 | Count | | DPDK 21.05 | | DPDK 21.05 |
1397 | | | OFED 4.6 | | OFED 4.6 |
1398 | | | rdma-core 24 | | rdma-core 23 |
1399 | | | ConnectX-5 | | ConnectX-5 |
1400 +-----------------------+-----------------+-----------------+
1405 MARK and META items are interrelated with datapath - they might move from/to
1406 the applications in mbuf fields. Hence, zero value for these items has the
1407 special meaning - it means "no metadata are provided", not zero values are
1408 treated by applications and PMD as valid ones.
1410 Moreover in the flow engine domain the value zero is acceptable to match and
1411 set, and we should allow to specify zero values as rte_flow parameters for the
1412 META and MARK items and actions. In the same time zero mask has no meaning and
1413 should be rejected on validation stage.
1418 Flows are not cached in the driver.
1419 When stopping a device port, all the flows created on this port from the
1420 application will be flushed automatically in the background.
1421 After stopping the device port, all flows on this port become invalid and
1422 not represented in the system.
1423 All references to these flows held by the application should be discarded
1424 directly but neither destroyed nor flushed.
1426 The application should re-create the flows as required after the port restart.
1431 Compared to librte_net_mlx4 that implements a single RSS configuration per
1432 port, librte_net_mlx5 supports per-protocol RSS configuration.
1434 Since ``testpmd`` defaults to IP RSS mode and there is currently no
1435 command-line parameter to enable additional protocols (UDP and TCP as well
1436 as IP), the following commands must be entered from its CLI to get the same
1437 behavior as librte_net_mlx4::
1440 > port config all rss all
1446 This section demonstrates how to launch **testpmd** with Mellanox
1447 ConnectX-4/ConnectX-5/ConnectX-6/BlueField devices managed by librte_net_mlx5.
1449 #. Load the kernel modules::
1451 modprobe -a ib_uverbs mlx5_core mlx5_ib
1453 Alternatively if MLNX_OFED/MLNX_EN is fully installed, the following script
1456 /etc/init.d/openibd restart
1460 User space I/O kernel modules (uio and igb_uio) are not used and do
1461 not have to be loaded.
1463 #. Make sure Ethernet interfaces are in working order and linked to kernel
1464 verbs. Related sysfs entries should be present::
1466 ls -d /sys/class/net/*/device/infiniband_verbs/uverbs* | cut -d / -f 5
1475 #. Optionally, retrieve their PCI bus addresses for to be used with the allow list::
1478 for intf in eth2 eth3 eth4 eth5;
1480 (cd "/sys/class/net/${intf}/device/" && pwd -P);
1483 sed -n 's,.*/\(.*\),-a \1,p'
1492 #. Request huge pages::
1494 dpdk-hugepages.py --setup 2G
1496 #. Start testpmd with basic parameters::
1498 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
1503 EAL: PCI device 0000:05:00.0 on NUMA socket 0
1504 EAL: probe driver: 15b3:1013 librte_net_mlx5
1505 PMD: librte_net_mlx5: PCI information matches, using device "mlx5_0" (VF: false)
1506 PMD: librte_net_mlx5: 1 port(s) detected
1507 PMD: librte_net_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:fe
1508 EAL: PCI device 0000:05:00.1 on NUMA socket 0
1509 EAL: probe driver: 15b3:1013 librte_net_mlx5
1510 PMD: librte_net_mlx5: PCI information matches, using device "mlx5_1" (VF: false)
1511 PMD: librte_net_mlx5: 1 port(s) detected
1512 PMD: librte_net_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:ff
1513 EAL: PCI device 0000:06:00.0 on NUMA socket 0
1514 EAL: probe driver: 15b3:1013 librte_net_mlx5
1515 PMD: librte_net_mlx5: PCI information matches, using device "mlx5_2" (VF: false)
1516 PMD: librte_net_mlx5: 1 port(s) detected
1517 PMD: librte_net_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:fa
1518 EAL: PCI device 0000:06:00.1 on NUMA socket 0
1519 EAL: probe driver: 15b3:1013 librte_net_mlx5
1520 PMD: librte_net_mlx5: PCI information matches, using device "mlx5_3" (VF: false)
1521 PMD: librte_net_mlx5: 1 port(s) detected
1522 PMD: librte_net_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:fb
1523 Interactive-mode selected
1524 Configuring Port 0 (socket 0)
1525 PMD: librte_net_mlx5: 0x8cba80: TX queues number update: 0 -> 2
1526 PMD: librte_net_mlx5: 0x8cba80: RX queues number update: 0 -> 2
1527 Port 0: E4:1D:2D:E7:0C:FE
1528 Configuring Port 1 (socket 0)
1529 PMD: librte_net_mlx5: 0x8ccac8: TX queues number update: 0 -> 2
1530 PMD: librte_net_mlx5: 0x8ccac8: RX queues number update: 0 -> 2
1531 Port 1: E4:1D:2D:E7:0C:FF
1532 Configuring Port 2 (socket 0)
1533 PMD: librte_net_mlx5: 0x8cdb10: TX queues number update: 0 -> 2
1534 PMD: librte_net_mlx5: 0x8cdb10: RX queues number update: 0 -> 2
1535 Port 2: E4:1D:2D:E7:0C:FA
1536 Configuring Port 3 (socket 0)
1537 PMD: librte_net_mlx5: 0x8ceb58: TX queues number update: 0 -> 2
1538 PMD: librte_net_mlx5: 0x8ceb58: RX queues number update: 0 -> 2
1539 Port 3: E4:1D:2D:E7:0C:FB
1540 Checking link statuses...
1541 Port 0 Link Up - speed 40000 Mbps - full-duplex
1542 Port 1 Link Up - speed 40000 Mbps - full-duplex
1543 Port 2 Link Up - speed 10000 Mbps - full-duplex
1544 Port 3 Link Up - speed 10000 Mbps - full-duplex
1551 This section demonstrates how to dump flows. Currently, it's possible to dump
1552 all flows with assistance of external tools.
1554 #. 2 ways to get flow raw file:
1556 - Using testpmd CLI:
1558 .. code-block:: console
1561 testpmd> flow dump <port> all <output_file>
1563 testpmd> flow dump <port> rule <rule_id> <output_file>
1565 - call rte_flow_dev_dump api:
1567 .. code-block:: console
1569 rte_flow_dev_dump(port, flow, file, NULL);
1571 #. Dump human-readable flows from raw file:
1573 Get flow parsing tool from: https://github.com/Mellanox/mlx_steering_dump
1575 .. code-block:: console
1577 mlx_steering_dump.py -f <output_file> -flowptr <flow_ptr>
1579 How to share a meter between ports in the same switch domain
1580 ------------------------------------------------------------
1582 This section demonstrates how to use the shared meter. A meter M can be created
1583 on port X and to be shared with a port Y on the same switch domain by the next way:
1585 .. code-block:: console
1587 flow create X ingress transfer pattern eth / port_id id is Y / end actions meter mtr_id M / end
1589 How to use meter hierarchy
1590 --------------------------
1592 This section demonstrates how to create and use a meter hierarchy.
1593 A termination meter M can be the policy green action of another termination meter N.
1594 The two meters are chained together as a chain. Using meter N in a flow will apply
1595 both the meters in hierarchy on that flow.
1597 .. code-block:: console
1599 add port meter policy 0 1 g_actions queue index 0 / end y_actions end r_actions drop / end
1600 create port meter 0 M 1 1 yes 0xffff 1 0
1601 add port meter policy 0 2 g_actions meter mtr_id M / end y_actions end r_actions drop / end
1602 create port meter 0 N 2 2 yes 0xffff 1 0
1603 flow create 0 ingress group 1 pattern eth / end actions meter mtr_id N / end