doc/guides/nics/thunderx.rst

   1 ..  BSD LICENSE
   2     Copyright (C) Cavium networks Ltd. 2016.
   3     All rights reserved.
   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 Cavium networks 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 ThunderX NICVF Poll Mode Driver
  32 ===============================
  33
  34 The ThunderX NICVF PMD (**librte_pmd_thunderx_nicvf**) provides poll mode driver
  35 support for the inbuilt NIC found in the **Cavium ThunderX** SoC family
  36 as well as their virtual functions (VF) in SR-IOV context.
  37
  38 More information can be found at `Cavium Networks Official Website
  39 <http://www.cavium.com/ThunderX_ARM_Processors.html>`_.
  40
  41 Features
  42 --------
  43
  44 Features of the ThunderX PMD are:
  45
  46 - Multiple queues for TX and RX
  47 - Receive Side Scaling (RSS)
  48 - Packet type information
  49 - Checksum offload
  50 - Promiscuous mode
  51 - Multicast mode
  52 - Port hardware statistics
  53 - Jumbo frames
  54 - Link state information
  55 - Scattered and gather for TX and RX
  56 - VLAN stripping
  57 - SR-IOV VF
  58 - NUMA support
  59 - Multi queue set support (up to 96 queues (12 queue sets)) per port
  60
  61 Supported ThunderX SoCs
  62 -----------------------
  63 - CN88xx
  64 - CN81xx
  65 - CN83xx
  66
  67 Prerequisites
  68 -------------
  69 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
  70
  71 Pre-Installation Configuration
  72 ------------------------------
  73
  74 Config File Options
  75 ~~~~~~~~~~~~~~~~~~~
  76
  77 The following options can be modified in the ``config`` file.
  78 Please note that enabling debugging options may affect system performance.
  79
  80 - ``CONFIG_RTE_LIBRTE_THUNDERX_NICVF_PMD`` (default ``y``)
  81
  82   Toggle compilation of the ``librte_pmd_thunderx_nicvf`` driver.
  83
  84 - ``CONFIG_RTE_LIBRTE_THUNDERX_NICVF_DEBUG_INIT`` (default ``n``)
  85
  86   Toggle display of initialization related messages.
  87
  88 - ``CONFIG_RTE_LIBRTE_THUNDERX_NICVF_DEBUG_RX`` (default ``n``)
  89
  90   Toggle display of receive fast path run-time message
  91
  92 - ``CONFIG_RTE_LIBRTE_THUNDERX_NICVF_DEBUG_TX`` (default ``n``)
  93
  94   Toggle display of transmit fast path run-time message
  95
  96 - ``CONFIG_RTE_LIBRTE_THUNDERX_NICVF_DEBUG_DRIVER`` (default ``n``)
  97
  98   Toggle display of generic debugging messages
  99
 100 - ``CONFIG_RTE_LIBRTE_THUNDERX_NICVF_DEBUG_MBOX`` (default ``n``)
 101
 102   Toggle display of PF mailbox related run-time check messages
 103
 104 Driver Compilation
 105 ~~~~~~~~~~~~~~~~~~
 106
 107 To compile the ThunderX NICVF PMD for Linux arm64 gcc target, run the
 108 following “make” command:
 109
 110 .. code-block:: console
 111
 112    cd <DPDK-source-directory>
 113    make config T=arm64-thunderx-linuxapp-gcc install
 114
 115 Linux
 116 -----
 117
 118 .. _thunderx_testpmd_example:
 119
 120 Running testpmd
 121 ~~~~~~~~~~~~~~~
 122
 123 This section demonstrates how to launch ``testpmd`` with ThunderX NIC VF device
 124 managed by ``librte_pmd_thunderx_nicvf`` in the Linux operating system.
 125
 126 #. Load ``vfio-pci`` driver:
 127
 128    .. code-block:: console
 129
 130       modprobe vfio-pci
 131
 132    .. _thunderx_vfio_noiommu:
 133
 134 #. Enable **VFIO-NOIOMMU** mode (optional):
 135
 136    .. code-block:: console
 137
 138       echo 1 > /sys/module/vfio/parameters/enable_unsafe_noiommu_mode
 139
 140    .. note::
 141
 142       **VFIO-NOIOMMU** is required only when running in VM context and should not be enabled otherwise.
 143       See also :ref:`SR-IOV: Prerequisites and sample Application Notes <thunderx_sriov_example>`.
 144
 145 #. Bind the ThunderX NIC VF device to ``vfio-pci`` loaded in the previous step:
 146
 147    Setup VFIO permissions for regular users and then bind to ``vfio-pci``:
 148
 149    .. code-block:: console
 150
 151       ./usertools/dpdk-devbind.py --bind vfio-pci 0002:01:00.2
 152
 153 #. Start ``testpmd`` with basic parameters:
 154
 155    .. code-block:: console
 156
 157       ./arm64-thunderx-linuxapp-gcc/app/testpmd -l 0-3 -n 4 -w 0002:01:00.2 \
 158         -- -i --disable-hw-vlan-filter --crc-strip --no-flush-rx \
 159         --port-topology=loop
 160
 161    Example output:
 162
 163    .. code-block:: console
 164
 165       ...
 166
 167       PMD: rte_nicvf_pmd_init(): librte_pmd_thunderx nicvf version 1.0
 168
 169       ...
 170       EAL:   probe driver: 177d:11 rte_nicvf_pmd
 171       EAL:   using IOMMU type 1 (Type 1)
 172       EAL:   PCI memory mapped at 0x3ffade50000
 173       EAL: Trying to map BAR 4 that contains the MSI-X table.
 174            Trying offsets: 0x40000000000:0x0000, 0x10000:0x1f0000
 175       EAL:   PCI memory mapped at 0x3ffadc60000
 176       PMD: nicvf_eth_dev_init(): nicvf: device (177d:11) 2:1:0:2
 177       PMD: nicvf_eth_dev_init(): node=0 vf=1 mode=tns-bypass sqs=false
 178            loopback_supported=true
 179       PMD: nicvf_eth_dev_init(): Port 0 (177d:11) mac=a6:c6:d9:17:78:01
 180       Interactive-mode selected
 181       Configuring Port 0 (socket 0)
 182       ...
 183
 184       PMD: nicvf_dev_configure(): Configured ethdev port0 hwcap=0x0
 185       Port 0: A6:C6:D9:17:78:01
 186       Checking link statuses...
 187       Port 0 Link Up - speed 10000 Mbps - full-duplex
 188       Done
 189       testpmd>
 190
 191 .. _thunderx_sriov_example:
 192
 193 SR-IOV: Prerequisites and sample Application Notes
 194 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 195
 196 Current ThunderX NIC PF/VF kernel modules maps each physical Ethernet port
 197 automatically to virtual function (VF) and presented them as PCIe-like SR-IOV device.
 198 This section provides instructions to configure SR-IOV with Linux OS.
 199
 200 #. Verify PF devices capabilities using ``lspci``:
 201
 202    .. code-block:: console
 203
 204       lspci -vvv
 205
 206    Example output:
 207
 208    .. code-block:: console
 209
 210       0002:01:00.0 Ethernet controller: Cavium Networks Device a01e (rev 01)
 211       ...
 212       Capabilities: [100 v1] Alternative Routing-ID Interpretation (ARI)
 213       ...
 214       Capabilities: [180 v1] Single Root I/O Virtualization (SR-IOV)
 215       ...
 216       Kernel driver in use: thunder-nic
 217       ...
 218
 219    .. note::
 220
 221       Unless ``thunder-nic`` driver is in use make sure your kernel config includes ``CONFIG_THUNDER_NIC_PF`` setting.
 222
 223 #. Verify VF devices capabilities and drivers using ``lspci``:
 224
 225    .. code-block:: console
 226
 227       lspci -vvv
 228
 229    Example output:
 230
 231    .. code-block:: console
 232
 233       0002:01:00.1 Ethernet controller: Cavium Networks Device 0011 (rev 01)
 234       ...
 235       Capabilities: [100 v1] Alternative Routing-ID Interpretation (ARI)
 236       ...
 237       Kernel driver in use: thunder-nicvf
 238       ...
 239
 240       0002:01:00.2 Ethernet controller: Cavium Networks Device 0011 (rev 01)
 241       ...
 242       Capabilities: [100 v1] Alternative Routing-ID Interpretation (ARI)
 243       ...
 244       Kernel driver in use: thunder-nicvf
 245       ...
 246
 247    .. note::
 248
 249       Unless ``thunder-nicvf`` driver is in use make sure your kernel config includes ``CONFIG_THUNDER_NIC_VF`` setting.
 250
 251 #. Verify PF/VF bind using ``dpdk-devbind.py``:
 252
 253    .. code-block:: console
 254
 255       ./usertools/dpdk-devbind.py --status
 256
 257    Example output:
 258
 259    .. code-block:: console
 260
 261       ...
 262       0002:01:00.0 'Device a01e' if= drv=thunder-nic unused=vfio-pci
 263       0002:01:00.1 'Device 0011' if=eth0 drv=thunder-nicvf unused=vfio-pci
 264       0002:01:00.2 'Device 0011' if=eth1 drv=thunder-nicvf unused=vfio-pci
 265       ...
 266
 267 #. Load ``vfio-pci`` driver:
 268
 269    .. code-block:: console
 270
 271       modprobe vfio-pci
 272
 273 #. Bind VF devices to ``vfio-pci`` using ``dpdk-devbind.py``:
 274
 275    .. code-block:: console
 276
 277       ./usertools/dpdk-devbind.py --bind vfio-pci 0002:01:00.1
 278       ./usertools/dpdk-devbind.py --bind vfio-pci 0002:01:00.2
 279
 280 #. Verify VF bind using ``dpdk-devbind.py``:
 281
 282    .. code-block:: console
 283
 284       ./usertools/dpdk-devbind.py --status
 285
 286    Example output:
 287
 288    .. code-block:: console
 289
 290       ...
 291       0002:01:00.1 'Device 0011' drv=vfio-pci unused=
 292       0002:01:00.2 'Device 0011' drv=vfio-pci unused=
 293       ...
 294       0002:01:00.0 'Device a01e' if= drv=thunder-nic unused=vfio-pci
 295       ...
 296
 297 #. Pass VF device to VM context (PCIe Passthrough):
 298
 299    The VF devices may be passed through to the guest VM using qemu or
 300    virt-manager or virsh etc.
 301    ``librte_pmd_thunderx_nicvf`` or ``thunder-nicvf`` should be used to bind
 302    the VF devices in the guest VM in :ref:`VFIO-NOIOMMU <thunderx_vfio_noiommu>` mode.
 303
 304    Example qemu guest launch command:
 305
 306    .. code-block:: console
 307
 308       sudo qemu-system-aarch64 -name vm1 \
 309       -machine virt,gic_version=3,accel=kvm,usb=off \
 310       -cpu host -m 4096 \
 311       -smp 4,sockets=1,cores=8,threads=1 \
 312       -nographic -nodefaults \
 313       -kernel <kernel image> \
 314       -append "root=/dev/vda console=ttyAMA0 rw hugepagesz=512M hugepages=3" \
 315       -device vfio-pci,host=0002:01:00.1 \
 316       -drive file=<rootfs.ext3>,if=none,id=disk1,format=raw  \
 317       -device virtio-blk-device,scsi=off,drive=disk1,id=virtio-disk1,bootindex=1 \
 318       -netdev tap,id=net0,ifname=tap0,script=/etc/qemu-ifup_thunder \
 319       -device virtio-net-device,netdev=net0 \
 320       -serial stdio \
 321       -mem-path /dev/huge
 322
 323 #. Refer to section :ref:`Running testpmd <thunderx_testpmd_example>` for instruction
 324    how to launch ``testpmd`` application.
 325
 326 Multiple Queue Set per DPDK port configuration
 327 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 328
 329 There are two types of VFs:
 330
 331 - Primary VF
 332 - Secondary VF
 333
 334 Each port consists of a primary VF and n secondary VF(s). Each VF provides 8 Tx/Rx queues to a port.
 335 When a given port is configured to use more than 8 queues, it requires one (or more) secondary VF.
 336 Each secondary VF adds 8 additional queues to the queue set.
 337
 338 During PMD driver initialization, the primary VF's are enumerated by checking the
 339 specific flag (see sqs message in DPDK boot log - sqs indicates secondary queue set).
 340 They are at the beginning of VF list (the remain ones are secondary VF's).
 341
 342 The primary VFs are used as master queue sets. Secondary VFs provide
 343 additional queue sets for primary ones. If a port is configured for more then
 344 8 queues than it will request for additional queues from secondary VFs.
 345
 346 Secondary VFs cannot be shared between primary VFs.
 347
 348 Primary VFs are present on the beginning of the 'Network devices using kernel
 349 driver' list, secondary VFs are on the remaining on the remaining part of the list.
 350
 351    .. note::
 352
 353       The VNIC driver in the multiqueue setup works differently than other drivers like `ixgbe`.
 354       We need to bind separately each specific queue set device with the ``usertools/dpdk-devbind.py`` utility.
 355
 356    .. note::
 357
 358       Depending on the hardware used, the kernel driver sets a threshold ``vf_id``. VFs that try to attached with an id below or equal to
 359       this boundary are considered primary VFs. VFs that try to attach with an id above this boundary are considered secondary VFs.
 360
 361
 362 Example device binding
 363 ~~~~~~~~~~~~~~~~~~~~~~
 364
 365 If a system has three interfaces, a total of 18 VF devices will be created
 366 on a non-NUMA machine.
 367
 368    .. note::
 369
 370       NUMA systems have 12 VFs per port and non-NUMA 6 VFs per port.
 371
 372    .. code-block:: console
 373
 374       # usertools/dpdk-devbind.py --status
 375
 376       Network devices using DPDK-compatible driver
 377       ============================================
 378       <none>
 379
 380       Network devices using kernel driver
 381       ===================================
 382       0000:01:10.0 'Device a026' if= drv=thunder-BGX unused=vfio-pci,uio_pci_generic
 383       0000:01:10.1 'Device a026' if= drv=thunder-BGX unused=vfio-pci,uio_pci_generic
 384       0002:01:00.0 'Device a01e' if= drv=thunder-nic unused=vfio-pci,uio_pci_generic
 385       0002:01:00.1 'Device 0011' if=eth0 drv=thunder-nicvf unused=vfio-pci,uio_pci_generic
 386       0002:01:00.2 'Device 0011' if=eth1 drv=thunder-nicvf unused=vfio-pci,uio_pci_generic
 387       0002:01:00.3 'Device 0011' if=eth2 drv=thunder-nicvf unused=vfio-pci,uio_pci_generic
 388       0002:01:00.4 'Device 0011' if= drv=thunder-nicvf unused=vfio-pci,uio_pci_generic
 389       0002:01:00.5 'Device 0011' if= drv=thunder-nicvf unused=vfio-pci,uio_pci_generic
 390       0002:01:00.6 'Device 0011' if= drv=thunder-nicvf unused=vfio-pci,uio_pci_generic
 391       0002:01:00.7 'Device 0011' if= drv=thunder-nicvf unused=vfio-pci,uio_pci_generic
 392       0002:01:01.0 'Device 0011' if= drv=thunder-nicvf unused=vfio-pci,uio_pci_generic
 393       0002:01:01.1 'Device 0011' if= drv=thunder-nicvf unused=vfio-pci,uio_pci_generic
 394       0002:01:01.2 'Device 0011' if= drv=thunder-nicvf unused=vfio-pci,uio_pci_generic
 395       0002:01:01.3 'Device 0011' if= drv=thunder-nicvf unused=vfio-pci,uio_pci_generic
 396       0002:01:01.4 'Device 0011' if= drv=thunder-nicvf unused=vfio-pci,uio_pci_generic
 397       0002:01:01.5 'Device 0011' if= drv=thunder-nicvf unused=vfio-pci,uio_pci_generic
 398       0002:01:01.6 'Device 0011' if= drv=thunder-nicvf unused=vfio-pci,uio_pci_generic
 399       0002:01:01.7 'Device 0011' if= drv=thunder-nicvf unused=vfio-pci,uio_pci_generic
 400       0002:01:02.0 'Device 0011' if= drv=thunder-nicvf unused=vfio-pci,uio_pci_generic
 401       0002:01:02.1 'Device 0011' if= drv=thunder-nicvf unused=vfio-pci,uio_pci_generic
 402       0002:01:02.2 'Device 0011' if= drv=thunder-nicvf unused=vfio-pci,uio_pci_generic
 403
 404       Other network devices
 405       =====================
 406       0002:00:03.0 'Device a01f' unused=vfio-pci,uio_pci_generic
 407
 408
 409 We want to bind two physical interfaces with 24 queues each device, we attach two primary VFs
 410 and four secondary queues. In our example we choose two 10G interfaces eth1 (0002:01:00.2) and eth2 (0002:01:00.3).
 411 We will choose four secondary queue sets from the ending of the list (0002:01:01.7-0002:01:02.2).
 412
 413
 414 #. Bind two primary VFs to the ``vfio-pci`` driver:
 415
 416    .. code-block:: console
 417
 418       usertools/dpdk-devbind.py -b vfio-pci 0002:01:00.2
 419       usertools/dpdk-devbind.py -b vfio-pci 0002:01:00.3
 420
 421 #. Bind four primary VFs to the ``vfio-pci`` driver:
 422
 423    .. code-block:: console
 424
 425       usertools/dpdk-devbind.py -b vfio-pci 0002:01:01.7
 426       usertools/dpdk-devbind.py -b vfio-pci 0002:01:02.0
 427       usertools/dpdk-devbind.py -b vfio-pci 0002:01:02.1
 428       usertools/dpdk-devbind.py -b vfio-pci 0002:01:02.2
 429
 430 The nicvf thunderx driver will make use of attached secondary VFs automatically during the interface configuration stage.
 431
 432 Limitations
 433 -----------
 434
 435 CRC striping
 436 ~~~~~~~~~~~~
 437
 438 The ThunderX SoC family NICs strip the CRC for every packets coming into the
 439 host interface. So, CRC will be stripped even when the
 440 ``rxmode.hw_strip_crc`` member is set to 0 in ``struct rte_eth_conf``.
 441
 442 Maximum packet length
 443 ~~~~~~~~~~~~~~~~~~~~~
 444
 445 The ThunderX SoC family NICs support a maximum of a 9K jumbo frame. The value
 446 is fixed and cannot be changed. So, even when the ``rxmode.max_rx_pkt_len``
 447 member of ``struct rte_eth_conf`` is set to a value lower than 9200, frames
 448 up to 9200 bytes can still reach the host interface.
 449
 450 Maximum packet segments
 451 ~~~~~~~~~~~~~~~~~~~~~~~
 452
 453 The ThunderX SoC family NICs support up to 12 segments per packet when working
 454 in scatter/gather mode. So, setting MTU will result with ``EINVAL`` when the
 455 frame size does not fit in the maximum number of segments.