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