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