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