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