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