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
 111 * **Added support for event crypto adapter on Marvell CN10K and CN9K.**
 112
 113   * Added event crypto adapter OP_FORWARD mode support.
 114
 115 * **Updated NXP dpaa_sec crypto PMD.**
 116
 117   * Added DES-CBC, AES-XCBC-MAC, AES-CMAC and non-HMAC algo support.
 118   * Added PDCP short MAC-I support.
 119
 120 * **Updated NXP dpaa2_sec crypto PMD.**
 121
 122   * Added PDCP short MAC-I support.
 123
 124 * **Added multi-process support for testpmd.**
 125
 126   Added command-line options to specify total number of processes and
 127   current process ID. Each process owns subset of Rx and Tx queues.
 128
 129 * **Updated test-crypto-perf application with new cases.**
 130
 131   * Added support for asymmetric crypto throughput performance measurement.
 132     Only modex is supported for now.
 133
 134 * **Added lookaside protocol (IPsec) tests in dpdk-test.**
 135
 136   * Added known vector tests (AES-GCM 128, 192, 256).
 137   * Added tests to verify error reporting with ICV corruption.
 138   * Added tests to verify IV generation.
 139   * Added tests to verify UDP encapsulation.
 140   * Added tests to verify UDP encapsulation ports.
 141   * Added tests to validate packets soft expiry.
 142   * Added tests to validate packets hard expiry.
 143   * Added tests to verify tunnel header verification in IPsec inbound.
 144
 145
 146 Removed Items
 147 -------------
 148
 149 .. This section should contain removed items in this release. Sample format:
 150
 151    * Add a short 1-2 sentence description of the removed item
 152      in the past tense.
 153
 154    This section is a comment. Do not overwrite or remove it.
 155    Also, make sure to start the actual text at the margin.
 156    =======================================================
 157
 158 * eal: Removed the deprecated function ``rte_get_master_lcore()``
 159   and the iterator macro ``RTE_LCORE_FOREACH_SLAVE``.
 160
 161 * eal: The old api arguments that were deprecated for
 162   blacklist/whitelist are removed. Users must use the new
 163   block/allow list arguments.
 164
 165 * ethdev: Removed the port mirroring API. A more fine-grain flow API
 166   action ``RTE_FLOW_ACTION_TYPE_SAMPLE`` should be used instead.
 167   The structures ``rte_eth_mirror_conf`` and ``rte_eth_vlan_mirror`` and
 168   the functions ``rte_eth_mirror_rule_set`` and
 169   ``rte_eth_mirror_rule_reset`` along with the associated macros
 170   ``ETH_MIRROR_*`` are removed.
 171
 172 * i40e: Removed i40evf driver.
 173   iavf already became the default VF driver for i40e devices,
 174   so there is no need to maintain i40evf.
 175
 176
 177 API Changes
 178 -----------
 179
 180 .. This section should contain API changes. Sample format:
 181
 182    * sample: Add a short 1-2 sentence description of the API change
 183      which was announced in the previous releases and made in this release.
 184      Start with a scope label like "ethdev:".
 185      Use fixed width quotes for ``function_names`` or ``struct_names``.
 186      Use the past tense.
 187
 188    This section is a comment. Do not overwrite or remove it.
 189    Also, make sure to start the actual text at the margin.
 190    =======================================================
 191
 192 * kvargs: The experimental function ``rte_kvargs_strcmp()`` has been
 193   removed. Its usages have been replaced by a new function
 194   ``rte_kvargs_get_with_value()``.
 195
 196 * net: Renamed ``s_addr`` and ``d_addr`` fields of ``rte_ether_hdr`` structure
 197   to ``src_addr`` and ``dst_addr``, respectively.
 198
 199 * cryptodev: The API rte_cryptodev_pmd_is_valid_dev is modified to
 200   rte_cryptodev_is_valid_dev as it can be used by the application as
 201   well as PMD to check whether the device is valid or not.
 202
 203 * cryptodev: The rte_cryptodev_pmd.* files are renamed as cryptodev_pmd.*
 204   as it is for drivers only and should be private to DPDK, and not
 205   installed for app use.
 206
 207 * cryptodev: A ``reserved`` byte from structure ``rte_crypto_op`` was
 208   renamed to ``aux_flags`` to indicate warnings and other information from
 209   the crypto/security operation. This field will be used to communicate
 210   events such as soft expiry with IPsec in lookaside mode.
 211
 212
 213 ABI Changes
 214 -----------
 215
 216 .. This section should contain ABI changes. Sample format:
 217
 218    * sample: Add a short 1-2 sentence description of the ABI change
 219      which was announced in the previous releases and made in this release.
 220      Start with a scope label like "ethdev:".
 221      Use fixed width quotes for ``function_names`` or ``struct_names``.
 222      Use the past tense.
 223
 224    This section is a comment. Do not overwrite or remove it.
 225    Also, make sure to start the actual text at the margin.
 226    =======================================================
 227
 228 * security: ``rte_security_set_pkt_metadata`` and ``rte_security_get_userdata``
 229   routines used by inline outbound and inline inbound security processing were
 230   made inline and enhanced to do simple 64-bit set/get for PMDs that do not
 231   have much processing in PMD specific callbacks but just 64-bit set/get.
 232   This avoids a per packet function pointer jump overhead for such PMDs.
 233
 234 * security: A new option ``iv_gen_disable`` was added in structure
 235   ``rte_security_ipsec_sa_options`` to disable IV generation inside PMD,
 236   so that application can provide its own IV and test known test vectors.
 237
 238 * security: A new option ``tunnel_hdr_verify`` was added in structure
 239   ``rte_security_ipsec_sa_options`` to indicate whether outer header
 240   verification need to be done as part of inbound IPsec processing.
 241
 242 * security: A new option ``udp_ports_verify`` was added in structure
 243   ``rte_security_ipsec_sa_options`` to indicate whether UDP ports
 244   verification need to be done as part of inbound IPsec processing.
 245
 246 * security: A new structure ``rte_security_ipsec_lifetime`` was added to
 247   replace ``esn_soft_limit`` in IPsec configuration structure
 248   ``rte_security_ipsec_xform`` to allow applications to configure SA soft
 249   and hard expiry limits. Limits can be either in number of packets or bytes.
 250
 251
 252 Known Issues
 253 ------------
 254
 255 .. This section should contain new known issues in this release. Sample format:
 256
 257    * **Add title in present tense with full stop.**
 258
 259      Add a short 1-2 sentence description of the known issue
 260      in the present tense. Add information on any known workarounds.
 261
 262    This section is a comment. Do not overwrite or remove it.
 263    Also, make sure to start the actual text at the margin.
 264    =======================================================
 265
 266
 267 Tested Platforms
 268 ----------------
 269
 270 .. This section should contain a list of platforms that were tested
 271    with this release.
 272
 273    The format is:
 274
 275    * <vendor> platform with <vendor> <type of devices> combinations
 276
 277      * List of CPU
 278      * List of OS
 279      * List of devices
 280      * Other relevant details...
 281
 282    This section is a comment. Do not overwrite or remove it.
 283    Also, make sure to start the actual text at the margin.
 284    =======================================================