doc/guides/nics/i40e.rst

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