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