doc/guides/rel_notes/release_21_08.rst

   1 .. SPDX-License-Identifier: BSD-3-Clause
   2    Copyright 2021 The DPDK contributors
   3
   4 .. include:: <isonum.txt>
   5
   6 DPDK Release 21.08
   7 ==================
   8
   9 .. **Read this first.**
  10
  11    The text in the sections below explains how to update the release notes.
  12
  13    Use proper spelling, capitalization and punctuation in all sections.
  14
  15    Variable and config names should be quoted as fixed width text:
  16    ``LIKE_THIS``.
  17
  18    Build the docs and view the output file to ensure the changes are correct::
  19
  20       make doc-guides-html
  21       xdg-open build/doc/html/guides/rel_notes/release_21_08.html
  22
  23
  24 New Features
  25 ------------
  26
  27 .. This section should contain new features added in this release.
  28    Sample format:
  29
  30    * **Add a title in the past tense with a full stop.**
  31
  32      Add a short 1-2 sentence description in the past tense.
  33      The description should be enough to allow someone scanning
  34      the release notes to understand the new feature.
  35
  36      If the feature adds a lot of sub-features you can use a bullet list
  37      like this:
  38
  39      * Added feature foo to do something.
  40      * Enhanced feature bar to do something else.
  41
  42      Refer to the previous release notes for examples.
  43
  44      Suggested order in release notes items:
  45      * Core libs (EAL, mempool, ring, mbuf, buses)
  46      * Device abstraction libs and PMDs (ordered alphabetically by vendor name)
  47        - ethdev (lib, PMDs)
  48        - cryptodev (lib, PMDs)
  49        - eventdev (lib, PMDs)
  50        - etc
  51      * Other libs
  52      * Apps, Examples, Tools (if significant)
  53
  54      This section is a comment. Do not overwrite or remove it.
  55      Also, make sure to start the actual text at the margin.
  56      =======================================================
  57
  58 * **Added auxiliary bus support.**
  59
  60   An auxiliary bus provides a way to split a function into child-devices
  61   representing sub-domains of functionality. Each auxiliary device
  62   represents a part of its parent functionality.
  63
  64 * **Added XZ compressed firmware support.**
  65
  66   Using ``rte_firmware_read`` a driver can now handle XZ compressed firmware
  67   in a transparent way, with EAL uncompressing using libarchive, if this library
  68   is available when building DPDK.
  69
  70 * **Updated Amazon ENA PMD.**
  71
  72   Updated the Amazon ENA PMD. The new driver version (v2.4.0) introduced
  73   bug fixes and improvements, including:
  74
  75   * Added Rx interrupt support.
  76   * RSS hash function key reconfiguration support.
  77
  78 * **Updated Intel iavf driver.**
  79
  80   * Added Tx QoS VF queue TC mapping.
  81   * Added FDIR and RSS for GTPoGRE, and support for filters based on GTPU TEID/QFI,
  82     outermost L3 or innermost L3/L4.
  83
  84 * **Updated Intel ice driver.**
  85
  86   * Added new RX and TX paths in the AVX2 code to use HW offload
  87     features. When the HW offload features are configured to be used, the
  88     offload paths are chosen automatically. In parallel the support for HW
  89     offload features was removed from the legacy AVX2 paths.
  90   * Added Tx QoS TC bandwidth configuration in DCF.
  91
  92 * **Added support for Marvell CN10K SoC Ethernet device.**
  93
  94   * Added net/cnxk driver which provides the support for the integrated Ethernet
  95     device.
  96
  97 * **Updated Mellanox mlx5 driver.**
  98
  99   * Added Sub-Function support based on auxiliary bus.
 100   * Added support for meter hierarchy.
 101   * Added support for metering policy actions of yellow color.
 102   * Added support for metering trTCM RFC2698 and RFC4115.
 103   * Added devargs option ``allow_duplicate_pattern``.
 104   * Added matching on IPv4 Internet Header Length (IHL).
 105   * Added support for matching on VXLAN header last 8-bits reserved field.
 106   * Optimized multi-thread flow rule insertion rate.
 107
 108 * **Updated Solarflare network PMD.**
 109
 110   Updated the Solarflare ``sfc_efx`` driver with changes including:
 111
 112   * Added COUNT action support for SN1000 NICs.
 113
 114 * **Added Wangxun ngbe PMD.**
 115
 116   Added a new PMD driver for Wangxun 1Gb Ethernet NICs.
 117   See the :doc:`../nics/ngbe` for more details.
 118
 119 * **Added inflight packets clear API in vhost library.**
 120
 121   Added an API which can clear the inflight packets submitted to
 122   the DMA engine in the vhost async data path.
 123
 124 * **Updated Intel QuickAssist crypto PMD.**
 125
 126   Added fourth generation of QuickAssist Technology(QAT) devices support.
 127   Only symmetric crypto has been currently enabled. Compression and asymmetric
 128   crypto PMD will fail to create.
 129
 130 * **Added support for Marvell CNXK crypto driver.**
 131
 132   * Added cnxk crypto PMD which provides support for an integrated
 133     crypto driver for CN9K and CN10K series of SOCs. Support for
 134     symmetric crypto algorithms was added to both the PMDs.
 135   * Added support for lookaside protocol (IPsec) offload in cn10k PMD.
 136   * Added support for asymmetric crypto operations in cn9k and cn10k PMD.
 137
 138 * **Updated Marvell OCTEON TX crypto PMD.**
 139
 140   Added support for crypto adapter ``OP_FORWARD`` mode.
 141
 142 * **Added support for Nvidia crypto device driver.**
 143
 144   Added mlx5 crypto driver to support AES-XTS cipher operations.
 145   The first device to support it is ConnectX-6.
 146
 147 * **Updated ISAL compress device PMD.**
 148
 149   The ISAL compress device PMD now supports Arm platforms.
 150
 151 * **Added Baseband PHY CNXK PMD.**
 152
 153   Added Baseband PHY PMD which allows configuration of the BPHY hardware block
 154   comprising accelerators and DSPs specifically tailored for 5G/LTE inline
 155   use cases. Configuration happens via standard rawdev enq/deq operations. See
 156   the :doc:`../rawdevs/cnxk_bphy` rawdev guide for more details on this driver.
 157
 158 * **Added support for Marvell CN10K, CN9K, event Rx/Tx adapter.**
 159
 160   * Added Rx/Tx adapter support for event/cnxk when the Ethernet device requested
 161     is net/cnxk.
 162   * Added support for event vectorization for Rx/Tx adapter.
 163
 164 * **Added cppc_cpufreq support to Power Management library.**
 165
 166   Added support for cppc_cpufreq driver which works on most arm64 platforms.
 167
 168 * **Added multi-queue support to Ethernet PMD Power Management.**
 169
 170   The experimental PMD power management API now supports managing
 171   multiple Ethernet Rx queues per lcore.
 172
 173 * **Updated testpmd to output log errors to stderr.**
 174
 175   Updated testpmd application to output log errors and warnings to stderr
 176   instead of stdout.
 177
 178
 179 API Changes
 180 -----------
 181
 182 .. This section should contain API changes. Sample format:
 183
 184    * sample: Add a short 1-2 sentence description of the API change
 185      which was announced in the previous releases and made in this release.
 186      Start with a scope label like "ethdev:".
 187      Use fixed width quotes for ``function_names`` or ``struct_names``.
 188      Use the past tense.
 189
 190    This section is a comment. Do not overwrite or remove it.
 191    Also, make sure to start the actual text at the margin.
 192    =======================================================
 193
 194 * eal: ``rte_strscpy`` sets ``rte_errno`` to ``E2BIG`` in case of string
 195   truncation.
 196
 197 * eal: ``rte_bsf32_safe`` now takes a 32-bit value for its first argument.
 198   This fixes warnings about loss of precision
 199   when used with some compilers settings.
 200
 201 * eal: ``rte_power_monitor`` and the ``rte_power_monitor_cond`` struct changed
 202   to use a callback mechanism.
 203
 204 * rte_power: The experimental PMD power management API is no longer considered
 205   to be thread safe; all Rx queues affected by the API will now need to be
 206   stopped before making any changes to the power management scheme.
 207
 208
 209 ABI Changes
 210 -----------
 211
 212 .. This section should contain ABI changes. Sample format:
 213
 214    * sample: Add a short 1-2 sentence description of the ABI change
 215      which was announced in the previous releases and made in this release.
 216      Start with a scope label like "ethdev:".
 217      Use fixed width quotes for ``function_names`` or ``struct_names``.
 218      Use the past tense.
 219
 220    This section is a comment. Do not overwrite or remove it.
 221    Also, make sure to start the actual text at the margin.
 222    =======================================================
 223
 224 * No ABI change that would break compatibility with 20.11.
 225
 226
 227 Known Issues
 228 ------------
 229
 230 .. This section should contain new known issues in this release. Sample format:
 231
 232    * **Add title in present tense with full stop.**
 233
 234      Add a short 1-2 sentence description of the known issue
 235      in the present tense. Add information on any known workarounds.
 236
 237    This section is a comment. Do not overwrite or remove it.
 238    Also, make sure to start the actual text at the margin.
 239    =======================================================
 240
 241 * **Last mbuf segment not implicitly reset.**
 242
 243   It is expected that free mbufs have their field ``nb_seg`` set to 1,
 244   so that when it is allocated, the user does not need to set its value.
 245   The mbuf free functions are responsible of resetting this field to 1
 246   before returning the mbuf to the pool.
 247
 248   When a multi-segment mbuf is freed, the field ``nb_seg`` is not reset
 249   to 1 for the last segment of the chain. On next allocation of this segment,
 250   if the field is not explicitly reset by the user,
 251   an invalid mbuf can be created, and can cause an undefined behavior.
 252
 253   This issue has a root cause in DPDK 17.05, meaning it is 4 years old.
 254   A fix is available and discussed but not merged in DPDK 21.08:
 255   https://patches.dpdk.org/patch/86458/
 256
 257
 258 Tested Platforms
 259 ----------------
 260
 261 .. This section should contain a list of platforms that were tested
 262    with this release.
 263
 264    The format is:
 265
 266    * <vendor> platform with <vendor> <type of devices> combinations
 267
 268      * List of CPU
 269      * List of OS
 270      * List of devices
 271      * Other relevant details...
 272
 273    This section is a comment. Do not overwrite or remove it.
 274    Also, make sure to start the actual text at the margin.
 275    =======================================================
 276
 277 * Intel\ |reg| platforms with Intel\ |reg| NICs combinations
 278
 279   * CPU
 280
 281     * Intel\ |reg| Atom\ |trade| CPU C3958 @ 2.00GHz
 282     * Intel\ |reg| Atom\ |trade| CPU C3758 @ 2.20GHz
 283     * Intel\ |reg| Xeon\ |reg| CPU D-1541 @ 2.10GHz
 284     * Intel\ |reg| Xeon\ |reg| CPU D-1553N @ 2.30GHz
 285     * Intel\ |reg| Xeon\ |reg| CPU E5-2680 v2 @ 2.80GHz
 286     * Intel\ |reg| Xeon\ |reg| CPU E5-2699 v3 @ 2.30GHz
 287     * Intel\ |reg| Xeon\ |reg| CPU E5-2699 v4 @ 2.20GHz
 288     * Intel\ |reg| Xeon\ |reg| Gold 6140M CPU @ 2.30GHz
 289     * Intel\ |reg| Xeon\ |reg| Gold 6139 CPU @ 2.30GHz
 290     * Intel\ |reg| Xeon\ |reg| Gold 6252N CPU @ 2.30GHz
 291     * Intel\ |reg| Xeon\ |reg| Platinum 8180 CPU @ 2.50GHz
 292     * Intel\ |reg| Xeon\ |reg| Platinum 8180M CPU @ 2.50GHz
 293     * Intel\ |reg| Xeon\ |reg| Platinum 8280M CPU @ 2.70GHz
 294
 295   * OS:
 296
 297     * Fedora 34
 298     * OpenWRT 19.07.4
 299     * FreeBSD 12.1
 300     * Red Hat Enterprise Linux Server release 8.3
 301     * Suse 15 SP2
 302     * Ubuntu 20.04
 303     * Ubuntu 21.04
 304
 305   * NICs:
 306
 307     * Intel\ |reg| Ethernet Controller E810-C for SFP (4x25G)
 308
 309       * Firmware version: 3.10
 310       * Device id (pf/vf): 8086:1593 / 8086:1889
 311       * Driver version: 1.7.0 (ice)
 312       * OS Default DDP: 1.3.27.0
 313       * COMMS DDP: 1.3.31.0
 314       * Wireless Edge DDP: 1.3.7.0
 315
 316     * Intel\ |reg| Ethernet Controller E810-C for QSFP (2x100G)
 317
 318       * Firmware version: 3.10
 319       * Device id (pf/vf): 8086:1592 / 8086:1889
 320       * Driver version: 1.7.0 (ice)
 321       * OS Default DDP: 1.3.27.0
 322       * COMMS DDP: 1.3.31.0
 323       * Wireless Edge DDP: 1.3.7.0
 324
 325     * Intel\ |reg| 82599ES 10 Gigabit Ethernet Controller
 326
 327       * Firmware version: 0x61bf0001
 328       * Device id (pf/vf): 8086:10fb / 8086:10ed
 329       * Driver version: 5.1.0-k (ixgbe)
 330
 331     * Intel\ |reg| Corporation Ethernet Connection X552/X557-AT 10GBASE-T
 332
 333       * Firmware version: 0x800003e7
 334       * Device id (pf/vf): 8086:15ad / 8086:15a8
 335       * Driver version: 5.1.0-k (ixgbe)
 336
 337     * Intel\ |reg| Corporation Ethernet Controller 10G X550T
 338
 339       * Firmware version: 0x8000113b
 340       * Device id (pf): 8086:1563
 341       * Driver version: 5.11.3 (ixgbe)
 342
 343     * Intel\ |reg| Ethernet Controller 10-Gigabit X540-AT2
 344
 345       * Firmware version: 0x800005f9
 346       * Device id (pf): 8086:1528
 347       * Driver version: 4.18.0-305.7.1.el8_4.x86_64 (ixgbe)
 348
 349     * Intel\ |reg| Ethernet Converged Network Adapter X710-DA4 (4x10G)
 350
 351       * Firmware version: 8.30 0x8000a49d 1.2926.0
 352       * Device id (pf/vf): 8086:1572 / 8086:154c
 353       * Driver version: 2.15.9 (i40e)
 354
 355     * Intel\ |reg| Corporation Ethernet Connection X722 for 10GbE SFP+ (4x10G)
 356
 357       * Firmware version: 5.30 0x80002a29 1.2926.0
 358       * Device id (pf/vf): 8086:37d0 / 8086:37cd
 359       * Driver version: 2.15.9 (i40e)
 360
 361     * Intel\ |reg| Corporation Ethernet Connection X722 for 10GBASE-T (2x10G)
 362
 363       * Firmware version: 4.10 0x80001a7a 1.2154.0
 364       * Device id (pf/vf): 8086:37d2 / 8086:37cd
 365       * Driver version: 2.15.9 (i40e)
 366
 367     * Intel\ |reg| Ethernet Converged Network Adapter XXV710-DA2 (2x25G)
 368
 369       * Firmware version: 8.30 0x8000a485 1.2926.0
 370       * Device id (pf/vf): 8086:158b / 8086:154c
 371       * Driver version: 2.15.9 (i40e)
 372
 373     * Intel\ |reg| Ethernet Converged Network Adapter XL710-QDA2 (2X40G)
 374
 375       * Firmware version: 8.30 0x8000a4ae 1.2926.0
 376       * Device id (pf/vf): 8086:1583 / 8086:154c
 377       * Driver version: 2.15.9 (i40e)
 378
 379     * Intel\ |reg| Ethernet Converged Network Adapter X710-T2L
 380
 381       * Firmware version: 8.30 0x8000a489 1.2926.0
 382       * Device id (pf): 8086:15ff
 383       * Driver version: 2.15.9 (i40e)
 384
 385 * Intel\ |reg| platforms with Mellanox\ |reg| NICs combinations
 386
 387   * CPU:
 388
 389     * Intel\ |reg| Xeon\ |reg| Gold 6154 CPU @ 3.00GHz
 390     * Intel\ |reg| Xeon\ |reg| CPU E5-2697A v4 @ 2.60GHz
 391     * Intel\ |reg| Xeon\ |reg| CPU E5-2697 v3 @ 2.60GHz
 392     * Intel\ |reg| Xeon\ |reg| CPU E5-2680 v2 @ 2.80GHz
 393     * Intel\ |reg| Xeon\ |reg| CPU E5-2670 0 @ 2.60GHz
 394     * Intel\ |reg| Xeon\ |reg| CPU E5-2650 v4 @ 2.20GHz
 395     * Intel\ |reg| Xeon\ |reg| CPU E5-2650 v3 @ 2.30GHz
 396     * Intel\ |reg| Xeon\ |reg| CPU E5-2640 @ 2.50GHz
 397     * Intel\ |reg| Xeon\ |reg| CPU E5-2650 0 @ 2.00GHz
 398     * Intel\ |reg| Xeon\ |reg| CPU E5-2620 v4 @ 2.10GHz
 399
 400   * OS:
 401
 402     * Red Hat Enterprise Linux release 8.2 (Ootpa)
 403     * Red Hat Enterprise Linux Server release 7.8 (Maipo)
 404     * Red Hat Enterprise Linux Server release 7.6 (Maipo)
 405     * Red Hat Enterprise Linux Server release 7.5 (Maipo)
 406     * Red Hat Enterprise Linux Server release 7.4 (Maipo)
 407     * Red Hat Enterprise Linux Server release 7.3 (Maipo)
 408     * Red Hat Enterprise Linux Server release 7.2 (Maipo)
 409     * Ubuntu 20.04
 410     * Ubuntu 18.04
 411     * Ubuntu 16.04
 412     * SUSE Enterprise Linux 15 SP2
 413     * SUSE Enterprise Linux 12 SP4
 414
 415   * OFED:
 416
 417     * MLNX_OFED 5.4-1.0.3.0 and above
 418     * MLNX_OFED 5.3-1.0.0.1
 419
 420   * upstream kernel:
 421
 422     * Linux 5.14.0-rc3 and above
 423
 424   * rdma-core:
 425
 426     * rdma-core-36.0 and above
 427
 428   * NICs:
 429
 430     * Mellanox\ |reg| ConnectX\ |reg|-3 Pro 40G MCX354A-FCC_Ax (2x40G)
 431
 432       * Host interface: PCI Express 3.0 x8
 433       * Device ID: 15b3:1007
 434       * Firmware version: 2.42.5000
 435
 436     * Mellanox\ |reg| ConnectX\ |reg|-3 Pro 40G MCX354A-FCCT (2x40G)
 437
 438       * Host interface: PCI Express 3.0 x8
 439       * Device ID: 15b3:1007
 440       * Firmware version: 2.42.5000
 441
 442     * Mellanox\ |reg| ConnectX\ |reg|-4 Lx 25G MCX4121A-ACAT (2x25G)
 443
 444       * Host interface: PCI Express 3.0 x8
 445       * Device ID: 15b3:1015
 446       * Firmware version: 14.31.1014 and above
 447
 448     * Mellanox\ |reg| ConnectX\ |reg|-4 Lx 50G MCX4131A-GCAT (1x50G)
 449
 450       * Host interface: PCI Express 3.0 x8
 451       * Device ID: 15b3:1015
 452       * Firmware version: 14.31.1014 and above
 453
 454     * Mellanox\ |reg| ConnectX\ |reg|-5 100G MCX516A-CCAT (2x100G)
 455
 456       * Host interface: PCI Express 3.0 x16
 457       * Device ID: 15b3:1017
 458       * Firmware version: 16.31.1014 and above
 459
 460     * Mellanox\ |reg| ConnectX\ |reg|-5 100G MCX556A-ECAT (2x100G)
 461
 462       * Host interface: PCI Express 3.0 x16
 463       * Device ID: 15b3:1017
 464       * Firmware version: 16.31.1014 and above
 465
 466     * Mellanox\ |reg| ConnectX\ |reg|-5 100G MCX556A-EDAT (2x100G)
 467
 468       * Host interface: PCI Express 3.0 x16
 469       * Device ID: 15b3:1017
 470       * Firmware version: 16.31.1014 and above
 471
 472     * Mellanox\ |reg| ConnectX\ |reg|-5 Ex EN 100G MCX516A-CDAT (2x100G)
 473
 474       * Host interface: PCI Express 4.0 x16
 475       * Device ID: 15b3:1019
 476       * Firmware version: 16.31.1014 and above
 477
 478     * Mellanox\ |reg| ConnectX\ |reg|-6 Dx EN 100G MCX623106AN-CDAT (2x100G)
 479
 480       * Host interface: PCI Express 4.0 x16
 481       * Device ID: 15b3:101d
 482       * Firmware version: 22.31.1014 and above
 483
 484     * Mellanox\ |reg| ConnectX\ |reg|-6 Lx EN 25G MCX631102AN-ADAT (2x25G)
 485
 486       * Host interface: PCI Express 4.0 x8
 487       * Device ID: 15b3:101f
 488       * Firmware version: 26.31.1014 and above
 489
 490 * Mellanox\ |reg| BlueField\ |reg| SmartNIC
 491
 492   * Mellanox\ |reg| BlueField\ |reg| 2 SmartNIC MT41686 - MBF2H332A-AEEOT_A1 (2x25G)
 493
 494     * Host interface: PCI Express 3.0 x16
 495     * Device ID: 15b3:a2d6
 496     * Firmware version: 24.31.1014 and above
 497
 498   * Embedded software:
 499
 500     * CentOS Linux release 7.6.1810 (AltArch)
 501     * MLNX_OFED 5.4-1.0.3.0 and above
 502     * DPDK application running on Arm cores