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