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