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