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   * Added advanced RSS configuration for VFs.
 120
 121 * **Updated the Intel ice driver.**
 122
 123   Updated the Intel ice driver with new features and improvements, including:
 124
 125   * Added support for DCF (Device Config Function) feature.
 126   * Added switch filter support for intel DCF.
 127
 128 * **Updated Marvell OCTEON TX2 ethdev driver.**
 129
 130   Updated Marvell OCTEON TX2 ethdev driver with traffic manager support with
 131   below features.
 132
 133   * Hierarchial Scheduling with DWRR and SP.
 134   * Single rate - Two color, Two rate - Three color shaping.
 135
 136 * **Updated Mellanox mlx5 driver.**
 137
 138   Updated Mellanox mlx5 driver with new features and improvements, including:
 139
 140   * Added support for matching on IPv4 Time To Live and IPv6 Hop Limit.
 141   * Added support for creating Relaxed Ordering Memory Regions.
 142   * Added support for configuring Hairpin queue data buffer size.
 143   * Added support for jumbo frame size (9K MTU) in Multi-Packet RQ mode.
 144   * Optimized the memory consumption of flow.
 145   * Added support for flow aging based on hardware counter.
 146
 147 * **Updated the AESNI MB crypto PMD.**
 148
 149   * Added support for intel-ipsec-mb version 0.54.
 150   * Updated the AESNI MB PMD with AES-256 DOCSIS algorithm.
 151   * Added support for synchronous Crypto burst API.
 152
 153 * **Updated the AESNI GCM crypto PMD.**
 154
 155   * Added support for intel-ipsec-mb version 0.54.
 156
 157 * **Added a new driver for Intel Foxville I225 devices.**
 158
 159   Added the new ``igc`` net driver for Intel Foxville I225 devices. See the
 160   :doc:`../nics/igc` NIC guide for more details on this new driver.
 161
 162 * **Updated Broadcom bnxt driver.**
 163
 164   Updated Broadcom bnxt driver with new features and improvements, including:
 165
 166   * Added support for host based flow table management
 167   * Added flow counters to extended stats
 168   * Added PCI function stats to extended stats
 169
 170 * **Added handling of mixed crypto algorithms in QAT PMD for GEN2.**
 171
 172   Enabled handling of mixed algorithms in encrypted digest hash-cipher
 173   (generation) and cipher-hash (verification) requests in QAT PMD
 174   when running on GEN2 QAT hardware with particular firmware versions
 175   (GEN3 support was added in DPDK 20.02).
 176
 177 * **Added plain SHA-1,224,256,384,512 support to QAT PMD.**
 178
 179   Added support for plain SHA-1, SHA-224, SHA-256, SHA-384 and SHA-512 hashes
 180   to QAT PMD.
 181
 182 * **Added QAT intermediate buffer too small handling in QAT compression PMD.**
 183
 184   Added a special way of buffer handling when internal QAT intermediate buffer
 185   is too small for Huffman dynamic compression operation. Instead of falling
 186   back to fixed compression, the operation is now split into multiple smaller
 187   dynamic compression requests (possible to execute on QAT) and their results
 188   are then combined and copied into the output buffer. This is not possible if
 189   any checksum calculation was requested - in such case the code falls back to
 190   fixed compression as before.
 191
 192 * **Updated the turbo_sw bbdev PMD.**
 193
 194   Supported large size code blocks which does not fit in one mbuf segment.
 195
 196 * **Added Intel FPGA_5GNR_FEC bbdev PMD.**
 197
 198   Added a new ``fpga_5gnr_fec`` bbdev driver for the Intel\ |reg| FPGA PAC
 199   (Programmable  Acceleration Card) N3000.  See the
 200   :doc:`../bbdevs/fpga_5gnr_fec` BBDEV guide for more details on this new driver.
 201
 202 * **Updated ipsec-secgw sample application with following features.**
 203
 204   * Updated ipsec-secgw application to add event based packet processing.
 205     The worker thread(s) would receive events and submit them back to the
 206     event device after the processing. This way, multicore scaling and HW
 207     assisted scheduling is achieved by making use of the event device
 208     capabilities. The event mode currently supports only inline IPsec
 209     protocol offload.
 210
 211   * Updated ipsec-secgw application to support key sizes for AES-192-CBC,
 212     AES-192-GCM, AES-256-GCM algorithms.
 213
 214   * Added IPsec inbound load-distribution support for ipsec-secgw application
 215     using NIC load distribution feature(Flow Director).
 216
 217 * **Added rte_graph library.**
 218
 219   Graph architecture abstracts the data processing functions as a ``node`` and
 220   ``links`` them together to create a complex ``graph`` to enable reusable/modular
 221   data processing functions. The graph library provides API to enable graph
 222   framework operations such as create, lookup, dump and destroy on graph and node
 223   operations such as clone, edge update, and edge shrink, etc.
 224   The API also allows to create the stats cluster to monitor per graph and per node stats.
 225
 226 * **Added rte_node library which consists of a set of packet processing nodes.**
 227
 228   The rte_node library that consists of nodes used by rte_graph library. Each
 229   node performs a specific packet processing function based on application
 230   configuration. The following nodes are added:
 231
 232   * Null node: Skeleton node that defines the general structure of a node.
 233   * Ethernet device node: Consists of ethernet Rx/Tx nodes as well as ethernet
 234     control APIs.
 235   * IPv4 lookup node: Consists of ipv4 extract and lpm lookup node. Routes can
 236     be configured by the application through ``rte_node_ip4_route_add`` function.
 237   * IPv4 rewrite node: Consists of ipv4 and ethernet header rewrite functionality
 238     that can be configured through ``rte_node_ip4_rewrite_add`` function.
 239   * Packet drop node: Frees the packets received to their respective mempool.
 240
 241 * **Added new l3fwd-graph sample application.**
 242
 243   Added an example application ``l3fwd-graph``. It demonstrates the usage of graph
 244   library and node library for packet processing. In addition to the library usage
 245   demonstration, this application can use for performance comparison with existing
 246   ``l3fwd`` (The static code without any nodes) with the modular ``l3fwd-graph``
 247   approach.
 248
 249
 250 Removed Items
 251 -------------
 252
 253 .. This section should contain removed items in this release. Sample format:
 254
 255    * Add a short 1-2 sentence description of the removed item
 256      in the past tense.
 257
 258    This section is a comment. Do not overwrite or remove it.
 259    Also, make sure to start the actual text at the margin.
 260    =========================================================
 261
 262
 263 API Changes
 264 -----------
 265
 266 .. This section should contain API changes. Sample format:
 267
 268    * sample: Add a short 1-2 sentence description of the API change
 269      which was announced in the previous releases and made in this release.
 270      Start with a scope label like "ethdev:".
 271      Use fixed width quotes for ``function_names`` or ``struct_names``.
 272      Use the past tense.
 273
 274    This section is a comment. Do not overwrite or remove it.
 275    Also, make sure to start the actual text at the margin.
 276    =========================================================
 277
 278 * mempool: The API of ``rte_mempool_populate_iova()`` and
 279   ``rte_mempool_populate_virt()`` changed to return 0 instead of -EINVAL
 280   when there is not enough room to store one object.
 281
 282
 283 ABI Changes
 284 -----------
 285
 286 .. This section should contain ABI changes. Sample format:
 287
 288    * sample: Add a short 1-2 sentence description of the ABI change
 289      which was announced in the previous releases and made in this release.
 290      Start with a scope label like "ethdev:".
 291      Use fixed width quotes for ``function_names`` or ``struct_names``.
 292      Use the past tense.
 293
 294    This section is a comment. Do not overwrite or remove it.
 295    Also, make sure to start the actual text at the margin.
 296    =========================================================
 297
 298 * No ABI change that would break compatibility with DPDK 20.02 and 19.11.
 299
 300
 301 Known Issues
 302 ------------
 303
 304 .. This section should contain new known issues in this release. Sample format:
 305
 306    * **Add title in present tense with full stop.**
 307
 308      Add a short 1-2 sentence description of the known issue
 309      in the present tense. Add information on any known workarounds.
 310
 311    This section is a comment. Do not overwrite or remove it.
 312    Also, make sure to start the actual text at the margin.
 313    =========================================================
 314
 315
 316 Tested Platforms
 317 ----------------
 318
 319 .. This section should contain a list of platforms that were tested
 320    with this release.
 321
 322    The format is:
 323
 324    * <vendor> platform with <vendor> <type of devices> combinations
 325
 326      * List of CPU
 327      * List of OS
 328      * List of devices
 329      * Other relevant details...
 330
 331    This section is a comment. Do not overwrite or remove it.
 332    Also, make sure to start the actual text at the margin.
 333    =========================================================