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 eCPRI protocol support in rte_flow.**
  93
  94   The ``ECPRI`` item has been added to support eCPRI packet offloading for
  95   5G network.
  96
  97 * **Introduced send packet scheduling on the timestamps.**
  98
  99    Added the new mbuf dynamic field and flag to provide timestamp on what packet
 100    transmitting can be synchronized. The device Tx offload flag is added to
 101    indicate the PMD supports send scheduling.
 102
 103 * **Updated PCAP driver.**
 104
 105   Updated PCAP driver with new features and improvements, including:
 106
 107   * Support software Tx nanosecond timestamps precision.
 108
 109 * **Updated Broadcom bnxt driver.**
 110
 111   Updated the Broadcom bnxt driver with new features and improvements, including:
 112
 113   * Added support for VF representors.
 114   * Added support for multiple devices.
 115   * Added support for new resource manager API.
 116   * Added support for VXLAN encap/decap.
 117   * Added support for rte_flow_query for COUNT action.
 118   * Added support for rx_burst_mode_get and tx_burst_mode_get.
 119   * Added vector mode support for ARM CPUs.
 120   * Added support for VLAN push and pop actions.
 121   * Added support for NAT action items.
 122
 123 * **Updated Cisco enic driver.**
 124
 125   * Added support for VLAN push and pop flow actions.
 126
 127 * **Updated Hisilicon hns3 driver.**
 128
 129   * Added support for 200G speed rate.
 130   * Added support for copper media type.
 131   * Added support for keeping CRC.
 132   * Added support for LRO.
 133   * Added support for setting VF PVID by PF driver.
 134
 135 * **Updated Mellanox mlx5 net driver and common layer.**
 136
 137   Updated Mellanox mlx5 driver with new features and improvements, including:
 138
 139   * Added mlx5 PCI layer to share a PCI device among multiple PMDs.
 140   * Added new PMD devarg ``reclaim_mem_mode``.
 141   * Added new devarg ``lacp_by_user``.
 142   * Added support for eCPRI protocol offloading.
 143
 144 * **Added vDPA device APIs to query virtio queue statistics.**
 145
 146      A new 3 APIs has been added to query virtio queue statistics, to get their
 147      names and to reset them by a vDPA device.
 148
 149 * **Updated Mellanox mlx5 vDPA driver.**
 150
 151   Updated Mellanox mlx5 vDPA driver with new features, including:
 152
 153   * Added support for virtio queue statistics.
 154   * Added support for MTU update.
 155
 156 * **Updated Marvell octeontx2 ethdev PMD.**
 157
 158   Updated Marvell octeontx2 driver with cn98xx support.
 159
 160 * **Updated the Intel ice driver.**
 161
 162   Updated the Intel ice driver with new features and improvements, including:
 163
 164   * Added support for DCF datapath configuration.
 165   * Added support for more PPPoE packet type for switch filter.
 166
 167 * **Updated Intel i40e driver.**
 168
 169   Updated i40e PMD with new features and improvements, including:
 170
 171   * Supported cloud filter for IPv4/6_TCP/UDP/SCTP with SRC port only or DST port only.
 172   * Re-implemented get_fdir_info and get_fdir_stat in private API.
 173   * Re-implemented set_gre_key_len in private API.
 174   * Added support for flow query RSS.
 175
 176 * **Updated the Intel ixgbe driver.**
 177
 178   Updated the Intel ixgbe driver with new features and improvements, including:
 179
 180   * Re-implemented get_fdir_info and get_fdir_stat in private API.
 181
 182 * **Updated NXP dpaa ethdev PMD.**
 183
 184   Updated the NXP dpaa ethdev with new features and improvements, including:
 185
 186   * Added support for link status and interrupt
 187   * Added support to use datapath APIs from non-EAL pthread
 188
 189 * **Updated NXP dpaa2 ethdev PMD.**
 190
 191   Updated the NXP dpaa2 ethdev with new features and improvements, including:
 192
 193   * Added support to use datapath APIs from non-EAL pthread
 194   * Added support for dynamic flow management
 195
 196 * **Added DOCSIS protocol to rte_security.**
 197
 198   Added support for combined crypto and CRC operations for the DOCSIS protocol
 199   to ``rte_security`` API.
 200
 201 * **Updated the AESNI MB crypto PMD.**
 202
 203   Added support for lookaside protocol offload for DOCSIS through the
 204   ``rte_security`` API.
 205
 206 * **Updated the QuickAssist Technology (QAT) PMD.**
 207
 208   * Added support for lookaside protocol offload in QAT crypto PMD
 209     for DOCSIS through the ``rte_security`` API.
 210   * Added Chacha20-Poly1305 AEAD algorithm in QAT crypto PMD.
 211   * Improved handling of multi process in QAT crypto and compression PMDs.
 212   * Added support for Intel GEN2 QuickAssist device 200xx
 213     (PF Did 0x18ee, VF Did 0x18ef).
 214
 215 * **Updated the OCTEON TX2 crypto PMD.**
 216
 217   * Added Chacha20-Poly1305 AEAD algorithm support in OCTEON TX2 crypto PMD.
 218
 219   * Updated the OCTEON TX2 crypto PMD to support ``rte_security`` lookaside
 220     protocol offload for IPsec.
 221
 222 * **Added support for BPF_ABS/BPF_IND load instructions.**
 223
 224   Added support for two BPF non-generic instructions:
 225   ``(BPF_ABS | <size> | BPF_LD)`` and ``(BPF_IND | <size> | BPF_LD)``
 226   which are used to access packet data in a safe manner. Currently JIT support
 227   for these instructions is implemented for x86 only.
 228
 229 * **Added new testpmd forward mode.**
 230
 231   Added new ``5tswap`` forward mode to testpmd.
 232   the  ``5tswap`` swaps source and destination in layers 2,3,4
 233   for ipv4 and ipv6 in L3 and UDP and TCP in L4.
 234
 235 * **Added flow performance test application.**
 236
 237   Added new application to test ``rte_flow`` performance, including:
 238
 239   * Measure ``rte_flow`` insertion rate.
 240   * Measure ``rte_flow`` deletion rate.
 241   * Dump ``rte_flow`` memory consumption.
 242   * Measure packet per second forwarding.
 243
 244 * **Added --portmap command line parameter to l2fwd example.**
 245
 246   Added new command line option ``--portmap="(port, port)[,(port, port)]"`` to
 247   pass forwarding port details.
 248   See the :doc:`../sample_app_ug/l2_forward_real_virtual` for more
 249   details of this parameter usage.
 250
 251 * **Updated ipsec-secgw sample application.**
 252
 253   Added ``rte_flow`` based rules, which allows hardware parsing and steering
 254   of ingress packets to specific NIC queues.
 255   See the :doc:`../sample_app_ug/ipsec_secgw` for more details.
 256
 257
 258 Removed Items
 259 -------------
 260
 261 .. This section should contain removed items in this release. Sample format:
 262
 263    * Add a short 1-2 sentence description of the removed item
 264      in the past tense.
 265
 266    This section is a comment. Do not overwrite or remove it.
 267    Also, make sure to start the actual text at the margin.
 268    =========================================================
 269
 270 * Removed ``RTE_KDRV_NONE`` based PCI device driver probing.
 271
 272
 273 API Changes
 274 -----------
 275
 276 .. This section should contain API changes. Sample format:
 277
 278    * sample: Add a short 1-2 sentence description of the API change
 279      which was announced in the previous releases and made in this release.
 280      Start with a scope label like "ethdev:".
 281      Use fixed width quotes for ``function_names`` or ``struct_names``.
 282      Use the past tense.
 283
 284    This section is a comment. Do not overwrite or remove it.
 285    Also, make sure to start the actual text at the margin.
 286    =========================================================
 287
 288 * ``rte_page_sizes`` enumeration is replaced with ``RTE_PGSIZE_xxx`` defines.
 289
 290 * vhost: The API of ``rte_vhost_host_notifier_ctrl`` was changed to be per
 291   queue and not per device, a qid parameter was added to the arguments list.
 292
 293
 294 ABI Changes
 295 -----------
 296
 297 .. This section should contain ABI changes. Sample format:
 298
 299    * sample: Add a short 1-2 sentence description of the ABI change
 300      which was announced in the previous releases and made in this release.
 301      Start with a scope label like "ethdev:".
 302      Use fixed width quotes for ``function_names`` or ``struct_names``.
 303      Use the past tense.
 304
 305    This section is a comment. Do not overwrite or remove it.
 306    Also, make sure to start the actual text at the margin.
 307    =========================================================
 308
 309 * No ABI change that would break compatibility with 19.11.
 310
 311
 312 Known Issues
 313 ------------
 314
 315 .. This section should contain new known issues in this release. Sample format:
 316
 317    * **Add title in present tense with full stop.**
 318
 319      Add a short 1-2 sentence description of the known issue
 320      in the present tense. Add information on any known workarounds.
 321
 322    This section is a comment. Do not overwrite or remove it.
 323    Also, make sure to start the actual text at the margin.
 324    =========================================================
 325
 326
 327 Tested Platforms
 328 ----------------
 329
 330 .. This section should contain a list of platforms that were tested
 331    with this release.
 332
 333    The format is:
 334
 335    * <vendor> platform with <vendor> <type of devices> combinations
 336
 337      * List of CPU
 338      * List of OS
 339      * List of devices
 340      * Other relevant details...
 341
 342    This section is a comment. Do not overwrite or remove it.
 343    Also, make sure to start the actual text at the margin.
 344    =========================================================