1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright 2015 6WIND S.A.
3 Copyright 2015 Mellanox Technologies, Ltd
8 The MLX5 poll mode driver library (**librte_pmd_mlx5**) provides support
9 for **Mellanox ConnectX-4**, **Mellanox ConnectX-4 Lx** , **Mellanox
10 ConnectX-5**, **Mellanox ConnectX-6** and **Mellanox Bluefield** families
11 of 10/25/40/50/100/200 Gb/s adapters as well as their virtual functions (VF)
14 Information and documentation about these adapters can be found on the
15 `Mellanox website <http://www.mellanox.com>`__. Help is also provided by the
16 `Mellanox community <http://community.mellanox.com/welcome>`__.
18 There is also a `section dedicated to this poll mode driver
19 <http://www.mellanox.com/page/products_dyn?product_family=209&mtag=pmd_for_dpdk>`__.
23 Due to external dependencies, this driver is disabled by default. It must
24 be enabled manually by setting ``CONFIG_RTE_LIBRTE_MLX5_PMD=y`` and
27 Implementation details
28 ----------------------
30 Besides its dependency on libibverbs (that implies libmlx5 and associated
31 kernel support), librte_pmd_mlx5 relies heavily on system calls for control
32 operations such as querying/updating the MTU and flow control parameters.
34 For security reasons and robustness, this driver only deals with virtual
35 memory addresses. The way resources allocations are handled by the kernel
36 combined with hardware specifications that allow it to handle virtual memory
37 addresses directly ensure that DPDK applications cannot access random
38 physical memory (or memory that does not belong to the current process).
40 This capability allows the PMD to coexist with kernel network interfaces
41 which remain functional, although they stop receiving unicast packets as
42 long as they share the same MAC address.
43 This means legacy linux control tools (for example: ethtool, ifconfig and
44 more) can operate on the same network interfaces that owned by the DPDK
47 Enabling librte_pmd_mlx5 causes DPDK applications to be linked against
53 - Multi arch support: x86_64, POWER8, ARMv8, i686.
54 - Multiple TX and RX queues.
55 - Support for scattered TX and RX frames.
56 - IPv4, IPv6, TCPv4, TCPv6, UDPv4 and UDPv6 RSS on any number of queues.
57 - Several RSS hash keys, one for each flow type.
58 - Default RSS operation with no hash key specification.
59 - Configurable RETA table.
60 - Support for multiple MAC addresses.
64 - RX CRC stripping configuration.
66 - Multicast promiscuous mode.
67 - Hardware checksum offloads.
68 - Flow director (RTE_FDIR_MODE_PERFECT, RTE_FDIR_MODE_PERFECT_MAC_VLAN and
70 - Flow API, including :ref:`flow_isolated_mode`.
72 - KVM and VMware ESX SR-IOV modes are supported.
73 - RSS hash result is supported.
74 - Hardware TSO for generic IP or UDP tunnel, including VXLAN and GRE.
75 - Hardware checksum Tx offload for generic IP or UDP tunnel, including VXLAN and GRE.
77 - Statistics query including Basic, Extended and per queue.
79 - Tunnel types: VXLAN, L3 VXLAN, VXLAN-GPE, GRE, MPLSoGRE, MPLSoUDP.
80 - Tunnel HW offloads: packet type, inner/outer RSS, IP and UDP checksum verification.
85 - For secondary process:
87 - Forked secondary process not supported.
88 - External memory unregistered in EAL memseg list cannot be used for DMA
89 unless such memory has been registered by ``mlx5_mr_update_ext_mp()`` in
90 primary process and remapped to the same virtual address in secondary
91 process. If the external memory is registered by primary process but has
92 different virtual address in secondary process, unexpected error may happen.
94 - Flow pattern without any specific vlan will match for vlan packets as well:
96 When VLAN spec is not specified in the pattern, the matching rule will be created with VLAN as a wild card.
97 Meaning, the flow rule::
99 flow create 0 ingress pattern eth / vlan vid is 3 / ipv4 / end ...
101 Will only match vlan packets with vid=3. and the flow rules::
103 flow create 0 ingress pattern eth / ipv4 / end ...
107 flow create 0 ingress pattern eth / vlan / ipv4 / end ...
109 Will match any ipv4 packet (VLAN included).
111 - A multi segment packet must have less than 6 segments in case the Tx burst function
112 is set to multi-packet send or Enhanced multi-packet send. Otherwise it must have
113 less than 50 segments.
115 - Count action for RTE flow is **only supported in Mellanox OFED**.
117 - Flows with a VXLAN Network Identifier equal (or ends to be equal)
118 to 0 are not supported.
120 - VXLAN TSO and checksum offloads are not supported on VM.
122 - L3 VXLAN and VXLAN-GPE tunnels cannot be supported together with MPLSoGRE and MPLSoUDP.
124 - VF: flow rules created on VF devices can only match traffic targeted at the
125 configured MAC addresses (see ``rte_eth_dev_mac_addr_add()``).
129 MAC addresses not already present in the bridge table of the associated
130 kernel network device will be added and cleaned up by the PMD when closing
131 the device. In case of ungraceful program termination, some entries may
132 remain present and should be removed manually by other means.
134 - When Multi-Packet Rx queue is configured (``mprq_en``), a Rx packet can be
135 externally attached to a user-provided mbuf with having EXT_ATTACHED_MBUF in
136 ol_flags. As the mempool for the external buffer is managed by PMD, all the
137 Rx mbufs must be freed before the device is closed. Otherwise, the mempool of
138 the external buffers will be freed by PMD and the application which still
139 holds the external buffers may be corrupted.
141 - If Multi-Packet Rx queue is configured (``mprq_en``) and Rx CQE compression is
142 enabled (``rxq_cqe_comp_en``) at the same time, RSS hash result is not fully
143 supported. Some Rx packets may not have PKT_RX_RSS_HASH.
145 - IPv6 Multicast messages are not supported on VM, while promiscuous mode
146 and allmulticast mode are both set to off.
147 To receive IPv6 Multicast messages on VM, explicitly set the relevant
148 MAC address using rte_eth_dev_mac_addr_add() API.
150 - E-Switch VXLAN tunnel is not supported together with outer VLAN.
152 - E-Switch Flows with VNI pattern must include the VXLAN decapsulation action.
154 - E-Switch VXLAN decapsulation Flow:
156 - can be applied to PF port only.
157 - must specify VF port action (packet redirection from PF to VF).
158 - must specify tunnel outer UDP local (destination) port, wildcards not allowed.
159 - must specify tunnel outer VNI, wildcards not allowed.
160 - must specify tunnel outer local (destination) IPv4 or IPv6 address, wildcards not allowed.
161 - optionally may specify tunnel outer remote (source) IPv4 or IPv6, wildcards or group IPs allowed.
162 - optionally may specify tunnel inner source and destination MAC addresses.
164 - E-Switch VXLAN encapsulation Flow:
166 - can be applied to VF ports only.
167 - must specify PF port action (packet redirection from VF to PF).
168 - must specify the VXLAN item with tunnel outer parameters.
169 - must specify the tunnel outer VNI in the VXLAN item.
170 - must specify the tunnel outer remote (destination) UDP port in the VXLAN item.
171 - must specify the tunnel outer local (source) IPv4 or IPv6 in the , this address will locally (with scope link) assigned to the outer network interace, wildcards not allowed.
172 - must specify the tunnel outer remote (destination) IPv4 or IPv6 in the VXLAN item, group IPs allowed.
173 - must specify the tunnel outer destination MAC address in the VXLAN item, this address will be used to create neigh rule.
178 MLX5 supports various of methods to report statistics:
180 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.
182 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.
184 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.
192 These options can be modified in the ``.config`` file.
194 - ``CONFIG_RTE_LIBRTE_MLX5_PMD`` (default **n**)
196 Toggle compilation of librte_pmd_mlx5 itself.
198 - ``CONFIG_RTE_IBVERBS_LINK_DLOPEN`` (default **n**)
200 Build PMD with additional code to make it loadable without hard
201 dependencies on **libibverbs** nor **libmlx5**, which may not be installed
202 on the target system.
204 In this mode, their presence is still required for it to run properly,
205 however their absence won't prevent a DPDK application from starting (with
206 ``CONFIG_RTE_BUILD_SHARED_LIB`` disabled) and they won't show up as
207 missing with ``ldd(1)``.
209 It works by moving these dependencies to a purpose-built rdma-core "glue"
210 plug-in which must either be installed in a directory whose name is based
211 on ``CONFIG_RTE_EAL_PMD_PATH`` suffixed with ``-glue`` if set, or in a
212 standard location for the dynamic linker (e.g. ``/lib``) if left to the
213 default empty string (``""``).
215 This option has no performance impact.
217 - ``CONFIG_RTE_IBVERBS_LINK_STATIC`` (default **n**)
219 Embed static flavour of the dependencies **libibverbs** and **libmlx5**
220 in the PMD shared library or the executable static binary.
222 - ``CONFIG_RTE_LIBRTE_MLX5_DEBUG`` (default **n**)
224 Toggle debugging code and stricter compilation flags. Enabling this option
225 adds additional run-time checks and debugging messages at the cost of
230 For Bluefield, target should be set to ``arm64-bluefield-linux-gcc``. This
231 will enable ``CONFIG_RTE_LIBRTE_MLX5_PMD`` and set ``RTE_CACHE_LINE_SIZE`` to
232 64. Default armv8a configuration of make build and meson build set it to 128
233 then brings performance degradation.
235 Environment variables
236 ~~~~~~~~~~~~~~~~~~~~~
240 A list of directories in which to search for the rdma-core "glue" plug-in,
241 separated by colons or semi-colons.
243 Only matters when compiled with ``CONFIG_RTE_IBVERBS_LINK_DLOPEN``
244 enabled and most useful when ``CONFIG_RTE_EAL_PMD_PATH`` is also set,
245 since ``LD_LIBRARY_PATH`` has no effect in this case.
247 - ``MLX5_SHUT_UP_BF``
249 Configures HW Tx doorbell register as IO-mapped.
251 By default, the HW Tx doorbell is configured as a write-combining register.
252 The register would be flushed to HW usually when the write-combining buffer
253 becomes full, but it depends on CPU design.
255 Except for vectorized Tx burst routines, a write memory barrier is enforced
256 after updating the register so that the update can be immediately visible to
259 When vectorized Tx burst is called, the barrier is set only if the burst size
260 is not aligned to MLX5_VPMD_TX_MAX_BURST. However, setting this environmental
261 variable will bring better latency even though the maximum throughput can
264 Run-time configuration
265 ~~~~~~~~~~~~~~~~~~~~~~
267 - librte_pmd_mlx5 brings kernel network interfaces up during initialization
268 because it is affected by their state. Forcing them down prevents packets
271 - **ethtool** operations on related kernel interfaces also affect the PMD.
273 - ``rxq_cqe_comp_en`` parameter [int]
275 A nonzero value enables the compression of CQE on RX side. This feature
276 allows to save PCI bandwidth and improve performance. Enabled by default.
280 - x86_64 with ConnectX-4, ConnectX-4 LX, ConnectX-5, ConnectX-6 and Bluefield.
281 - POWER8 and ARMv8 with ConnectX-4 LX, ConnectX-5, ConnectX-6 and Bluefield.
283 - ``rxq_cqe_pad_en`` parameter [int]
285 A nonzero value enables 128B padding of CQE on RX side. The size of CQE
286 is aligned with the size of a cacheline of the core. If cacheline size is
287 128B, the CQE size is configured to be 128B even though the device writes
288 only 64B data on the cacheline. This is to avoid unnecessary cache
289 invalidation by device's two consecutive writes on to one cacheline.
290 However in some architecture, it is more beneficial to update entire
291 cacheline with padding the rest 64B rather than striding because
292 read-modify-write could drop performance a lot. On the other hand,
293 writing extra data will consume more PCIe bandwidth and could also drop
294 the maximum throughput. It is recommended to empirically set this
295 parameter. Disabled by default.
299 - CPU having 128B cacheline with ConnectX-5 and Bluefield.
301 - ``rxq_pkt_pad_en`` parameter [int]
303 A nonzero value enables padding Rx packet to the size of cacheline on PCI
304 transaction. This feature would waste PCI bandwidth but could improve
305 performance by avoiding partial cacheline write which may cause costly
306 read-modify-copy in memory transaction on some architectures. Disabled by
311 - x86_64 with ConnectX-4, ConnectX-4 LX, ConnectX-5, ConnectX-6 and Bluefield.
312 - POWER8 and ARMv8 with ConnectX-4 LX, ConnectX-5, ConnectX-6 and Bluefield.
314 - ``mprq_en`` parameter [int]
316 A nonzero value enables configuring Multi-Packet Rx queues. Rx queue is
317 configured as Multi-Packet RQ if the total number of Rx queues is
318 ``rxqs_min_mprq`` or more and Rx scatter isn't configured. Disabled by
321 Multi-Packet Rx Queue (MPRQ a.k.a Striding RQ) can further save PCIe bandwidth
322 by posting a single large buffer for multiple packets. Instead of posting a
323 buffers per a packet, one large buffer is posted in order to receive multiple
324 packets on the buffer. A MPRQ buffer consists of multiple fixed-size strides
325 and each stride receives one packet. MPRQ can improve throughput for
326 small-packet traffic.
328 When MPRQ is enabled, max_rx_pkt_len can be larger than the size of
329 user-provided mbuf even if DEV_RX_OFFLOAD_SCATTER isn't enabled. PMD will
330 configure large stride size enough to accommodate max_rx_pkt_len as long as
331 device allows. Note that this can waste system memory compared to enabling Rx
332 scatter and multi-segment packet.
334 - ``mprq_log_stride_num`` parameter [int]
336 Log 2 of the number of strides for Multi-Packet Rx queue. Configuring more
337 strides can reduce PCIe traffic further. If configured value is not in the
338 range of device capability, the default value will be set with a warning
339 message. The default value is 4 which is 16 strides per a buffer, valid only
340 if ``mprq_en`` is set.
342 The size of Rx queue should be bigger than the number of strides.
344 - ``mprq_max_memcpy_len`` parameter [int]
346 The maximum length of packet to memcpy in case of Multi-Packet Rx queue. Rx
347 packet is mem-copied to a user-provided mbuf if the size of Rx packet is less
348 than or equal to this parameter. Otherwise, PMD will attach the Rx packet to
349 the mbuf by external buffer attachment - ``rte_pktmbuf_attach_extbuf()``.
350 A mempool for external buffers will be allocated and managed by PMD. If Rx
351 packet is externally attached, ol_flags field of the mbuf will have
352 EXT_ATTACHED_MBUF and this flag must be preserved. ``RTE_MBUF_HAS_EXTBUF()``
353 checks the flag. The default value is 128, valid only if ``mprq_en`` is set.
355 - ``rxqs_min_mprq`` parameter [int]
357 Configure Rx queues as Multi-Packet RQ if the total number of Rx queues is
358 greater or equal to this value. The default value is 12, valid only if
361 - ``txq_inline`` parameter [int]
363 Amount of data to be inlined during TX operations. Improves latency.
364 Can improve PPS performance when PCI back pressure is detected and may be
365 useful for scenarios involving heavy traffic on many queues.
367 Because additional software logic is necessary to handle this mode, this
368 option should be used with care, as it can lower performance when back
369 pressure is not expected.
371 - ``txqs_min_inline`` parameter [int]
373 Enable inline send only when the number of TX queues is greater or equal
376 This option should be used in combination with ``txq_inline`` above.
378 On ConnectX-4, ConnectX-4 LX, ConnectX-5, ConnectX-6 and Bluefield without
381 - Disabled by default.
382 - In case ``txq_inline`` is set recommendation is 4.
384 On ConnectX-5, ConnectX-6 and Bluefield with Enhanced MPW:
386 - Set to 8 by default.
388 - ``txqs_max_vec`` parameter [int]
390 Enable vectorized Tx only when the number of TX queues is less than or
391 equal to this value. Effective only when ``tx_vec_en`` is enabled.
395 - Set to 8 by default on ARMv8.
396 - Set to 4 by default otherwise.
400 - Set to 16 by default.
402 - ``txq_mpw_en`` parameter [int]
404 A nonzero value enables multi-packet send (MPS) for ConnectX-4 Lx and
405 enhanced multi-packet send (Enhanced MPS) for ConnectX-5, ConnectX-6 and Bluefield.
406 MPS allows the TX burst function to pack up multiple packets in a
407 single descriptor session in order to save PCI bandwidth and improve
408 performance at the cost of a slightly higher CPU usage. When
409 ``txq_inline`` is set along with ``txq_mpw_en``, TX burst function tries
410 to copy entire packet data on to TX descriptor instead of including
411 pointer of packet only if there is enough room remained in the
412 descriptor. ``txq_inline`` sets per-descriptor space for either pointers
413 or inlined packets. In addition, Enhanced MPS supports hybrid mode -
414 mixing inlined packets and pointers in the same descriptor.
416 This option cannot be used with certain offloads such as ``DEV_TX_OFFLOAD_TCP_TSO,
417 DEV_TX_OFFLOAD_VXLAN_TNL_TSO, DEV_TX_OFFLOAD_GRE_TNL_TSO, DEV_TX_OFFLOAD_VLAN_INSERT``.
418 When those offloads are requested the MPS send function will not be used.
420 It is currently only supported on the ConnectX-4 Lx, ConnectX-5, ConnectX-6 and Bluefield
421 families of adapters.
422 On ConnectX-4 Lx the MPW is considered un-secure hence disabled by default.
423 Users which enable the MPW should be aware that application which provides incorrect
424 mbuf descriptors in the Tx burst can lead to serious errors in the host including, on some cases,
426 On ConnectX-5, ConnectX-6 and Bluefield the MPW is secure and enabled by default.
428 - ``txq_mpw_hdr_dseg_en`` parameter [int]
430 A nonzero value enables including two pointers in the first block of TX
431 descriptor. This can be used to lessen CPU load for memory copy.
433 Effective only when Enhanced MPS is supported. Disabled by default.
435 - ``txq_max_inline_len`` parameter [int]
437 Maximum size of packet to be inlined. This limits the size of packet to
438 be inlined. If the size of a packet is larger than configured value, the
439 packet isn't inlined even though there's enough space remained in the
440 descriptor. Instead, the packet is included with pointer.
442 Effective only when Enhanced MPS is supported. The default value is 256.
444 - ``tx_vec_en`` parameter [int]
446 A nonzero value enables Tx vector on ConnectX-5, ConnectX-6 and Bluefield NICs if the number of
447 global Tx queues on the port is less than ``txqs_max_vec``.
449 This option cannot be used with certain offloads such as ``DEV_TX_OFFLOAD_TCP_TSO,
450 DEV_TX_OFFLOAD_VXLAN_TNL_TSO, DEV_TX_OFFLOAD_GRE_TNL_TSO, DEV_TX_OFFLOAD_VLAN_INSERT``.
451 When those offloads are requested the MPS send function will not be used.
453 Enabled by default on ConnectX-5, ConnectX-6 and Bluefield.
455 - ``rx_vec_en`` parameter [int]
457 A nonzero value enables Rx vector if the port is not configured in
458 multi-segment otherwise this parameter is ignored.
462 - ``vf_nl_en`` parameter [int]
464 A nonzero value enables Netlink requests from the VF to add/remove MAC
465 addresses or/and enable/disable promiscuous/all multicast on the Netdevice.
466 Otherwise the relevant configuration must be run with Linux iproute2 tools.
467 This is a prerequisite to receive this kind of traffic.
469 Enabled by default, valid only on VF devices ignored otherwise.
471 - ``l3_vxlan_en`` parameter [int]
473 A nonzero value allows L3 VXLAN and VXLAN-GPE flow creation. To enable
474 L3 VXLAN or VXLAN-GPE, users has to configure firmware and enable this
475 parameter. This is a prerequisite to receive this kind of traffic.
479 - ``dv_flow_en`` parameter [int]
481 A nonzero value enables the DV flow steering assuming it is supported
483 The DV flow steering is not supported on switchdev mode.
487 - ``mr_ext_memseg_en`` parameter [int]
489 A nonzero value enables extending memseg when registering DMA memory. If
490 enabled, the number of entries in MR (Memory Region) lookup table on datapath
491 is minimized and it benefits performance. On the other hand, it worsens memory
492 utilization because registered memory is pinned by kernel driver. Even if a
493 page in the extended chunk is freed, that doesn't become reusable until the
494 entire memory is freed.
498 - ``representor`` parameter [list]
500 This parameter can be used to instantiate DPDK Ethernet devices from
501 existing port (or VF) representors configured on the device.
503 It is a standard parameter whose format is described in
504 :ref:`ethernet_device_standard_device_arguments`.
506 For instance, to probe port representors 0 through 2::
510 Firmware configuration
511 ~~~~~~~~~~~~~~~~~~~~~~
513 - L3 VXLAN and VXLAN-GPE destination UDP port
515 .. code-block:: console
517 mlxconfig -d <mst device> set IP_OVER_VXLAN_EN=1
518 mlxconfig -d <mst device> set IP_OVER_VXLAN_PORT=<udp dport>
520 Verify configurations are set:
522 .. code-block:: console
524 mlxconfig -d <mst device> query | grep IP_OVER_VXLAN
525 IP_OVER_VXLAN_EN True(1)
526 IP_OVER_VXLAN_PORT <udp dport>
531 This driver relies on external libraries and kernel drivers for resources
532 allocations and initialization. The following dependencies are not part of
533 DPDK and must be installed separately:
537 User space Verbs framework used by librte_pmd_mlx5. This library provides
538 a generic interface between the kernel and low-level user space drivers
541 It allows slow and privileged operations (context initialization, hardware
542 resources allocations) to be managed by the kernel and fast operations to
543 never leave user space.
547 Low-level user space driver library for Mellanox
548 ConnectX-4/ConnectX-5/ConnectX-6/Bluefield devices, it is automatically loaded
551 This library basically implements send/receive calls to the hardware
556 Minimalistic Netlink library mainly relied on to manage E-Switch flow
557 rules (i.e. those with the "transfer" attribute and typically involving
562 They provide the kernel-side Verbs API and low level device drivers that
563 manage actual hardware initialization and resources sharing with user
566 Unlike most other PMDs, these modules must remain loaded and bound to
569 - mlx5_core: hardware driver managing Mellanox
570 ConnectX-4/ConnectX-5/ConnectX-6/Bluefield devices and related Ethernet kernel
572 - mlx5_ib: InifiniBand device driver.
573 - ib_uverbs: user space driver for Verbs (entry point for libibverbs).
575 - **Firmware update**
577 Mellanox OFED/EN releases include firmware updates for
578 ConnectX-4/ConnectX-5/ConnectX-6/Bluefield adapters.
580 Because each release provides new features, these updates must be applied to
581 match the kernel modules and libraries they come with.
585 Both libraries are BSD and GPL licensed. Linux kernel modules are GPL
591 Either RDMA Core library with a recent enough Linux kernel release
592 (recommended) or Mellanox OFED/EN, which provides compatibility with older
595 RMDA Core with Linux Kernel
596 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
598 - Minimal kernel version : v4.14 or the most recent 4.14-rc (see `Linux installation documentation`_)
599 - Minimal rdma-core version: v15+ commit 0c5f5765213a ("Merge pull request #227 from yishaih/tm")
600 (see `RDMA Core installation documentation`_)
601 - When building for i686 use:
603 - rdma-core version 18.0 or above built with 32bit support.
604 - Kernel version 4.14.41 or above.
606 - Starting with rdma-core v21, static libraries can be built::
609 CFLAGS=-fPIC cmake -DIN_PLACE=1 -DENABLE_STATIC=1 -GNinja ..
612 .. _`Linux installation documentation`: https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux-stable.git/plain/Documentation/admin-guide/README.rst
613 .. _`RDMA Core installation documentation`: https://raw.githubusercontent.com/linux-rdma/rdma-core/master/README.md
615 If rdma-core libraries are built but not installed, DPDK makefile can link them,
616 thanks to these environment variables:
618 - ``EXTRA_CFLAGS=-I/path/to/rdma-core/build/include``
619 - ``EXTRA_LDFLAGS=-L/path/to/rdma-core/build/lib``
620 - ``PKG_CONFIG_PATH=/path/to/rdma-core/build/lib/pkgconfig``
625 - Mellanox OFED version: **4.4, 4.5** / Mellanox EN version: **4.5**
628 - ConnectX-4: **12.21.1000** and above.
629 - ConnectX-4 Lx: **14.21.1000** and above.
630 - ConnectX-5: **16.21.1000** and above.
631 - ConnectX-5 Ex: **16.21.1000** and above.
632 - ConnectX-6: **20.99.5374** and above.
633 - Bluefield: **18.99.3950** and above.
635 While these libraries and kernel modules are available on OpenFabrics
636 Alliance's `website <https://www.openfabrics.org/>`__ and provided by package
637 managers on most distributions, this PMD requires Ethernet extensions that
638 may not be supported at the moment (this is a work in progress).
641 <http://www.mellanox.com/page/products_dyn?product_family=26&mtag=linux>`__ and
643 <http://www.mellanox.com/page/products_dyn?product_family=27&mtag=linux>`__
644 include the necessary support and should be used in the meantime. For DPDK,
645 only libibverbs, libmlx5, mlnx-ofed-kernel packages and firmware updates are
646 required from that distribution.
650 Several versions of Mellanox OFED/EN are available. Installing the version
651 this DPDK release was developed and tested against is strongly
652 recommended. Please check the `prerequisites`_.
657 Minimal version for libmnl is **1.0.3**.
659 As a dependency of the **iproute2** suite, this library is often installed
660 by default. It is otherwise readily available through standard system
663 Its development headers must be installed in order to compile this PMD.
664 These packages are usually named **libmnl-dev** or **libmnl-devel**
665 depending on the Linux distribution.
670 * Mellanox(R) ConnectX(R)-4 10G MCX4111A-XCAT (1x10G)
671 * Mellanox(R) ConnectX(R)-4 10G MCX4121A-XCAT (2x10G)
672 * Mellanox(R) ConnectX(R)-4 25G MCX4111A-ACAT (1x25G)
673 * Mellanox(R) ConnectX(R)-4 25G MCX4121A-ACAT (2x25G)
674 * Mellanox(R) ConnectX(R)-4 40G MCX4131A-BCAT (1x40G)
675 * Mellanox(R) ConnectX(R)-4 40G MCX413A-BCAT (1x40G)
676 * Mellanox(R) ConnectX(R)-4 40G MCX415A-BCAT (1x40G)
677 * Mellanox(R) ConnectX(R)-4 50G MCX4131A-GCAT (1x50G)
678 * Mellanox(R) ConnectX(R)-4 50G MCX413A-GCAT (1x50G)
679 * Mellanox(R) ConnectX(R)-4 50G MCX414A-BCAT (2x50G)
680 * Mellanox(R) ConnectX(R)-4 50G MCX415A-GCAT (2x50G)
681 * Mellanox(R) ConnectX(R)-4 50G MCX416A-BCAT (2x50G)
682 * Mellanox(R) ConnectX(R)-4 50G MCX416A-GCAT (2x50G)
683 * Mellanox(R) ConnectX(R)-4 50G MCX415A-CCAT (1x100G)
684 * Mellanox(R) ConnectX(R)-4 100G MCX416A-CCAT (2x100G)
685 * Mellanox(R) ConnectX(R)-4 Lx 10G MCX4121A-XCAT (2x10G)
686 * Mellanox(R) ConnectX(R)-4 Lx 25G MCX4121A-ACAT (2x25G)
687 * Mellanox(R) ConnectX(R)-5 100G MCX556A-ECAT (2x100G)
688 * Mellanox(R) ConnectX(R)-5 Ex EN 100G MCX516A-CDAT (2x100G)
690 Quick Start Guide on OFED/EN
691 ----------------------------
693 1. Download latest Mellanox OFED/EN. For more info check the `prerequisites`_.
696 2. Install the required libraries and kernel modules either by installing
697 only the required set, or by installing the entire Mellanox OFED/EN:
699 .. code-block:: console
701 ./mlnxofedinstall --upstream-libs --dpdk
703 3. Verify the firmware is the correct one:
705 .. code-block:: console
709 4. Verify all ports links are set to Ethernet:
711 .. code-block:: console
713 mlxconfig -d <mst device> query | grep LINK_TYPE
717 Link types may have to be configured to Ethernet:
719 .. code-block:: console
721 mlxconfig -d <mst device> set LINK_TYPE_P1/2=1/2/3
723 * LINK_TYPE_P1=<1|2|3> , 1=Infiniband 2=Ethernet 3=VPI(auto-sense)
725 For hypervisors verify SR-IOV is enabled on the NIC:
727 .. code-block:: console
729 mlxconfig -d <mst device> query | grep SRIOV_EN
732 If needed, set enable the set the relevant fields:
734 .. code-block:: console
736 mlxconfig -d <mst device> set SRIOV_EN=1 NUM_OF_VFS=16
737 mlxfwreset -d <mst device> reset
739 5. Restart the driver:
741 .. code-block:: console
743 /etc/init.d/openibd restart
747 .. code-block:: console
749 service openibd restart
751 If link type was changed, firmware must be reset as well:
753 .. code-block:: console
755 mlxfwreset -d <mst device> reset
757 For hypervisors, after reset write the sysfs number of virtual functions
760 To dynamically instantiate a given number of virtual functions (VFs):
762 .. code-block:: console
764 echo [num_vfs] > /sys/class/infiniband/mlx5_0/device/sriov_numvfs
766 6. Compile DPDK and you are ready to go. See instructions on
767 :ref:`Development Kit Build System <Development_Kit_Build_System>`
772 1. Configure aggressive CQE Zipping for maximum performance:
774 .. code-block:: console
776 mlxconfig -d <mst device> s CQE_COMPRESSION=1
778 To set it back to the default CQE Zipping mode use:
780 .. code-block:: console
782 mlxconfig -d <mst device> s CQE_COMPRESSION=0
784 2. In case of virtualization:
786 - Make sure that hypervisor kernel is 3.16 or newer.
787 - Configure boot with ``iommu=pt``.
789 - Make sure to allocate a VM on huge pages.
790 - Make sure to set CPU pinning.
792 3. Use the CPU near local NUMA node to which the PCIe adapter is connected,
793 for better performance. For VMs, verify that the right CPU
794 and NUMA node are pinned according to the above. Run:
796 .. code-block:: console
800 to identify the NUMA node to which the PCIe adapter is connected.
802 4. If more than one adapter is used, and root complex capabilities allow
803 to put both adapters on the same NUMA node without PCI bandwidth degradation,
804 it is recommended to locate both adapters on the same NUMA node.
805 This in order to forward packets from one to the other without
806 NUMA performance penalty.
808 5. Disable pause frames:
810 .. code-block:: console
812 ethtool -A <netdev> rx off tx off
814 6. Verify IO non-posted prefetch is disabled by default. This can be checked
815 via the BIOS configuration. Please contact you server provider for more
816 information about the settings.
820 On some machines, depends on the machine integrator, it is beneficial
821 to set the PCI max read request parameter to 1K. This can be
822 done in the following way:
824 To query the read request size use:
826 .. code-block:: console
828 setpci -s <NIC PCI address> 68.w
830 If the output is different than 3XXX, set it by:
832 .. code-block:: console
834 setpci -s <NIC PCI address> 68.w=3XXX
836 The XXX can be different on different systems. Make sure to configure
837 according to the setpci output.
839 7. To minimize overhead of searching Memory Regions:
841 - '--socket-mem' is recommended to pin memory by predictable amount.
842 - Configure per-lcore cache when creating Mempools for packet buffer.
843 - Refrain from dynamically allocating/freeing memory in run-time.
848 Compared to librte_pmd_mlx4 that implements a single RSS configuration per
849 port, librte_pmd_mlx5 supports per-protocol RSS configuration.
851 Since ``testpmd`` defaults to IP RSS mode and there is currently no
852 command-line parameter to enable additional protocols (UDP and TCP as well
853 as IP), the following commands must be entered from its CLI to get the same
854 behavior as librte_pmd_mlx4:
856 .. code-block:: console
859 > port config all rss all
865 This section demonstrates how to launch **testpmd** with Mellanox
866 ConnectX-4/ConnectX-5/ConnectX-6/Bluefield devices managed by librte_pmd_mlx5.
868 #. Load the kernel modules:
870 .. code-block:: console
872 modprobe -a ib_uverbs mlx5_core mlx5_ib
874 Alternatively if MLNX_OFED/MLNX_EN is fully installed, the following script
877 .. code-block:: console
879 /etc/init.d/openibd restart
883 User space I/O kernel modules (uio and igb_uio) are not used and do
884 not have to be loaded.
886 #. Make sure Ethernet interfaces are in working order and linked to kernel
887 verbs. Related sysfs entries should be present:
889 .. code-block:: console
891 ls -d /sys/class/net/*/device/infiniband_verbs/uverbs* | cut -d / -f 5
895 .. code-block:: console
902 #. Optionally, retrieve their PCI bus addresses for whitelisting:
904 .. code-block:: console
907 for intf in eth2 eth3 eth4 eth5;
909 (cd "/sys/class/net/${intf}/device/" && pwd -P);
912 sed -n 's,.*/\(.*\),-w \1,p'
916 .. code-block:: console
923 #. Request huge pages:
925 .. code-block:: console
927 echo 1024 > /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages/nr_hugepages
929 #. Start testpmd with basic parameters:
931 .. code-block:: console
933 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
937 .. code-block:: console
940 EAL: PCI device 0000:05:00.0 on NUMA socket 0
941 EAL: probe driver: 15b3:1013 librte_pmd_mlx5
942 PMD: librte_pmd_mlx5: PCI information matches, using device "mlx5_0" (VF: false)
943 PMD: librte_pmd_mlx5: 1 port(s) detected
944 PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:fe
945 EAL: PCI device 0000:05:00.1 on NUMA socket 0
946 EAL: probe driver: 15b3:1013 librte_pmd_mlx5
947 PMD: librte_pmd_mlx5: PCI information matches, using device "mlx5_1" (VF: false)
948 PMD: librte_pmd_mlx5: 1 port(s) detected
949 PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:ff
950 EAL: PCI device 0000:06:00.0 on NUMA socket 0
951 EAL: probe driver: 15b3:1013 librte_pmd_mlx5
952 PMD: librte_pmd_mlx5: PCI information matches, using device "mlx5_2" (VF: false)
953 PMD: librte_pmd_mlx5: 1 port(s) detected
954 PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:fa
955 EAL: PCI device 0000:06:00.1 on NUMA socket 0
956 EAL: probe driver: 15b3:1013 librte_pmd_mlx5
957 PMD: librte_pmd_mlx5: PCI information matches, using device "mlx5_3" (VF: false)
958 PMD: librte_pmd_mlx5: 1 port(s) detected
959 PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:fb
960 Interactive-mode selected
961 Configuring Port 0 (socket 0)
962 PMD: librte_pmd_mlx5: 0x8cba80: TX queues number update: 0 -> 2
963 PMD: librte_pmd_mlx5: 0x8cba80: RX queues number update: 0 -> 2
964 Port 0: E4:1D:2D:E7:0C:FE
965 Configuring Port 1 (socket 0)
966 PMD: librte_pmd_mlx5: 0x8ccac8: TX queues number update: 0 -> 2
967 PMD: librte_pmd_mlx5: 0x8ccac8: RX queues number update: 0 -> 2
968 Port 1: E4:1D:2D:E7:0C:FF
969 Configuring Port 2 (socket 0)
970 PMD: librte_pmd_mlx5: 0x8cdb10: TX queues number update: 0 -> 2
971 PMD: librte_pmd_mlx5: 0x8cdb10: RX queues number update: 0 -> 2
972 Port 2: E4:1D:2D:E7:0C:FA
973 Configuring Port 3 (socket 0)
974 PMD: librte_pmd_mlx5: 0x8ceb58: TX queues number update: 0 -> 2
975 PMD: librte_pmd_mlx5: 0x8ceb58: RX queues number update: 0 -> 2
976 Port 3: E4:1D:2D:E7:0C:FB
977 Checking link statuses...
978 Port 0 Link Up - speed 40000 Mbps - full-duplex
979 Port 1 Link Up - speed 40000 Mbps - full-duplex
980 Port 2 Link Up - speed 10000 Mbps - full-duplex
981 Port 3 Link Up - speed 10000 Mbps - full-duplex