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