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
 100 * **Updated the Intel iavf driver.**
 101
 102   Update the Intel iavf driver with new features and improvements, including:
 103
 104   * Added generic filter support.
 105
 106 * **Updated the Intel ice driver.**
 107
 108   Updated the Intel ice driver with new features and improvements, including:
 109
 110   * Added support for DCF (Device Config Function) feature.
 111   * Added switch filter support for intel DCF.
 112
 113 * **Updated Marvell OCTEON TX2 ethdev driver.**
 114
 115   Updated Marvell OCTEON TX2 ethdev driver with traffic manager support with
 116   below features.
 117
 118   * Hierarchial Scheduling with DWRR and SP.
 119   * Single rate - Two color, Two rate - Three color shaping.
 120
 121 * **Updated Mellanox mlx5 driver.**
 122
 123   Updated Mellanox mlx5 driver with new features and improvements, including:
 124
 125   * Added support for matching on IPv4 Time To Live and IPv6 Hop Limit.
 126   * Added support for creating Relaxed Ordering Memory Regions.
 127
 128 * **Updated the AESNI MB crypto PMD.**
 129
 130   * Added support for intel-ipsec-mb version 0.54.
 131   * Updated the AESNI MB PMD with AES-256 DOCSIS algorithm.
 132   * Added support for synchronous Crypto burst API.
 133
 134 * **Updated the AESNI GCM crypto PMD.**
 135
 136   * Added support for intel-ipsec-mb version 0.54.
 137
 138 * **Added handling of mixed crypto algorithms in QAT PMD for GEN2.**
 139
 140   Enabled handling of mixed algorithms in encrypted digest hash-cipher
 141   (generation) and cipher-hash (verification) requests in QAT PMD
 142   when running on GEN2 QAT hardware with particular firmware versions
 143   (GEN3 support was added in DPDK 20.02).
 144
 145 * **Added plain SHA-1,224,256,384,512 support to QAT PMD.**
 146
 147   Added support for plain SHA-1, SHA-224, SHA-256, SHA-384 and SHA-512 hashes
 148   to QAT PMD.
 149
 150 * **Added QAT intermediate buffer too small handling in QAT compression PMD.**
 151
 152   Added a special way of buffer handling when internal QAT intermediate buffer
 153   is too small for Huffman dynamic compression operation. Instead of falling
 154   back to fixed compression, the operation is now split into multiple smaller
 155   dynamic compression requests (possible to execute on QAT) and their results
 156   are then combined and copied into the output buffer. This is not possible if
 157   any checksum calculation was requested - in such case the code falls back to
 158   fixed compression as before.
 159
 160 * **Updated the turbo_sw bbdev PMD.**
 161
 162   Supported large size code blocks which does not fit in one mbuf segment.
 163
 164 * **Added Intel FPGA_5GNR_FEC bbdev PMD.**
 165
 166   Added a new ``fpga_5gnr_fec`` bbdev driver for the Intel\ |reg| FPGA PAC
 167   (Programmable  Acceleration Card) N3000.  See the
 168   :doc:`../bbdevs/fpga_5gnr_fec` BBDEV guide for more details on this new driver.
 169
 170 * **Updated ipsec-secgw sample application with following features.**
 171
 172   * Updated ipsec-secgw application to add event based packet processing.
 173     The worker thread(s) would receive events and submit them back to the
 174     event device after the processing. This way, multicore scaling and HW
 175     assisted scheduling is achieved by making use of the event device
 176     capabilities. The event mode currently supports only inline IPsec
 177     protocol offload.
 178
 179   * Updated ipsec-secgw application to support key sizes for AES-192-CBC,
 180     AES-192-GCM, AES-256-GCM algorithms.
 181
 182   * Added IPsec inbound load-distribution support for ipsec-secgw application
 183     using NIC load distribution feature(Flow Director).
 184
 185
 186 Removed Items
 187 -------------
 188
 189 .. This section should contain removed items in this release. Sample format:
 190
 191    * Add a short 1-2 sentence description of the removed item
 192      in the past tense.
 193
 194    This section is a comment. Do not overwrite or remove it.
 195    Also, make sure to start the actual text at the margin.
 196    =========================================================
 197
 198
 199 API Changes
 200 -----------
 201
 202 .. This section should contain API changes. Sample format:
 203
 204    * sample: Add a short 1-2 sentence description of the API change
 205      which was announced in the previous releases and made in this release.
 206      Start with a scope label like "ethdev:".
 207      Use fixed width quotes for ``function_names`` or ``struct_names``.
 208      Use the past tense.
 209
 210    This section is a comment. Do not overwrite or remove it.
 211    Also, make sure to start the actual text at the margin.
 212    =========================================================
 213
 214
 215 ABI Changes
 216 -----------
 217
 218 .. This section should contain ABI changes. Sample format:
 219
 220    * sample: Add a short 1-2 sentence description of the ABI change
 221      which was announced in the previous releases and made in this release.
 222      Start with a scope label like "ethdev:".
 223      Use fixed width quotes for ``function_names`` or ``struct_names``.
 224      Use the past tense.
 225
 226    This section is a comment. Do not overwrite or remove it.
 227    Also, make sure to start the actual text at the margin.
 228    =========================================================
 229
 230 * No ABI change that would break compatibility with DPDK 20.02 and 19.11.
 231
 232
 233 Known Issues
 234 ------------
 235
 236 .. This section should contain new known issues in this release. Sample format:
 237
 238    * **Add title in present tense with full stop.**
 239
 240      Add a short 1-2 sentence description of the known issue
 241      in the present tense. Add information on any known workarounds.
 242
 243    This section is a comment. Do not overwrite or remove it.
 244    Also, make sure to start the actual text at the margin.
 245    =========================================================
 246
 247
 248 Tested Platforms
 249 ----------------
 250
 251 .. This section should contain a list of platforms that were tested
 252    with this release.
 253
 254    The format is:
 255
 256    * <vendor> platform with <vendor> <type of devices> combinations
 257
 258      * List of CPU
 259      * List of OS
 260      * List of devices
 261      * Other relevant details...
 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    =========================================================