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