doc/guides/nics/mlx4.rst

   1 ..  BSD LICENSE
   2     Copyright 2012 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 MLX4 poll mode driver library
  32 =============================
  33
  34 The MLX4 poll mode driver library (**librte_pmd_mlx4**) implements support
  35 for **Mellanox ConnectX-3** and **Mellanox ConnectX-3 Pro** 10/40 Gbps adapters
  36 as well as their virtual functions (VF) in SR-IOV context.
  37
  38 Information and documentation about this family of adapters can be found on
  39 the `Mellanox website <http://www.mellanox.com>`_. Help is also provided by
  40 the `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_MLX4_PMD=y`` and
  49    recompiling DPDK.
  50
  51 Implementation details
  52 ----------------------
  53
  54 Most Mellanox ConnectX-3 devices provide two ports but expose a single PCI
  55 bus address, thus unlike most drivers, librte_pmd_mlx4 registers itself as a
  56 PCI driver that allocates one Ethernet device per detected port.
  57
  58 For this reason, one cannot white/blacklist a single port without also
  59 white/blacklisting the others on the same device.
  60
  61 Besides its dependency on libibverbs (that implies libmlx4 and associated
  62 kernel support), librte_pmd_mlx4 relies heavily on system calls for control
  63 operations such as querying/updating the MTU and flow control parameters.
  64
  65 For security reasons and robustness, this driver only deals with virtual
  66 memory addresses. The way resources allocations are handled by the kernel
  67 combined with hardware specifications that allow it to handle virtual memory
  68 addresses directly ensure that DPDK applications cannot access random
  69 physical memory (or memory that does not belong to the current process).
  70
  71 This capability allows the PMD to coexist with kernel network interfaces
  72 which remain functional, although they stop receiving unicast packets as
  73 long as they share the same MAC address.
  74
  75 Compiling librte_pmd_mlx4 causes DPDK to be linked against libibverbs.
  76
  77 Configuration
  78 -------------
  79
  80 Compilation options
  81 ~~~~~~~~~~~~~~~~~~~
  82
  83 These options can be modified in the ``.config`` file.
  84
  85 - ``CONFIG_RTE_LIBRTE_MLX4_PMD`` (default **n**)
  86
  87   Toggle compilation of librte_pmd_mlx4 itself.
  88
  89 - ``CONFIG_RTE_LIBRTE_MLX4_DLOPEN_DEPS`` (default **n**)
  90
  91   Build PMD with additional code to make it loadable without hard
  92   dependencies on **libibverbs** nor **libmlx4**, which may not be installed
  93   on the target system.
  94
  95   In this mode, their presence is still required for it to run properly,
  96   however their absence won't prevent a DPDK application from starting (with
  97   ``CONFIG_RTE_BUILD_SHARED_LIB`` disabled) and they won't show up as
  98   missing with ``ldd(1)``.
  99
 100   It works by moving these dependencies to a purpose-built rdma-core "glue"
 101   plug-in, which must either be installed in ``CONFIG_RTE_EAL_PMD_PATH`` if
 102   set, or in a standard location for the dynamic linker (e.g. ``/lib``) if
 103   left to the default empty string (``""``).
 104
 105   This option has no performance impact.
 106
 107 - ``CONFIG_RTE_LIBRTE_MLX4_DEBUG`` (default **n**)
 108
 109   Toggle debugging code and stricter compilation flags. Enabling this option
 110   adds additional run-time checks and debugging messages at the cost of
 111   lower performance.
 112
 113 - ``CONFIG_RTE_LIBRTE_MLX4_TX_MP_CACHE`` (default **8**)
 114
 115   Maximum number of cached memory pools (MPs) per TX queue. Each MP from
 116   which buffers are to be transmitted must be associated to memory regions
 117   (MRs). This is a slow operation that must be cached.
 118
 119   This value is always 1 for RX queues since they use a single MP.
 120
 121 Environment variables
 122 ~~~~~~~~~~~~~~~~~~~~~
 123
 124 - ``MLX4_GLUE_PATH``
 125
 126   A list of directories in which to search for the rdma-core "glue" plug-in,
 127   separated by colons or semi-colons.
 128
 129   Only matters when compiled with ``CONFIG_RTE_LIBRTE_MLX4_DLOPEN_DEPS``
 130   enabled and most useful when ``CONFIG_RTE_EAL_PMD_PATH`` is also set,
 131   since ``LD_LIBRARY_PATH`` has no effect in this case.
 132
 133 Run-time configuration
 134 ~~~~~~~~~~~~~~~~~~~~~~
 135
 136 - librte_pmd_mlx4 brings kernel network interfaces up during initialization
 137   because it is affected by their state. Forcing them down prevents packets
 138   reception.
 139
 140 - **ethtool** operations on related kernel interfaces also affect the PMD.
 141
 142 - ``port`` parameter [int]
 143
 144   This parameter provides a physical port to probe and can be specified multiple
 145   times for additional ports. All ports are probed by default if left
 146   unspecified.
 147
 148 Kernel module parameters
 149 ~~~~~~~~~~~~~~~~~~~~~~~~
 150
 151 The **mlx4_core** kernel module has several parameters that affect the
 152 behavior and/or the performance of librte_pmd_mlx4. Some of them are described
 153 below.
 154
 155 - **num_vfs** (integer or triplet, optionally prefixed by device address
 156   strings)
 157
 158   Create the given number of VFs on the specified devices.
 159
 160 - **log_num_mgm_entry_size** (integer)
 161
 162   Device-managed flow steering (DMFS) is required by DPDK applications. It is
 163   enabled by using a negative value, the last four bits of which have a
 164   special meaning.
 165
 166   - **-1**: force device-managed flow steering (DMFS).
 167   - **-7**: configure optimized steering mode to improve performance with the
 168     following limitation: VLAN filtering is not supported with this mode.
 169     This is the recommended mode in case VLAN filter is not needed.
 170
 171 Prerequisites
 172 -------------
 173
 174 This driver relies on external libraries and kernel drivers for resources
 175 allocations and initialization. The following dependencies are not part of
 176 DPDK and must be installed separately:
 177
 178 - **libibverbs** (provided by rdma-core package)
 179
 180   User space verbs framework used by librte_pmd_mlx4. This library provides
 181   a generic interface between the kernel and low-level user space drivers
 182   such as libmlx4.
 183
 184   It allows slow and privileged operations (context initialization, hardware
 185   resources allocations) to be managed by the kernel and fast operations to
 186   never leave user space.
 187
 188 - **libmlx4** (provided by rdma-core package)
 189
 190   Low-level user space driver library for Mellanox ConnectX-3 devices,
 191   it is automatically loaded by libibverbs.
 192
 193   This library basically implements send/receive calls to the hardware
 194   queues.
 195
 196 - **Kernel modules**
 197
 198   They provide the kernel-side verbs API and low level device drivers that
 199   manage actual hardware initialization and resources sharing with user
 200   space processes.
 201
 202   Unlike most other PMDs, these modules must remain loaded and bound to
 203   their devices:
 204
 205   - mlx4_core: hardware driver managing Mellanox ConnectX-3 devices.
 206   - mlx4_en: Ethernet device driver that provides kernel network interfaces.
 207   - mlx4_ib: InifiniBand device driver.
 208   - ib_uverbs: user space driver for verbs (entry point for libibverbs).
 209
 210 - **Firmware update**
 211
 212   Mellanox OFED releases include firmware updates for ConnectX-3 adapters.
 213
 214   Because each release provides new features, these updates must be applied to
 215   match the kernel modules and libraries they come with.
 216
 217 .. note::
 218
 219    Both libraries are BSD and GPL licensed. Linux kernel modules are GPL
 220    licensed.
 221
 222 Depending on system constraints and user preferences either RDMA core library
 223 with a recent enough Linux kernel release (recommended) or Mellanox OFED,
 224 which provides compatibility with older releases.
 225
 226 Current RDMA core package and Linux kernel (recommended)
 227 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 228
 229 - Minimal Linux kernel version: 4.14.
 230 - Minimal RDMA core version: v15 (see `RDMA core installation documentation`_).
 231
 232 .. _`RDMA core installation documentation`: https://raw.githubusercontent.com/linux-rdma/rdma-core/master/README.md
 233
 234 .. _Mellanox_OFED_as_a_fallback:
 235
 236 Mellanox OFED as a fallback
 237 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 238
 239 - `Mellanox OFED`_ version: **4.2, 4.3**.
 240 - firmware version: **2.42.5000** and above.
 241
 242 .. _`Mellanox OFED`: http://www.mellanox.com/page/products_dyn?product_family=26&mtag=linux_sw_drivers
 243
 244 .. note::
 245
 246    Several versions of Mellanox OFED are available. Installing the version
 247    this DPDK release was developed and tested against is strongly
 248    recommended. Please check the `prerequisites`_.
 249
 250 Installing Mellanox OFED
 251 ^^^^^^^^^^^^^^^^^^^^^^^^
 252
 253 1. Download latest Mellanox OFED.
 254
 255 2. Install the required libraries and kernel modules either by installing
 256    only the required set, or by installing the entire Mellanox OFED:
 257
 258    For bare metal use:
 259
 260    .. code-block:: console
 261
 262         ./mlnxofedinstall --dpdk --upstream-libs
 263
 264    For SR-IOV hypervisors use:
 265
 266    .. code-block:: console
 267
 268         ./mlnxofedinstall --dpdk --upstream-libs --enable-sriov --hypervisor
 269
 270    For SR-IOV virtual machine use:
 271
 272    .. code-block:: console
 273
 274         ./mlnxofedinstall --dpdk --upstream-libs --guest
 275
 276 3. Verify the firmware is the correct one:
 277
 278    .. code-block:: console
 279
 280         ibv_devinfo
 281
 282 4. Set all ports links to Ethernet, follow instructions on the screen:
 283
 284    .. code-block:: console
 285
 286         connectx_port_config
 287
 288 5. Continue with :ref:`section 2 of the Quick Start Guide <QSG_2>`.
 289
 290 Supported NICs
 291 --------------
 292
 293 * Mellanox(R) ConnectX(R)-3 Pro 40G MCX354A-FCC_Ax (2*40G)
 294
 295 .. _qsg:
 296
 297 Quick Start Guide
 298 -----------------
 299
 300 1. Set all ports links to Ethernet
 301
 302    .. code-block:: console
 303
 304         PCI=<NIC PCI address>
 305         echo eth > "/sys/bus/pci/devices/$PCI/mlx4_port0"
 306         echo eth > "/sys/bus/pci/devices/$PCI/mlx4_port1"
 307
 308    .. note::
 309
 310         If using Mellanox OFED one can permanently set the port link
 311         to Ethernet using connectx_port_config tool provided by it.
 312         :ref:`Mellanox_OFED_as_a_fallback`:
 313
 314 .. _QSG_2:
 315
 316 2. In case of bare metal or hypervisor, configure optimized steering mode
 317    by adding the following line to ``/etc/modprobe.d/mlx4_core.conf``:
 318
 319    .. code-block:: console
 320
 321         options mlx4_core log_num_mgm_entry_size=-7
 322
 323    .. note::
 324
 325         If VLAN filtering is used, set log_num_mgm_entry_size=-1.
 326         Performance degradation can occur on this case.
 327
 328 3. Restart the driver:
 329
 330    .. code-block:: console
 331
 332         /etc/init.d/openibd restart
 333
 334    or:
 335
 336    .. code-block:: console
 337
 338         service openibd restart
 339
 340 4. Compile DPDK and you are ready to go. See instructions on
 341    :ref:`Development Kit Build System <Development_Kit_Build_System>`
 342
 343 Performance tuning
 344 ------------------
 345
 346 1. Verify the optimized steering mode is configured:
 347
 348   .. code-block:: console
 349
 350         cat /sys/module/mlx4_core/parameters/log_num_mgm_entry_size
 351
 352 2. Use the CPU near local NUMA node to which the PCIe adapter is connected,
 353    for better performance. For VMs, verify that the right CPU
 354    and NUMA node are pinned according to the above. Run:
 355
 356    .. code-block:: console
 357
 358         lstopo-no-graphics
 359
 360    to identify the NUMA node to which the PCIe adapter is connected.
 361
 362 3. If more than one adapter is used, and root complex capabilities allow
 363    to put both adapters on the same NUMA node without PCI bandwidth degradation,
 364    it is recommended to locate both adapters on the same NUMA node.
 365    This in order to forward packets from one to the other without
 366    NUMA performance penalty.
 367
 368 4. Disable pause frames:
 369
 370    .. code-block:: console
 371
 372         ethtool -A <netdev> rx off tx off
 373
 374 5. Verify IO non-posted prefetch is disabled by default. This can be checked
 375    via the BIOS configuration. Please contact you server provider for more
 376    information about the settings.
 377
 378 .. note::
 379
 380         On some machines, depends on the machine integrator, it is beneficial
 381         to set the PCI max read request parameter to 1K. This can be
 382         done in the following way:
 383
 384         To query the read request size use:
 385
 386         .. code-block:: console
 387
 388                 setpci -s <NIC PCI address> 68.w
 389
 390         If the output is different than 3XXX, set it by:
 391
 392         .. code-block:: console
 393
 394                 setpci -s <NIC PCI address> 68.w=3XXX
 395
 396         The XXX can be different on different systems. Make sure to configure
 397         according to the setpci output.
 398
 399 Usage example
 400 -------------
 401
 402 This section demonstrates how to launch **testpmd** with Mellanox ConnectX-3
 403 devices managed by librte_pmd_mlx4.
 404
 405 #. Load the kernel modules:
 406
 407    .. code-block:: console
 408
 409       modprobe -a ib_uverbs mlx4_en mlx4_core mlx4_ib
 410
 411    Alternatively if MLNX_OFED is fully installed, the following script can
 412    be run:
 413
 414    .. code-block:: console
 415
 416       /etc/init.d/openibd restart
 417
 418    .. note::
 419
 420       User space I/O kernel modules (uio and igb_uio) are not used and do
 421       not have to be loaded.
 422
 423 #. Make sure Ethernet interfaces are in working order and linked to kernel
 424    verbs. Related sysfs entries should be present:
 425
 426    .. code-block:: console
 427
 428       ls -d /sys/class/net/*/device/infiniband_verbs/uverbs* | cut -d / -f 5
 429
 430    Example output:
 431
 432    .. code-block:: console
 433
 434       eth2
 435       eth3
 436       eth4
 437       eth5
 438
 439 #. Optionally, retrieve their PCI bus addresses for whitelisting:
 440
 441    .. code-block:: console
 442
 443       {
 444           for intf in eth2 eth3 eth4 eth5;
 445           do
 446               (cd "/sys/class/net/${intf}/device/" && pwd -P);
 447           done;
 448       } |
 449       sed -n 's,.*/\(.*\),-w \1,p'
 450
 451    Example output:
 452
 453    .. code-block:: console
 454
 455       -w 0000:83:00.0
 456       -w 0000:83:00.0
 457       -w 0000:84:00.0
 458       -w 0000:84:00.0
 459
 460    .. note::
 461
 462       There are only two distinct PCI bus addresses because the Mellanox
 463       ConnectX-3 adapters installed on this system are dual port.
 464
 465 #. Request huge pages:
 466
 467    .. code-block:: console
 468
 469       echo 1024 > /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages/nr_hugepages
 470
 471 #. Start testpmd with basic parameters:
 472
 473    .. code-block:: console
 474
 475       testpmd -l 8-15 -n 4 -w 0000:83:00.0 -w 0000:84:00.0 -- --rxq=2 --txq=2 -i
 476
 477    Example output:
 478
 479    .. code-block:: console
 480
 481       [...]
 482       EAL: PCI device 0000:83:00.0 on NUMA socket 1
 483       EAL:   probe driver: 15b3:1007 librte_pmd_mlx4
 484       PMD: librte_pmd_mlx4: PCI information matches, using device "mlx4_0" (VF: false)
 485       PMD: librte_pmd_mlx4: 2 port(s) detected
 486       PMD: librte_pmd_mlx4: port 1 MAC address is 00:02:c9:b5:b7:50
 487       PMD: librte_pmd_mlx4: port 2 MAC address is 00:02:c9:b5:b7:51
 488       EAL: PCI device 0000:84:00.0 on NUMA socket 1
 489       EAL:   probe driver: 15b3:1007 librte_pmd_mlx4
 490       PMD: librte_pmd_mlx4: PCI information matches, using device "mlx4_1" (VF: false)
 491       PMD: librte_pmd_mlx4: 2 port(s) detected
 492       PMD: librte_pmd_mlx4: port 1 MAC address is 00:02:c9:b5:ba:b0
 493       PMD: librte_pmd_mlx4: port 2 MAC address is 00:02:c9:b5:ba:b1
 494       Interactive-mode selected
 495       Configuring Port 0 (socket 0)
 496       PMD: librte_pmd_mlx4: 0x867d60: TX queues number update: 0 -> 2
 497       PMD: librte_pmd_mlx4: 0x867d60: RX queues number update: 0 -> 2
 498       Port 0: 00:02:C9:B5:B7:50
 499       Configuring Port 1 (socket 0)
 500       PMD: librte_pmd_mlx4: 0x867da0: TX queues number update: 0 -> 2
 501       PMD: librte_pmd_mlx4: 0x867da0: RX queues number update: 0 -> 2
 502       Port 1: 00:02:C9:B5:B7:51
 503       Configuring Port 2 (socket 0)
 504       PMD: librte_pmd_mlx4: 0x867de0: TX queues number update: 0 -> 2
 505       PMD: librte_pmd_mlx4: 0x867de0: RX queues number update: 0 -> 2
 506       Port 2: 00:02:C9:B5:BA:B0
 507       Configuring Port 3 (socket 0)
 508       PMD: librte_pmd_mlx4: 0x867e20: TX queues number update: 0 -> 2
 509       PMD: librte_pmd_mlx4: 0x867e20: RX queues number update: 0 -> 2
 510       Port 3: 00:02:C9:B5:BA:B1
 511       Checking link statuses...
 512       Port 0 Link Up - speed 10000 Mbps - full-duplex
 513       Port 1 Link Up - speed 40000 Mbps - full-duplex
 514       Port 2 Link Up - speed 10000 Mbps - full-duplex
 515       Port 3 Link Up - speed 40000 Mbps - full-duplex
 516       Done
 517       testpmd>