doc/guides/rel_notes/release_20_05.rst

   1 .. SPDX-License-Identifier: BSD-3-Clause
   2    Copyright 2020 The DPDK contributors
   3
   4 .. include:: <isonum.txt>
   5
   6 DPDK Release 20.05
   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_05.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 Trace Library and Tracepoints**
  60
  61   A native implementation of ``common trace format(CTF)`` based trace library
  62   has been added to provide the ability to add tracepoints in
  63   application/library to get runtime trace/debug information for control and
  64   fast APIs with minimum impact on fast path performance.
  65   Typical trace overhead is ~20 cycles and instrumentation overhead is 1 cycle.
  66   Added tracepoints in ``EAL``, ``ethdev``, ``cryptodev``, ``eventdev`` and
  67   ``mempool`` libraries for important functions.
  68
  69 * **Added new API for rte_ring.**
  70
  71   * New synchronization modes for rte_ring.
  72
  73   Introduced new optional MT synchronization modes for rte_ring:
  74   Relaxed Tail Sync (RTS) mode and Head/Tail Sync (HTS) mode.
  75   With these mode selected, rte_ring shows significant improvements for
  76   average enqueue/dequeue times on overcommitted systems.
  77
  78   * Added peek style API for rte_ring.
  79
  80   For rings with producer/consumer in RTE_RING_SYNC_ST, RTE_RING_SYNC_MT_HTS
  81   mode, provide an ability to split enqueue/dequeue operation into two phases
  82   (enqueue/dequeue start; enqueue/dequeue finish). That allows user to inspect
  83   objects in the ring without removing them from it (aka MT safe peek).
  84
  85 * **Updated Amazon ena driver.**
  86
  87   Updated ena PMD with new features and improvements, including:
  88
  89   * Added support for large LLQ (Low-latency queue) headers.
  90   * Added Tx drops as new extended driver statistic.
  91   * Added support for accelerated LLQ mode.
  92   * Handling of the 0 length descriptors on the Rx path.
  93
  94 * **Updated Intel i40e driver.**
  95
  96   Updated i40e PMD with new features and improvements, including:
  97
  98   * Enable MAC address as FDIR input set for ipv4-other, ipv4-udp and ipv4-tcp.
  99   * Added support for RSS using L3/L4 source/destination only.
 100   * Added support for setting hash function in rte flow.
 101
 102 * **Updated the Intel iavf driver.**
 103
 104   Update the Intel iavf driver with new features and improvements, including:
 105
 106   * Added generic filter support.
 107   * Added advanced iavf with FDIR capability.
 108
 109 * **Updated the Intel ice driver.**
 110
 111   Updated the Intel ice driver with new features and improvements, including:
 112
 113   * Added support for DCF (Device Config Function) feature.
 114   * Added switch filter support for intel DCF.
 115
 116 * **Updated Marvell OCTEON TX2 ethdev driver.**
 117
 118   Updated Marvell OCTEON TX2 ethdev driver with traffic manager support with
 119   below features.
 120
 121   * Hierarchial Scheduling with DWRR and SP.
 122   * Single rate - Two color, Two rate - Three color shaping.
 123
 124 * **Updated Mellanox mlx5 driver.**
 125
 126   Updated Mellanox mlx5 driver with new features and improvements, including:
 127
 128   * Added support for matching on IPv4 Time To Live and IPv6 Hop Limit.
 129   * Added support for creating Relaxed Ordering Memory Regions.
 130   * Added support for jumbo frame size (9K MTU) in Multi-Packet RQ mode.
 131   * Optimized the memory consumption of flow.
 132
 133 * **Updated the AESNI MB crypto PMD.**
 134
 135   * Added support for intel-ipsec-mb version 0.54.
 136   * Updated the AESNI MB PMD with AES-256 DOCSIS algorithm.
 137   * Added support for synchronous Crypto burst API.
 138
 139 * **Updated the AESNI GCM crypto PMD.**
 140
 141   * Added support for intel-ipsec-mb version 0.54.
 142
 143 * **Added a new driver for Intel Foxville I225 devices.**
 144
 145   Added the new ``igc`` net driver for Intel Foxville I225 devices. See the
 146   :doc:`../nics/igc` NIC guide for more details on this new driver.
 147
 148 * **Updated Broadcom bnxt driver.**
 149
 150   Updated Broadcom bnxt driver with new features and improvements, including:
 151
 152   * Added support for host based flow table management
 153   * Added flow counters to extended stats
 154   * Added PCI function stats to extended stats
 155
 156 * **Added handling of mixed crypto algorithms in QAT PMD for GEN2.**
 157
 158   Enabled handling of mixed algorithms in encrypted digest hash-cipher
 159   (generation) and cipher-hash (verification) requests in QAT PMD
 160   when running on GEN2 QAT hardware with particular firmware versions
 161   (GEN3 support was added in DPDK 20.02).
 162
 163 * **Added plain SHA-1,224,256,384,512 support to QAT PMD.**
 164
 165   Added support for plain SHA-1, SHA-224, SHA-256, SHA-384 and SHA-512 hashes
 166   to QAT PMD.
 167
 168 * **Added QAT intermediate buffer too small handling in QAT compression PMD.**
 169
 170   Added a special way of buffer handling when internal QAT intermediate buffer
 171   is too small for Huffman dynamic compression operation. Instead of falling
 172   back to fixed compression, the operation is now split into multiple smaller
 173   dynamic compression requests (possible to execute on QAT) and their results
 174   are then combined and copied into the output buffer. This is not possible if
 175   any checksum calculation was requested - in such case the code falls back to
 176   fixed compression as before.
 177
 178 * **Updated the turbo_sw bbdev PMD.**
 179
 180   Supported large size code blocks which does not fit in one mbuf segment.
 181
 182 * **Added Intel FPGA_5GNR_FEC bbdev PMD.**
 183
 184   Added a new ``fpga_5gnr_fec`` bbdev driver for the Intel\ |reg| FPGA PAC
 185   (Programmable  Acceleration Card) N3000.  See the
 186   :doc:`../bbdevs/fpga_5gnr_fec` BBDEV guide for more details on this new driver.
 187
 188 * **Updated ipsec-secgw sample application with following features.**
 189
 190   * Updated ipsec-secgw application to add event based packet processing.
 191     The worker thread(s) would receive events and submit them back to the
 192     event device after the processing. This way, multicore scaling and HW
 193     assisted scheduling is achieved by making use of the event device
 194     capabilities. The event mode currently supports only inline IPsec
 195     protocol offload.
 196
 197   * Updated ipsec-secgw application to support key sizes for AES-192-CBC,
 198     AES-192-GCM, AES-256-GCM algorithms.
 199
 200   * Added IPsec inbound load-distribution support for ipsec-secgw application
 201     using NIC load distribution feature(Flow Director).
 202
 203
 204 Removed Items
 205 -------------
 206
 207 .. This section should contain removed items in this release. Sample format:
 208
 209    * Add a short 1-2 sentence description of the removed item
 210      in the past tense.
 211
 212    This section is a comment. Do not overwrite or remove it.
 213    Also, make sure to start the actual text at the margin.
 214    =========================================================
 215
 216
 217 API Changes
 218 -----------
 219
 220 .. This section should contain API changes. Sample format:
 221
 222    * sample: Add a short 1-2 sentence description of the API change
 223      which was announced in the previous releases and made in this release.
 224      Start with a scope label like "ethdev:".
 225      Use fixed width quotes for ``function_names`` or ``struct_names``.
 226      Use the past tense.
 227
 228    This section is a comment. Do not overwrite or remove it.
 229    Also, make sure to start the actual text at the margin.
 230    =========================================================
 231
 232
 233 ABI Changes
 234 -----------
 235
 236 .. This section should contain ABI changes. Sample format:
 237
 238    * sample: Add a short 1-2 sentence description of the ABI change
 239      which was announced in the previous releases and made in this release.
 240      Start with a scope label like "ethdev:".
 241      Use fixed width quotes for ``function_names`` or ``struct_names``.
 242      Use the past tense.
 243
 244    This section is a comment. Do not overwrite or remove it.
 245    Also, make sure to start the actual text at the margin.
 246    =========================================================
 247
 248 * No ABI change that would break compatibility with DPDK 20.02 and 19.11.
 249
 250
 251 Known Issues
 252 ------------
 253
 254 .. This section should contain new known issues in this release. Sample format:
 255
 256    * **Add title in present tense with full stop.**
 257
 258      Add a short 1-2 sentence description of the known issue
 259      in the present tense. Add information on any known workarounds.
 260
 261    This section is a comment. Do not overwrite or remove it.
 262    Also, make sure to start the actual text at the margin.
 263    =========================================================
 264
 265
 266 Tested Platforms
 267 ----------------
 268
 269 .. This section should contain a list of platforms that were tested
 270    with this release.
 271
 272    The format is:
 273
 274    * <vendor> platform with <vendor> <type of devices> combinations
 275
 276      * List of CPU
 277      * List of OS
 278      * List of devices
 279      * Other relevant details...
 280
 281    This section is a comment. Do not overwrite or remove it.
 282    Also, make sure to start the actual text at the margin.
 283    =========================================================