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