doc/guides/rel_notes/release_21_11.rst

   1 .. SPDX-License-Identifier: BSD-3-Clause
   2    Copyright 2021 The DPDK contributors
   3
   4 .. include:: <isonum.txt>
   5
   6 DPDK Release 21.11
   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_21_11.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 * **Enabled new devargs parser.**
  59
  60   * Enabled devargs syntax
  61     ``bus=X,paramX=x/class=Y,paramY=y/driver=Z,paramZ=z``
  62   * Added bus-level parsing of the devargs syntax.
  63   * Kept compatibility with the legacy syntax as parsing fallback.
  64
  65 * **Added new RSS offload types for IPv4/L4 checksum in RSS flow.**
  66
  67   Added macros ETH_RSS_IPV4_CHKSUM and ETH_RSS_L4_CHKSUM, now IPv4 and
  68   TCP/UDP/SCTP header checksum field can be used as input set for RSS.
  69
  70 * **Updated af_packet ethdev driver.**
  71
  72   * Default VLAN strip behavior was changed. VLAN tag won't be stripped
  73     unless ``DEV_RX_OFFLOAD_VLAN_STRIP`` offload is enabled.
  74
  75 * **Updated Broadcom bnxt PMD.**
  76
  77   * Added flow offload support for Thor.
  78   * Implement support for tunnel offload.
  79   * Updated HWRM API to version 1.10.2.44
  80
  81 * **Updated Intel iavf driver.**
  82
  83   * Added Intel iavf support on Windows.
  84   * Added IPv4 and L4 (TCP/UDP/SCTP) checksum hash support in RSS flow.
  85
  86 * **Updated Intel ice driver.**
  87
  88   * Added 1PPS out support by a devargs.
  89   * Added IPv4 and L4 (TCP/UDP/SCTP) checksum hash support in RSS flow.
  90   * Added DEV_RX_OFFLOAD_TIMESTAMP support.
  91   * Added timesync API support under scalar path.
  92
  93 * **Updated Intel ixgbe driver.**
  94
  95   * Added Intel ixgbe support on Windows.
  96
  97 * **Updated Marvell cnxk ethdev driver.**
  98
  99   * Added rte_flow support for dual VLAN insert and strip actions.
 100   * Added rte_tm support.
 101   * Added support for Inline IPsec for CN9K event mode and CN10K
 102     poll mode and event mode.
 103
 104 * **Updated Marvell cnxk crypto PMD.**
 105
 106   * Added AES-CBC SHA1-HMAC support in lookaside protocol (IPsec) for CN10K.
 107   * Added Transport mode support in lookaside protocol (IPsec) for CN10K.
 108   * Added UDP encapsulation support in lookaside protocol (IPsec) for CN10K.
 109   * Added support for lookaside protocol (IPsec) offload for CN9K.
 110   * Added support for ZUC algorithm with 256-bit key length for CN10K.
 111
 112 * **Added support for event crypto adapter on Marvell CN10K and CN9K.**
 113
 114   * Added event crypto adapter OP_FORWARD mode support.
 115
 116 * **Updated NXP dpaa_sec crypto PMD.**
 117
 118   * Added DES-CBC, AES-XCBC-MAC, AES-CMAC and non-HMAC algo support.
 119   * Added PDCP short MAC-I support.
 120
 121 * **Updated NXP dpaa2_sec crypto PMD.**
 122
 123   * Added PDCP short MAC-I support.
 124
 125 * **Added multi-process support for testpmd.**
 126
 127   Added command-line options to specify total number of processes and
 128   current process ID. Each process owns subset of Rx and Tx queues.
 129
 130 * **Updated test-crypto-perf application with new cases.**
 131
 132   * Added support for asymmetric crypto throughput performance measurement.
 133     Only modex is supported for now.
 134
 135 * **Added lookaside protocol (IPsec) tests in dpdk-test.**
 136
 137   * Added known vector tests (AES-GCM 128, 192, 256).
 138   * Added tests to verify error reporting with ICV corruption.
 139   * Added tests to verify IV generation.
 140   * Added tests to verify UDP encapsulation.
 141   * Added tests to verify UDP encapsulation ports.
 142   * Added tests to validate packets soft expiry.
 143   * Added tests to validate packets hard expiry.
 144   * Added tests to verify tunnel header verification in IPsec inbound.
 145
 146
 147 Removed Items
 148 -------------
 149
 150 .. This section should contain removed items in this release. Sample format:
 151
 152    * Add a short 1-2 sentence description of the removed item
 153      in the past tense.
 154
 155    This section is a comment. Do not overwrite or remove it.
 156    Also, make sure to start the actual text at the margin.
 157    =======================================================
 158
 159 * eal: Removed the deprecated function ``rte_get_master_lcore()``
 160   and the iterator macro ``RTE_LCORE_FOREACH_SLAVE``.
 161
 162 * eal: The old api arguments that were deprecated for
 163   blacklist/whitelist are removed. Users must use the new
 164   block/allow list arguments.
 165
 166 * ethdev: Removed the port mirroring API. A more fine-grain flow API
 167   action ``RTE_FLOW_ACTION_TYPE_SAMPLE`` should be used instead.
 168   The structures ``rte_eth_mirror_conf`` and ``rte_eth_vlan_mirror`` and
 169   the functions ``rte_eth_mirror_rule_set`` and
 170   ``rte_eth_mirror_rule_reset`` along with the associated macros
 171   ``ETH_MIRROR_*`` are removed.
 172
 173 * i40e: Removed i40evf driver.
 174   iavf already became the default VF driver for i40e devices,
 175   so there is no need to maintain i40evf.
 176
 177
 178 API Changes
 179 -----------
 180
 181 .. This section should contain API changes. Sample format:
 182
 183    * sample: Add a short 1-2 sentence description of the API change
 184      which was announced in the previous releases and made in this release.
 185      Start with a scope label like "ethdev:".
 186      Use fixed width quotes for ``function_names`` or ``struct_names``.
 187      Use the past tense.
 188
 189    This section is a comment. Do not overwrite or remove it.
 190    Also, make sure to start the actual text at the margin.
 191    =======================================================
 192
 193 * kvargs: The experimental function ``rte_kvargs_strcmp()`` has been
 194   removed. Its usages have been replaced by a new function
 195   ``rte_kvargs_get_with_value()``.
 196
 197 * net: Renamed ``s_addr`` and ``d_addr`` fields of ``rte_ether_hdr`` structure
 198   to ``src_addr`` and ``dst_addr``, respectively.
 199
 200 * cryptodev: The API rte_cryptodev_pmd_is_valid_dev is modified to
 201   rte_cryptodev_is_valid_dev as it can be used by the application as
 202   well as PMD to check whether the device is valid or not.
 203
 204 * cryptodev: The rte_cryptodev_pmd.* files are renamed as cryptodev_pmd.*
 205   as it is for drivers only and should be private to DPDK, and not
 206   installed for app use.
 207
 208 * cryptodev: A ``reserved`` byte from structure ``rte_crypto_op`` was
 209   renamed to ``aux_flags`` to indicate warnings and other information from
 210   the crypto/security operation. This field will be used to communicate
 211   events such as soft expiry with IPsec in lookaside mode.
 212
 213
 214 ABI Changes
 215 -----------
 216
 217 .. This section should contain ABI changes. Sample format:
 218
 219    * sample: Add a short 1-2 sentence description of the ABI change
 220      which was announced in the previous releases and made in this release.
 221      Start with a scope label like "ethdev:".
 222      Use fixed width quotes for ``function_names`` or ``struct_names``.
 223      Use the past tense.
 224
 225    This section is a comment. Do not overwrite or remove it.
 226    Also, make sure to start the actual text at the margin.
 227    =======================================================
 228
 229 * security: ``rte_security_set_pkt_metadata`` and ``rte_security_get_userdata``
 230   routines used by inline outbound and inline inbound security processing were
 231   made inline and enhanced to do simple 64-bit set/get for PMDs that do not
 232   have much processing in PMD specific callbacks but just 64-bit set/get.
 233   This avoids a per packet function pointer jump overhead for such PMDs.
 234
 235 * security: A new option ``iv_gen_disable`` was added in structure
 236   ``rte_security_ipsec_sa_options`` to disable IV generation inside PMD,
 237   so that application can provide its own IV and test known test vectors.
 238
 239 * security: A new option ``tunnel_hdr_verify`` was added in structure
 240   ``rte_security_ipsec_sa_options`` to indicate whether outer header
 241   verification need to be done as part of inbound IPsec processing.
 242
 243 * security: A new option ``udp_ports_verify`` was added in structure
 244   ``rte_security_ipsec_sa_options`` to indicate whether UDP ports
 245   verification need to be done as part of inbound IPsec processing.
 246
 247 * security: A new structure ``rte_security_ipsec_lifetime`` was added to
 248   replace ``esn_soft_limit`` in IPsec configuration structure
 249   ``rte_security_ipsec_xform`` to allow applications to configure SA soft
 250   and hard expiry limits. Limits can be either in number of packets or bytes.
 251
 252 * bbdev: Added capability related to more comprehensive CRC options,
 253   shifting values of the ``enum rte_bbdev_op_ldpcdec_flag_bitmasks``.
 254
 255
 256 Known Issues
 257 ------------
 258
 259 .. This section should contain new known issues in this release. Sample format:
 260
 261    * **Add title in present tense with full stop.**
 262
 263      Add a short 1-2 sentence description of the known issue
 264      in the present tense. Add information on any known workarounds.
 265
 266    This section is a comment. Do not overwrite or remove it.
 267    Also, make sure to start the actual text at the margin.
 268    =======================================================
 269
 270
 271 Tested Platforms
 272 ----------------
 273
 274 .. This section should contain a list of platforms that were tested
 275    with this release.
 276
 277    The format is:
 278
 279    * <vendor> platform with <vendor> <type of devices> combinations
 280
 281      * List of CPU
 282      * List of OS
 283      * List of devices
 284      * Other relevant details...
 285
 286    This section is a comment. Do not overwrite or remove it.
 287    Also, make sure to start the actual text at the margin.
 288    =======================================================