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 APIs for RCU defer queue.**
  70
  71   Added APIs to create and delete defer queue. Additional APIs are provided
  72   to enqueue a deleted resource and reclaim the resource in the future.
  73   These APIs help the application use lock-free data structures with
  74   less effort.
  75
  76 * **Added new API for rte_ring.**
  77
  78   * New synchronization modes for rte_ring.
  79
  80   Introduced new optional MT synchronization modes for rte_ring:
  81   Relaxed Tail Sync (RTS) mode and Head/Tail Sync (HTS) mode.
  82   With these mode selected, rte_ring shows significant improvements for
  83   average enqueue/dequeue times on overcommitted systems.
  84
  85   * Added peek style API for rte_ring.
  86
  87   For rings with producer/consumer in RTE_RING_SYNC_ST, RTE_RING_SYNC_MT_HTS
  88   mode, provide an ability to split enqueue/dequeue operation into two phases
  89   (enqueue/dequeue start; enqueue/dequeue finish). That allows user to inspect
  90   objects in the ring without removing them from it (aka MT safe peek).
  91
  92 * **Added flow aging support.**
  93
  94   Added flow aging support to detect and report aged-out flows, including:
  95
  96   * Added new action: ``RTE_FLOW_ACTION_TYPE_AGE`` to set the timeout
  97     and the application flow context for each flow.
  98   * Added new event: ``RTE_ETH_EVENT_FLOW_AGED`` for the driver to report
  99     that there are new aged-out flows.
 100   * Added new query: ``rte_flow_get_aged_flows`` to get the aged-out flows
 101     contexts from the port.
 102
 103 * **ethdev: Added a new value to link speed for 200Gbps**
 104
 105 * **Updated Amazon ena driver.**
 106
 107   Updated ena PMD with new features and improvements, including:
 108
 109   * Added support for large LLQ (Low-latency queue) headers.
 110   * Added Tx drops as new extended driver statistic.
 111   * Added support for accelerated LLQ mode.
 112   * Handling of the 0 length descriptors on the Rx path.
 113
 114 * **Updated Intel i40e driver.**
 115
 116   Updated i40e PMD with new features and improvements, including:
 117
 118   * Enable MAC address as FDIR input set for ipv4-other, ipv4-udp and ipv4-tcp.
 119   * Added support for RSS using L3/L4 source/destination only.
 120   * Added support for setting hash function in rte flow.
 121
 122 * **Updated the Intel iavf driver.**
 123
 124   Update the Intel iavf driver with new features and improvements, including:
 125
 126   * Added generic filter support.
 127   * Added advanced iavf with FDIR capability.
 128   * Added advanced RSS configuration for VFs.
 129
 130 * **Updated the Intel ice driver.**
 131
 132   Updated the Intel ice driver with new features and improvements, including:
 133
 134   * Added support for DCF (Device Config Function) feature.
 135   * Added switch filter support for intel DCF.
 136
 137 * **Updated Marvell OCTEON TX2 ethdev driver.**
 138
 139   Updated Marvell OCTEON TX2 ethdev driver with traffic manager support with
 140   below features.
 141
 142   * Hierarchial Scheduling with DWRR and SP.
 143   * Single rate - Two color, Two rate - Three color shaping.
 144
 145 * **Updated Mellanox mlx5 driver.**
 146
 147   Updated Mellanox mlx5 driver with new features and improvements, including:
 148
 149   * Added support for matching on IPv4 Time To Live and IPv6 Hop Limit.
 150   * Added support for creating Relaxed Ordering Memory Regions.
 151   * Added support for configuring Hairpin queue data buffer size.
 152   * Added support for jumbo frame size (9K MTU) in Multi-Packet RQ mode.
 153   * Removed flow rules caching for memory saving and compliance with ethdev API.
 154   * Optimized the memory consumption of flow.
 155   * Added support for flow aging based on hardware counter.
 156   * Added support for flow pattern with wildcard VLAN item (without VID value).
 157   * Updated support for matching on GTP header, added match on GTP flags.
 158
 159 * **Added Chacha20-Poly1305 algorithm to Cryptodev API.**
 160
 161   Chacha20-Poly1305 AEAD algorithm can now be supported in Cryptodev.
 162
 163 * **Updated the AESNI MB crypto PMD.**
 164
 165   * Added support for intel-ipsec-mb version 0.54.
 166   * Updated the AESNI MB PMD with AES-256 DOCSIS algorithm.
 167   * Added support for synchronous Crypto burst API.
 168
 169 * **Updated the AESNI GCM crypto PMD.**
 170
 171   * Added support for intel-ipsec-mb version 0.54.
 172
 173 * **Updated the ZUC crypto PMD.**
 174
 175   * Added support for intel-ipsec-mb version 0.54.
 176   * Updated the PMD to support Multi-buffer ZUC-EIA3,
 177     improving performance significantly, when using
 178     intel-ipsec-mb version 0.54
 179
 180 * **Updated the SNOW3G crypto PMD.**
 181
 182   * Added support for intel-ipsec-mb version 0.54.
 183
 184 * **Updated the KASUMI crypto PMD.**
 185
 186   * Added support for intel-ipsec-mb version 0.54.
 187
 188 * **Added a new driver for Intel Foxville I225 devices.**
 189
 190   Added the new ``igc`` net driver for Intel Foxville I225 devices. See the
 191   :doc:`../nics/igc` NIC guide for more details on this new driver.
 192
 193 * **Updated Broadcom bnxt driver.**
 194
 195   Updated Broadcom bnxt driver with new features and improvements, including:
 196
 197   * Added support for host based flow table management
 198   * Added flow counters to extended stats
 199   * Added PCI function stats to extended stats
 200
 201 * **Added handling of mixed crypto algorithms in QAT PMD for GEN2.**
 202
 203   Enabled handling of mixed algorithms in encrypted digest hash-cipher
 204   (generation) and cipher-hash (verification) requests in QAT PMD
 205   when running on GEN2 QAT hardware with particular firmware versions
 206   (GEN3 support was added in DPDK 20.02).
 207
 208 * **Added plain SHA-1,224,256,384,512 support to QAT PMD.**
 209
 210   Added support for plain SHA-1, SHA-224, SHA-256, SHA-384 and SHA-512 hashes
 211   to QAT PMD.
 212
 213 * **Added AES-GCM/GMAC J0 support to QAT PMD.**
 214
 215   Added support for AES-GCM/GMAC J0 to Intel QuickAssist Technology PMD. User can
 216   use this feature by passing zero length IV in appropriate xform. For more
 217   info please refer to rte_crypto_sym.h J0 comments.
 218
 219 * **Updated the QAT PMD for AES-256 DOCSIS.**
 220
 221   Added AES-256 DOCSIS algorithm support to QAT PMD.
 222
 223 * **Added QAT intermediate buffer too small handling in QAT compression PMD.**
 224
 225   Added a special way of buffer handling when internal QAT intermediate buffer
 226   is too small for Huffman dynamic compression operation. Instead of falling
 227   back to fixed compression, the operation is now split into multiple smaller
 228   dynamic compression requests (possible to execute on QAT) and their results
 229   are then combined and copied into the output buffer. This is not possible if
 230   any checksum calculation was requested - in such case the code falls back to
 231   fixed compression as before.
 232
 233 * **Updated the turbo_sw bbdev PMD.**
 234
 235   Supported large size code blocks which does not fit in one mbuf segment.
 236
 237 * **Added Intel FPGA_5GNR_FEC bbdev PMD.**
 238
 239   Added a new ``fpga_5gnr_fec`` bbdev driver for the Intel\ |reg| FPGA PAC
 240   (Programmable  Acceleration Card) N3000.  See the
 241   :doc:`../bbdevs/fpga_5gnr_fec` BBDEV guide for more details on this new driver.
 242
 243 * **Updated the DSW event device.**
 244
 245   Updated the DSW PMD with new features and improvements, including:
 246
 247   * Improved flow migration mechanism, allowing faster and more
 248     accurate load balancing.
 249   * Improved behavior on high-core count systems.
 250   * Reduced latency in low-load situations.
 251   * Extended DSW xstats with migration- and load-related statistics.
 252
 253 * **Updated ipsec-secgw sample application with following features.**
 254
 255   * Updated ipsec-secgw application to add event based packet processing.
 256     The worker thread(s) would receive events and submit them back to the
 257     event device after the processing. This way, multicore scaling and HW
 258     assisted scheduling is achieved by making use of the event device
 259     capabilities. The event mode currently supports only inline IPsec
 260     protocol offload.
 261
 262   * Updated ipsec-secgw application to support key sizes for AES-192-CBC,
 263     AES-192-GCM, AES-256-GCM algorithms.
 264
 265   * Added IPsec inbound load-distribution support for ipsec-secgw application
 266     using NIC load distribution feature(Flow Director).
 267
 268 * **Updated Telemetry Library.**
 269
 270   The updated Telemetry library has many improvements on the original version
 271   to make it more accessible and scalable:
 272
 273   * It enables DPDK libraries and applications provide their own specific
 274     telemetry information, rather than being limited to what could be reported
 275     through the metrics library.
 276
 277   * It is no longer dependent on the external Jansson library, which allows
 278     Telemetry be enabled by default.
 279
 280   * The socket handling has been simplified making it easier for clients to
 281     connect and retrieve information.
 282
 283 * **Added rte_graph library.**
 284
 285   Graph architecture abstracts the data processing functions as a ``node`` and
 286   ``links`` them together to create a complex ``graph`` to enable reusable/modular
 287   data processing functions. The graph library provides API to enable graph
 288   framework operations such as create, lookup, dump and destroy on graph and node
 289   operations such as clone, edge update, and edge shrink, etc.
 290   The API also allows to create the stats cluster to monitor per graph and per node stats.
 291
 292 * **Added rte_node library which consists of a set of packet processing nodes.**
 293
 294   The rte_node library that consists of nodes used by rte_graph library. Each
 295   node performs a specific packet processing function based on application
 296   configuration. The following nodes are added:
 297
 298   * Null node: Skeleton node that defines the general structure of a node.
 299   * Ethernet device node: Consists of ethernet Rx/Tx nodes as well as ethernet
 300     control APIs.
 301   * IPv4 lookup node: Consists of ipv4 extract and lpm lookup node. Routes can
 302     be configured by the application through ``rte_node_ip4_route_add`` function.
 303   * IPv4 rewrite node: Consists of ipv4 and ethernet header rewrite functionality
 304     that can be configured through ``rte_node_ip4_rewrite_add`` function.
 305   * Packet drop node: Frees the packets received to their respective mempool.
 306
 307 * **Added new l3fwd-graph sample application.**
 308
 309   Added an example application ``l3fwd-graph``. It demonstrates the usage of graph
 310   library and node library for packet processing. In addition to the library usage
 311   demonstration, this application can use for performance comparison with existing
 312   ``l3fwd`` (The static code without any nodes) with the modular ``l3fwd-graph``
 313   approach.
 314
 315 * **Updated testpmd application.**
 316
 317   * Added a new cmdline option ``--rx-mq-mode`` which can be used to test PMD's
 318     behaviour on handling Rx mq mode.
 319
 320
 321 Removed Items
 322 -------------
 323
 324 .. This section should contain removed items in this release. Sample format:
 325
 326    * Add a short 1-2 sentence description of the removed item
 327      in the past tense.
 328
 329    This section is a comment. Do not overwrite or remove it.
 330    Also, make sure to start the actual text at the margin.
 331    =========================================================
 332
 333
 334 API Changes
 335 -----------
 336
 337 .. This section should contain API changes. Sample format:
 338
 339    * sample: Add a short 1-2 sentence description of the API change
 340      which was announced in the previous releases and made in this release.
 341      Start with a scope label like "ethdev:".
 342      Use fixed width quotes for ``function_names`` or ``struct_names``.
 343      Use the past tense.
 344
 345    This section is a comment. Do not overwrite or remove it.
 346    Also, make sure to start the actual text at the margin.
 347    =========================================================
 348
 349 * mempool: The API of ``rte_mempool_populate_iova()`` and
 350   ``rte_mempool_populate_virt()`` changed to return 0 instead of -EINVAL
 351   when there is not enough room to store one object.
 352
 353
 354 ABI Changes
 355 -----------
 356
 357 .. This section should contain ABI changes. Sample format:
 358
 359    * sample: Add a short 1-2 sentence description of the ABI change
 360      which was announced in the previous releases and made in this release.
 361      Start with a scope label like "ethdev:".
 362      Use fixed width quotes for ``function_names`` or ``struct_names``.
 363      Use the past tense.
 364
 365    This section is a comment. Do not overwrite or remove it.
 366    Also, make sure to start the actual text at the margin.
 367    =========================================================
 368
 369 * No ABI change that would break compatibility with DPDK 20.02 and 19.11.
 370
 371
 372 Known Issues
 373 ------------
 374
 375 .. This section should contain new known issues in this release. Sample format:
 376
 377    * **Add title in present tense with full stop.**
 378
 379      Add a short 1-2 sentence description of the known issue
 380      in the present tense. Add information on any known workarounds.
 381
 382    This section is a comment. Do not overwrite or remove it.
 383    Also, make sure to start the actual text at the margin.
 384    =========================================================
 385
 386
 387 Tested Platforms
 388 ----------------
 389
 390 .. This section should contain a list of platforms that were tested
 391    with this release.
 392
 393    The format is:
 394
 395    * <vendor> platform with <vendor> <type of devices> combinations
 396
 397      * List of CPU
 398      * List of OS
 399      * List of devices
 400      * Other relevant details...
 401
 402    This section is a comment. Do not overwrite or remove it.
 403    Also, make sure to start the actual text at the margin.
 404    =========================================================