50fced3f41b2343d2de9110e255c38462768def0
[deb_dpdk.git] / doc / guides / nics / mlx5.rst
1 ..  BSD LICENSE
2     Copyright 2015 6WIND S.A.
3     Copyright 2015 Mellanox
4
5     Redistribution and use in source and binary forms, with or without
6     modification, are permitted provided that the following conditions
7     are met:
8
9     * Redistributions of source code must retain the above copyright
10     notice, this list of conditions and the following disclaimer.
11     * Redistributions in binary form must reproduce the above copyright
12     notice, this list of conditions and the following disclaimer in
13     the documentation and/or other materials provided with the
14     distribution.
15     * Neither the name of 6WIND S.A. nor the names of its
16     contributors may be used to endorse or promote products derived
17     from this software without specific prior written permission.
18
19     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20     "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21     LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22     A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23     OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25     LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26     DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27     THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29     OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30
31 MLX5 poll mode driver
32 =====================
33
34 The MLX5 poll mode driver library (**librte_pmd_mlx5**) provides support
35 for **Mellanox ConnectX-4**, **Mellanox ConnectX-4 Lx** and **Mellanox
36 ConnectX-5** families of 10/25/40/50/100 Gb/s adapters as well as their
37 virtual functions (VF) in SR-IOV context.
38
39 Information and documentation about these adapters can be found on the
40 `Mellanox website <http://www.mellanox.com>`__. Help is also provided by the
41 `Mellanox community <http://community.mellanox.com/welcome>`__.
42
43 There is also a `section dedicated to this poll mode driver
44 <http://www.mellanox.com/page/products_dyn?product_family=209&mtag=pmd_for_dpdk>`__.
45
46 .. note::
47
48    Due to external dependencies, this driver is disabled by default. It must
49    be enabled manually by setting ``CONFIG_RTE_LIBRTE_MLX5_PMD=y`` and
50    recompiling DPDK.
51
52 Implementation details
53 ----------------------
54
55 Besides its dependency on libibverbs (that implies libmlx5 and associated
56 kernel support), librte_pmd_mlx5 relies heavily on system calls for control
57 operations such as querying/updating the MTU and flow control parameters.
58
59 For security reasons and robustness, this driver only deals with virtual
60 memory addresses. The way resources allocations are handled by the kernel
61 combined with hardware specifications that allow it to handle virtual memory
62 addresses directly ensure that DPDK applications cannot access random
63 physical memory (or memory that does not belong to the current process).
64
65 This capability allows the PMD to coexist with kernel network interfaces
66 which remain functional, although they stop receiving unicast packets as
67 long as they share the same MAC address.
68 This means legacy linux control tools (for example: ethtool, ifconfig and
69 more) can operate on the same network interfaces that owned by the DPDK
70 application.
71
72 Enabling librte_pmd_mlx5 causes DPDK applications to be linked against
73 libibverbs.
74
75 Features
76 --------
77
78 - Multi arch support: x86_64, POWER8, ARMv8.
79 - Multiple TX and RX queues.
80 - Support for scattered TX and RX frames.
81 - IPv4, IPv6, TCPv4, TCPv6, UDPv4 and UDPv6 RSS on any number of queues.
82 - Several RSS hash keys, one for each flow type.
83 - Configurable RETA table.
84 - Support for multiple MAC addresses.
85 - VLAN filtering.
86 - RX VLAN stripping.
87 - TX VLAN insertion.
88 - RX CRC stripping configuration.
89 - Promiscuous mode.
90 - Multicast promiscuous mode.
91 - Hardware checksum offloads.
92 - Flow director (RTE_FDIR_MODE_PERFECT, RTE_FDIR_MODE_PERFECT_MAC_VLAN and
93   RTE_ETH_FDIR_REJECT).
94 - Flow API.
95 - Multiple process.
96 - KVM and VMware ESX SR-IOV modes are supported.
97 - RSS hash result is supported.
98 - Hardware TSO.
99 - Hardware checksum TX offload for VXLAN and GRE.
100 - RX interrupts.
101 - Statistics query including Basic, Extended and per queue.
102 - Rx HW timestamp.
103
104 Limitations
105 -----------
106
107 - Inner RSS for VXLAN frames is not supported yet.
108 - Port statistics through software counters only. Flow statistics are
109   supported by hardware counters.
110 - Hardware checksum RX offloads for VXLAN inner header are not supported yet.
111 - For secondary process:
112
113   - Forked secondary process not supported.
114   - All mempools must be initialized before rte_eth_dev_start().
115
116 - Flow pattern without any specific vlan will match for vlan packets as well:
117
118   When VLAN spec is not specified in the pattern, the matching rule will be created with VLAN as a wild card.
119   Meaning, the flow rule::
120
121         flow create 0 ingress pattern eth / vlan vid is 3 / ipv4 / end ...
122
123   Will only match vlan packets with vid=3. and the flow rules::
124
125         flow create 0 ingress pattern eth / ipv4 / end ...
126
127   Or::
128
129         flow create 0 ingress pattern eth / vlan / ipv4 / end ...
130
131   Will match any ipv4 packet (VLAN included).
132
133 - A multi segment packet must have less than 6 segments in case the Tx burst function
134   is set to multi-packet send or Enhanced multi-packet send. Otherwise it must have
135   less than 50 segments.
136 - Count action for RTE flow is only supported in Mellanox OFED 4.2.
137 - Flows with a VXLAN Network Identifier equal (or ends to be equal)
138   to 0 are not supported.
139 - VXLAN TSO and checksum offloads are not supported on VM.
140
141 Configuration
142 -------------
143
144 Compilation options
145 ~~~~~~~~~~~~~~~~~~~
146
147 These options can be modified in the ``.config`` file.
148
149 - ``CONFIG_RTE_LIBRTE_MLX5_PMD`` (default **n**)
150
151   Toggle compilation of librte_pmd_mlx5 itself.
152
153 - ``CONFIG_RTE_LIBRTE_MLX5_DEBUG`` (default **n**)
154
155   Toggle debugging code and stricter compilation flags. Enabling this option
156   adds additional run-time checks and debugging messages at the cost of
157   lower performance.
158
159 - ``CONFIG_RTE_LIBRTE_MLX5_TX_MP_CACHE`` (default **8**)
160
161   Maximum number of cached memory pools (MPs) per TX queue. Each MP from
162   which buffers are to be transmitted must be associated to memory regions
163   (MRs). This is a slow operation that must be cached.
164
165   This value is always 1 for RX queues since they use a single MP.
166
167 Environment variables
168 ~~~~~~~~~~~~~~~~~~~~~
169
170 - ``MLX5_PMD_ENABLE_PADDING``
171
172   Enables HW packet padding in PCI bus transactions.
173
174   When packet size is cache aligned and CRC stripping is enabled, 4 fewer
175   bytes are written to the PCI bus. Enabling padding makes such packets
176   aligned again.
177
178   In cases where PCI bandwidth is the bottleneck, padding can improve
179   performance by 10%.
180
181   This is disabled by default since this can also decrease performance for
182   unaligned packet sizes.
183
184 - ``MLX5_SHUT_UP_BF``
185
186   Configures HW Tx doorbell register as IO-mapped.
187
188   By default, the HW Tx doorbell is configured as a write-combining register.
189   The register would be flushed to HW usually when the write-combining buffer
190   becomes full, but it depends on CPU design.
191
192   Except for vectorized Tx burst routines, a write memory barrier is enforced
193   after updating the register so that the update can be immediately visible to
194   HW.
195
196   When vectorized Tx burst is called, the barrier is set only if the burst size
197   is not aligned to MLX5_VPMD_TX_MAX_BURST. However, setting this environmental
198   variable will bring better latency even though the maximum throughput can
199   slightly decline.
200
201 Run-time configuration
202 ~~~~~~~~~~~~~~~~~~~~~~
203
204 - librte_pmd_mlx5 brings kernel network interfaces up during initialization
205   because it is affected by their state. Forcing them down prevents packets
206   reception.
207
208 - **ethtool** operations on related kernel interfaces also affect the PMD.
209
210 - ``rxq_cqe_comp_en`` parameter [int]
211
212   A nonzero value enables the compression of CQE on RX side. This feature
213   allows to save PCI bandwidth and improve performance. Enabled by default.
214
215   Supported on:
216
217   - x86_64 with ConnectX-4, ConnectX-4 LX and ConnectX-5.
218   - POWER8 and ARMv8 with ConnectX-4 LX and ConnectX-5.
219
220 - ``txq_inline`` parameter [int]
221
222   Amount of data to be inlined during TX operations. Improves latency.
223   Can improve PPS performance when PCI back pressure is detected and may be
224   useful for scenarios involving heavy traffic on many queues.
225
226   Because additional software logic is necessary to handle this mode, this
227   option should be used with care, as it can lower performance when back
228   pressure is not expected.
229
230 - ``txqs_min_inline`` parameter [int]
231
232   Enable inline send only when the number of TX queues is greater or equal
233   to this value.
234
235   This option should be used in combination with ``txq_inline`` above.
236
237   On ConnectX-4, ConnectX-4 LX and ConnectX-5 without Enhanced MPW:
238
239         - Disabled by default.
240         - In case ``txq_inline`` is set recommendation is 4.
241
242   On ConnectX-5 with Enhanced MPW:
243
244         - Set to 8 by default.
245
246 - ``txq_mpw_en`` parameter [int]
247
248   A nonzero value enables multi-packet send (MPS) for ConnectX-4 Lx and
249   enhanced multi-packet send (Enhanced MPS) for ConnectX-5. MPS allows the
250   TX burst function to pack up multiple packets in a single descriptor
251   session in order to save PCI bandwidth and improve performance at the
252   cost of a slightly higher CPU usage. When ``txq_inline`` is set along
253   with ``txq_mpw_en``, TX burst function tries to copy entire packet data
254   on to TX descriptor instead of including pointer of packet only if there
255   is enough room remained in the descriptor. ``txq_inline`` sets
256   per-descriptor space for either pointers or inlined packets. In addition,
257   Enhanced MPS supports hybrid mode - mixing inlined packets and pointers
258   in the same descriptor.
259
260   This option cannot be used in conjunction with ``tso`` below. When ``tso``
261   is set, ``txq_mpw_en`` is disabled.
262
263   It is currently only supported on the ConnectX-4 Lx and ConnectX-5
264   families of adapters. Enabled by default.
265
266 - ``txq_mpw_hdr_dseg_en`` parameter [int]
267
268   A nonzero value enables including two pointers in the first block of TX
269   descriptor. This can be used to lessen CPU load for memory copy.
270
271   Effective only when Enhanced MPS is supported. Disabled by default.
272
273 - ``txq_max_inline_len`` parameter [int]
274
275   Maximum size of packet to be inlined. This limits the size of packet to
276   be inlined. If the size of a packet is larger than configured value, the
277   packet isn't inlined even though there's enough space remained in the
278   descriptor. Instead, the packet is included with pointer.
279
280   Effective only when Enhanced MPS is supported. The default value is 256.
281
282 - ``tso`` parameter [int]
283
284   A nonzero value enables hardware TSO.
285   When hardware TSO is enabled, packets marked with TCP segmentation
286   offload will be divided into segments by the hardware. Disabled by default.
287
288 - ``tx_vec_en`` parameter [int]
289
290   A nonzero value enables Tx vector on ConnectX-5 only NIC if the number of
291   global Tx queues on the port is lesser than MLX5_VPMD_MIN_TXQS.
292
293   Enabled by default on ConnectX-5.
294
295 - ``rx_vec_en`` parameter [int]
296
297   A nonzero value enables Rx vector if the port is not configured in
298   multi-segment otherwise this parameter is ignored.
299
300   Enabled by default.
301
302 Prerequisites
303 -------------
304
305 This driver relies on external libraries and kernel drivers for resources
306 allocations and initialization. The following dependencies are not part of
307 DPDK and must be installed separately:
308
309 - **libibverbs**
310
311   User space Verbs framework used by librte_pmd_mlx5. This library provides
312   a generic interface between the kernel and low-level user space drivers
313   such as libmlx5.
314
315   It allows slow and privileged operations (context initialization, hardware
316   resources allocations) to be managed by the kernel and fast operations to
317   never leave user space.
318
319 - **libmlx5**
320
321   Low-level user space driver library for Mellanox ConnectX-4/ConnectX-5
322   devices, it is automatically loaded by libibverbs.
323
324   This library basically implements send/receive calls to the hardware
325   queues.
326
327 - **Kernel modules**
328
329   They provide the kernel-side Verbs API and low level device drivers that
330   manage actual hardware initialization and resources sharing with user
331   space processes.
332
333   Unlike most other PMDs, these modules must remain loaded and bound to
334   their devices:
335
336   - mlx5_core: hardware driver managing Mellanox ConnectX-4/ConnectX-5
337     devices and related Ethernet kernel network devices.
338   - mlx5_ib: InifiniBand device driver.
339   - ib_uverbs: user space driver for Verbs (entry point for libibverbs).
340
341 - **Firmware update**
342
343   Mellanox OFED releases include firmware updates for ConnectX-4/ConnectX-5
344   adapters.
345
346   Because each release provides new features, these updates must be applied to
347   match the kernel modules and libraries they come with.
348
349 .. note::
350
351    Both libraries are BSD and GPL licensed. Linux kernel modules are GPL
352    licensed.
353
354 Installation
355 ~~~~~~~~~~~~
356
357 Either RDMA Core library with a recent enough Linux kernel release
358 (recommended) or Mellanox OFED, which provides compatibility with older
359 releases.
360
361 RMDA Core with Linux Kernel
362 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
363
364 - Minimal kernel version : v4.14 or the most recent 4.14-rc (see `Linux installation documentation`_)
365 - Minimal rdma-core version: v15+ commit 0c5f5765213a ("Merge pull request #227 from yishaih/tm")
366   (see `RDMA Core installation documentation`_)
367
368 .. _`Linux installation documentation`: https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux-stable.git/plain/Documentation/admin-guide/README.rst
369 .. _`RDMA Core installation documentation`: https://raw.githubusercontent.com/linux-rdma/rdma-core/master/README.md
370
371 Mellanox OFED
372 ^^^^^^^^^^^^^
373
374 - Mellanox OFED version: **4.2**.
375 - firmware version:
376
377   - ConnectX-4: **12.21.1000** and above.
378   - ConnectX-4 Lx: **14.21.1000** and above.
379   - ConnectX-5: **16.21.1000** and above.
380   - ConnectX-5 Ex: **16.21.1000** and above.
381
382 While these libraries and kernel modules are available on OpenFabrics
383 Alliance's `website <https://www.openfabrics.org/>`__ and provided by package
384 managers on most distributions, this PMD requires Ethernet extensions that
385 may not be supported at the moment (this is a work in progress).
386
387 `Mellanox OFED
388 <http://www.mellanox.com/page/products_dyn?product_family=26&mtag=linux>`__
389 includes the necessary support and should be used in the meantime. For DPDK,
390 only libibverbs, libmlx5, mlnx-ofed-kernel packages and firmware updates are
391 required from that distribution.
392
393 .. note::
394
395    Several versions of Mellanox OFED are available. Installing the version
396    this DPDK release was developed and tested against is strongly
397    recommended. Please check the `prerequisites`_.
398
399 Supported NICs
400 --------------
401
402 * Mellanox(R) ConnectX(R)-4 10G MCX4111A-XCAT (1x10G)
403 * Mellanox(R) ConnectX(R)-4 10G MCX4121A-XCAT (2x10G)
404 * Mellanox(R) ConnectX(R)-4 25G MCX4111A-ACAT (1x25G)
405 * Mellanox(R) ConnectX(R)-4 25G MCX4121A-ACAT (2x25G)
406 * Mellanox(R) ConnectX(R)-4 40G MCX4131A-BCAT (1x40G)
407 * Mellanox(R) ConnectX(R)-4 40G MCX413A-BCAT (1x40G)
408 * Mellanox(R) ConnectX(R)-4 40G MCX415A-BCAT (1x40G)
409 * Mellanox(R) ConnectX(R)-4 50G MCX4131A-GCAT (1x50G)
410 * Mellanox(R) ConnectX(R)-4 50G MCX413A-GCAT (1x50G)
411 * Mellanox(R) ConnectX(R)-4 50G MCX414A-BCAT (2x50G)
412 * Mellanox(R) ConnectX(R)-4 50G MCX415A-GCAT (2x50G)
413 * Mellanox(R) ConnectX(R)-4 50G MCX416A-BCAT (2x50G)
414 * Mellanox(R) ConnectX(R)-4 50G MCX416A-GCAT (2x50G)
415 * Mellanox(R) ConnectX(R)-4 50G MCX415A-CCAT (1x100G)
416 * Mellanox(R) ConnectX(R)-4 100G MCX416A-CCAT (2x100G)
417 * Mellanox(R) ConnectX(R)-4 Lx 10G MCX4121A-XCAT (2x10G)
418 * Mellanox(R) ConnectX(R)-4 Lx 25G MCX4121A-ACAT (2x25G)
419 * Mellanox(R) ConnectX(R)-5 100G MCX556A-ECAT (2x100G)
420 * Mellanox(R) ConnectX(R)-5 Ex EN 100G MCX516A-CDAT (2x100G)
421
422 Quick Start Guide on OFED
423 -------------------------
424
425 1. Download latest Mellanox OFED. For more info check the  `prerequisites`_.
426
427
428 2. Install the required libraries and kernel modules either by installing
429    only the required set, or by installing the entire Mellanox OFED:
430
431    .. code-block:: console
432
433         ./mlnxofedinstall --upstream-libs --dpdk
434
435 3. Verify the firmware is the correct one:
436
437    .. code-block:: console
438
439         ibv_devinfo
440
441 4. Verify all ports links are set to Ethernet:
442
443    .. code-block:: console
444
445         mlxconfig -d <mst device> query | grep LINK_TYPE
446         LINK_TYPE_P1                        ETH(2)
447         LINK_TYPE_P2                        ETH(2)
448
449    Link types may have to be configured to Ethernet:
450
451    .. code-block:: console
452
453         mlxconfig -d <mst device> set LINK_TYPE_P1/2=1/2/3
454
455         * LINK_TYPE_P1=<1|2|3> , 1=Infiniband 2=Ethernet 3=VPI(auto-sense)
456
457    For hypervisors verify SR-IOV is enabled on the NIC:
458
459    .. code-block:: console
460
461         mlxconfig -d <mst device> query | grep SRIOV_EN
462         SRIOV_EN                            True(1)
463
464    If needed, set enable the set the relevant fields:
465
466    .. code-block:: console
467
468         mlxconfig -d <mst device> set SRIOV_EN=1 NUM_OF_VFS=16
469         mlxfwreset -d <mst device> reset
470
471 5. Restart the driver:
472
473    .. code-block:: console
474
475         /etc/init.d/openibd restart
476
477    or:
478
479    .. code-block:: console
480
481         service openibd restart
482
483    If link type was changed, firmware must be reset as well:
484
485    .. code-block:: console
486
487         mlxfwreset -d <mst device> reset
488
489    For hypervisors, after reset write the sysfs number of virtual functions
490    needed for the PF.
491
492    To dynamically instantiate a given number of virtual functions (VFs):
493
494    .. code-block:: console
495
496         echo [num_vfs] > /sys/class/infiniband/mlx5_0/device/sriov_numvfs
497
498 6. Compile DPDK and you are ready to go. See instructions on
499    :ref:`Development Kit Build System <Development_Kit_Build_System>`
500
501 Performance tuning
502 ------------------
503
504 1. Configure aggressive CQE Zipping for maximum performance:
505
506   .. code-block:: console
507
508         mlxconfig -d <mst device> s CQE_COMPRESSION=1
509
510   To set it back to the default CQE Zipping mode use:
511
512   .. code-block:: console
513
514         mlxconfig -d <mst device> s CQE_COMPRESSION=0
515
516 2. In case of virtualization:
517
518    - Make sure that hypervisor kernel is 3.16 or newer.
519    - Configure boot with ``iommu=pt``.
520    - Use 1G huge pages.
521    - Make sure to allocate a VM on huge pages.
522    - Make sure to set CPU pinning.
523
524 3. Use the CPU near local NUMA node to which the PCIe adapter is connected,
525    for better performance. For VMs, verify that the right CPU
526    and NUMA node are pinned according to the above. Run:
527
528    .. code-block:: console
529
530         lstopo-no-graphics
531
532    to identify the NUMA node to which the PCIe adapter is connected.
533
534 4. If more than one adapter is used, and root complex capabilities allow
535    to put both adapters on the same NUMA node without PCI bandwidth degradation,
536    it is recommended to locate both adapters on the same NUMA node.
537    This in order to forward packets from one to the other without
538    NUMA performance penalty.
539
540 5. Disable pause frames:
541
542    .. code-block:: console
543
544         ethtool -A <netdev> rx off tx off
545
546 6. Verify IO non-posted prefetch is disabled by default. This can be checked
547    via the BIOS configuration. Please contact you server provider for more
548    information about the settings.
549
550 .. note::
551
552         On some machines, depends on the machine integrator, it is beneficial
553         to set the PCI max read request parameter to 1K. This can be
554         done in the following way:
555
556         To query the read request size use:
557
558         .. code-block:: console
559
560                 setpci -s <NIC PCI address> 68.w
561
562         If the output is different than 3XXX, set it by:
563
564         .. code-block:: console
565
566                 setpci -s <NIC PCI address> 68.w=3XXX
567
568         The XXX can be different on different systems. Make sure to configure
569         according to the setpci output.
570
571 Notes for testpmd
572 -----------------
573
574 Compared to librte_pmd_mlx4 that implements a single RSS configuration per
575 port, librte_pmd_mlx5 supports per-protocol RSS configuration.
576
577 Since ``testpmd`` defaults to IP RSS mode and there is currently no
578 command-line parameter to enable additional protocols (UDP and TCP as well
579 as IP), the following commands must be entered from its CLI to get the same
580 behavior as librte_pmd_mlx4:
581
582 .. code-block:: console
583
584    > port stop all
585    > port config all rss all
586    > port start all
587
588 Usage example
589 -------------
590
591 This section demonstrates how to launch **testpmd** with Mellanox
592 ConnectX-4/ConnectX-5 devices managed by librte_pmd_mlx5.
593
594 #. Load the kernel modules:
595
596    .. code-block:: console
597
598       modprobe -a ib_uverbs mlx5_core mlx5_ib
599
600    Alternatively if MLNX_OFED is fully installed, the following script can
601    be run:
602
603    .. code-block:: console
604
605       /etc/init.d/openibd restart
606
607    .. note::
608
609       User space I/O kernel modules (uio and igb_uio) are not used and do
610       not have to be loaded.
611
612 #. Make sure Ethernet interfaces are in working order and linked to kernel
613    verbs. Related sysfs entries should be present:
614
615    .. code-block:: console
616
617       ls -d /sys/class/net/*/device/infiniband_verbs/uverbs* | cut -d / -f 5
618
619    Example output:
620
621    .. code-block:: console
622
623       eth30
624       eth31
625       eth32
626       eth33
627
628 #. Optionally, retrieve their PCI bus addresses for whitelisting:
629
630    .. code-block:: console
631
632       {
633           for intf in eth2 eth3 eth4 eth5;
634           do
635               (cd "/sys/class/net/${intf}/device/" && pwd -P);
636           done;
637       } |
638       sed -n 's,.*/\(.*\),-w \1,p'
639
640    Example output:
641
642    .. code-block:: console
643
644       -w 0000:05:00.1
645       -w 0000:06:00.0
646       -w 0000:06:00.1
647       -w 0000:05:00.0
648
649 #. Request huge pages:
650
651    .. code-block:: console
652
653       echo 1024 > /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages/nr_hugepages
654
655 #. Start testpmd with basic parameters:
656
657    .. code-block:: console
658
659       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
660
661    Example output:
662
663    .. code-block:: console
664
665       [...]
666       EAL: PCI device 0000:05:00.0 on NUMA socket 0
667       EAL:   probe driver: 15b3:1013 librte_pmd_mlx5
668       PMD: librte_pmd_mlx5: PCI information matches, using device "mlx5_0" (VF: false)
669       PMD: librte_pmd_mlx5: 1 port(s) detected
670       PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:fe
671       EAL: PCI device 0000:05:00.1 on NUMA socket 0
672       EAL:   probe driver: 15b3:1013 librte_pmd_mlx5
673       PMD: librte_pmd_mlx5: PCI information matches, using device "mlx5_1" (VF: false)
674       PMD: librte_pmd_mlx5: 1 port(s) detected
675       PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:ff
676       EAL: PCI device 0000:06:00.0 on NUMA socket 0
677       EAL:   probe driver: 15b3:1013 librte_pmd_mlx5
678       PMD: librte_pmd_mlx5: PCI information matches, using device "mlx5_2" (VF: false)
679       PMD: librte_pmd_mlx5: 1 port(s) detected
680       PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:fa
681       EAL: PCI device 0000:06:00.1 on NUMA socket 0
682       EAL:   probe driver: 15b3:1013 librte_pmd_mlx5
683       PMD: librte_pmd_mlx5: PCI information matches, using device "mlx5_3" (VF: false)
684       PMD: librte_pmd_mlx5: 1 port(s) detected
685       PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:fb
686       Interactive-mode selected
687       Configuring Port 0 (socket 0)
688       PMD: librte_pmd_mlx5: 0x8cba80: TX queues number update: 0 -> 2
689       PMD: librte_pmd_mlx5: 0x8cba80: RX queues number update: 0 -> 2
690       Port 0: E4:1D:2D:E7:0C:FE
691       Configuring Port 1 (socket 0)
692       PMD: librte_pmd_mlx5: 0x8ccac8: TX queues number update: 0 -> 2
693       PMD: librte_pmd_mlx5: 0x8ccac8: RX queues number update: 0 -> 2
694       Port 1: E4:1D:2D:E7:0C:FF
695       Configuring Port 2 (socket 0)
696       PMD: librte_pmd_mlx5: 0x8cdb10: TX queues number update: 0 -> 2
697       PMD: librte_pmd_mlx5: 0x8cdb10: RX queues number update: 0 -> 2
698       Port 2: E4:1D:2D:E7:0C:FA
699       Configuring Port 3 (socket 0)
700       PMD: librte_pmd_mlx5: 0x8ceb58: TX queues number update: 0 -> 2
701       PMD: librte_pmd_mlx5: 0x8ceb58: RX queues number update: 0 -> 2
702       Port 3: E4:1D:2D:E7:0C:FB
703       Checking link statuses...
704       Port 0 Link Up - speed 40000 Mbps - full-duplex
705       Port 1 Link Up - speed 40000 Mbps - full-duplex
706       Port 2 Link Up - speed 10000 Mbps - full-duplex
707       Port 3 Link Up - speed 10000 Mbps - full-duplex
708       Done
709       testpmd>