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