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