doc/guides/nics/mlx5.rst

   1 ..  BSD LICENSE
   2     Copyright 2015 6WIND S.A.
   3
   4     Redistribution and use in source and binary forms, with or without
   5     modification, are permitted provided that the following conditions
   6     are met:
   7
   8     * Redistributions of source code must retain the above copyright
   9     notice, this list of conditions and the following disclaimer.
  10     * Redistributions in binary form must reproduce the above copyright
  11     notice, this list of conditions and the following disclaimer in
  12     the documentation and/or other materials provided with the
  13     distribution.
  14     * Neither the name of 6WIND S.A. nor the names of its
  15     contributors may be used to endorse or promote products derived
  16     from this software without specific prior written permission.
  17
  18     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19     "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20     LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21     A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22     OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24     LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25     DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26     THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28     OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29
  30 MLX5 poll mode driver
  31 =====================
  32
  33 The MLX5 poll mode driver library (**librte_pmd_mlx5**) provides support for
  34 **Mellanox ConnectX-4** and **Mellanox ConnectX-4 Lx** families of
  35 10/25/40/50/100 Gb/s adapters as well as their virtual functions (VF) in
  36 SR-IOV context.
  37
  38 Information and documentation about these adapters can be found on the
  39 `Mellanox website <http://www.mellanox.com>`__. Help is also provided by the
  40 `Mellanox community <http://community.mellanox.com/welcome>`__.
  41
  42 There is also a `section dedicated to this poll mode driver
  43 <http://www.mellanox.com/page/products_dyn?product_family=209&mtag=pmd_for_dpdk>`__.
  44
  45 .. note::
  46
  47    Due to external dependencies, this driver is disabled by default. It must
  48    be enabled manually by setting ``CONFIG_RTE_LIBRTE_MLX5_PMD=y`` and
  49    recompiling DPDK.
  50
  51 Implementation details
  52 ----------------------
  53
  54 Besides its dependency on libibverbs (that implies libmlx5 and associated
  55 kernel support), librte_pmd_mlx5 relies heavily on system calls for control
  56 operations such as querying/updating the MTU and flow control parameters.
  57
  58 For security reasons and robustness, this driver only deals with virtual
  59 memory addresses. The way resources allocations are handled by the kernel
  60 combined with hardware specifications that allow it to handle virtual memory
  61 addresses directly ensure that DPDK applications cannot access random
  62 physical memory (or memory that does not belong to the current process).
  63
  64 This capability allows the PMD to coexist with kernel network interfaces
  65 which remain functional, although they stop receiving unicast packets as
  66 long as they share the same MAC address.
  67
  68 Enabling librte_pmd_mlx5 causes DPDK applications to be linked against
  69 libibverbs.
  70
  71 Features
  72 --------
  73
  74 - Multiple TX and RX queues.
  75 - Support for scattered TX and RX frames.
  76 - IPv4, IPv6, TCPv4, TCPv6, UDPv4 and UDPv6 RSS on any number of queues.
  77 - Several RSS hash keys, one for each flow type.
  78 - Configurable RETA table.
  79 - Support for multiple MAC addresses.
  80 - VLAN filtering.
  81 - RX VLAN stripping.
  82 - TX VLAN insertion.
  83 - RX CRC stripping configuration.
  84 - Promiscuous mode.
  85 - Multicast promiscuous mode.
  86 - Hardware checksum offloads.
  87 - Flow director (RTE_FDIR_MODE_PERFECT and RTE_FDIR_MODE_PERFECT_MAC_VLAN).
  88 - Secondary process TX is supported.
  89 - KVM and VMware ESX SR-IOV modes are supported.
  90
  91 Limitations
  92 -----------
  93
  94 - Inner RSS for VXLAN frames is not supported yet.
  95 - Port statistics through software counters only.
  96 - Hardware checksum offloads for VXLAN inner header are not supported yet.
  97 - Secondary process RX is not supported.
  98
  99 Configuration
 100 -------------
 101
 102 Compilation options
 103 ~~~~~~~~~~~~~~~~~~~
 104
 105 These options can be modified in the ``.config`` file.
 106
 107 - ``CONFIG_RTE_LIBRTE_MLX5_PMD`` (default **n**)
 108
 109   Toggle compilation of librte_pmd_mlx5 itself.
 110
 111 - ``CONFIG_RTE_LIBRTE_MLX5_DEBUG`` (default **n**)
 112
 113   Toggle debugging code and stricter compilation flags. Enabling this option
 114   adds additional run-time checks and debugging messages at the cost of
 115   lower performance.
 116
 117 - ``CONFIG_RTE_LIBRTE_MLX5_TX_MP_CACHE`` (default **8**)
 118
 119   Maximum number of cached memory pools (MPs) per TX queue. Each MP from
 120   which buffers are to be transmitted must be associated to memory regions
 121   (MRs). This is a slow operation that must be cached.
 122
 123   This value is always 1 for RX queues since they use a single MP.
 124
 125 Environment variables
 126 ~~~~~~~~~~~~~~~~~~~~~
 127
 128 - ``MLX5_ENABLE_CQE_COMPRESSION``
 129
 130   A nonzero value lets ConnectX-4 return smaller completion entries to
 131   improve performance when PCI backpressure is detected. It is most useful
 132   for scenarios involving heavy traffic on many queues.
 133
 134   Since the additional software logic necessary to handle this mode can
 135   lower performance when there is no backpressure, it is not enabled by
 136   default.
 137
 138 - ``MLX5_PMD_ENABLE_PADDING``
 139
 140   Enables HW packet padding in PCI bus transactions.
 141
 142   When packet size is cache aligned and CRC stripping is enabled, 4 fewer
 143   bytes are written to the PCI bus. Enabling padding makes such packets
 144   aligned again.
 145
 146   In cases where PCI bandwidth is the bottleneck, padding can improve
 147   performance by 10%.
 148
 149   This is disabled by default since this can also decrease performance for
 150   unaligned packet sizes.
 151
 152 Run-time configuration
 153 ~~~~~~~~~~~~~~~~~~~~~~
 154
 155 - librte_pmd_mlx5 brings kernel network interfaces up during initialization
 156   because it is affected by their state. Forcing them down prevents packets
 157   reception.
 158
 159 - **ethtool** operations on related kernel interfaces also affect the PMD.
 160
 161 Prerequisites
 162 -------------
 163
 164 This driver relies on external libraries and kernel drivers for resources
 165 allocations and initialization. The following dependencies are not part of
 166 DPDK and must be installed separately:
 167
 168 - **libibverbs**
 169
 170   User space Verbs framework used by librte_pmd_mlx5. This library provides
 171   a generic interface between the kernel and low-level user space drivers
 172   such as libmlx5.
 173
 174   It allows slow and privileged operations (context initialization, hardware
 175   resources allocations) to be managed by the kernel and fast operations to
 176   never leave user space.
 177
 178 - **libmlx5**
 179
 180   Low-level user space driver library for Mellanox ConnectX-4 devices,
 181   it is automatically loaded by libibverbs.
 182
 183   This library basically implements send/receive calls to the hardware
 184   queues.
 185
 186 - **Kernel modules** (mlnx-ofed-kernel)
 187
 188   They provide the kernel-side Verbs API and low level device drivers that
 189   manage actual hardware initialization and resources sharing with user
 190   space processes.
 191
 192   Unlike most other PMDs, these modules must remain loaded and bound to
 193   their devices:
 194
 195   - mlx5_core: hardware driver managing Mellanox ConnectX-4 devices and
 196     related Ethernet kernel network devices.
 197   - mlx5_ib: InifiniBand device driver.
 198   - ib_uverbs: user space driver for Verbs (entry point for libibverbs).
 199
 200 - **Firmware update**
 201
 202   Mellanox OFED releases include firmware updates for ConnectX-4 adapters.
 203
 204   Because each release provides new features, these updates must be applied to
 205   match the kernel modules and libraries they come with.
 206
 207 .. note::
 208
 209    Both libraries are BSD and GPL licensed. Linux kernel modules are GPL
 210    licensed.
 211
 212 Currently supported by DPDK:
 213
 214 - Mellanox OFED **3.1-1.0.3**, **3.1-1.5.7.1** or **3.2-2.0.0.0** depending
 215   on usage.
 216
 217     The following features are supported with version **3.1-1.5.7.1** and
 218     above only:
 219
 220     - IPv6, UPDv6, TCPv6 RSS.
 221     - RX checksum offloads.
 222     - IBM POWER8.
 223
 224     The following features are supported with version **3.2-2.0.0.0** and
 225     above only:
 226
 227     - Flow director.
 228     - RX VLAN stripping.
 229     - TX VLAN insertion.
 230     - RX CRC stripping configuration.
 231
 232 - Minimum firmware version:
 233
 234   With MLNX_OFED **3.1-1.0.3**:
 235
 236   - ConnectX-4: **12.12.1240**
 237   - ConnectX-4 Lx: **14.12.1100**
 238
 239   With MLNX_OFED **3.1-1.5.7.1**:
 240
 241   - ConnectX-4: **12.13.0144**
 242   - ConnectX-4 Lx: **14.13.0144**
 243
 244   With MLNX_OFED **3.2-2.0.0.0**:
 245
 246   - ConnectX-4: **12.14.2036**
 247   - ConnectX-4 Lx: **14.14.2036**
 248
 249 Getting Mellanox OFED
 250 ~~~~~~~~~~~~~~~~~~~~~
 251
 252 While these libraries and kernel modules are available on OpenFabrics
 253 Alliance's `website <https://www.openfabrics.org/>`__ and provided by package
 254 managers on most distributions, this PMD requires Ethernet extensions that
 255 may not be supported at the moment (this is a work in progress).
 256
 257 `Mellanox OFED
 258 <http://www.mellanox.com/page/products_dyn?product_family=26&mtag=linux>`__
 259 includes the necessary support and should be used in the meantime. For DPDK,
 260 only libibverbs, libmlx5, mlnx-ofed-kernel packages and firmware updates are
 261 required from that distribution.
 262
 263 .. note::
 264
 265    Several versions of Mellanox OFED are available. Installing the version
 266    this DPDK release was developed and tested against is strongly
 267    recommended. Please check the `prerequisites`_.
 268
 269 Notes for testpmd
 270 -----------------
 271
 272 Compared to librte_pmd_mlx4 that implements a single RSS configuration per
 273 port, librte_pmd_mlx5 supports per-protocol RSS configuration.
 274
 275 Since ``testpmd`` defaults to IP RSS mode and there is currently no
 276 command-line parameter to enable additional protocols (UDP and TCP as well
 277 as IP), the following commands must be entered from its CLI to get the same
 278 behavior as librte_pmd_mlx4:
 279
 280 .. code-block:: console
 281
 282    > port stop all
 283    > port config all rss all
 284    > port start all
 285
 286 Usage example
 287 -------------
 288
 289 This section demonstrates how to launch **testpmd** with Mellanox ConnectX-4
 290 devices managed by librte_pmd_mlx5.
 291
 292 #. Load the kernel modules:
 293
 294    .. code-block:: console
 295
 296       modprobe -a ib_uverbs mlx5_core mlx5_ib
 297
 298    Alternatively if MLNX_OFED is fully installed, the following script can
 299    be run:
 300
 301    .. code-block:: console
 302
 303       /etc/init.d/openibd restart
 304
 305    .. note::
 306
 307       User space I/O kernel modules (uio and igb_uio) are not used and do
 308       not have to be loaded.
 309
 310 #. Make sure Ethernet interfaces are in working order and linked to kernel
 311    verbs. Related sysfs entries should be present:
 312
 313    .. code-block:: console
 314
 315       ls -d /sys/class/net/*/device/infiniband_verbs/uverbs* | cut -d / -f 5
 316
 317    Example output:
 318
 319    .. code-block:: console
 320
 321       eth30
 322       eth31
 323       eth32
 324       eth33
 325
 326 #. Optionally, retrieve their PCI bus addresses for whitelisting:
 327
 328    .. code-block:: console
 329
 330       {
 331           for intf in eth2 eth3 eth4 eth5;
 332           do
 333               (cd "/sys/class/net/${intf}/device/" && pwd -P);
 334           done;
 335       } |
 336       sed -n 's,.*/\(.*\),-w \1,p'
 337
 338    Example output:
 339
 340    .. code-block:: console
 341
 342       -w 0000:05:00.1
 343       -w 0000:06:00.0
 344       -w 0000:06:00.1
 345       -w 0000:05:00.0
 346
 347 #. Request huge pages:
 348
 349    .. code-block:: console
 350
 351       echo 1024 > /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages/nr_hugepages
 352
 353 #. Start testpmd with basic parameters:
 354
 355    .. code-block:: console
 356
 357       testpmd -c 0xff00 -n 4 -w 05:00.0 -w 05:00.1 -w 06:00.0 -w 06:00.1 -- --rxq=2 --txq=2 -i
 358
 359    Example output:
 360
 361    .. code-block:: console
 362
 363       [...]
 364       EAL: PCI device 0000:05:00.0 on NUMA socket 0
 365       EAL:   probe driver: 15b3:1013 librte_pmd_mlx5
 366       PMD: librte_pmd_mlx5: PCI information matches, using device "mlx5_0" (VF: false)
 367       PMD: librte_pmd_mlx5: 1 port(s) detected
 368       PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:fe
 369       EAL: PCI device 0000:05:00.1 on NUMA socket 0
 370       EAL:   probe driver: 15b3:1013 librte_pmd_mlx5
 371       PMD: librte_pmd_mlx5: PCI information matches, using device "mlx5_1" (VF: false)
 372       PMD: librte_pmd_mlx5: 1 port(s) detected
 373       PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:ff
 374       EAL: PCI device 0000:06:00.0 on NUMA socket 0
 375       EAL:   probe driver: 15b3:1013 librte_pmd_mlx5
 376       PMD: librte_pmd_mlx5: PCI information matches, using device "mlx5_2" (VF: false)
 377       PMD: librte_pmd_mlx5: 1 port(s) detected
 378       PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:fa
 379       EAL: PCI device 0000:06:00.1 on NUMA socket 0
 380       EAL:   probe driver: 15b3:1013 librte_pmd_mlx5
 381       PMD: librte_pmd_mlx5: PCI information matches, using device "mlx5_3" (VF: false)
 382       PMD: librte_pmd_mlx5: 1 port(s) detected
 383       PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:fb
 384       Interactive-mode selected
 385       Configuring Port 0 (socket 0)
 386       PMD: librte_pmd_mlx5: 0x8cba80: TX queues number update: 0 -> 2
 387       PMD: librte_pmd_mlx5: 0x8cba80: RX queues number update: 0 -> 2
 388       Port 0: E4:1D:2D:E7:0C:FE
 389       Configuring Port 1 (socket 0)
 390       PMD: librte_pmd_mlx5: 0x8ccac8: TX queues number update: 0 -> 2
 391       PMD: librte_pmd_mlx5: 0x8ccac8: RX queues number update: 0 -> 2
 392       Port 1: E4:1D:2D:E7:0C:FF
 393       Configuring Port 2 (socket 0)
 394       PMD: librte_pmd_mlx5: 0x8cdb10: TX queues number update: 0 -> 2
 395       PMD: librte_pmd_mlx5: 0x8cdb10: RX queues number update: 0 -> 2
 396       Port 2: E4:1D:2D:E7:0C:FA
 397       Configuring Port 3 (socket 0)
 398       PMD: librte_pmd_mlx5: 0x8ceb58: TX queues number update: 0 -> 2
 399       PMD: librte_pmd_mlx5: 0x8ceb58: RX queues number update: 0 -> 2
 400       Port 3: E4:1D:2D:E7:0C:FB
 401       Checking link statuses...
 402       Port 0 Link Up - speed 40000 Mbps - full-duplex
 403       Port 1 Link Up - speed 40000 Mbps - full-duplex
 404       Port 2 Link Up - speed 10000 Mbps - full-duplex
 405       Port 3 Link Up - speed 10000 Mbps - full-duplex
 406       Done
 407       testpmd>