doc/guides/nics/i40e.rst

   1 ..  BSD LICENSE
   2     Copyright(c) 2016 Intel Corporation. All rights reserved.
   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 Intel Corporation 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 I40E Poll Mode Driver
  32 ======================
  33
  34 The I40E PMD (librte_pmd_i40e) provides poll mode driver support
  35 for the Intel X710/XL710/X722 10/40 Gbps family of adapters.
  36
  37
  38 Features
  39 --------
  40
  41 Features of the I40E PMD are:
  42
  43 - Multiple queues for TX and RX
  44 - Receiver Side Scaling (RSS)
  45 - MAC/VLAN filtering
  46 - Packet type information
  47 - Flow director
  48 - Cloud filter
  49 - Checksum offload
  50 - VLAN/QinQ stripping and inserting
  51 - TSO offload
  52 - Promiscuous mode
  53 - Multicast mode
  54 - Port hardware statistics
  55 - Jumbo frames
  56 - Link state information
  57 - Link flow control
  58 - Mirror on port, VLAN and VSI
  59 - Interrupt mode for RX
  60 - Scattered and gather for TX and RX
  61 - Vector Poll mode driver
  62 - DCB
  63 - VMDQ
  64 - SR-IOV VF
  65 - Hot plug
  66 - IEEE1588/802.1AS timestamping
  67 - VF Daemon (VFD) - EXPERIMENTAL
  68 - Dynamic Device Personalization (DDP)
  69 - Queue region configuration
  70
  71 Prerequisites
  72 -------------
  73
  74 - Identifying your adapter using `Intel Support
  75   <http://www.intel.com/support>`_ and get the latest NVM/FW images.
  76
  77 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
  78
  79 - To get better performance on Intel platforms, please follow the "How to get best performance with NICs on Intel platforms"
  80   section of the :ref:`Getting Started Guide for Linux <linux_gsg>`.
  81
  82 - Upgrade the NVM/FW version following the `Intel® Ethernet NVM Update Tool Quick Usage Guide for Linux
  83   <https://www-ssl.intel.com/content/www/us/en/embedded/products/networking/nvm-update-tool-quick-linux-usage-guide.html>`_ if needed.
  84
  85 Pre-Installation Configuration
  86 ------------------------------
  87
  88 Config File Options
  89 ~~~~~~~~~~~~~~~~~~~
  90
  91 The following options can be modified in the ``config`` file.
  92 Please note that enabling debugging options may affect system performance.
  93
  94 - ``CONFIG_RTE_LIBRTE_I40E_PMD`` (default ``y``)
  95
  96   Toggle compilation of the ``librte_pmd_i40e`` driver.
  97
  98 - ``CONFIG_RTE_LIBRTE_I40E_DEBUG_*`` (default ``n``)
  99
 100   Toggle display of generic debugging messages.
 101
 102 - ``CONFIG_RTE_LIBRTE_I40E_RX_ALLOW_BULK_ALLOC`` (default ``y``)
 103
 104   Toggle bulk allocation for RX.
 105
 106 - ``CONFIG_RTE_LIBRTE_I40E_INC_VECTOR`` (default ``n``)
 107
 108   Toggle the use of Vector PMD instead of normal RX/TX path.
 109   To enable vPMD for RX, bulk allocation for Rx must be allowed.
 110
 111 - ``CONFIG_RTE_LIBRTE_I40E_16BYTE_RX_DESC`` (default ``n``)
 112
 113   Toggle to use a 16-byte RX descriptor, by default the RX descriptor is 32 byte.
 114
 115 - ``CONFIG_RTE_LIBRTE_I40E_QUEUE_NUM_PER_PF`` (default ``64``)
 116
 117   Number of queues reserved for PF.
 118
 119 - ``CONFIG_RTE_LIBRTE_I40E_QUEUE_NUM_PER_VM`` (default ``4``)
 120
 121   Number of queues reserved for each VMDQ Pool.
 122
 123 - ``CONFIG_RTE_LIBRTE_I40E_ITR_INTERVAL`` (default ``-1``)
 124
 125   Interrupt Throttling interval.
 126
 127
 128 Runtime Config Options
 129 ~~~~~~~~~~~~~~~~~~~~~~
 130
 131 - ``Number of Queues per VF`` (default ``4``)
 132
 133   The number of queue per VF is determined by its host PF. If the PCI address
 134   of an i40e PF is aaaa:bb.cc, the number of queues per VF can be configured
 135   with EAL parameter like -w aaaa:bb.cc,queue-num-per-vf=n. The value n can be
 136   1, 2, 4, 8 or 16. If no such parameter is configured, the number of queues
 137   per VF is 4 by default.
 138
 139
 140 Driver compilation and testing
 141 ------------------------------
 142
 143 Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
 144 for details.
 145
 146
 147 SR-IOV: Prerequisites and sample Application Notes
 148 --------------------------------------------------
 149
 150 #. Load the kernel module:
 151
 152    .. code-block:: console
 153
 154       modprobe i40e
 155
 156    Check the output in dmesg:
 157
 158    .. code-block:: console
 159
 160       i40e 0000:83:00.1 ens802f0: renamed from eth0
 161
 162 #. Bring up the PF ports:
 163
 164    .. code-block:: console
 165
 166       ifconfig ens802f0 up
 167
 168 #. Create VF device(s):
 169
 170    Echo the number of VFs to be created into the ``sriov_numvfs`` sysfs entry
 171    of the parent PF.
 172
 173    Example:
 174
 175    .. code-block:: console
 176
 177       echo 2 > /sys/devices/pci0000:00/0000:00:03.0/0000:81:00.0/sriov_numvfs
 178
 179
 180 #. Assign VF MAC address:
 181
 182    Assign MAC address to the VF using iproute2 utility. The syntax is:
 183
 184    .. code-block:: console
 185
 186       ip link set <PF netdev id> vf <VF id> mac <macaddr>
 187
 188    Example:
 189
 190    .. code-block:: console
 191
 192       ip link set ens802f0 vf 0 mac a0:b0:c0:d0:e0:f0
 193
 194 #. Assign VF to VM, and bring up the VM.
 195    Please see the documentation for the *I40E/IXGBE/IGB Virtual Function Driver*.
 196
 197 #. Running testpmd:
 198
 199    Follow instructions available in the document
 200    :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
 201    to run testpmd.
 202
 203    Example output:
 204
 205    .. code-block:: console
 206
 207       ...
 208       EAL: PCI device 0000:83:00.0 on NUMA socket 1
 209       EAL: probe driver: 8086:1572 rte_i40e_pmd
 210       EAL: PCI memory mapped at 0x7f7f80000000
 211       EAL: PCI memory mapped at 0x7f7f80800000
 212       PMD: eth_i40e_dev_init(): FW 5.0 API 1.5 NVM 05.00.02 eetrack 8000208a
 213       Interactive-mode selected
 214       Configuring Port 0 (socket 0)
 215       ...
 216
 217       PMD: i40e_dev_rx_queue_setup(): Rx Burst Bulk Alloc Preconditions are
 218       satisfied.Rx Burst Bulk Alloc function will be used on port=0, queue=0.
 219
 220       ...
 221       Port 0: 68:05:CA:26:85:84
 222       Checking link statuses...
 223       Port 0 Link Up - speed 10000 Mbps - full-duplex
 224       Done
 225
 226       testpmd>
 227
 228
 229 Sample Application Notes
 230 ------------------------
 231
 232 Vlan filter
 233 ~~~~~~~~~~~
 234
 235 Vlan filter only works when Promiscuous mode is off.
 236
 237 To start ``testpmd``, and add vlan 10 to port 0:
 238
 239 .. code-block:: console
 240
 241     ./app/testpmd -l 0-15 -n 4 -- -i --forward-mode=mac
 242     ...
 243
 244     testpmd> set promisc 0 off
 245     testpmd> rx_vlan add 10 0
 246
 247
 248 Flow Director
 249 ~~~~~~~~~~~~~
 250
 251 The Flow Director works in receive mode to identify specific flows or sets of flows and route them to specific queues.
 252 The Flow Director filters can match the different fields for different type of packet: flow type, specific input set per flow type and the flexible payload.
 253
 254 The default input set of each flow type is::
 255
 256    ipv4-other : src_ip_address, dst_ip_address
 257    ipv4-frag  : src_ip_address, dst_ip_address
 258    ipv4-tcp   : src_ip_address, dst_ip_address, src_port, dst_port
 259    ipv4-udp   : src_ip_address, dst_ip_address, src_port, dst_port
 260    ipv4-sctp  : src_ip_address, dst_ip_address, src_port, dst_port,
 261                 verification_tag
 262    ipv6-other : src_ip_address, dst_ip_address
 263    ipv6-frag  : src_ip_address, dst_ip_address
 264    ipv6-tcp   : src_ip_address, dst_ip_address, src_port, dst_port
 265    ipv6-udp   : src_ip_address, dst_ip_address, src_port, dst_port
 266    ipv6-sctp  : src_ip_address, dst_ip_address, src_port, dst_port,
 267                 verification_tag
 268    l2_payload : ether_type
 269
 270 The flex payload is selected from offset 0 to 15 of packet's payload by default, while it is masked out from matching.
 271
 272 Start ``testpmd`` with ``--disable-rss`` and ``--pkt-filter-mode=perfect``:
 273
 274 .. code-block:: console
 275
 276    ./app/testpmd -l 0-15 -n 4 -- -i --disable-rss --pkt-filter-mode=perfect \
 277                  --rxq=8 --txq=8 --nb-cores=8 --nb-ports=1
 278
 279 Add a rule to direct ``ipv4-udp`` packet whose ``dst_ip=2.2.2.5, src_ip=2.2.2.3, src_port=32, dst_port=32`` to queue 1:
 280
 281 .. code-block:: console
 282
 283    testpmd> flow_director_filter 0 mode IP add flow ipv4-udp  \
 284             src 2.2.2.3 32 dst 2.2.2.5 32 vlan 0 flexbytes () \
 285             fwd pf queue 1 fd_id 1
 286
 287 Check the flow director status:
 288
 289 .. code-block:: console
 290
 291    testpmd> show port fdir 0
 292
 293    ######################## FDIR infos for port 0      ####################
 294      MODE:   PERFECT
 295      SUPPORTED FLOW TYPE:  ipv4-frag ipv4-tcp ipv4-udp ipv4-sctp ipv4-other
 296                            ipv6-frag ipv6-tcp ipv6-udp ipv6-sctp ipv6-other
 297                            l2_payload
 298      FLEX PAYLOAD INFO:
 299      max_len:       16          payload_limit: 480
 300      payload_unit:  2           payload_seg:   3
 301      bitmask_unit:  2           bitmask_num:   2
 302      MASK:
 303        vlan_tci: 0x0000,
 304        src_ipv4: 0x00000000,
 305        dst_ipv4: 0x00000000,
 306        src_port: 0x0000,
 307        dst_port: 0x0000
 308        src_ipv6: 0x00000000,0x00000000,0x00000000,0x00000000,
 309        dst_ipv6: 0x00000000,0x00000000,0x00000000,0x00000000
 310      FLEX PAYLOAD SRC OFFSET:
 311        L2_PAYLOAD:    0      1      2      3      4      5      6  ...
 312        L3_PAYLOAD:    0      1      2      3      4      5      6  ...
 313        L4_PAYLOAD:    0      1      2      3      4      5      6  ...
 314      FLEX MASK CFG:
 315        ipv4-udp:    00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
 316        ipv4-tcp:    00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
 317        ipv4-sctp:   00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
 318        ipv4-other:  00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
 319        ipv4-frag:   00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
 320        ipv6-udp:    00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
 321        ipv6-tcp:    00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
 322        ipv6-sctp:   00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
 323        ipv6-other:  00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
 324        ipv6-frag:   00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
 325        l2_payload:  00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
 326      guarant_count: 1           best_count:    0
 327      guarant_space: 512         best_space:    7168
 328      collision:     0           free:          0
 329      maxhash:       0           maxlen:        0
 330      add:           0           remove:        0
 331      f_add:         0           f_remove:      0
 332
 333
 334 Delete all flow director rules on a port:
 335
 336 .. code-block:: console
 337
 338    testpmd> flush_flow_director 0
 339
 340 Floating VEB
 341 ~~~~~~~~~~~~~
 342
 343 The Intel® Ethernet Controller X710 and XL710 Family support a feature called
 344 "Floating VEB".
 345
 346 A Virtual Ethernet Bridge (VEB) is an IEEE Edge Virtual Bridging (EVB) term
 347 for functionality that allows local switching between virtual endpoints within
 348 a physical endpoint and also with an external bridge/network.
 349
 350 A "Floating" VEB doesn't have an uplink connection to the outside world so all
 351 switching is done internally and remains within the host. As such, this
 352 feature provides security benefits.
 353
 354 In addition, a Floating VEB overcomes a limitation of normal VEBs where they
 355 cannot forward packets when the physical link is down. Floating VEBs don't need
 356 to connect to the NIC port so they can still forward traffic from VF to VF
 357 even when the physical link is down.
 358
 359 Therefore, with this feature enabled VFs can be limited to communicating with
 360 each other but not an outside network, and they can do so even when there is
 361 no physical uplink on the associated NIC port.
 362
 363 To enable this feature, the user should pass a ``devargs`` parameter to the
 364 EAL, for example::
 365
 366     -w 84:00.0,enable_floating_veb=1
 367
 368 In this configuration the PMD will use the floating VEB feature for all the
 369 VFs created by this PF device.
 370
 371 Alternatively, the user can specify which VFs need to connect to this floating
 372 VEB using the ``floating_veb_list`` argument::
 373
 374     -w 84:00.0,enable_floating_veb=1,floating_veb_list=1;3-4
 375
 376 In this example ``VF1``, ``VF3`` and ``VF4`` connect to the floating VEB,
 377 while other VFs connect to the normal VEB.
 378
 379 The current implementation only supports one floating VEB and one regular
 380 VEB. VFs can connect to a floating VEB or a regular VEB according to the
 381 configuration passed on the EAL command line.
 382
 383 The floating VEB functionality requires a NIC firmware version of 5.0
 384 or greater.
 385
 386 Dynamic Device Personalization (DDP)
 387 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 388
 389 The Intel® Ethernet Controller X*710 support a feature called "Dynamic Device
 390 Personalization (DDP)", which is used to configure hardware by downloading
 391 a profile to support protocols/filters which are not supported by default.
 392 The DDP functionality requires a NIC firmware version of 6.0 or greater.
 393
 394 Current implementation supports MPLSoUDP/MPLSoGRE/GTP-C/GTP-U/PPPoE/PPPoL2TP,
 395 steering can be used with rte_flow API.
 396
 397 Load a profile which supports MPLSoUDP/MPLSoGRE and store backup profile:
 398
 399 .. code-block:: console
 400
 401    testpmd> ddp add 0 ./mpls.pkgo,./backup.pkgo
 402
 403 Delete a MPLS profile and restore backup profile:
 404
 405 .. code-block:: console
 406
 407    testpmd> ddp del 0 ./backup.pkgo
 408
 409 Get loaded DDP package info list:
 410
 411 .. code-block:: console
 412
 413    testpmd> ddp get list 0
 414
 415 Display information about a MPLS profile:
 416
 417 .. code-block:: console
 418
 419    testpmd> ddp get info ./mpls.pkgo
 420
 421 Input set configuration
 422 ~~~~~~~~~~~~~~~~~~~~~~~
 423 Input set for any PCTYPE can be configured with user defined configuration,
 424 For example, to use only 48bit prefix for IPv6 src address for IPv6 TCP RSS:
 425
 426 .. code-block:: console
 427
 428    testpmd> port config 0 pctype 43 hash_inset clear all
 429    testpmd> port config 0 pctype 43 hash_inset set field 13
 430    testpmd> port config 0 pctype 43 hash_inset set field 14
 431    testpmd> port config 0 pctype 43 hash_inset set field 15
 432
 433 Queue region configuration
 434 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 435 The Ethernet Controller X710/XL710 supports a feature of queue regions
 436 configuration for RSS in the PF, so that different traffic classes or
 437 different packet classification types can be separated to different
 438 queues in different queue regions. There is an API for configuration
 439 of queue regions in RSS with a command line. It can parse the parameters
 440 of the region index, queue number, queue start index, user priority, traffic
 441 classes and so on. Depending on commands from the command line, it will call
 442 i40e private APIs and start the process of setting or flushing the queue
 443 region configuration. As this feature is specific for i40e only private
 444 APIs are used. These new ``test_pmd`` commands are as shown below. For
 445 details please refer to :doc:`../testpmd_app_ug/index`.
 446
 447 .. code-block:: console
 448
 449    testpmd> set port (port_id) queue-region region_id (value) \
 450                 queue_start_index (value) queue_num (value)
 451    testpmd> set port (port_id) queue-region region_id (value) flowtype (value)
 452    testpmd> set port (port_id) queue-region UP (value) region_id (value)
 453    testpmd> set port (port_id) queue-region flush (on|off)
 454    testpmd> show port (port_id) queue-region
 455
 456 Limitations or Known issues
 457 ---------------------------
 458
 459 MPLS packet classification on X710/XL710
 460 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 461
 462 For firmware versions prior to 5.0, MPLS packets are not recognized by the NIC.
 463 The L2 Payload flow type in flow director can be used to classify MPLS packet
 464 by using a command in testpmd like:
 465
 466    testpmd> flow_director_filter 0 mode IP add flow l2_payload ether \
 467             0x8847 flexbytes () fwd pf queue <N> fd_id <M>
 468
 469 With the NIC firmware version 5.0 or greater, some limited MPLS support
 470 is added: Native MPLS (MPLS in Ethernet) skip is implemented, while no
 471 new packet type, no classification or offload are possible. With this change,
 472 L2 Payload flow type in flow director cannot be used to classify MPLS packet
 473 as with previous firmware versions. Meanwhile, the Ethertype filter can be
 474 used to classify MPLS packet by using a command in testpmd like:
 475
 476    testpmd> ethertype_filter 0 add mac_ignr 00:00:00:00:00:00 ethertype \
 477             0x8847 fwd queue <M>
 478
 479 16 Byte RX Descriptor setting on DPDK VF
 480 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 481
 482 Currently the VF's RX descriptor mode is decided by PF. There's no PF-VF
 483 interface for VF to request the RX descriptor mode, also no interface to notify
 484 VF its own RX descriptor mode.
 485 For all available versions of the i40e driver, these drivers don't support 16
 486 byte RX descriptor. If the Linux i40e kernel driver is used as host driver,
 487 while DPDK i40e PMD is used as the VF driver, DPDK cannot choose 16 byte receive
 488 descriptor. The reason is that the RX descriptor is already set to 32 byte by
 489 the i40e kernel driver. That is to say, user should keep
 490 ``CONFIG_RTE_LIBRTE_I40E_16BYTE_RX_DESC=n`` in config file.
 491 In the future, if the Linux i40e driver supports 16 byte RX descriptor, user
 492 should make sure the DPDK VF uses the same RX descriptor mode, 16 byte or 32
 493 byte, as the PF driver.
 494
 495 The same rule for DPDK PF + DPDK VF. The PF and VF should use the same RX
 496 descriptor mode. Or the VF RX will not work.
 497
 498 Receive packets with Ethertype 0x88A8
 499 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 500
 501 Due to the FW limitation, PF can receive packets with Ethertype 0x88A8
 502 only when floating VEB is disabled.
 503
 504 Incorrect Rx statistics when packet is oversize
 505 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 506
 507 When a packet is over maximum frame size, the packet is dropped.
 508 However the Rx statistics, when calling `rte_eth_stats_get` incorrectly
 509 shows it as received.
 510
 511 VF & TC max bandwidth setting
 512 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 513
 514 The per VF max bandwidth and per TC max bandwidth cannot be enabled in parallel.
 515 The dehavior is different when handling per VF and per TC max bandwidth setting.
 516 When enabling per VF max bandwidth, SW will check if per TC max bandwidth is
 517 enabled. If so, return failure.
 518 When enabling per TC max bandwidth, SW will check if per VF max bandwidth
 519 is enabled. If so, disable per VF max bandwidth and continue with per TC max
 520 bandwidth setting.
 521
 522 TC TX scheduling mode setting
 523 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 524
 525 There're 2 TX scheduling modes for TCs, round robin and strict priority mode.
 526 If a TC is set to strict priority mode, it can consume unlimited bandwidth.
 527 It means if APP has set the max bandwidth for that TC, it comes to no
 528 effect.
 529 It's suggested to set the strict priority mode for a TC that is latency
 530 sensitive but no consuming much bandwidth.
 531
 532 VF performance is impacted by PCI extended tag setting
 533 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 534
 535 To reach maximum NIC performance in the VF the PCI extended tag must be
 536 enabled. The DPDK I40E PF driver will set this feature during initialization,
 537 but the kernel PF driver does not. So when running traffic on a VF which is
 538 managed by the kernel PF driver, a significant NIC performance downgrade has
 539 been observed (for 64 byte packets, there is about 25% linerate downgrade for
 540 a 25G device and about 35% for a 40G device).
 541
 542 For kernel version >= 4.11, the kernel's PCI driver will enable the extended
 543 tag if it detects that the device supports it. So by default, this is not an
 544 issue. For kernels <= 4.11 or when the PCI extended tag is disabled it can be
 545 enabled using the steps below.
 546
 547 #. Get the current value of the PCI configure register::
 548
 549       setpci -s <XX:XX.X> a8.w
 550
 551 #. Set bit 8::
 552
 553       value = value | 0x100
 554
 555 #. Set the PCI configure register with new value::
 556
 557       setpci -s <XX:XX.X> a8.w=<value>
 558
 559 Vlan strip of VF
 560 ~~~~~~~~~~~~~~~~
 561
 562 The VF vlan strip function is only supported in the i40e kernel driver >= 2.1.26.
 563
 564 DCB function
 565 ~~~~~~~~~~~~
 566
 567 DCB works only when RSS is enabled.
 568
 569 Global configuration warning
 570 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 571
 572 I40E PMD will set some global registers to enable some function or set some
 573 configure. Then when using different ports of the same NIC with Linux kernel
 574 and DPDK, the port with Linux kernel will be impacted by the port with DPDK.
 575 For example, register I40E_GL_SWT_L2TAGCTRL is used to control L2 tag, i40e
 576 PMD uses I40E_GL_SWT_L2TAGCTRL to set vlan TPID. If setting TPID in port A
 577 with DPDK, then the configuration will also impact port B in the NIC with
 578 kernel driver, which don't want to use the TPID.
 579 So PMD reports warning to clarify what is changed by writing global register.
 580
 581 High Performance of Small Packets on 40G NIC
 582 --------------------------------------------
 583
 584 As there might be firmware fixes for performance enhancement in latest version
 585 of firmware image, the firmware update might be needed for getting high performance.
 586 Check with the local Intel's Network Division application engineers for firmware updates.
 587 Users should consult the release notes specific to a DPDK release to identify
 588 the validated firmware version for a NIC using the i40e driver.
 589
 590 Use 16 Bytes RX Descriptor Size
 591 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 592
 593 As i40e PMD supports both 16 and 32 bytes RX descriptor sizes, and 16 bytes size can provide helps to high performance of small packets.
 594 Configuration of ``CONFIG_RTE_LIBRTE_I40E_16BYTE_RX_DESC`` in config files can be changed to use 16 bytes size RX descriptors.
 595
 596 High Performance and per Packet Latency Tradeoff
 597 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 598
 599 Due to the hardware design, the interrupt signal inside NIC is needed for per
 600 packet descriptor write-back. The minimum interval of interrupts could be set
 601 at compile time by ``CONFIG_RTE_LIBRTE_I40E_ITR_INTERVAL`` in configuration files.
 602 Though there is a default configuration, the interval could be tuned by the
 603 users with that configuration item depends on what the user cares about more,
 604 performance or per packet latency.
 605
 606 Example of getting best performance with l3fwd example
 607 ------------------------------------------------------
 608
 609 The following is an example of running the DPDK ``l3fwd`` sample application to get high performance with an
 610 Intel server platform and Intel XL710 NICs.
 611
 612 The example scenario is to get best performance with two Intel XL710 40GbE ports.
 613 See :numref:`figure_intel_perf_test_setup` for the performance test setup.
 614
 615 .. _figure_intel_perf_test_setup:
 616
 617 .. figure:: img/intel_perf_test_setup.*
 618
 619    Performance Test Setup
 620
 621
 622 1. Add two Intel XL710 NICs to the platform, and use one port per card to get best performance.
 623    The reason for using two NICs is to overcome a PCIe Gen3's limitation since it cannot provide 80G bandwidth
 624    for two 40G ports, but two different PCIe Gen3 x8 slot can.
 625    Refer to the sample NICs output above, then we can select ``82:00.0`` and ``85:00.0`` as test ports::
 626
 627       82:00.0 Ethernet [0200]: Intel XL710 for 40GbE QSFP+ [8086:1583]
 628       85:00.0 Ethernet [0200]: Intel XL710 for 40GbE QSFP+ [8086:1583]
 629
 630 2. Connect the ports to the traffic generator. For high speed testing, it's best to use a hardware traffic generator.
 631
 632 3. Check the PCI devices numa node (socket id) and get the cores number on the exact socket id.
 633    In this case, ``82:00.0`` and ``85:00.0`` are both in socket 1, and the cores on socket 1 in the referenced platform
 634    are 18-35 and 54-71.
 635    Note: Don't use 2 logical cores on the same core (e.g core18 has 2 logical cores, core18 and core54), instead, use 2 logical
 636    cores from different cores (e.g core18 and core19).
 637
 638 4. Bind these two ports to igb_uio.
 639
 640 5. As to XL710 40G port, we need at least two queue pairs to achieve best performance, then two queues per port
 641    will be required, and each queue pair will need a dedicated CPU core for receiving/transmitting packets.
 642
 643 6. The DPDK sample application ``l3fwd`` will be used for performance testing, with using two ports for bi-directional forwarding.
 644    Compile the ``l3fwd sample`` with the default lpm mode.
 645
 646 7. The command line of running l3fwd would be something like the following::
 647
 648       ./l3fwd -l 18-21 -n 4 -w 82:00.0 -w 85:00.0 \
 649               -- -p 0x3 --config '(0,0,18),(0,1,19),(1,0,20),(1,1,21)'
 650
 651    This means that the application uses core 18 for port 0, queue pair 0 forwarding, core 19 for port 0, queue pair 1 forwarding,
 652    core 20 for port 1, queue pair 0 forwarding, and core 21 for port 1, queue pair 1 forwarding.
 653
 654 8. Configure the traffic at a traffic generator.
 655
 656    * Start creating a stream on packet generator.
 657
 658    * Set the Ethernet II type to 0x0800.