net/ixgbe: fix flow control mode setting
[dpdk.git] / doc / guides / nics / mlx5.rst
1 ..  SPDX-License-Identifier: BSD-3-Clause
2     Copyright 2015 6WIND S.A.
3     Copyright 2015 Mellanox Technologies, Ltd
4
5 MLX5 poll mode driver
6 =====================
7
8 The MLX5 poll mode driver library (**librte_pmd_mlx5**) provides support
9 for **Mellanox ConnectX-4**, **Mellanox ConnectX-4 Lx** , **Mellanox
10 ConnectX-5**, **Mellanox ConnectX-6**, **Mellanox ConnectX-6DX** and
11 **Mellanox BlueField** families of 10/25/40/50/100/200 Gb/s adapters
12 as well as their virtual functions (VF) in SR-IOV context.
13
14 Information and documentation about these adapters can be found on the
15 `Mellanox website <http://www.mellanox.com>`__. Help is also provided by the
16 `Mellanox community <http://community.mellanox.com/welcome>`__.
17
18 There is also a `section dedicated to this poll mode driver
19 <http://www.mellanox.com/page/products_dyn?product_family=209&mtag=pmd_for_dpdk>`__.
20
21 .. note::
22
23    Due to external dependencies, this driver is disabled in default configuration
24    of the "make" build. It can be enabled with ``CONFIG_RTE_LIBRTE_MLX5_PMD=y``
25    or by using "meson" build system which will detect dependencies.
26
27 Design
28 ------
29
30 Besides its dependency on libibverbs (that implies libmlx5 and associated
31 kernel support), librte_pmd_mlx5 relies heavily on system calls for control
32 operations such as querying/updating the MTU and flow control parameters.
33
34 For security reasons and robustness, this driver only deals with virtual
35 memory addresses. The way resources allocations are handled by the kernel,
36 combined with hardware specifications that allow to handle virtual memory
37 addresses directly, ensure that DPDK applications cannot access random
38 physical memory (or memory that does not belong to the current process).
39
40 This capability allows the PMD to coexist with kernel network interfaces
41 which remain functional, although they stop receiving unicast packets as
42 long as they share the same MAC address.
43 This means legacy linux control tools (for example: ethtool, ifconfig and
44 more) can operate on the same network interfaces that owned by the DPDK
45 application.
46
47 The PMD can use libibverbs and libmlx5 to access the device firmware
48 or directly the hardware components.
49 There are different levels of objects and bypassing abilities
50 to get the best performances:
51
52 - Verbs is a complete high-level generic API
53 - Direct Verbs is a device-specific API
54 - DevX allows to access firmware objects
55 - Direct Rules manages flow steering at low-level hardware layer
56
57 Enabling librte_pmd_mlx5 causes DPDK applications to be linked against
58 libibverbs.
59
60 Features
61 --------
62
63 - Multi arch support: x86_64, POWER8, ARMv8, i686.
64 - Multiple TX and RX queues.
65 - Support for scattered TX and RX frames.
66 - IPv4, IPv6, TCPv4, TCPv6, UDPv4 and UDPv6 RSS on any number of queues.
67 - RSS using different combinations of fields: L3 only, L4 only or both,
68   and source only, destination only or both.
69 - Several RSS hash keys, one for each flow type.
70 - Default RSS operation with no hash key specification.
71 - Configurable RETA table.
72 - Link flow control (pause frame).
73 - Support for multiple MAC addresses.
74 - VLAN filtering.
75 - RX VLAN stripping.
76 - TX VLAN insertion.
77 - RX CRC stripping configuration.
78 - Promiscuous mode on PF and VF.
79 - Multicast promiscuous mode on PF and VF.
80 - Hardware checksum offloads.
81 - Flow director (RTE_FDIR_MODE_PERFECT, RTE_FDIR_MODE_PERFECT_MAC_VLAN and
82   RTE_ETH_FDIR_REJECT).
83 - Flow API, including :ref:`flow_isolated_mode`.
84 - Multiple process.
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.
89 - RX interrupts.
90 - Statistics query including Basic, Extended and per queue.
91 - Rx HW timestamp.
92 - Tunnel types: VXLAN, L3 VXLAN, VXLAN-GPE, GRE, MPLSoGRE, MPLSoUDP, IP-in-IP, Geneve.
93 - Tunnel types: VXLAN, L3 VXLAN, VXLAN-GPE, GRE, MPLSoGRE, MPLSoUDP, IP-in-IP, Geneve, GTP.
94 - Tunnel HW offloads: packet type, inner/outer RSS, IP and UDP checksum verification.
95 - NIC HW offloads: encapsulation (vxlan, gre, mplsoudp, mplsogre), NAT, routing, TTL
96   increment/decrement, count, drop, mark. For details please see :ref:`mlx5_offloads_support`.
97 - Flow insertion rate of more then million flows per second, when using Direct Rules.
98 - Support for multiple rte_flow groups.
99 - Hardware LRO.
100
101 Limitations
102 -----------
103
104 - For secondary process:
105
106   - Forked secondary process not supported.
107   - External memory unregistered in EAL memseg list cannot be used for DMA
108     unless such memory has been registered by ``mlx5_mr_update_ext_mp()`` in
109     primary process and remapped to the same virtual address in secondary
110     process. If the external memory is registered by primary process but has
111     different virtual address in secondary process, unexpected error may happen.
112
113 - When using Verbs flow engine (``dv_flow_en`` = 0), flow pattern without any
114   specific VLAN will match for VLAN packets as well:
115
116   When VLAN spec is not specified in the pattern, the matching rule will be created with VLAN as a wild card.
117   Meaning, the flow rule::
118
119         flow create 0 ingress pattern eth / vlan vid is 3 / ipv4 / end ...
120
121   Will only match vlan packets with vid=3. and the flow rule::
122
123         flow create 0 ingress pattern eth / ipv4 / end ...
124
125   Will match any ipv4 packet (VLAN included).
126
127 - VLAN pop offload command:
128
129   - Flow rules having a VLAN pop offload command as one of their actions and
130     are lacking a match on VLAN as one of their items are not supported.
131   - The command is not supported on egress traffic.
132
133 - VLAN push offload is not supported on ingress traffic.
134
135 - VLAN set PCP offload is not supported on existing headers.
136
137 - A multi segment packet must have not more segments than reported by dev_infos_get()
138   in tx_desc_lim.nb_seg_max field. This value depends on maximal supported Tx descriptor
139   size and ``txq_inline_min`` settings and may be from 2 (worst case forced by maximal
140   inline settings) to 58.
141
142 - Flows with a VXLAN Network Identifier equal (or ends to be equal)
143   to 0 are not supported.
144
145 - VXLAN TSO and checksum offloads are not supported on VM.
146
147 - L3 VXLAN and VXLAN-GPE tunnels cannot be supported together with MPLSoGRE and MPLSoUDP.
148
149 - Match on Geneve header supports the following fields only:
150
151      - VNI
152      - OAM
153      - protocol type
154      - options length
155        Currently, the only supported options length value is 0.
156
157 - VF: flow rules created on VF devices can only match traffic targeted at the
158   configured MAC addresses (see ``rte_eth_dev_mac_addr_add()``).
159
160 - Match on GTP tunnel header item supports the following fields only:
161
162      - msg_type
163      - teid
164
165 .. note::
166
167    MAC addresses not already present in the bridge table of the associated
168    kernel network device will be added and cleaned up by the PMD when closing
169    the device. In case of ungraceful program termination, some entries may
170    remain present and should be removed manually by other means.
171
172 - When Multi-Packet Rx queue is configured (``mprq_en``), a Rx packet can be
173   externally attached to a user-provided mbuf with having EXT_ATTACHED_MBUF in
174   ol_flags. As the mempool for the external buffer is managed by PMD, all the
175   Rx mbufs must be freed before the device is closed. Otherwise, the mempool of
176   the external buffers will be freed by PMD and the application which still
177   holds the external buffers may be corrupted.
178
179 - If Multi-Packet Rx queue is configured (``mprq_en``) and Rx CQE compression is
180   enabled (``rxq_cqe_comp_en``) at the same time, RSS hash result is not fully
181   supported. Some Rx packets may not have PKT_RX_RSS_HASH.
182
183 - IPv6 Multicast messages are not supported on VM, while promiscuous mode
184   and allmulticast mode are both set to off.
185   To receive IPv6 Multicast messages on VM, explicitly set the relevant
186   MAC address using rte_eth_dev_mac_addr_add() API.
187
188 - The amount of descriptors in Tx queue may be limited by data inline settings.
189   Inline data require the more descriptor building blocks and overall block
190   amount may exceed the hardware supported limits. The application should
191   reduce the requested Tx size or adjust data inline settings with
192   ``txq_inline_max`` and ``txq_inline_mpw`` devargs keys.
193
194 - E-Switch decapsulation Flow:
195
196   - can be applied to PF port only.
197   - must specify VF port action (packet redirection from PF to VF).
198   - optionally may specify tunnel inner source and destination MAC addresses.
199
200 - E-Switch  encapsulation Flow:
201
202   - can be applied to VF ports only.
203   - must specify PF port action (packet redirection from VF to PF).
204
205 - ICMP/ICMP6 code/type matching, IP-in-IP and MPLS flow matching are all
206   mutually exclusive features which cannot be supported together
207   (see :ref:`mlx5_firmware_config`).
208
209 - LRO:
210
211   - Requires DevX and DV flow to be enabled.
212   - KEEP_CRC offload cannot be supported with LRO.
213   - The first mbuf length, without head-room,  must be big enough to include the
214     TCP header (122B).
215   - Rx queue with LRO offload enabled, receiving a non-LRO packet, can forward
216     it with size limited to max LRO size, not to max RX packet length.
217
218 Statistics
219 ----------
220
221 MLX5 supports various methods to report statistics:
222
223 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.
224
225 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.
226
227 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.
228
229 Configuration
230 -------------
231
232 Compilation options
233 ~~~~~~~~~~~~~~~~~~~
234
235 These options can be modified in the ``.config`` file.
236
237 - ``CONFIG_RTE_LIBRTE_MLX5_PMD`` (default **n**)
238
239   Toggle compilation of librte_pmd_mlx5 itself.
240
241 - ``CONFIG_RTE_IBVERBS_LINK_DLOPEN`` (default **n**)
242
243   Build PMD with additional code to make it loadable without hard
244   dependencies on **libibverbs** nor **libmlx5**, which may not be installed
245   on the target system.
246
247   In this mode, their presence is still required for it to run properly,
248   however their absence won't prevent a DPDK application from starting (with
249   ``CONFIG_RTE_BUILD_SHARED_LIB`` disabled) and they won't show up as
250   missing with ``ldd(1)``.
251
252   It works by moving these dependencies to a purpose-built rdma-core "glue"
253   plug-in which must either be installed in a directory whose name is based
254   on ``CONFIG_RTE_EAL_PMD_PATH`` suffixed with ``-glue`` if set, or in a
255   standard location for the dynamic linker (e.g. ``/lib``) if left to the
256   default empty string (``""``).
257
258   This option has no performance impact.
259
260 - ``CONFIG_RTE_IBVERBS_LINK_STATIC`` (default **n**)
261
262   Embed static flavor of the dependencies **libibverbs** and **libmlx5**
263   in the PMD shared library or the executable static binary.
264
265 - ``CONFIG_RTE_LIBRTE_MLX5_DEBUG`` (default **n**)
266
267   Toggle debugging code and stricter compilation flags. Enabling this option
268   adds additional run-time checks and debugging messages at the cost of
269   lower performance.
270
271 .. note::
272
273    For BlueField, target should be set to ``arm64-bluefield-linux-gcc``. This
274    will enable ``CONFIG_RTE_LIBRTE_MLX5_PMD`` and set ``RTE_CACHE_LINE_SIZE`` to
275    64. Default armv8a configuration of make build and meson build set it to 128
276    then brings performance degradation.
277
278 This option is available in meson:
279
280 - ``ibverbs_link`` can be ``static``, ``shared``, or ``dlopen``.
281
282 Environment variables
283 ~~~~~~~~~~~~~~~~~~~~~
284
285 - ``MLX5_GLUE_PATH``
286
287   A list of directories in which to search for the rdma-core "glue" plug-in,
288   separated by colons or semi-colons.
289
290   Only matters when compiled with ``CONFIG_RTE_IBVERBS_LINK_DLOPEN``
291   enabled and most useful when ``CONFIG_RTE_EAL_PMD_PATH`` is also set,
292   since ``LD_LIBRARY_PATH`` has no effect in this case.
293
294 - ``MLX5_SHUT_UP_BF``
295
296   Configures HW Tx doorbell register as IO-mapped.
297
298   By default, the HW Tx doorbell is configured as a write-combining register.
299   The register would be flushed to HW usually when the write-combining buffer
300   becomes full, but it depends on CPU design.
301
302   Except for vectorized Tx burst routines, a write memory barrier is enforced
303   after updating the register so that the update can be immediately visible to
304   HW.
305
306   When vectorized Tx burst is called, the barrier is set only if the burst size
307   is not aligned to MLX5_VPMD_TX_MAX_BURST. However, setting this environmental
308   variable will bring better latency even though the maximum throughput can
309   slightly decline.
310
311 Run-time configuration
312 ~~~~~~~~~~~~~~~~~~~~~~
313
314 - librte_pmd_mlx5 brings kernel network interfaces up during initialization
315   because it is affected by their state. Forcing them down prevents packets
316   reception.
317
318 - **ethtool** operations on related kernel interfaces also affect the PMD.
319
320 - ``rxq_cqe_comp_en`` parameter [int]
321
322   A nonzero value enables the compression of CQE on RX side. This feature
323   allows to save PCI bandwidth and improve performance. Enabled by default.
324
325   Supported on:
326
327   - x86_64 with ConnectX-4, ConnectX-4 LX, ConnectX-5, ConnectX-6, ConnectX-6 DX
328     and BlueField.
329   - POWER9 and ARMv8 with ConnectX-4 LX, ConnectX-5, ConnectX-6, ConnectX-6 DX
330     and BlueField.
331
332 - ``rxq_cqe_pad_en`` parameter [int]
333
334   A nonzero value enables 128B padding of CQE on RX side. The size of CQE
335   is aligned with the size of a cacheline of the core. If cacheline size is
336   128B, the CQE size is configured to be 128B even though the device writes
337   only 64B data on the cacheline. This is to avoid unnecessary cache
338   invalidation by device's two consecutive writes on to one cacheline.
339   However in some architecture, it is more beneficial to update entire
340   cacheline with padding the rest 64B rather than striding because
341   read-modify-write could drop performance a lot. On the other hand,
342   writing extra data will consume more PCIe bandwidth and could also drop
343   the maximum throughput. It is recommended to empirically set this
344   parameter. Disabled by default.
345
346   Supported on:
347
348   - CPU having 128B cacheline with ConnectX-5 and BlueField.
349
350 - ``rxq_pkt_pad_en`` parameter [int]
351
352   A nonzero value enables padding Rx packet to the size of cacheline on PCI
353   transaction. This feature would waste PCI bandwidth but could improve
354   performance by avoiding partial cacheline write which may cause costly
355   read-modify-copy in memory transaction on some architectures. Disabled by
356   default.
357
358   Supported on:
359
360   - x86_64 with ConnectX-4, ConnectX-4 LX, ConnectX-5, ConnectX-6, ConnectX-6 DX
361     and BlueField.
362   - POWER8 and ARMv8 with ConnectX-4 LX, ConnectX-5, ConnectX-6, ConnectX-6 DX
363     and BlueField.
364
365 - ``mprq_en`` parameter [int]
366
367   A nonzero value enables configuring Multi-Packet Rx queues. Rx queue is
368   configured as Multi-Packet RQ if the total number of Rx queues is
369   ``rxqs_min_mprq`` or more and Rx scatter isn't configured. Disabled by
370   default.
371
372   Multi-Packet Rx Queue (MPRQ a.k.a Striding RQ) can further save PCIe bandwidth
373   by posting a single large buffer for multiple packets. Instead of posting a
374   buffers per a packet, one large buffer is posted in order to receive multiple
375   packets on the buffer. A MPRQ buffer consists of multiple fixed-size strides
376   and each stride receives one packet. MPRQ can improve throughput for
377   small-packet traffic.
378
379   When MPRQ is enabled, max_rx_pkt_len can be larger than the size of
380   user-provided mbuf even if DEV_RX_OFFLOAD_SCATTER isn't enabled. PMD will
381   configure large stride size enough to accommodate max_rx_pkt_len as long as
382   device allows. Note that this can waste system memory compared to enabling Rx
383   scatter and multi-segment packet.
384
385 - ``mprq_log_stride_num`` parameter [int]
386
387   Log 2 of the number of strides for Multi-Packet Rx queue. Configuring more
388   strides can reduce PCIe traffic further. If configured value is not in the
389   range of device capability, the default value will be set with a warning
390   message. The default value is 4 which is 16 strides per a buffer, valid only
391   if ``mprq_en`` is set.
392
393   The size of Rx queue should be bigger than the number of strides.
394
395 - ``mprq_max_memcpy_len`` parameter [int]
396
397   The maximum length of packet to memcpy in case of Multi-Packet Rx queue. Rx
398   packet is mem-copied to a user-provided mbuf if the size of Rx packet is less
399   than or equal to this parameter. Otherwise, PMD will attach the Rx packet to
400   the mbuf by external buffer attachment - ``rte_pktmbuf_attach_extbuf()``.
401   A mempool for external buffers will be allocated and managed by PMD. If Rx
402   packet is externally attached, ol_flags field of the mbuf will have
403   EXT_ATTACHED_MBUF and this flag must be preserved. ``RTE_MBUF_HAS_EXTBUF()``
404   checks the flag. The default value is 128, valid only if ``mprq_en`` is set.
405
406 - ``rxqs_min_mprq`` parameter [int]
407
408   Configure Rx queues as Multi-Packet RQ if the total number of Rx queues is
409   greater or equal to this value. The default value is 12, valid only if
410   ``mprq_en`` is set.
411
412 - ``txq_inline`` parameter [int]
413
414   Amount of data to be inlined during TX operations. This parameter is
415   deprecated and converted to the new parameter ``txq_inline_max`` providing
416   partial compatibility.
417
418 - ``txqs_min_inline`` parameter [int]
419
420   Enable inline data send only when the number of TX queues is greater or equal
421   to this value.
422
423   This option should be used in combination with ``txq_inline_max`` and
424   ``txq_inline_mpw`` below and does not affect ``txq_inline_min`` settings above.
425
426   If this option is not specified the default value 16 is used for BlueField
427   and 8 for other platforms
428
429   The data inlining consumes the CPU cycles, so this option is intended to
430   auto enable inline data if we have enough Tx queues, which means we have
431   enough CPU cores and PCI bandwidth is getting more critical and CPU
432   is not supposed to be bottleneck anymore.
433
434   The copying data into WQE improves latency and can improve PPS performance
435   when PCI back pressure is detected and may be useful for scenarios involving
436   heavy traffic on many queues.
437
438   Because additional software logic is necessary to handle this mode, this
439   option should be used with care, as it may lower performance when back
440   pressure is not expected.
441
442   If inline data are enabled it may affect the maximal size of Tx queue in
443   descriptors because the inline data increase the descriptor size and
444   queue size limits supported by hardware may be exceeded.
445
446 - ``txq_inline_min`` parameter [int]
447
448   Minimal amount of data to be inlined into WQE during Tx operations. NICs
449   may require this minimal data amount to operate correctly. The exact value
450   may depend on NIC operation mode, requested offloads, etc. It is strongly
451   recommended to omit this parameter and use the default values. Anyway,
452   applications using this parameter should take into consideration that
453   specifying an inconsistent value may prevent the NIC from sending packets.
454
455   If ``txq_inline_min`` key is present the specified value (may be aligned
456   by the driver in order not to exceed the limits and provide better descriptor
457   space utilization) will be used by the driver and it is guaranteed that
458   requested amount of data bytes are inlined into the WQE beside other inline
459   settings. This key also may update ``txq_inline_max`` value (default
460   or specified explicitly in devargs) to reserve the space for inline data.
461
462   If ``txq_inline_min`` key is not present, the value may be queried by the
463   driver from the NIC via DevX if this feature is available. If there is no DevX
464   enabled/supported the value 18 (supposing L2 header including VLAN) is set
465   for ConnectX-4 and ConnectX-4LX, and 0 is set by default for ConnectX-5
466   and newer NICs. If packet is shorter the ``txq_inline_min`` value, the entire
467   packet is inlined.
468
469   For ConnectX-4 NIC, driver does not allow specifying value below 18
470   (minimal L2 header, including VLAN), error will be raised.
471
472   For ConnectX-4LX NIC, it is allowed to specify values below 18, but
473   it is not recommended and may prevent NIC from sending packets over
474   some configurations.
475
476   Please, note, this minimal data inlining disengages eMPW feature (Enhanced
477   Multi-Packet Write), because last one does not support partial packet inlining.
478   This is not very critical due to minimal data inlining is mostly required
479   by ConnectX-4 and ConnectX-4 Lx, these NICs do not support eMPW feature.
480
481 - ``txq_inline_max`` parameter [int]
482
483   Specifies the maximal packet length to be completely inlined into WQE
484   Ethernet Segment for ordinary SEND method. If packet is larger than specified
485   value, the packet data won't be copied by the driver at all, data buffer
486   is addressed with a pointer. If packet length is less or equal all packet
487   data will be copied into WQE. This may improve PCI bandwidth utilization for
488   short packets significantly but requires the extra CPU cycles.
489
490   The data inline feature is controlled by number of Tx queues, if number of Tx
491   queues is larger than ``txqs_min_inline`` key parameter, the inline feature
492   is engaged, if there are not enough Tx queues (which means not enough CPU cores
493   and CPU resources are scarce), data inline is not performed by the driver.
494   Assigning ``txqs_min_inline`` with zero always enables the data inline.
495
496   The default ``txq_inline_max`` value is 290. The specified value may be adjusted
497   by the driver in order not to exceed the limit (930 bytes) and to provide better
498   WQE space filling without gaps, the adjustment is reflected in the debug log.
499   Also, the default value (290) may be decreased in run-time if the large transmit
500   queue size is requested and hardware does not support enough descriptor
501   amount, in this case warning is emitted. If ``txq_inline_max`` key is
502   specified and requested inline settings can not be satisfied then error
503   will be raised.
504
505 - ``txq_inline_mpw`` parameter [int]
506
507   Specifies the maximal packet length to be completely inlined into WQE for
508   Enhanced MPW method. If packet is large the specified value, the packet data
509   won't be copied, and data buffer is addressed with pointer. If packet length
510   is less or equal, all packet data will be copied into WQE. This may improve PCI
511   bandwidth utilization for short packets significantly but requires the extra
512   CPU cycles.
513
514   The data inline feature is controlled by number of TX queues, if number of Tx
515   queues is larger than ``txqs_min_inline`` key parameter, the inline feature
516   is engaged, if there are not enough Tx queues (which means not enough CPU cores
517   and CPU resources are scarce), data inline is not performed by the driver.
518   Assigning ``txqs_min_inline`` with zero always enables the data inline.
519
520   The default ``txq_inline_mpw`` value is 268. The specified value may be adjusted
521   by the driver in order not to exceed the limit (930 bytes) and to provide better
522   WQE space filling without gaps, the adjustment is reflected in the debug log.
523   Due to multiple packets may be included to the same WQE with Enhanced Multi
524   Packet Write Method and overall WQE size is limited it is not recommended to
525   specify large values for the ``txq_inline_mpw``. Also, the default value (268)
526   may be decreased in run-time if the large transmit queue size is requested
527   and hardware does not support enough descriptor amount, in this case warning
528   is emitted. If ``txq_inline_mpw`` key is  specified and requested inline
529   settings can not be satisfied then error will be raised.
530
531 - ``txqs_max_vec`` parameter [int]
532
533   Enable vectorized Tx only when the number of TX queues is less than or
534   equal to this value. This parameter is deprecated and ignored, kept
535   for compatibility issue to not prevent driver from probing.
536
537 - ``txq_mpw_hdr_dseg_en`` parameter [int]
538
539   A nonzero value enables including two pointers in the first block of TX
540   descriptor. The parameter is deprecated and ignored, kept for compatibility
541   issue.
542
543 - ``txq_max_inline_len`` parameter [int]
544
545   Maximum size of packet to be inlined. This limits the size of packet to
546   be inlined. If the size of a packet is larger than configured value, the
547   packet isn't inlined even though there's enough space remained in the
548   descriptor. Instead, the packet is included with pointer. This parameter
549   is deprecated and converted directly to ``txq_inline_mpw`` providing full
550   compatibility. Valid only if eMPW feature is engaged.
551
552 - ``txq_mpw_en`` parameter [int]
553
554   A nonzero value enables Enhanced Multi-Packet Write (eMPW) for ConnectX-5,
555   ConnectX-6, ConnectX-6 DX and BlueField. eMPW allows the TX burst function to pack
556   up multiple packets in a single descriptor session in order to save PCI bandwidth
557   and improve performance at the cost of a slightly higher CPU usage. When
558   ``txq_inline_mpw`` is set along with ``txq_mpw_en``, TX burst function copies
559   entire packet data on to TX descriptor instead of including pointer of packet.
560
561   The Enhanced Multi-Packet Write feature is enabled by default if NIC supports
562   it, can be disabled by explicit specifying 0 value for ``txq_mpw_en`` option.
563   Also, if minimal data inlining is requested by non-zero ``txq_inline_min``
564   option or reported by the NIC, the eMPW feature is disengaged.
565
566 - ``tx_db_nc`` parameter [int]
567
568   The rdma core library can map doorbell register in two ways, depending on the
569   environment variable "MLX5_SHUT_UP_BF":
570
571   - As regular cached memory, if the variable is either missing or set to zero.
572   - As non-cached memory, if the variable is present and set to not "0" value.
573
574   The type of mapping may slightly affect the Tx performance, the optimal choice
575   is strongly relied on the host architecture and should be deduced practically.
576
577   If ``tx_db_nc`` is set to zero, the doorbell is forced to be mapped to regular
578   memory, the PMD will perform the extra write memory barrier after writing to
579   doorbell, it might increase the needed CPU clocks per packet to send, but
580   latency might be improved.
581
582   If ``tx_db_nc`` is set to one, the doorbell is forced to be mapped to non
583   cached memory, the PMD will not perform the extra write memory barrier
584   after writing to doorbell, on some architectures it might improve the
585   performance.
586
587   If ``tx_db_nc`` is set to two, the doorbell is forced to be mapped to regular
588   memory, the PMD will use heuristics to decide whether write memory barrier
589   should be performed. For bursts with size multiple of recommended one (64 pkts)
590   it is supposed the next burst is coming and no need to issue the extra memory
591   barrier (it is supposed to be issued in the next coming burst, at least after
592   descriptor writing). It might increase latency (on some hosts till next
593   packets transmit) and should be used with care.
594
595   If ``tx_db_nc`` is omitted or set to zero, the preset (if any) environment
596   variable "MLX5_SHUT_UP_BF" value is used. If there is no "MLX5_SHUT_UP_BF",
597   the default ``tx_db_nc`` value is zero for ARM64 hosts and one for others.
598
599 - ``tx_vec_en`` parameter [int]
600
601   A nonzero value enables Tx vector on ConnectX-5, ConnectX-6, ConnectX-6 DX
602   and BlueField NICs if the number of global Tx queues on the port is less than
603   ``txqs_max_vec``. The parameter is deprecated and ignored.
604
605 - ``rx_vec_en`` parameter [int]
606
607   A nonzero value enables Rx vector if the port is not configured in
608   multi-segment otherwise this parameter is ignored.
609
610   Enabled by default.
611
612 - ``vf_nl_en`` parameter [int]
613
614   A nonzero value enables Netlink requests from the VF to add/remove MAC
615   addresses or/and enable/disable promiscuous/all multicast on the Netdevice.
616   Otherwise the relevant configuration must be run with Linux iproute2 tools.
617   This is a prerequisite to receive this kind of traffic.
618
619   Enabled by default, valid only on VF devices ignored otherwise.
620
621 - ``l3_vxlan_en`` parameter [int]
622
623   A nonzero value allows L3 VXLAN and VXLAN-GPE flow creation. To enable
624   L3 VXLAN or VXLAN-GPE, users has to configure firmware and enable this
625   parameter. This is a prerequisite to receive this kind of traffic.
626
627   Disabled by default.
628
629 - ``dv_xmeta_en`` parameter [int]
630
631   A nonzero value enables extensive flow metadata support if device is
632   capable and driver supports it. This can enable extensive support of
633   ``MARK`` and ``META`` item of ``rte_flow``. The newly introduced
634   ``SET_TAG`` and ``SET_META`` actions do not depend on ``dv_xmeta_en``.
635
636   There are some possible configurations, depending on parameter value:
637
638   - 0, this is default value, defines the legacy mode, the ``MARK`` and
639     ``META`` related actions and items operate only within NIC Tx and
640     NIC Rx steering domains, no ``MARK`` and ``META`` information crosses
641     the domain boundaries. The ``MARK`` item is 24 bits wide, the ``META``
642     item is 32 bits wide and match supported on egress only.
643
644   - 1, this engages extensive metadata mode, the ``MARK`` and ``META``
645     related actions and items operate within all supported steering domains,
646     including FDB, ``MARK`` and ``META`` information may cross the domain
647     boundaries. The ``MARK`` item is 24 bits wide, the ``META`` item width
648     depends on kernel and firmware configurations and might be 0, 16 or
649     32 bits. Within NIC Tx domain ``META`` data width is 32 bits for
650     compatibility, the actual width of data transferred to the FDB domain
651     depends on kernel configuration and may be vary. The actual supported
652     width can be retrieved in runtime by series of rte_flow_validate()
653     trials.
654
655   - 2, this engages extensive metadata mode, the ``MARK`` and ``META``
656     related actions and items operate within all supported steering domains,
657     including FDB, ``MARK`` and ``META`` information may cross the domain
658     boundaries. The ``META`` item is 32 bits wide, the ``MARK`` item width
659     depends on kernel and firmware configurations and might be 0, 16 or
660     24 bits. The actual supported width can be retrieved in runtime by
661     series of rte_flow_validate() trials.
662
663   +------+-----------+-----------+-------------+-------------+
664   | Mode | ``MARK``  | ``META``  | ``META`` Tx | FDB/Through |
665   +======+===========+===========+=============+=============+
666   | 0    | 24 bits   | 32 bits   | 32 bits     | no          |
667   +------+-----------+-----------+-------------+-------------+
668   | 1    | 24 bits   | vary 0-32 | 32 bits     | yes         |
669   +------+-----------+-----------+-------------+-------------+
670   | 2    | vary 0-32 | 32 bits   | 32 bits     | yes         |
671   +------+-----------+-----------+-------------+-------------+
672
673   If there is no E-Switch configuration the ``dv_xmeta_en`` parameter is
674   ignored and the device is configured to operate in legacy mode (0).
675
676   Disabled by default (set to 0).
677
678   The Direct Verbs/Rules (engaged with ``dv_flow_en`` = 1) supports all
679   of the extensive metadata features. The legacy Verbs supports FLAG and
680   MARK metadata actions over NIC Rx steering domain only.
681
682 - ``dv_flow_en`` parameter [int]
683
684   A nonzero value enables the DV flow steering assuming it is supported
685   by the driver (RDMA Core library version is rdma-core-24.0 or higher).
686
687   Enabled by default if supported.
688
689 - ``dv_esw_en`` parameter [int]
690
691   A nonzero value enables E-Switch using Direct Rules.
692
693   Enabled by default if supported.
694
695 - ``mr_ext_memseg_en`` parameter [int]
696
697   A nonzero value enables extending memseg when registering DMA memory. If
698   enabled, the number of entries in MR (Memory Region) lookup table on datapath
699   is minimized and it benefits performance. On the other hand, it worsens memory
700   utilization because registered memory is pinned by kernel driver. Even if a
701   page in the extended chunk is freed, that doesn't become reusable until the
702   entire memory is freed.
703
704   Enabled by default.
705
706 - ``representor`` parameter [list]
707
708   This parameter can be used to instantiate DPDK Ethernet devices from
709   existing port (or VF) representors configured on the device.
710
711   It is a standard parameter whose format is described in
712   :ref:`ethernet_device_standard_device_arguments`.
713
714   For instance, to probe port representors 0 through 2::
715
716     representor=[0-2]
717
718 - ``max_dump_files_num`` parameter [int]
719
720   The maximum number of files per PMD entity that may be created for debug information.
721   The files will be created in /var/log directory or in current directory.
722
723   set to 128 by default.
724
725 - ``lro_timeout_usec`` parameter [int]
726
727   The maximum allowed duration of an LRO session, in micro-seconds.
728   PMD will set the nearest value supported by HW, which is not bigger than
729   the input ``lro_timeout_usec`` value.
730   If this parameter is not specified, by default PMD will set
731   the smallest value supported by HW.
732
733 .. _mlx5_firmware_config:
734
735 Firmware configuration
736 ~~~~~~~~~~~~~~~~~~~~~~
737
738 Firmware features can be configured as key/value pairs.
739
740 The command to set a value is::
741
742   mlxconfig -d <device> set <key>=<value>
743
744 The command to query a value is::
745
746   mlxconfig -d <device> query | grep <key>
747
748 The device name for the command ``mlxconfig`` can be either the PCI address,
749 or the mst device name found with::
750
751   mst status
752
753 Below are some firmware configurations listed.
754
755 - link type::
756
757     LINK_TYPE_P1
758     LINK_TYPE_P2
759     value: 1=Infiniband 2=Ethernet 3=VPI(auto-sense)
760
761 - enable SR-IOV::
762
763     SRIOV_EN=1
764
765 - maximum number of SR-IOV virtual functions::
766
767     NUM_OF_VFS=<max>
768
769 - enable DevX (required by Direct Rules and other features)::
770
771     UCTX_EN=1
772
773 - aggressive CQE zipping::
774
775     CQE_COMPRESSION=1
776
777 - L3 VXLAN and VXLAN-GPE destination UDP port::
778
779     IP_OVER_VXLAN_EN=1
780     IP_OVER_VXLAN_PORT=<udp dport>
781
782 - enable IP-in-IP tunnel flow matching::
783
784     FLEX_PARSER_PROFILE_ENABLE=0
785
786 - enable MPLS flow matching::
787
788     FLEX_PARSER_PROFILE_ENABLE=1
789
790 - enable ICMP/ICMP6 code/type fields matching::
791
792     FLEX_PARSER_PROFILE_ENABLE=2
793
794 - enable Geneve flow matching::
795
796    FLEX_PARSER_PROFILE_ENABLE=0
797
798 - enable GTP flow matching::
799
800    FLEX_PARSER_PROFILE_ENABLE=3
801
802 Prerequisites
803 -------------
804
805 This driver relies on external libraries and kernel drivers for resources
806 allocations and initialization. The following dependencies are not part of
807 DPDK and must be installed separately:
808
809 - **libibverbs**
810
811   User space Verbs framework used by librte_pmd_mlx5. This library provides
812   a generic interface between the kernel and low-level user space drivers
813   such as libmlx5.
814
815   It allows slow and privileged operations (context initialization, hardware
816   resources allocations) to be managed by the kernel and fast operations to
817   never leave user space.
818
819 - **libmlx5**
820
821   Low-level user space driver library for Mellanox
822   ConnectX-4/ConnectX-5/ConnectX-6/BlueField devices, it is automatically loaded
823   by libibverbs.
824
825   This library basically implements send/receive calls to the hardware
826   queues.
827
828 - **Kernel modules**
829
830   They provide the kernel-side Verbs API and low level device drivers that
831   manage actual hardware initialization and resources sharing with user
832   space processes.
833
834   Unlike most other PMDs, these modules must remain loaded and bound to
835   their devices:
836
837   - mlx5_core: hardware driver managing Mellanox
838     ConnectX-4/ConnectX-5/ConnectX-6/BlueField devices and related Ethernet kernel
839     network devices.
840   - mlx5_ib: InifiniBand device driver.
841   - ib_uverbs: user space driver for Verbs (entry point for libibverbs).
842
843 - **Firmware update**
844
845   Mellanox OFED/EN releases include firmware updates for
846   ConnectX-4/ConnectX-5/ConnectX-6/BlueField adapters.
847
848   Because each release provides new features, these updates must be applied to
849   match the kernel modules and libraries they come with.
850
851 .. note::
852
853    Both libraries are BSD and GPL licensed. Linux kernel modules are GPL
854    licensed.
855
856 Installation
857 ~~~~~~~~~~~~
858
859 Either RDMA Core library with a recent enough Linux kernel release
860 (recommended) or Mellanox OFED/EN, which provides compatibility with older
861 releases.
862
863 RDMA Core with Linux Kernel
864 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
865
866 - Minimal kernel version : v4.14 or the most recent 4.14-rc (see `Linux installation documentation`_)
867 - Minimal rdma-core version: v15+ commit 0c5f5765213a ("Merge pull request #227 from yishaih/tm")
868   (see `RDMA Core installation documentation`_)
869 - When building for i686 use:
870
871   - rdma-core version 18.0 or above built with 32bit support.
872   - Kernel version 4.14.41 or above.
873
874 - Starting with rdma-core v21, static libraries can be built::
875
876     cd build
877     CFLAGS=-fPIC cmake -DIN_PLACE=1 -DENABLE_STATIC=1 -GNinja ..
878     ninja
879
880 .. _`Linux installation documentation`: https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux-stable.git/plain/Documentation/admin-guide/README.rst
881 .. _`RDMA Core installation documentation`: https://raw.githubusercontent.com/linux-rdma/rdma-core/master/README.md
882
883 If rdma-core libraries are built but not installed, DPDK makefile can link them,
884 thanks to these environment variables:
885
886    - ``EXTRA_CFLAGS=-I/path/to/rdma-core/build/include``
887    - ``EXTRA_LDFLAGS=-L/path/to/rdma-core/build/lib``
888    - ``PKG_CONFIG_PATH=/path/to/rdma-core/build/lib/pkgconfig``
889
890 Mellanox OFED/EN
891 ^^^^^^^^^^^^^^^^
892
893 - Mellanox OFED version: ** 4.5, 4.6** /
894   Mellanox EN version: **4.5, 4.6**
895 - firmware version:
896
897   - ConnectX-4: **12.21.1000** and above.
898   - ConnectX-4 Lx: **14.21.1000** and above.
899   - ConnectX-5: **16.21.1000** and above.
900   - ConnectX-5 Ex: **16.21.1000** and above.
901   - ConnectX-6: **20.99.5374** and above.
902   - ConnectX-6 DX: **22.27.0090** and above.
903   - BlueField: **18.25.1010** and above.
904
905 While these libraries and kernel modules are available on OpenFabrics
906 Alliance's `website <https://www.openfabrics.org/>`__ and provided by package
907 managers on most distributions, this PMD requires Ethernet extensions that
908 may not be supported at the moment (this is a work in progress).
909
910 `Mellanox OFED
911 <http://www.mellanox.com/page/products_dyn?product_family=26&mtag=linux>`__ and
912 `Mellanox EN
913 <http://www.mellanox.com/page/products_dyn?product_family=27&mtag=linux>`__
914 include the necessary support and should be used in the meantime. For DPDK,
915 only libibverbs, libmlx5, mlnx-ofed-kernel packages and firmware updates are
916 required from that distribution.
917
918 .. note::
919
920    Several versions of Mellanox OFED/EN are available. Installing the version
921    this DPDK release was developed and tested against is strongly
922    recommended. Please check the `prerequisites`_.
923
924 Supported NICs
925 --------------
926
927 * Mellanox(R) ConnectX(R)-4 10G MCX4111A-XCAT (1x10G)
928 * Mellanox(R) ConnectX(R)-4 10G MCX4121A-XCAT (2x10G)
929 * Mellanox(R) ConnectX(R)-4 25G MCX4111A-ACAT (1x25G)
930 * Mellanox(R) ConnectX(R)-4 25G MCX4121A-ACAT (2x25G)
931 * Mellanox(R) ConnectX(R)-4 40G MCX4131A-BCAT (1x40G)
932 * Mellanox(R) ConnectX(R)-4 40G MCX413A-BCAT (1x40G)
933 * Mellanox(R) ConnectX(R)-4 40G MCX415A-BCAT (1x40G)
934 * Mellanox(R) ConnectX(R)-4 50G MCX4131A-GCAT (1x50G)
935 * Mellanox(R) ConnectX(R)-4 50G MCX413A-GCAT (1x50G)
936 * Mellanox(R) ConnectX(R)-4 50G MCX414A-BCAT (2x50G)
937 * Mellanox(R) ConnectX(R)-4 50G MCX415A-GCAT (2x50G)
938 * Mellanox(R) ConnectX(R)-4 50G MCX416A-BCAT (2x50G)
939 * Mellanox(R) ConnectX(R)-4 50G MCX416A-GCAT (2x50G)
940 * Mellanox(R) ConnectX(R)-4 50G MCX415A-CCAT (1x100G)
941 * Mellanox(R) ConnectX(R)-4 100G MCX416A-CCAT (2x100G)
942 * Mellanox(R) ConnectX(R)-4 Lx 10G MCX4121A-XCAT (2x10G)
943 * Mellanox(R) ConnectX(R)-4 Lx 25G MCX4121A-ACAT (2x25G)
944 * Mellanox(R) ConnectX(R)-5 100G MCX556A-ECAT (2x100G)
945 * Mellanox(R) ConnectX(R)-5 Ex EN 100G MCX516A-CDAT (2x100G)
946 * Mellanox(R) ConnectX(R)-6 200G MCX654106A-HCAT (4x200G)
947 * Mellanox(R) ConnectX(R)-6DX EN 100G MCX623106AN-CDAT (2*100g)
948 * Mellanox(R) ConnectX(R)-6DX EN 200G MCX623105AN-VDAT (1*200g)
949
950 Quick Start Guide on OFED/EN
951 ----------------------------
952
953 1. Download latest Mellanox OFED/EN. For more info check the  `prerequisites`_.
954
955
956 2. Install the required libraries and kernel modules either by installing
957    only the required set, or by installing the entire Mellanox OFED/EN::
958
959         ./mlnxofedinstall --upstream-libs --dpdk
960
961 3. Verify the firmware is the correct one::
962
963         ibv_devinfo
964
965 4. Verify all ports links are set to Ethernet::
966
967         mlxconfig -d <mst device> query | grep LINK_TYPE
968         LINK_TYPE_P1                        ETH(2)
969         LINK_TYPE_P2                        ETH(2)
970
971    Link types may have to be configured to Ethernet::
972
973         mlxconfig -d <mst device> set LINK_TYPE_P1/2=1/2/3
974
975         * LINK_TYPE_P1=<1|2|3> , 1=Infiniband 2=Ethernet 3=VPI(auto-sense)
976
977    For hypervisors, verify SR-IOV is enabled on the NIC::
978
979         mlxconfig -d <mst device> query | grep SRIOV_EN
980         SRIOV_EN                            True(1)
981
982    If needed, configure SR-IOV::
983
984         mlxconfig -d <mst device> set SRIOV_EN=1 NUM_OF_VFS=16
985         mlxfwreset -d <mst device> reset
986
987 5. Restart the driver::
988
989         /etc/init.d/openibd restart
990
991    or::
992
993         service openibd restart
994
995    If link type was changed, firmware must be reset as well::
996
997         mlxfwreset -d <mst device> reset
998
999    For hypervisors, after reset write the sysfs number of virtual functions
1000    needed for the PF.
1001
1002    To dynamically instantiate a given number of virtual functions (VFs)::
1003
1004         echo [num_vfs] > /sys/class/infiniband/mlx5_0/device/sriov_numvfs
1005
1006 6. Compile DPDK and you are ready to go. See instructions on
1007    :ref:`Development Kit Build System <Development_Kit_Build_System>`
1008
1009 Enable switchdev mode
1010 ---------------------
1011
1012 Switchdev mode is a mode in E-Switch, that binds between representor and VF.
1013 Representor is a port in DPDK that is connected to a VF in such a way
1014 that assuming there are no offload flows, each packet that is sent from the VF
1015 will be received by the corresponding representor. While each packet that is
1016 sent to a representor will be received by the VF.
1017 This is very useful in case of SRIOV mode, where the first packet that is sent
1018 by the VF will be received by the DPDK application which will decide if this
1019 flow should be offloaded to the E-Switch. After offloading the flow packet
1020 that the VF that are matching the flow will not be received any more by
1021 the DPDK application.
1022
1023 1. Enable SRIOV mode::
1024
1025         mlxconfig -d <mst device> set SRIOV_EN=true
1026
1027 2. Configure the max number of VFs::
1028
1029         mlxconfig -d <mst device> set NUM_OF_VFS=<num of vfs>
1030
1031 3. Reset the FW::
1032
1033         mlxfwreset -d <mst device> reset
1034
1035 3. Configure the actual number of VFs::
1036
1037         echo <num of vfs > /sys/class/net/<net device>/device/sriov_numvfs
1038
1039 4. Unbind the device (can be rebind after the switchdev mode)::
1040
1041         echo -n "<device pci address" > /sys/bus/pci/drivers/mlx5_core/unbind
1042
1043 5. Enbale switchdev mode::
1044
1045         echo switchdev > /sys/class/net/<net device>/compat/devlink/mode
1046
1047 Performance tuning
1048 ------------------
1049
1050 1. Configure aggressive CQE Zipping for maximum performance::
1051
1052         mlxconfig -d <mst device> s CQE_COMPRESSION=1
1053
1054   To set it back to the default CQE Zipping mode use::
1055
1056         mlxconfig -d <mst device> s CQE_COMPRESSION=0
1057
1058 2. In case of virtualization:
1059
1060    - Make sure that hypervisor kernel is 3.16 or newer.
1061    - Configure boot with ``iommu=pt``.
1062    - Use 1G huge pages.
1063    - Make sure to allocate a VM on huge pages.
1064    - Make sure to set CPU pinning.
1065
1066 3. Use the CPU near local NUMA node to which the PCIe adapter is connected,
1067    for better performance. For VMs, verify that the right CPU
1068    and NUMA node are pinned according to the above. Run::
1069
1070         lstopo-no-graphics
1071
1072    to identify the NUMA node to which the PCIe adapter is connected.
1073
1074 4. If more than one adapter is used, and root complex capabilities allow
1075    to put both adapters on the same NUMA node without PCI bandwidth degradation,
1076    it is recommended to locate both adapters on the same NUMA node.
1077    This in order to forward packets from one to the other without
1078    NUMA performance penalty.
1079
1080 5. Disable pause frames::
1081
1082         ethtool -A <netdev> rx off tx off
1083
1084 6. Verify IO non-posted prefetch is disabled by default. This can be checked
1085    via the BIOS configuration. Please contact you server provider for more
1086    information about the settings.
1087
1088 .. note::
1089
1090         On some machines, depends on the machine integrator, it is beneficial
1091         to set the PCI max read request parameter to 1K. This can be
1092         done in the following way:
1093
1094         To query the read request size use::
1095
1096                 setpci -s <NIC PCI address> 68.w
1097
1098         If the output is different than 3XXX, set it by::
1099
1100                 setpci -s <NIC PCI address> 68.w=3XXX
1101
1102         The XXX can be different on different systems. Make sure to configure
1103         according to the setpci output.
1104
1105 7. To minimize overhead of searching Memory Regions:
1106
1107    - '--socket-mem' is recommended to pin memory by predictable amount.
1108    - Configure per-lcore cache when creating Mempools for packet buffer.
1109    - Refrain from dynamically allocating/freeing memory in run-time.
1110
1111 .. _mlx5_offloads_support:
1112
1113 Supported hardware offloads
1114 ---------------------------
1115
1116 .. table:: Minimal SW/HW versions for queue offloads
1117
1118    ============== ===== ===== ========= ===== ========== ==========
1119    Offload        DPDK  Linux rdma-core OFED   firmware   hardware
1120    ============== ===== ===== ========= ===== ========== ==========
1121    common base    17.11  4.14    16     4.2-1 12.21.1000 ConnectX-4
1122    checksums      17.11  4.14    16     4.2-1 12.21.1000 ConnectX-4
1123    Rx timestamp   17.11  4.14    16     4.2-1 12.21.1000 ConnectX-4
1124    TSO            17.11  4.14    16     4.2-1 12.21.1000 ConnectX-4
1125    LRO            19.08  N/A     N/A    4.6-4 16.25.6406 ConnectX-5
1126    ============== ===== ===== ========= ===== ========== ==========
1127
1128 .. table:: Minimal SW/HW versions for rte_flow offloads
1129
1130    +-----------------------+-----------------+-----------------+
1131    | Offload               | with E-Switch   | with NIC        |
1132    +=======================+=================+=================+
1133    | Count                 | | DPDK 19.05    | | DPDK 19.02    |
1134    |                       | | OFED 4.6      | | OFED 4.6      |
1135    |                       | | rdma-core 24  | | rdma-core 23  |
1136    |                       | | ConnectX-5    | | ConnectX-5    |
1137    +-----------------------+-----------------+-----------------+
1138    | Drop                  | | DPDK 19.05    | | DPDK 18.11    |
1139    |                       | | OFED 4.6      | | OFED 4.5      |
1140    |                       | | rdma-core 24  | | rdma-core 23  |
1141    |                       | | ConnectX-5    | | ConnectX-4    |
1142    +-----------------------+-----------------+-----------------+
1143    | Queue / RSS           | |               | | DPDK 18.11    |
1144    |                       | |     N/A       | | OFED 4.5      |
1145    |                       | |               | | rdma-core 23  |
1146    |                       | |               | | ConnectX-4    |
1147    +-----------------------+-----------------+-----------------+
1148    | Encapsulation         | | DPDK 19.05    | | DPDK 19.02    |
1149    | (VXLAN / NVGRE / RAW) | | OFED 4.7-1    | | OFED 4.6      |
1150    |                       | | rdma-core 24  | | rdma-core 23  |
1151    |                       | | ConnectX-5    | | ConnectX-5    |
1152    +-----------------------+-----------------+-----------------+
1153    | Encapsulation         | | DPDK 19.11    | | DPDK 19.11    |
1154    | GENEVE                | | OFED 4.7-3    | | OFED 4.7-3    |
1155    |                       | | rdma-core 27  | | rdma-core 27  |
1156    |                       | | ConnectX-5    | | ConnectX-5    |
1157    +-----------------------+-----------------+-----------------+
1158    | | Header rewrite      | | DPDK 19.05    | | DPDK 19.02    |
1159    | | (set_ipv4_src /     | | OFED 4.7-1    | | OFED 4.7-1    |
1160    | | set_ipv4_dst /      | | rdma-core 24  | | rdma-core 24  |
1161    | | set_ipv6_src /      | | ConnectX-5    | | ConnectX-5    |
1162    | | set_ipv6_dst /      | |               | |               |
1163    | | set_tp_src /        | |               | |               |
1164    | | set_tp_dst /        | |               | |               |
1165    | | dec_ttl /           | |               | |               |
1166    | | set_ttl /           | |               | |               |
1167    | | set_mac_src /       | |               | |               |
1168    | | set_mac_dst)        | |               | |               |
1169    +-----------------------+-----------------+-----------------+
1170    | Jump                  | | DPDK 19.05    | | DPDK 19.02    |
1171    |                       | | OFED 4.7-1    | | OFED 4.7-1    |
1172    |                       | | rdma-core 24  | | N/A           |
1173    |                       | | ConnectX-5    | | ConnectX-5    |
1174    +-----------------------+-----------------+-----------------+
1175    | Mark / Flag           | | DPDK 19.05    | | DPDK 18.11    |
1176    |                       | | OFED 4.6      | | OFED 4.5      |
1177    |                       | | rdma-core 24  | | rdma-core 23  |
1178    |                       | | ConnectX-5    | | ConnectX-4    |
1179    +-----------------------+-----------------+-----------------+
1180    | Port ID               | | DPDK 19.05    |     | N/A       |
1181    |                       | | OFED 4.7-1    |     | N/A       |
1182    |                       | | rdma-core 24  |     | N/A       |
1183    |                       | | ConnectX-5    |     | N/A       |
1184    +-----------------------+-----------------+-----------------+
1185    | | VLAN                | | DPDK 19.11    | | DPDK 19.11    |
1186    | | (of_pop_vlan /      | | OFED 4.7-1    | | OFED 4.7-1    |
1187    | | of_push_vlan /      | | ConnectX-5    | | ConnectX-5    |
1188    | | of_set_vlan_pcp /   | |               | |               |
1189    | | of_set_vlan_vid)    | |               | |               |
1190    +-----------------------+-----------------+-----------------+
1191    | Hairpin               | |               | | DPDK 19.11    |
1192    |                       | |     N/A       | | OFED 4.7-3    |
1193    |                       | |               | | rdma-core 26  |
1194    |                       | |               | | ConnectX-5    |
1195    +-----------------------+-----------------+-----------------+
1196    | Meta data             | |  DPDK 19.11   | | DPDK 19.11    |
1197    |                       | |  OFED 4.7-3   | | OFED 4.7-3    |
1198    |                       | |  rdma-core 26 | | rdma-core 26  |
1199    |                       | |  ConnectX-5   | | ConnectX-5    |
1200    +-----------------------+-----------------+-----------------+
1201    | Metering              | |  DPDK 19.11   | | DPDK 19.11    |
1202    |                       | |  OFED 4.7-3   | | OFED 4.7-3    |
1203    |                       | |  rdma-core 26 | | rdma-core 26  |
1204    |                       | |  ConnectX-5   | | ConnectX-5    |
1205    +-----------------------+-----------------+-----------------+
1206
1207 Notes for testpmd
1208 -----------------
1209
1210 Compared to librte_pmd_mlx4 that implements a single RSS configuration per
1211 port, librte_pmd_mlx5 supports per-protocol RSS configuration.
1212
1213 Since ``testpmd`` defaults to IP RSS mode and there is currently no
1214 command-line parameter to enable additional protocols (UDP and TCP as well
1215 as IP), the following commands must be entered from its CLI to get the same
1216 behavior as librte_pmd_mlx4::
1217
1218    > port stop all
1219    > port config all rss all
1220    > port start all
1221
1222 Usage example
1223 -------------
1224
1225 This section demonstrates how to launch **testpmd** with Mellanox
1226 ConnectX-4/ConnectX-5/ConnectX-6/BlueField devices managed by librte_pmd_mlx5.
1227
1228 #. Load the kernel modules::
1229
1230       modprobe -a ib_uverbs mlx5_core mlx5_ib
1231
1232    Alternatively if MLNX_OFED/MLNX_EN is fully installed, the following script
1233    can be run::
1234
1235       /etc/init.d/openibd restart
1236
1237    .. note::
1238
1239       User space I/O kernel modules (uio and igb_uio) are not used and do
1240       not have to be loaded.
1241
1242 #. Make sure Ethernet interfaces are in working order and linked to kernel
1243    verbs. Related sysfs entries should be present::
1244
1245       ls -d /sys/class/net/*/device/infiniband_verbs/uverbs* | cut -d / -f 5
1246
1247    Example output::
1248
1249       eth30
1250       eth31
1251       eth32
1252       eth33
1253
1254 #. Optionally, retrieve their PCI bus addresses for whitelisting::
1255
1256       {
1257           for intf in eth2 eth3 eth4 eth5;
1258           do
1259               (cd "/sys/class/net/${intf}/device/" && pwd -P);
1260           done;
1261       } |
1262       sed -n 's,.*/\(.*\),-w \1,p'
1263
1264    Example output::
1265
1266       -w 0000:05:00.1
1267       -w 0000:06:00.0
1268       -w 0000:06:00.1
1269       -w 0000:05:00.0
1270
1271 #. Request huge pages::
1272
1273       echo 1024 > /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages/nr_hugepages
1274
1275 #. Start testpmd with basic parameters::
1276
1277       testpmd -l 8-15 -n 4 -w 05:00.0 -w 05:00.1 -w 06:00.0 -w 06:00.1 -- --rxq=2 --txq=2 -i
1278
1279    Example output::
1280
1281       [...]
1282       EAL: PCI device 0000:05:00.0 on NUMA socket 0
1283       EAL:   probe driver: 15b3:1013 librte_pmd_mlx5
1284       PMD: librte_pmd_mlx5: PCI information matches, using device "mlx5_0" (VF: false)
1285       PMD: librte_pmd_mlx5: 1 port(s) detected
1286       PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:fe
1287       EAL: PCI device 0000:05:00.1 on NUMA socket 0
1288       EAL:   probe driver: 15b3:1013 librte_pmd_mlx5
1289       PMD: librte_pmd_mlx5: PCI information matches, using device "mlx5_1" (VF: false)
1290       PMD: librte_pmd_mlx5: 1 port(s) detected
1291       PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:ff
1292       EAL: PCI device 0000:06:00.0 on NUMA socket 0
1293       EAL:   probe driver: 15b3:1013 librte_pmd_mlx5
1294       PMD: librte_pmd_mlx5: PCI information matches, using device "mlx5_2" (VF: false)
1295       PMD: librte_pmd_mlx5: 1 port(s) detected
1296       PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:fa
1297       EAL: PCI device 0000:06:00.1 on NUMA socket 0
1298       EAL:   probe driver: 15b3:1013 librte_pmd_mlx5
1299       PMD: librte_pmd_mlx5: PCI information matches, using device "mlx5_3" (VF: false)
1300       PMD: librte_pmd_mlx5: 1 port(s) detected
1301       PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:fb
1302       Interactive-mode selected
1303       Configuring Port 0 (socket 0)
1304       PMD: librte_pmd_mlx5: 0x8cba80: TX queues number update: 0 -> 2
1305       PMD: librte_pmd_mlx5: 0x8cba80: RX queues number update: 0 -> 2
1306       Port 0: E4:1D:2D:E7:0C:FE
1307       Configuring Port 1 (socket 0)
1308       PMD: librte_pmd_mlx5: 0x8ccac8: TX queues number update: 0 -> 2
1309       PMD: librte_pmd_mlx5: 0x8ccac8: RX queues number update: 0 -> 2
1310       Port 1: E4:1D:2D:E7:0C:FF
1311       Configuring Port 2 (socket 0)
1312       PMD: librte_pmd_mlx5: 0x8cdb10: TX queues number update: 0 -> 2
1313       PMD: librte_pmd_mlx5: 0x8cdb10: RX queues number update: 0 -> 2
1314       Port 2: E4:1D:2D:E7:0C:FA
1315       Configuring Port 3 (socket 0)
1316       PMD: librte_pmd_mlx5: 0x8ceb58: TX queues number update: 0 -> 2
1317       PMD: librte_pmd_mlx5: 0x8ceb58: RX queues number update: 0 -> 2
1318       Port 3: E4:1D:2D:E7:0C:FB
1319       Checking link statuses...
1320       Port 0 Link Up - speed 40000 Mbps - full-duplex
1321       Port 1 Link Up - speed 40000 Mbps - full-duplex
1322       Port 2 Link Up - speed 10000 Mbps - full-duplex
1323       Port 3 Link Up - speed 10000 Mbps - full-duplex
1324       Done
1325       testpmd>
1326
1327 How to dump flows
1328 -----------------
1329
1330 This section demonstrates how to dump flows. Currently, it's possible to dump
1331 all flows with assistance of external tools.
1332
1333 #. 2 ways to get flow raw file:
1334
1335    - Using testpmd CLI:
1336
1337    .. code-block:: console
1338
1339        testpmd> flow dump <port> <output_file>
1340
1341    - call rte_flow_dev_dump api:
1342
1343    .. code-block:: console
1344
1345        rte_flow_dev_dump(port, file, NULL);
1346
1347 #. Dump human-readable flows from raw file:
1348
1349    Get flow parsing tool from: https://github.com/Mellanox/mlx_steering_dump
1350
1351    .. code-block:: console
1352
1353        mlx_steering_dump.py -f <output_file>