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