doc/guides/rel_notes/release_20_02.rst

   1 .. SPDX-License-Identifier: BSD-3-Clause
   2    Copyright 2019 The DPDK contributors
   3
   4 .. include:: <isonum.txt>
   5
   6 DPDK Release 20.02
   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
  22       xdg-open build/doc/html/guides/rel_notes/release_20_02.html
  23
  24
  25 New Features
  26 ------------
  27
  28 .. This section should contain new features added in this release.
  29    Sample format:
  30
  31    * **Add a title in the past tense with a full stop.**
  32
  33      Add a short 1-2 sentence description in the past tense.
  34      The description should be enough to allow someone scanning
  35      the release notes to understand the new feature.
  36
  37      If the feature adds a lot of sub-features you can use a bullet list
  38      like this:
  39
  40      * Added feature foo to do something.
  41      * Enhanced feature bar to do something else.
  42
  43      Refer to the previous release notes for examples.
  44
  45      Suggested order in release notes items:
  46      * Core libs (EAL, mempool, ring, mbuf, buses)
  47      * Device abstraction libs and PMDs
  48        - ethdev (lib, PMDs)
  49        - cryptodev (lib, PMDs)
  50        - eventdev (lib, PMDs)
  51        - etc
  52      * Other libs
  53      * Apps, Examples, Tools (if significant)
  54
  55      This section is a comment. Do not overwrite or remove it.
  56      Also, make sure to start the actual text at the margin.
  57      =========================================================
  58
  59 * **Added Wait Until Equal API.**
  60
  61   A new API has been added to wait for a memory location to be updated with a
  62   16-bit, 32-bit, 64-bit value.
  63
  64 * **Added rte_ring_xxx_elem APIs.**
  65
  66   New APIs have been added to support rings with custom element size.
  67
  68 * **Added mbuf pool with pinned external memory.**
  69
  70   Added support of mbuf with data buffer allocated in an external device memory.
  71
  72 * **Updated rte_flow api to support L2TPv3 over IP flows.**
  73
  74   Added support for new flow item to handle L2TPv3 over IP rte_flow patterns.
  75
  76 * **Added DSCP rewrite action.**
  77
  78   New actions ``RTE_FLOW_ACTION_TYPE_SET_IPV[4/6]_DSCP`` have been added
  79   to support rewrite the DSCP field in the IP header.
  80
  81 * **Added IONIC net PMD.**
  82
  83   Added the new ``ionic`` net driver for Pensando Ethernet Network Adapters.
  84   See the :doc:`../nics/ionic` NIC guide for more details on this new driver.
  85
  86 * **Updated Broadcom bnxt driver.**
  87
  88   Updated Broadcom bnxt driver with new features and improvements, including:
  89
  90   * Added support for MARK action.
  91
  92 * **Updated Hisilicon hns3 driver.**
  93
  94   Updated Hisilicon hns3 driver with new features and improvements, including:
  95
  96   * Added support for Rx interrupt.
  97   * Added support setting VF MAC address by PF driver.
  98
  99 * **Updated the Intel ice driver.**
 100
 101   Updated the Intel ice driver with new features and improvements, including:
 102
 103   * Added support for MAC rules on a specific port.
 104   * Added support for MAC/VLAN with TCP/UDP in switch rule.
 105   * Added support for 1/10G device.
 106   * Added support for API ``rte_eth_tx_done_cleanup``.
 107
 108 * **Updated Intel iavf driver.**
 109
 110   Updated iavf PMD with new features and improvements, including:
 111
 112   * Added more supported device IDs.
 113   * Updated virtual channel to latest AVF spec.
 114
 115 * **Updated the Intel ixgbe driver.**
 116
 117   Updated ixgbe PMD with new features and improvements, including:
 118
 119   * Added support for API ``rte_eth_tx_done_cleanup()``.
 120   * Added support setting VF MAC address by PF driver.
 121   * Added support for setting the link to specific speed.
 122
 123 * **Updated Intel i40e driver.**
 124
 125   Updated i40e PMD with new features and improvements, including:
 126
 127   * Added support for L2TPv3 over IP profiles which can be programmed by the
 128     dynamic device personalization (DDP) process.
 129   * Added support for ESP-AH profiles which can be programmed by the
 130     dynamic device personalization (DDP) process.
 131   * Added PF support Malicious Device Drive event catch and notify.
 132   * Added LLDP support.
 133   * Extended PHY access AQ cmd.
 134   * Added support for reading LPI counters.
 135   * Added support for Energy Efficient Ethernet.
 136   * Added support for API ``rte_eth_tx_done_cleanup()``.
 137   * Added support for VF multiple queues interrupt.
 138   * Added support for setting the link to specific speed.
 139
 140 * **Updated Mellanox mlx5 driver.**
 141
 142   Updated Mellanox mlx5 driver with new features and improvements, including:
 143
 144   * Added support for the mbufs with external pinned buffers.
 145   * Added support for RSS using L3/L4 source/destination only.
 146   * Added support for matching on GTP tunnel header item.
 147   * Removed limitation of matching on tagged/untagged packets (when using DV flow engine).
 148   * Added support for IPv4/IPv6 DSCP rewrite action.
 149   * Added BlueField-2 integrated ConnectX-6 Dx device support.
 150
 151 * **Add new vDPA PMD based on Mellanox devices.**
 152
 153   Added a new Mellanox vDPA  (``mlx5_vdpa``) PMD.
 154   See the :doc:`../vdpadevs/mlx5` guide for more details on this driver.
 155
 156 * **Added support for virtio-PMD notification data.**
 157
 158   Added support for virtio-PMD notification data so that the driver
 159   passes extra data (besides identifying the virtqueue) in its device
 160   notifications, expanding the notifications to include the avail index and
 161   avail wrap counter (When split ring is used, the avail wrap counter is not
 162   included in the notification data).
 163
 164 * **Updated testpmd application.**
 165
 166   Added support for ESP and L2TPv3 over IP rte_flow patterns to the testpmd
 167   application.
 168
 169 * **Added algorithms to cryptodev API.**
 170
 171   Added new algorithms to the cryptodev API:
 172
 173   * ECDSA (Elliptic Curve Digital Signature Algorithm) is added to
 174     asymmetric crypto library specifications.
 175   * ECPM (Elliptic Curve Point Multiplication) is added to
 176     asymmetric crypto library specifications.
 177
 178 * **Added synchronous Crypto burst API.**
 179
 180   A new API has been introduced in the crypto library to handle synchronous cryptographic
 181   operations allowing it to achieve performance gains for cryptodevs which use
 182   CPU based acceleration, such as Intel AES-NI. An implementation for aesni_gcm
 183   cryptodev is provided. The IPsec example application and ipsec library itself
 184   were changed to allow utilization of this new feature.
 185
 186 * **Added handling of mixed algorithms in encrypted digest requests in QAT PMD.**
 187
 188   Added handling of mixed algorithms in encrypted digest hash-cipher
 189   (generation) and cipher-hash (verification) requests (e.g. SNOW3G + ZUC or
 190   ZUC + AES CTR) in QAT PMD possible when running on GEN3 QAT hardware.
 191   Such algorithm combinations are not supported on GEN1/GEN2 hardware
 192   and executing the request returns ``RTE_CRYPTO_OP_STATUS_INVALID_SESSION``.
 193
 194 * **Queue-pairs are now thread-safe on Intel QuickAssist Technology (QAT) PMD.**
 195
 196   Queue-pairs are thread-safe on Intel CPUs but Queues are not (that is, within
 197   a single queue-pair all enqueues to the TX queue must be done from one thread
 198   and all dequeues from the RX queue must be done from one thread, but enqueues
 199   and dequeues may be done in different threads.).
 200
 201 * **Updated the ZUC PMD.**
 202
 203   * Transitioned underlying library from libSSO ZUC to intel-ipsec-mb
 204     library (minimum version required 0.53).
 205   * Removed dynamic library limitation, so PMD can be built as a shared
 206     object now.
 207
 208 * **Updated the KASUMI PMD.**
 209
 210   * Transitioned underlying library from libSSO KASUMI to intel-ipsec-mb
 211     library (minimum version required 0.53).
 212
 213 * **Updated the SNOW3G PMD.**
 214
 215   * Transitioned underlying library from libSSO SNOW3G to intel-ipsec-mb
 216     library (minimum version required 0.53).
 217
 218 * **Changed armv8 crypto PMD external dependency.**
 219
 220   Changed armv8 crypto PMD external dependency. The
 221   armv8 crypto PMD now depends on the Arm crypto library, and Marvell's
 222   armv8 crypto library is not used anymore. The library name has been changed
 223   from armv8_crypto to AArch64crypto.
 224
 225 * **Added inline IPsec support to Marvell OCTEON TX2 PMD.**
 226
 227   Added inline IPsec support to Marvell OCTEON TX2 PMD. With this feature,
 228   applications will be able to offload entire IPsec offload to the hardware.
 229   For the configured sessions, hardware will do the lookup and perform
 230   decryption and IPsec transformation. For the outbound path, applications
 231   can submit a plain packet to the PMD, and it will be sent out on the wire
 232   after doing encryption and IPsec transformation of the packet.
 233
 234 * **Added Marvell OCTEON TX2 End Point rawdev PMD.**
 235
 236   Added a new OCTEON TX2 rawdev PMD for End Point mode of operation.
 237   See the :doc:`../rawdevs/octeontx2_ep` for more details on this new PMD.
 238
 239 * **Added event mode to l3fwd sample application.**
 240
 241   Added event device support for the ``l3fwd`` sample application. It demonstrates
 242   usage of poll and event mode IO mechanism under a single application.
 243
 244 * **Added cycle-count mode to the compression performance tool.**
 245
 246   Enhanced the compression performance tool by adding a cycle-count mode
 247   which can be used to help measure and tune hardware and software PMDs.
 248
 249 * **Added OpenWrt howto guide.**
 250
 251   Added document which describes how to enable DPDK on OpenWrt in both virtual and
 252   physical machines.
 253
 254
 255 Removed Items
 256 -------------
 257
 258 .. This section should contain removed items in this release. Sample format:
 259
 260    * Add a short 1-2 sentence description of the removed item
 261      in the past tense.
 262
 263    This section is a comment. Do not overwrite or remove it.
 264    Also, make sure to start the actual text at the margin.
 265    =========================================================
 266
 267 * **Disabled building all the Linux kernel modules by default.**
 268
 269   In order to remove the build time dependency on the Linux kernel,
 270   the Technical Board decided to disable all the kernel modules
 271   by default from 20.02 version.
 272
 273 * **Removed coalescing feature from Intel QuickAssist Technology (QAT) PMD.**
 274
 275   The internal tail write coalescing feature was removed as not compatible with
 276   dual-thread feature. It was replaced with a threshold feature. At busy times
 277   if only a small number of packets can be enqueued, each enqueue causes
 278   an expensive MMIO write. These MMIO write occurrences can be optimized by using
 279   the new threshold parameter on process start. Please see QAT documentation for
 280   more details.
 281
 282
 283 API Changes
 284 -----------
 285
 286 .. This section should contain API changes. Sample format:
 287
 288    * sample: Add a short 1-2 sentence description of the API change
 289      which was announced in the previous releases and made in this release.
 290      Start with a scope label like "ethdev:".
 291      Use fixed width quotes for ``function_names`` or ``struct_names``.
 292      Use the past tense.
 293
 294    This section is a comment. Do not overwrite or remove it.
 295    Also, make sure to start the actual text at the margin.
 296    =========================================================
 297
 298 * No change in this release.
 299
 300
 301 .. _20_02_abi_changes:
 302
 303 ABI Changes
 304 -----------
 305
 306 .. This section should contain ABI changes. Sample format:
 307
 308    * sample: Add a short 1-2 sentence description of the ABI change
 309      which was announced in the previous releases and made in this release.
 310      Start with a scope label like "ethdev:".
 311      Use fixed width quotes for ``function_names`` or ``struct_names``.
 312      Use the past tense.
 313
 314    This section is a comment. Do not overwrite or remove it.
 315    Also, make sure to start the actual text at the margin.
 316    =========================================================
 317
 318 * No change, kept ABI v20. DPDK 20.02 is compatible with DPDK 19.11.
 319
 320 * The soname for each stable ABI version should be just the ABI version major
 321   number without the minor number. Unfortunately both major and minor were used
 322   in the v19.11 release, causing version v20.x releases to be incompatible with
 323   ABI v20.0.
 324
 325   The `commit f26c2b39b271 <https://git.dpdk.org/dpdk/commit/?id=f26c2b39b271>`_
 326   fixed the issue by switching from 2-part to 3-part ABI version numbers so that
 327   we can keep v20.0 as soname and using the final digits to identify the DPDK
 328   20.x releases which are ABI compatible.
 329
 330
 331 Tested Platforms
 332 ----------------
 333
 334 .. This section should contain a list of platforms that were tested
 335    with this release.
 336
 337    The format is:
 338
 339    * <vendor> platform with <vendor> <type of devices> combinations
 340
 341      * List of CPU
 342      * List of OS
 343      * List of devices
 344      * Other relevant details...
 345
 346    This section is a comment. Do not overwrite or remove it.
 347    Also, make sure to start the actual text at the margin.
 348    =========================================================
 349
 350 * Intel\ |reg| platforms with Intel\ |reg| NICs combinations
 351
 352   * CPU
 353
 354     * Intel\ |reg| Atom\ |trade| CPU C3758 @ 2.20GHz
 355     * Intel\ |reg| Atom\ |trade| CPU C3858 @ 2.00GHz
 356     * Intel\ |reg| Atom\ |trade| CPU C3958 @ 2.00GHz
 357     * Intel\ |reg| Xeon\ |reg| CPU D-1541 @ 2.10GHz
 358     * Intel\ |reg| Xeon\ |reg| CPU D-1553N @ 2.30GHz
 359     * Intel\ |reg| Xeon\ |reg| CPU E5-2680 0 @ 2.70GHz
 360     * Intel\ |reg| Xeon\ |reg| CPU E5-2680 v2 @ 2.80GHz
 361     * Intel\ |reg| Xeon\ |reg| CPU E5-2699 v3 @ 2.30GHz
 362     * Intel\ |reg| Xeon\ |reg| CPU E5-2699 v4 @ 2.20GHz
 363     * Intel\ |reg| Xeon\ |reg| Gold 6139 CPU @ 2.30GHz
 364     * Intel\ |reg| Xeon\ |reg| Gold 6252N CPU @ 2.30GHz
 365     * Intel\ |reg| Xeon\ |reg| Platinum 8180 CPU @ 2.50GHz
 366     * Intel\ |reg| Xeon\ |reg| Platinum 8280M CPU @ 2.70GHz
 367
 368   * OS:
 369
 370     * CentOS 7.7
 371     * CentOS 8.0
 372     * Fedora 31
 373     * FreeBSD 12.1
 374     * Red Hat Enterprise Linux Server release 8.0
 375     * Red Hat Enterprise Linux Server release 7.7
 376     * Suse15SP1
 377     * Ubuntu 14.04
 378     * Ubuntu 16.04
 379     * Ubuntu 16.10
 380     * Ubuntu 18.04
 381     * Ubuntu 19.04
 382
 383   * NICs:
 384
 385     * Intel\ |reg| Corporation Ethernet Controller E810-C for SFP (4x25G)
 386
 387       * Firmware version: 1.02 0x80002b69
 388       * Device id (pf): 8086:1593
 389       * Driver version: 0.12.34 (ice)
 390
 391     * Intel\ |reg| Corporation Ethernet Controller E810-C for SFP (2x100G)
 392
 393       * Firmware version: 1.02 0x80002b68
 394       * Device id (pf): 8086:1592
 395       * Driver version: 0.12.34 (ice)
 396
 397     * Intel\ |reg| 82599ES 10 Gigabit Ethernet Controller
 398
 399       * Firmware version: 0x61bf0001
 400       * Device id (pf/vf): 8086:10fb / 8086:10ed
 401       * Driver version: 5.6.1 (ixgbe)
 402
 403     * Intel\ |reg| Corporation Ethernet Connection X552/X557-AT 10GBASE-T
 404
 405       * Firmware version: 0x800003e7
 406       * Device id (pf/vf): 8086:15ad / 8086:15a8
 407       * Driver version: 5.1.0 (ixgbe)
 408
 409     * Intel\ |reg| Corporation Ethernet Controller 10G X550T
 410
 411       * Firmware version: 0x80000482
 412       * Device id (pf): 8086:1563
 413       * Driver version: 5.6.1 (ixgbe)
 414
 415     * Intel\ |reg| Ethernet Converged Network Adapter X710-DA4 (4x10G)
 416
 417       * Firmware version: 7.20 0x800079e8
 418       * Device id (pf/vf): 8086:1572 / 8086:154c
 419       * Driver version: 2.10.19.30 (i40e)
 420
 421     * Intel\ |reg| Corporation Ethernet Connection X722 for 10GbE SFP+ (4x10G)
 422
 423       * Firmware version: 4.11 0x80001def
 424       * Device id (pf/vf): 8086:37d0 / 8086:37cd
 425       * Driver version: 2.10.19.30 (i40e)
 426
 427     * Intel\ |reg| Corporation Ethernet Connection X722 for 10GBASE-T (2x10G)
 428
 429       * Firmware version: 4.10 0x80001a7a
 430       * Device id (pf/vf): 8086:37d2 / 8086:37cd
 431       * Driver version: 2.10.19.30 (i40e)
 432
 433     * Intel\ |reg| Ethernet Converged Network Adapter XXV710-DA2 (2x25G)
 434
 435       * Firmware version: 7.20 0x80007947
 436       * Device id (pf/vf): 8086:158b / 8086:154c
 437       * Driver version: 2.10.19.30 (i40e)
 438
 439     * Intel\ |reg| Ethernet Converged Network Adapter XL710-QDA2 (2X40G)
 440
 441       * Firmware version: 7.20 0x80007948
 442       * Device id (pf/vf): 8086:1583 / 8086:154c
 443       * Driver version: 2.10.19.30 (i40e)
 444
 445     * Intel\ |reg| Corporation I350 Gigabit Network Connection
 446
 447       * Firmware version: 1.63, 0x80000cbc
 448       * Device id (pf/vf): 8086:1521 / 8086:1520
 449       * Driver version: 5.4.0-k (igb)
 450
 451     * Intel\ |reg| Corporation I210 Gigabit Network Connection
 452
 453       * Firmware version: 3.25, 0x800006eb
 454       * Device id (pf): 8086:1533
 455       * Driver version: 5.4.0-k(igb)
 456
 457 * Intel\ |reg| platforms with Mellanox\ |reg| NICs combinations
 458
 459   * CPU:
 460
 461     * Intel\ |reg| Xeon\ |reg| Gold 6154 CPU @ 3.00GHz
 462     * Intel\ |reg| Xeon\ |reg| CPU E5-2697A v4 @ 2.60GHz
 463     * Intel\ |reg| Xeon\ |reg| CPU E5-2697 v3 @ 2.60GHz
 464     * Intel\ |reg| Xeon\ |reg| CPU E5-2680 v2 @ 2.80GHz
 465     * Intel\ |reg| Xeon\ |reg| CPU E5-2650 v4 @ 2.20GHz
 466     * Intel\ |reg| Xeon\ |reg| CPU E5-2640 @ 2.50GHz
 467     * Intel\ |reg| Xeon\ |reg| CPU E5-2620 v4 @ 2.10GHz
 468
 469   * OS:
 470     * Red Hat Enterprise Linux Server release 7.5 (Maipo)
 471     * Red Hat Enterprise Linux Server release 7.4 (Maipo)
 472     * Red Hat Enterprise Linux Server release 7.3 (Maipo)
 473     * Red Hat Enterprise Linux Server release 7.2 (Maipo)
 474     * Ubuntu 18.04
 475     * Ubuntu 16.04
 476
 477   * OFED:
 478
 479     * MLNX_OFED 4.7-3.2.9.0
 480     * MLNX_OFED 5.0-0.4.1.0 and above
 481
 482   * upstream kernel:
 483
 484     * Linux 5.5 and above
 485
 486   * rdma-core:
 487
 488     * rdma-core-28.0-1 and above
 489
 490   * NICs:
 491
 492     * Mellanox\ |reg| ConnectX\ |reg|-3 Pro 40G MCX354A-FCC_Ax (2x40G)
 493
 494       * Host interface: PCI Express 3.0 x8
 495       * Device ID: 15b3:1007
 496       * Firmware version: 2.42.5000
 497
 498     * Mellanox\ |reg| ConnectX\ |reg|-3 Pro 40G MCX354A-FCCT (2x40G)
 499
 500       * Host interface: PCI Express 3.0 x8
 501       * Device ID: 15b3:1007
 502       * Firmware version: 2.42.5000
 503
 504     * Mellanox\ |reg| ConnectX\ |reg|-4 Lx 25G MCX4121A-ACAT (2x25G)
 505
 506       * Host interface: PCI Express 3.0 x8
 507       * Device ID: 15b3:1015
 508       * Firmware version: 14.27.1000 and above
 509
 510     * Mellanox\ |reg| ConnectX\ |reg|-4 Lx 50G MCX4131A-GCAT (1x50G)
 511
 512       * Host interface: PCI Express 3.0 x8
 513       * Device ID: 15b3:1015
 514       * Firmware version: 14.27.1000 and above
 515
 516     * Mellanox\ |reg| ConnectX\ |reg|-5 100G MCX516A-CCAT (2x100G)
 517
 518       * Host interface: PCI Express 3.0 x16
 519       * Device ID: 15b3:1017
 520       * Firmware version: 16.27.1000 and above
 521
 522     * Mellanox\ |reg| ConnectX\ |reg|-5 100G MCX556A-ECAT (2x100G)
 523
 524       * Host interface: PCI Express 3.0 x16
 525       * Device ID: 15b3:1017
 526       * Firmware version: 16.27.1000 and above
 527
 528     * Mellanox\ |reg| ConnectX\ |reg|-5 100G MCX556A-EDAT (2x100G)
 529
 530       * Host interface: PCI Express 3.0 x16
 531       * Device ID: 15b3:1017
 532       * Firmware version: 16.27.1000 and above
 533
 534     * Mellanox\ |reg| ConnectX\ |reg|-5 Ex EN 100G MCX516A-CDAT (2x100G)
 535
 536       * Host interface: PCI Express 4.0 x16
 537       * Device ID: 15b3:1019
 538       * Firmware version: 16.27.1000 and above
 539
 540
 541 * Mellanox\ |reg| BlueField SmartNIC
 542
 543   * Mellanox\ |reg| BlueField SmartNIC MT416842 (2x25G)
 544
 545     * Host interface: PCI Express 3.0 x16
 546     * Device ID: 15b3:a2d2
 547     * Firmware version: 18.27.1000
 548
 549   * SoC Arm cores running OS:
 550
 551     * CentOS Linux release 7.5.1804 (AltArch)
 552     * MLNX_OFED 5.0-0.4.0.0
 553
 554   * DPDK application running on Arm cores inside SmartNIC
 555
 556 * IBM Power 9 platforms with Mellanox\ |reg| NICs combinations
 557
 558   * CPU:
 559
 560     * POWER9 2.2 (pvr 004e 1202) 2300MHz
 561
 562   * OS:
 563
 564     * Ubuntu 18.04.1 LTS (Bionic Beaver)
 565
 566   * NICs:
 567
 568     * Mellanox\ |reg| ConnectX\ |reg|-5 100G MCX556A-ECAT (2x100G)
 569
 570       * Host interface: PCI Express 3.0 x16
 571       * Device ID: 15b3:1017
 572       * Firmware version: 16.27.1000
 573
 574   * OFED:
 575
 576     * MLNX_OFED 5.0-0.4.1.0
 577
 578 * ARMv8 SoC combinations from Marvell (with integrated NICs)
 579
 580   * SoC:
 581
 582     * CN83xx, CN96xx, CN93xx
 583
 584   * OS (Based on Marvell OCTEON TX SDK-10.3.2.x):
 585
 586     * Arch Linux
 587     * Buildroot 2018.11
 588     * Ubuntu 16.04.1 LTS
 589     * Ubuntu 16.10
 590     * Ubuntu 18.04.1
 591     * Ubuntu 19.04