doc/guides/rel_notes/release_22_03.rst

   1 .. SPDX-License-Identifier: BSD-3-Clause
   2    Copyright 2021 The DPDK contributors
   3
   4 .. include:: <isonum.txt>
   5
   6 DPDK Release 22.03
   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       ninja -C build doc
  21       xdg-open build/doc/guides/html/rel_notes/release_22_03.html
  22
  23
  24 New Features
  25 ------------
  26
  27 .. This section should contain new features added in this release.
  28    Sample format:
  29
  30    * **Add a title in the past tense with a full stop.**
  31
  32      Add a short 1-2 sentence description in the past tense.
  33      The description should be enough to allow someone scanning
  34      the release notes to understand the new feature.
  35
  36      If the feature adds a lot of sub-features you can use a bullet list
  37      like this:
  38
  39      * Added feature foo to do something.
  40      * Enhanced feature bar to do something else.
  41
  42      Refer to the previous release notes for examples.
  43
  44      Suggested order in release notes items:
  45      * Core libs (EAL, mempool, ring, mbuf, buses)
  46      * Device abstraction libs and PMDs (ordered alphabetically by vendor name)
  47        - ethdev (lib, PMDs)
  48        - cryptodev (lib, PMDs)
  49        - eventdev (lib, PMDs)
  50        - etc
  51      * Other libs
  52      * Apps, Examples, Tools (if significant)
  53
  54      This section is a comment. Do not overwrite or remove it.
  55      Also, make sure to start the actual text at the margin.
  56      =======================================================
  57
  58 * **Added ability to reuse hugepages in Linux.**
  59
  60   It is possible to reuse files in hugetlbfs to speed up hugepage mapping,
  61   which may be useful for fast restart and large allocations.
  62   The new mode is activated with ``--huge-unlink=never``
  63   and has security implications, refer to the user and programmer guides.
  64
  65 * **Added functions to calculate UDP/TCP checksum in mbuf.**
  66
  67   * Added the following functions to calculate UDP/TCP checksum of packets
  68     which can be over multi-segments:
  69     - ``rte_ipv4_udptcp_cksum_mbuf()``
  70     - ``rte_ipv4_udptcp_cksum_mbuf_verify()``
  71     - ``rte_ipv6_udptcp_cksum_mbuf()``
  72     - ``rte_ipv6_udptcp_cksum_mbuf_verify()``
  73
  74 * **Added functions to configure flow engine.**
  75
  76   * Added ``rte_flow_configure`` API to configure flow management
  77     engine, allowing to pre-allocate some resources for better performance.
  78     Added ``rte_flow_info_get`` API to retrieve available resources.
  79
  80   * Added ``rte_flow_template_table_create`` API to group flow rules
  81     with the same flow attributes and common matching patterns and actions
  82     defined by ``rte_flow_pattern_template_create`` and
  83     ``rte_flow_actions_template_create`` respectively.
  84     Corresponding functions to destroy these entities are:
  85     ``rte_flow_template_table_destroy``, ``rte_flow_pattern_template_destroy``
  86     and ``rte_flow_actions_template_destroy``.
  87
  88 * **Added functions for asynchronous flow rules creation/destruction.**
  89
  90   * Added ``rte_flow_async_create`` and ``rte_flow_async_destroy`` API
  91     to enqueue flow creaion/destruction operations asynchronously as well as
  92     ``rte_flow_pull`` to poll and retrieve results of these operations and
  93     ``rte_flow_push`` to push all the in-flight operations to the NIC.
  94
  95   * Added asynchronous API for indirect actions management:
  96     ``rte_flow_async_action_handle_create``,
  97     ``rte_flow_async_action_handle_destroy`` and
  98     ``rte_flow_async_action_handle_update``.
  99
 100 * **Added rte_flow support for matching GRE optional fields.**
 101
 102   Added ``gre_option`` item in rte_flow to support checksum/key/sequence
 103   matching in GRE packets.
 104
 105 * **Added new RSS offload types for L2TPv2 in RSS flow.**
 106
 107   Added macro RTE_ETH_RSS_L2TPV2, now L2TPv2 session ID field can be used as
 108   input set for RSS.
 109
 110 * **Added IP reassembly Ethernet offload API, to get and set config.**
 111
 112   Added IP reassembly offload APIs which provide functions to query IP
 113   reassembly capabilities, to set configuration and to get currently set
 114   reassembly configuration.
 115
 116 * **Added an API to enable queue based priority flow ctrl(PFC).**
 117
 118   New APIs, ``rte_eth_dev_priority_flow_ctrl_queue_info_get()`` and
 119   ``rte_eth_dev_priority_flow_ctrl_queue_configure()``, was added.
 120
 121 * **Added a private dump API, to dump private info from device.**
 122
 123   Added the private dump API which provides querying private info from device.
 124   There exists many private properties in different PMD drivers.
 125   The information of these properties is important for debug.
 126   As the information is private, a dump function is introduced.
 127
 128 * **Updated AF_XDP PMD**
 129
 130   * Added support for libxdp >=v1.2.2.
 131   * Re-enabled secondary process support. RX/TX is not supported.
 132
 133 * **Updated Amazon ENA PMD.**
 134
 135   The new driver version (v2.6.0) introduced bug fixes and improvements, including:
 136
 137   * Added new checksum related xstats: ``l3_csum_bad``, ``l4_csum_bad`` and
 138     ``l4_csum_good``.
 139   * Added support for the link status configuration.
 140   * Added optimized memcpy support for the ARM platforms.
 141   * Added ENA admin queue support for the MP applications.
 142   * Added free Tx mbuf on demand feature support.
 143   * Added ``rte_eth_xstats_get_names_by_id`` API support.
 144   * Added ``miss_txc_to`` device argument for setting the Tx completion timeout.
 145
 146 * **Updated Cisco enic driver.**
 147
 148   * Added rte_flow support for matching GENEVE packets.
 149   * Added rte_flow support for matching eCPRI packets.
 150
 151 * **Updated Intel iavf driver.**
 152
 153   * Added L2TPv2 (include PPP over L2TPv2) RSS support based on outer
 154     MAC src/dst address and L2TPv2 session ID.
 155   * Added L2TPv2 (include PPP over L2TPv2) FDIR support based on outer
 156     MAC src/dst address and L2TPv2 session ID.
 157   * Added PPPoL2TPv2oUDP FDIR distribute packets based on inner IP
 158     src/dst address and UDP/TCP src/dst port.
 159
 160 * **Updated Marvell cnxk ethdev PMD.**
 161
 162   * Added queue based priority flow control support for CN9K & CN10K.
 163
 164 * **Updated Mellanox mlx5 driver.**
 165
 166   * Supported ConnectX-7 capability to schedule traffic sending on timestamp.
 167   * Added WQE based hardware steering support with ``rte_flow_async`` API.
 168
 169 * **Updated Wangxun ngbe driver.**
 170
 171   * Added support for devices of custom PHY interfaces.
 172     - M88E1512 PHY connects to RJ45
 173     - M88E1512 PHY connects to RGMII combo
 174     - YT8521S PHY connects to SFP
 175   * Added LED OEM support.
 176
 177 * **Updated Wangxun txgbe driver.**
 178
 179   * Added LED OEM support.
 180
 181 * **Added an API for private user data in asymmetric crypto session.**
 182
 183   An API was added to get/set an asymmetric crypto session's user data.
 184
 185 * **Updated Marvell cnxk crypto PMD.**
 186
 187   * Added SHA256-HMAC support in lookaside protocol (IPsec) for CN10K.
 188   * Added SHA384-HMAC support in lookaside protocol (IPsec) for CN9K & CN10K.
 189   * Added SHA512-HMAC support in lookaside protocol (IPsec) for CN9K & CN10K.
 190   * Added AES-CTR support in lookaside protocol (IPsec) for CN9K & CN10K.
 191   * Added NULL cipher support in lookaside protocol (IPsec) for CN9K & CN10K.
 192   * Added AES-XCBC support in lookaside protocol (IPsec) for CN9K & CN10K.
 193   * Added AES-CMAC support in CN9K & CN10K.
 194   * Added ESN and anti-replay support in lookaside protocol (IPsec) for CN10K.
 195
 196 * **Updated Intel QuickAssist Technology crypto PMD.**
 197
 198   * Added support for CPM2.0b (4942) devices.
 199   * Added ECDSA algorithm support.
 200   * Added ECPM algorithm support.
 201
 202 * **Added an API to retrieve event port id of ethdev Rx adapter.**
 203
 204   The new API ``rte_event_eth_rx_adapter_event_port_get()`` was added.
 205
 206 * **Added support for Kunpeng930 DMA devices to HiSilicon DMA PMD.**
 207
 208   * Kunpeng930 DMA devices are now enabled for HiSilicon DMA PMD.
 209
 210 * **Added CNXK GPIO PMD.**
 211
 212   Added a new rawdevice PMD which allows to manage userspace GPIOs and install
 213   custom GPIO interrupt handlers which bypass kernel. This is especially useful
 214   for applications, that besides providing standard dataplane functionality
 215   want to have fast and low latency access to GPIO pin state.
 216
 217   See the :doc:`../rawdevs/cnxk_gpio` rawdev guide for more details on this
 218   driver.
 219
 220 * **Updated testpmd.**
 221
 222   * Called ``rte_ipv4/6_udptcp_cksum_mbuf()`` functions in testpmd csum mode
 223     to support software UDP/TCP checksum over multiple segments.
 224
 225 * **Added crypto producer mode in test-eventdev.**
 226
 227   * Crypto producer mode helps to measure performance of OP_NEW and OP_FORWARD
 228     modes of event crypto adapter.
 229
 230
 231 Removed Items
 232 -------------
 233
 234 .. This section should contain removed items in this release. Sample format:
 235
 236    * Add a short 1-2 sentence description of the removed item
 237      in the past tense.
 238
 239    This section is a comment. Do not overwrite or remove it.
 240    Also, make sure to start the actual text at the margin.
 241    =======================================================
 242
 243 * **Removed experimental performance thread example application.**
 244
 245
 246 API Changes
 247 -----------
 248
 249 .. This section should contain API changes. Sample format:
 250
 251    * sample: Add a short 1-2 sentence description of the API change
 252      which was announced in the previous releases and made in this release.
 253      Start with a scope label like "ethdev:".
 254      Use fixed width quotes for ``function_names`` or ``struct_names``.
 255      Use the past tense.
 256
 257    This section is a comment. Do not overwrite or remove it.
 258    Also, make sure to start the actual text at the margin.
 259    =======================================================
 260
 261 * net: added experimental functions ``rte_ipv4_udptcp_cksum_mbuf()``,
 262   ``rte_ipv4_udptcp_cksum_mbuf_verify()``, ``rte_ipv6_udptcp_cksum_mbuf()``,
 263   ``rte_ipv6_udptcp_cksum_mbuf_verify()``
 264
 265 * ethdev: Old public macros and enumeration constants without ``RTE_ETH_`` prefix,
 266   which are kept for backward compatibility, are marked as deprecated.
 267
 268 * cryptodev: The asymmetric session handling was modified to use a single
 269   mempool object. An API ``rte_cryptodev_asym_session_pool_create`` was added
 270   to create a mempool with element size big enough to hold the generic asymmetric
 271   session header, max size for a device private session data, and user data size.
 272   The session structure was moved to ``cryptodev_pmd.h``,
 273   hiding it from applications.
 274   The API ``rte_cryptodev_asym_session_init`` was removed as the initialization
 275   is now moved to ``rte_cryptodev_asym_session_create``, which was updated to
 276   return an integer value to indicate initialisation errors.
 277
 278
 279 ABI Changes
 280 -----------
 281
 282 .. This section should contain ABI changes. Sample format:
 283
 284    * sample: Add a short 1-2 sentence description of the ABI change
 285      which was announced in the previous releases and made in this release.
 286      Start with a scope label like "ethdev:".
 287      Use fixed width quotes for ``function_names`` or ``struct_names``.
 288      Use the past tense.
 289
 290    This section is a comment. Do not overwrite or remove it.
 291    Also, make sure to start the actual text at the margin.
 292    =======================================================
 293
 294 * No ABI change that would break compatibility with 21.11.
 295
 296
 297 Known Issues
 298 ------------
 299
 300 .. This section should contain new known issues in this release. Sample format:
 301
 302    * **Add title in present tense with full stop.**
 303
 304      Add a short 1-2 sentence description of the known issue
 305      in the present tense. Add information on any known workarounds.
 306
 307    This section is a comment. Do not overwrite or remove it.
 308    Also, make sure to start the actual text at the margin.
 309    =======================================================
 310
 311
 312 Tested Platforms
 313 ----------------
 314
 315 .. This section should contain a list of platforms that were tested
 316    with this release.
 317
 318    The format is:
 319
 320    * <vendor> platform with <vendor> <type of devices> combinations
 321
 322      * List of CPU
 323      * List of OS
 324      * List of devices
 325      * Other relevant details...
 326
 327    This section is a comment. Do not overwrite or remove it.
 328    Also, make sure to start the actual text at the margin.
 329    =======================================================