doc/guides/rel_notes/release_20_08.rst

   1 .. SPDX-License-Identifier: BSD-3-Clause
   2    Copyright 2020 The DPDK contributors
   3
   4 .. include:: <isonum.txt>
   5
   6 DPDK Release 20.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
  22       xdg-open build/doc/html/guides/rel_notes/release_20_08.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 non-EAL threads registration API.**
  60
  61   Added a new API to register non-EAL threads as lcores. This can be used by
  62   applications to have its threads known of DPDK without suffering from the
  63   non-EAL previous limitations in terms of performance.
  64
  65 * **rte_*mb APIs are updated to use DMB instruction for ARMv8.**
  66
  67   ARMv8 memory model has been strengthened to require other-multi-copy
  68   atomicity. This allows for using DMB instruction instead of DSB for IO
  69   barriers. rte_*mb APIs, for ARMv8 platforms, are changed to use DMB
  70   instruction to reflect this.
  71
  72 * **Added support for RTS and HTS modes into mempool ring driver.**
  73
  74   Added ability to select new ring synchronisation modes:
  75   ``relaxed tail sync (ring_mt_rts)`` and ``head/tail sync (ring_mt_hts)``
  76   via mempool ops API.
  77
  78 * **Added the support for vfio-pci new VF token interface.**
  79
  80   From Linux 5.7, vfio-pci supports to bind both SR-IOV PF and the created VFs,
  81   it uses a shared VF token (UUID) to represent the collaboration between PF
  82   and VFs. Update DPDK PCI driver to gain the access to the PF and VFs devices
  83   by appending the VF token parameter.
  84
  85 * **Added the RegEx Library, a generic RegEx service library.**
  86
  87   Added the RegEx library which provides an API for offload of regular
  88   expressions search operations to hardware or software accelerator devices.
  89
  90   Added Mellanox RegEx PMD, allowing to offload RegEx searches.
  91
  92 * **Added vhost async data path APIs.**
  93
  94   4 new APIs have been added to enable vhost async data path, including:
  95
  96   * Async device channel register/unregister APIs
  97   * Async packets enqueue/completion APIs (only split ring was implemented)
  98
  99 * **Added eCPRI protocol support in rte_flow.**
 100
 101   The ``ECPRI`` item has been added to support eCPRI packet offloading for
 102   5G network.
 103
 104 * **Introduced send packet scheduling on the timestamps.**
 105
 106    Added the new mbuf dynamic field and flag to provide timestamp on what packet
 107    transmitting can be synchronized. The device Tx offload flag is added to
 108    indicate the PMD supports send scheduling.
 109
 110 * **Updated PCAP driver.**
 111
 112   Updated PCAP driver with new features and improvements, including:
 113
 114   * Support software Tx nanosecond timestamps precision.
 115
 116 * **Updated Broadcom bnxt driver.**
 117
 118   Updated the Broadcom bnxt driver with new features and improvements, including:
 119
 120   * Added support for VF representors.
 121   * Added support for multiple devices.
 122   * Added support for new resource manager API.
 123   * Added support for VXLAN encap/decap.
 124   * Added support for rte_flow_query for COUNT action.
 125   * Added support for rx_burst_mode_get and tx_burst_mode_get.
 126   * Added vector mode support for ARM CPUs.
 127   * Added support for VLAN push and pop actions.
 128   * Added support for NAT action items.
 129   * Added TruFlow hash API for common hash uses across TruFlow core functions.
 130
 131 * **Updated Cisco enic driver.**
 132
 133   * Added support for VLAN push and pop flow actions.
 134
 135 * **Updated Hisilicon hns3 driver.**
 136
 137   * Added support for 200G speed rate.
 138   * Added support for copper media type.
 139   * Added support for keeping CRC.
 140   * Added support for LRO.
 141   * Added support for setting VF PVID by PF driver.
 142
 143 * **Updated Mellanox mlx5 net driver and common layer.**
 144
 145   Updated Mellanox mlx5 driver with new features and improvements, including:
 146
 147   * Added mlx5 PCI layer to share a PCI device among multiple PMDs.
 148   * Added support for eCPRI protocol offloading.
 149   * Added devargs options ``reclaim_mem_mode``, ``sys_mem_en``,
 150     ``lacp_by_user`` and ``decap_en``.
 151
 152 * **Added vDPA device APIs to query virtio queue statistics.**
 153
 154      A new 3 APIs has been added to query virtio queue statistics, to get their
 155      names and to reset them by a vDPA device.
 156
 157 * **Updated Mellanox mlx5 vDPA driver.**
 158
 159   Updated Mellanox mlx5 vDPA driver with new features, including:
 160
 161   * Added support for virtio queue statistics.
 162   * Added support for MTU update.
 163
 164 * **Updated Marvell octeontx2 ethdev PMD.**
 165
 166   Updated Marvell octeontx2 driver with cn98xx support.
 167
 168 * **Updated the Intel ice driver.**
 169
 170   Updated the Intel ice driver with new features and improvements, including:
 171
 172   * Added support for DCF datapath configuration.
 173   * Added support for more PPPoE packet type for switch filter.
 174
 175 * **Updated Intel i40e driver.**
 176
 177   Updated i40e PMD with new features and improvements, including:
 178
 179   * Supported cloud filter for IPv4/6_TCP/UDP/SCTP with SRC port only or DST port only.
 180   * Re-implemented get_fdir_info and get_fdir_stat in private API.
 181   * Re-implemented set_gre_key_len in private API.
 182   * Added support for flow query RSS.
 183
 184 * **Updated the Intel ixgbe driver.**
 185
 186   Updated the Intel ixgbe driver with new features and improvements, including:
 187
 188   * Re-implemented get_fdir_info and get_fdir_stat in private API.
 189
 190 * **Updated NXP dpaa ethdev PMD.**
 191
 192   Updated the NXP dpaa ethdev with new features and improvements, including:
 193
 194   * Added support for link status and interrupt
 195   * Added support to use datapath APIs from non-EAL pthread
 196
 197 * **Updated NXP dpaa2 ethdev PMD.**
 198
 199   Updated the NXP dpaa2 ethdev with new features and improvements, including:
 200
 201   * Added support to use datapath APIs from non-EAL pthread
 202   * Added support for dynamic flow management
 203
 204 * **Added DOCSIS protocol to rte_security.**
 205
 206   Added support for combined crypto and CRC operations for the DOCSIS protocol
 207   to ``rte_security`` API.
 208
 209 * **Updated the AESNI MB crypto PMD.**
 210
 211   Added support for lookaside protocol offload for DOCSIS through the
 212   ``rte_security`` API.
 213
 214 * **Updated the QuickAssist Technology (QAT) PMD.**
 215
 216   * Added support for lookaside protocol offload in QAT crypto PMD
 217     for DOCSIS through the ``rte_security`` API.
 218   * Added Chacha20-Poly1305 AEAD algorithm in QAT crypto PMD.
 219   * Improved handling of multi process in QAT crypto and compression PMDs.
 220   * Added support for Intel GEN2 QuickAssist device 200xx
 221     (PF Did 0x18ee, VF Did 0x18ef).
 222
 223 * **Updated the OCTEON TX2 crypto PMD.**
 224
 225   * Added Chacha20-Poly1305 AEAD algorithm support in OCTEON TX2 crypto PMD.
 226
 227   * Updated the OCTEON TX2 crypto PMD to support ``rte_security`` lookaside
 228     protocol offload for IPsec.
 229
 230 * **Added support for BPF_ABS/BPF_IND load instructions.**
 231
 232   Added support for two BPF non-generic instructions:
 233   ``(BPF_ABS | <size> | BPF_LD)`` and ``(BPF_IND | <size> | BPF_LD)``
 234   which are used to access packet data in a safe manner. Currently JIT support
 235   for these instructions is implemented for x86 only.
 236
 237 * **Added new testpmd forward mode.**
 238
 239   Added new ``5tswap`` forward mode to testpmd.
 240   the  ``5tswap`` swaps source and destination in layers 2,3,4
 241   for ipv4 and ipv6 in L3 and UDP and TCP in L4.
 242
 243 * **Added flow performance test application.**
 244
 245   Added new application to test ``rte_flow`` performance, including:
 246
 247   * Measure ``rte_flow`` insertion rate.
 248   * Measure ``rte_flow`` deletion rate.
 249   * Dump ``rte_flow`` memory consumption.
 250   * Measure packet per second forwarding.
 251
 252 * **Added --portmap command line parameter to l2fwd example.**
 253
 254   Added new command line option ``--portmap="(port, port)[,(port, port)]"`` to
 255   pass forwarding port details.
 256   See the :doc:`../sample_app_ug/l2_forward_real_virtual` for more
 257   details of this parameter usage.
 258
 259 * **Updated ipsec-secgw sample application.**
 260
 261   Added ``rte_flow`` based rules, which allows hardware parsing and steering
 262   of ingress packets to specific NIC queues.
 263   See the :doc:`../sample_app_ug/ipsec_secgw` for more details.
 264
 265
 266 Removed Items
 267 -------------
 268
 269 .. This section should contain removed items in this release. Sample format:
 270
 271    * Add a short 1-2 sentence description of the removed item
 272      in the past tense.
 273
 274    This section is a comment. Do not overwrite or remove it.
 275    Also, make sure to start the actual text at the margin.
 276    =========================================================
 277
 278 * Removed ``RTE_KDRV_NONE`` based PCI device driver probing.
 279
 280
 281 API Changes
 282 -----------
 283
 284 .. This section should contain API changes. Sample format:
 285
 286    * sample: Add a short 1-2 sentence description of the API change
 287      which was announced in the previous releases and made in this release.
 288      Start with a scope label like "ethdev:".
 289      Use fixed width quotes for ``function_names`` or ``struct_names``.
 290      Use the past tense.
 291
 292    This section is a comment. Do not overwrite or remove it.
 293    Also, make sure to start the actual text at the margin.
 294    =========================================================
 295
 296 * ``rte_page_sizes`` enumeration is replaced with ``RTE_PGSIZE_xxx`` defines.
 297
 298 * vhost: The API of ``rte_vhost_host_notifier_ctrl`` was changed to be per
 299   queue and not per device, a qid parameter was added to the arguments list.
 300
 301
 302 ABI Changes
 303 -----------
 304
 305 .. This section should contain ABI changes. Sample format:
 306
 307    * sample: Add a short 1-2 sentence description of the ABI change
 308      which was announced in the previous releases and made in this release.
 309      Start with a scope label like "ethdev:".
 310      Use fixed width quotes for ``function_names`` or ``struct_names``.
 311      Use the past tense.
 312
 313    This section is a comment. Do not overwrite or remove it.
 314    Also, make sure to start the actual text at the margin.
 315    =========================================================
 316
 317 * No ABI change that would break compatibility with 19.11.
 318
 319
 320 Known Issues
 321 ------------
 322
 323 .. This section should contain new known issues in this release. Sample format:
 324
 325    * **Add title in present tense with full stop.**
 326
 327      Add a short 1-2 sentence description of the known issue
 328      in the present tense. Add information on any known workarounds.
 329
 330    This section is a comment. Do not overwrite or remove it.
 331    Also, make sure to start the actual text at the margin.
 332    =========================================================
 333
 334 * **mlx5 PMD does not work on Power 9 with OFED 5.1-0.6.6.0.**
 335
 336   Consider using the newer OFED releases, the previous
 337   OFED 5.0-2.1.8.0, or upstream rdma-core library v29 and above.
 338
 339
 340 Tested Platforms
 341 ----------------
 342
 343 .. This section should contain a list of platforms that were tested
 344    with this release.
 345
 346    The format is:
 347
 348    * <vendor> platform with <vendor> <type of devices> combinations
 349
 350      * List of CPU
 351      * List of OS
 352      * List of devices
 353      * Other relevant details...
 354
 355    This section is a comment. Do not overwrite or remove it.
 356    Also, make sure to start the actual text at the margin.
 357    =========================================================
 358
 359 * Intel\ |reg| platforms with Mellanox\ |reg| NICs combinations
 360
 361   * CPU:
 362
 363     * Intel\ |reg| Xeon\ |reg| Gold 6154 CPU @ 3.00GHz
 364     * Intel\ |reg| Xeon\ |reg| CPU E5-2697A v4 @ 2.60GHz
 365     * Intel\ |reg| Xeon\ |reg| CPU E5-2697 v3 @ 2.60GHz
 366     * Intel\ |reg| Xeon\ |reg| CPU E5-2680 v2 @ 2.80GHz
 367     * Intel\ |reg| Xeon\ |reg| CPU E5-2670 0 @ 2.60GHz
 368     * Intel\ |reg| Xeon\ |reg| CPU E5-2650 v4 @ 2.20GHz
 369     * Intel\ |reg| Xeon\ |reg| CPU E5-2640 @ 2.50GHz
 370     * Intel\ |reg| Xeon\ |reg| CPU E5-2650 0 @ 2.00GHz
 371     * Intel\ |reg| Xeon\ |reg| CPU E5-2620 v4 @ 2.10GHz
 372
 373   * OS:
 374
 375     * Red Hat Enterprise Linux release 8.2 (Ootpa)
 376     * Red Hat Enterprise Linux Server release 7.8 (Maipo)
 377     * Red Hat Enterprise Linux Server release 7.6 (Maipo)
 378     * Red Hat Enterprise Linux Server release 7.5 (Maipo)
 379     * Red Hat Enterprise Linux Server release 7.4 (Maipo)
 380     * Red Hat Enterprise Linux Server release 7.3 (Maipo)
 381     * Red Hat Enterprise Linux Server release 7.2 (Maipo)
 382     * Ubuntu 20.04
 383     * Ubuntu 18.04
 384     * Ubuntu 16.04
 385     * SUSE Enterprise Linux 15 SP2
 386     * SUSE Enterprise Linux 12 SP4
 387
 388   * OFED:
 389
 390     * MLNX_OFED 5.0-2.1.8.0
 391     * MLNX_OFED 5.1-0.6.6.0 and above
 392
 393   * upstream kernel:
 394
 395     * Linux 5.8.0-rc6 and above
 396
 397   * rdma-core:
 398
 399     * rdma-core-30.0-1 and above
 400
 401   * NICs:
 402
 403     * Mellanox\ |reg| ConnectX\ |reg|-3 Pro 40G MCX354A-FCC_Ax (2x40G)
 404
 405       * Host interface: PCI Express 3.0 x8
 406       * Device ID: 15b3:1007
 407       * Firmware version: 2.42.5000
 408
 409     * Mellanox\ |reg| ConnectX\ |reg|-3 Pro 40G MCX354A-FCCT (2x40G)
 410
 411       * Host interface: PCI Express 3.0 x8
 412       * Device ID: 15b3:1007
 413       * Firmware version: 2.42.5000
 414
 415     * Mellanox\ |reg| ConnectX\ |reg|-4 Lx 25G MCX4121A-ACAT (2x25G)
 416
 417       * Host interface: PCI Express 3.0 x8
 418       * Device ID: 15b3:1015
 419       * Firmware version: 14.28.1002 and above
 420
 421     * Mellanox\ |reg| ConnectX\ |reg|-4 Lx 50G MCX4131A-GCAT (1x50G)
 422
 423       * Host interface: PCI Express 3.0 x8
 424       * Device ID: 15b3:1015
 425       * Firmware version: 14.28.1002 and above
 426
 427     * Mellanox\ |reg| ConnectX\ |reg|-5 100G MCX516A-CCAT (2x100G)
 428
 429       * Host interface: PCI Express 3.0 x16
 430       * Device ID: 15b3:1017
 431       * Firmware version: 16.28.1002 and above
 432
 433     * Mellanox\ |reg| ConnectX\ |reg|-5 100G MCX556A-ECAT (2x100G)
 434
 435       * Host interface: PCI Express 3.0 x16
 436       * Device ID: 15b3:1017
 437       * Firmware version: 16.28.1002 and above
 438
 439     * Mellanox\ |reg| ConnectX\ |reg|-5 100G MCX556A-EDAT (2x100G)
 440
 441       * Host interface: PCI Express 3.0 x16
 442       * Device ID: 15b3:1017
 443       * Firmware version: 16.28.1002 and above
 444
 445     * Mellanox\ |reg| ConnectX\ |reg|-5 Ex EN 100G MCX516A-CDAT (2x100G)
 446
 447       * Host interface: PCI Express 4.0 x16
 448       * Device ID: 15b3:1019
 449       * Firmware version: 16.28.1002 and above
 450
 451     * Mellanox\ |reg| ConnectX\ |reg|-6 Dx EN 100G MCX623106AN-CDAT (2x100G)
 452
 453       * Host interface: PCI Express 4.0 x16
 454       * Device ID: 15b3:101d
 455       * Firmware version: 22.28.1002 and above
 456
 457 * Mellanox\ |reg| BlueField\ |reg| SmartNIC
 458
 459   * Mellanox\ |reg| BlueField\ |reg| 2 SmartNIC MT41686 - MBF2H332A-AEEOT (2x25G)
 460
 461     * Host interface: PCI Express 3.0 x16
 462     * Device ID: 15b3:a2d2
 463     * Firmware version: 24.28.1002
 464
 465   * Embedded software:
 466
 467     * CentOS Linux release 7.6.1810 (AltArch)
 468     * MLNX_OFED 5.1-0.6.2
 469     * DPDK application running on Arm cores
 470
 471 * IBM Power 9 platforms with Mellanox\ |reg| NICs combinations
 472
 473   * CPU:
 474
 475     * POWER9 2.2 (pvr 004e 1202) 2300MHz
 476
 477   * OS:
 478
 479     * Red Hat Enterprise Linux Server release 7.6
 480
 481   * NICs:
 482
 483     * Mellanox\ |reg| ConnectX\ |reg|-5 100G MCX556A-ECAT (2x100G)
 484
 485       * Host interface: PCI Express 4.0 x16
 486       * Device ID: 15b3:1017
 487       * Firmware version: 16.28.1002
 488
 489     * Mellanox\ |reg| ConnectX\ |reg|-6 Dx 100G MCX623106AN-CDAT (2x100G)
 490
 491       * Host interface: PCI Express 4.0 x16
 492       * Device ID: 15b3:101d
 493       * Firmware version: 22.28.1002
 494
 495   * OFED:
 496
 497     * MLNX_OFED 5.0-2.1.8.0