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   * Removed flow rules caching for memory saving and compliance with ethdev API.
 145   * Optimized the memory consumption of flow.
 146   * Added support for flow aging based on hardware counter.
 147
 148 * **Added Chacha20-Poly1305 algorithm to Cryptodev API.**
 149
 150   Chacha20-Poly1305 AEAD algorithm can now be supported in Cryptodev.
 151
 152 * **Updated the AESNI MB crypto PMD.**
 153
 154   * Added support for intel-ipsec-mb version 0.54.
 155   * Updated the AESNI MB PMD with AES-256 DOCSIS algorithm.
 156   * Added support for synchronous Crypto burst API.
 157
 158 * **Updated the AESNI GCM crypto PMD.**
 159
 160   * Added support for intel-ipsec-mb version 0.54.
 161
 162 * **Updated the ZUC crypto PMD.**
 163
 164   * Added support for intel-ipsec-mb version 0.54.
 165   * Updated the PMD to support Multi-buffer ZUC-EIA3,
 166     improving performance significantly, when using
 167     intel-ipsec-mb version 0.54
 168
 169 * **Updated the SNOW3G crypto PMD.**
 170
 171   * Added support for intel-ipsec-mb version 0.54.
 172
 173 * **Updated the KASUMI crypto PMD.**
 174
 175   * Added support for intel-ipsec-mb version 0.54.
 176
 177 * **Added a new driver for Intel Foxville I225 devices.**
 178
 179   Added the new ``igc`` net driver for Intel Foxville I225 devices. See the
 180   :doc:`../nics/igc` NIC guide for more details on this new driver.
 181
 182 * **Updated Broadcom bnxt driver.**
 183
 184   Updated Broadcom bnxt driver with new features and improvements, including:
 185
 186   * Added support for host based flow table management
 187   * Added flow counters to extended stats
 188   * Added PCI function stats to extended stats
 189
 190 * **Added handling of mixed crypto algorithms in QAT PMD for GEN2.**
 191
 192   Enabled handling of mixed algorithms in encrypted digest hash-cipher
 193   (generation) and cipher-hash (verification) requests in QAT PMD
 194   when running on GEN2 QAT hardware with particular firmware versions
 195   (GEN3 support was added in DPDK 20.02).
 196
 197 * **Added plain SHA-1,224,256,384,512 support to QAT PMD.**
 198
 199   Added support for plain SHA-1, SHA-224, SHA-256, SHA-384 and SHA-512 hashes
 200   to QAT PMD.
 201
 202 * **Added AES-GCM/GMAC J0 support to QAT PMD.**
 203
 204   Added support for AES-GCM/GMAC J0 to Intel QuickAssist Technology PMD. User can
 205   use this feature by passing zero length IV in appropriate xform. For more
 206   info please refer to rte_crypto_sym.h J0 comments.
 207
 208 * **Added QAT intermediate buffer too small handling in QAT compression PMD.**
 209
 210   Added a special way of buffer handling when internal QAT intermediate buffer
 211   is too small for Huffman dynamic compression operation. Instead of falling
 212   back to fixed compression, the operation is now split into multiple smaller
 213   dynamic compression requests (possible to execute on QAT) and their results
 214   are then combined and copied into the output buffer. This is not possible if
 215   any checksum calculation was requested - in such case the code falls back to
 216   fixed compression as before.
 217
 218 * **Updated the turbo_sw bbdev PMD.**
 219
 220   Supported large size code blocks which does not fit in one mbuf segment.
 221
 222 * **Added Intel FPGA_5GNR_FEC bbdev PMD.**
 223
 224   Added a new ``fpga_5gnr_fec`` bbdev driver for the Intel\ |reg| FPGA PAC
 225   (Programmable  Acceleration Card) N3000.  See the
 226   :doc:`../bbdevs/fpga_5gnr_fec` BBDEV guide for more details on this new driver.
 227
 228 * **Updated ipsec-secgw sample application with following features.**
 229
 230   * Updated ipsec-secgw application to add event based packet processing.
 231     The worker thread(s) would receive events and submit them back to the
 232     event device after the processing. This way, multicore scaling and HW
 233     assisted scheduling is achieved by making use of the event device
 234     capabilities. The event mode currently supports only inline IPsec
 235     protocol offload.
 236
 237   * Updated ipsec-secgw application to support key sizes for AES-192-CBC,
 238     AES-192-GCM, AES-256-GCM algorithms.
 239
 240   * Added IPsec inbound load-distribution support for ipsec-secgw application
 241     using NIC load distribution feature(Flow Director).
 242
 243 * **Updated Telemetry Library.**
 244
 245   The updated Telemetry library has many improvements on the original version
 246   to make it more accessible and scalable:
 247
 248   * It enables DPDK libraries and applications provide their own specific
 249     telemetry information, rather than being limited to what could be reported
 250     through the metrics library.
 251
 252   * It is no longer dependent on the external Jansson library, which allows
 253     Telemetry be enabled by default.
 254
 255   * The socket handling has been simplified making it easier for clients to
 256     connect and retrieve information.
 257
 258 * **Added rte_graph library.**
 259
 260   Graph architecture abstracts the data processing functions as a ``node`` and
 261   ``links`` them together to create a complex ``graph`` to enable reusable/modular
 262   data processing functions. The graph library provides API to enable graph
 263   framework operations such as create, lookup, dump and destroy on graph and node
 264   operations such as clone, edge update, and edge shrink, etc.
 265   The API also allows to create the stats cluster to monitor per graph and per node stats.
 266
 267 * **Added rte_node library which consists of a set of packet processing nodes.**
 268
 269   The rte_node library that consists of nodes used by rte_graph library. Each
 270   node performs a specific packet processing function based on application
 271   configuration. The following nodes are added:
 272
 273   * Null node: Skeleton node that defines the general structure of a node.
 274   * Ethernet device node: Consists of ethernet Rx/Tx nodes as well as ethernet
 275     control APIs.
 276   * IPv4 lookup node: Consists of ipv4 extract and lpm lookup node. Routes can
 277     be configured by the application through ``rte_node_ip4_route_add`` function.
 278   * IPv4 rewrite node: Consists of ipv4 and ethernet header rewrite functionality
 279     that can be configured through ``rte_node_ip4_rewrite_add`` function.
 280   * Packet drop node: Frees the packets received to their respective mempool.
 281
 282 * **Added new l3fwd-graph sample application.**
 283
 284   Added an example application ``l3fwd-graph``. It demonstrates the usage of graph
 285   library and node library for packet processing. In addition to the library usage
 286   demonstration, this application can use for performance comparison with existing
 287   ``l3fwd`` (The static code without any nodes) with the modular ``l3fwd-graph``
 288   approach.
 289
 290
 291 Removed Items
 292 -------------
 293
 294 .. This section should contain removed items in this release. Sample format:
 295
 296    * Add a short 1-2 sentence description of the removed item
 297      in the past tense.
 298
 299    This section is a comment. Do not overwrite or remove it.
 300    Also, make sure to start the actual text at the margin.
 301    =========================================================
 302
 303
 304 API Changes
 305 -----------
 306
 307 .. This section should contain API changes. Sample format:
 308
 309    * sample: Add a short 1-2 sentence description of the API change
 310      which was announced in the previous releases and made in this release.
 311      Start with a scope label like "ethdev:".
 312      Use fixed width quotes for ``function_names`` or ``struct_names``.
 313      Use the past tense.
 314
 315    This section is a comment. Do not overwrite or remove it.
 316    Also, make sure to start the actual text at the margin.
 317    =========================================================
 318
 319 * mempool: The API of ``rte_mempool_populate_iova()`` and
 320   ``rte_mempool_populate_virt()`` changed to return 0 instead of -EINVAL
 321   when there is not enough room to store one object.
 322
 323
 324 ABI Changes
 325 -----------
 326
 327 .. This section should contain ABI changes. Sample format:
 328
 329    * sample: Add a short 1-2 sentence description of the ABI change
 330      which was announced in the previous releases and made in this release.
 331      Start with a scope label like "ethdev:".
 332      Use fixed width quotes for ``function_names`` or ``struct_names``.
 333      Use the past tense.
 334
 335    This section is a comment. Do not overwrite or remove it.
 336    Also, make sure to start the actual text at the margin.
 337    =========================================================
 338
 339 * No ABI change that would break compatibility with DPDK 20.02 and 19.11.
 340
 341
 342 Known Issues
 343 ------------
 344
 345 .. This section should contain new known issues in this release. Sample format:
 346
 347    * **Add title in present tense with full stop.**
 348
 349      Add a short 1-2 sentence description of the known issue
 350      in the present tense. Add information on any known workarounds.
 351
 352    This section is a comment. Do not overwrite or remove it.
 353    Also, make sure to start the actual text at the margin.
 354    =========================================================
 355
 356
 357 Tested Platforms
 358 ----------------
 359
 360 .. This section should contain a list of platforms that were tested
 361    with this release.
 362
 363    The format is:
 364
 365    * <vendor> platform with <vendor> <type of devices> combinations
 366
 367      * List of CPU
 368      * List of OS
 369      * List of devices
 370      * Other relevant details...
 371
 372    This section is a comment. Do not overwrite or remove it.
 373    Also, make sure to start the actual text at the margin.
 374    =========================================================