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   * Added raw vector datapath API support.
 146
 147 * **Updated the ACC100 bbdev PMD.**
 148
 149   Added support for more comprehensive CRC options.
 150
 151 * **Updated the turbo_sw bbdev PMD.**
 152
 153   Added support for more comprehensive CRC options.
 154
 155 * **Updated IPsec library.**
 156
 157   * Added support for more AEAD algorithms AES_CCM, CHACHA20_POLY1305
 158     and AES_GMAC.
 159   * Added support for NAT-T / UDP encapsulated ESP.
 160   * Added support for SA telemetry.
 161   * Added support for setting a non default starting ESN value.
 162
 163 * **Added multi-process support for testpmd.**
 164
 165   Added command-line options to specify total number of processes and
 166   current process ID. Each process owns subset of Rx and Tx queues.
 167
 168 * **Updated test-crypto-perf application with new cases.**
 169
 170   * Added support for asymmetric crypto throughput performance measurement.
 171     Only modex is supported for now.
 172
 173 * **Added lookaside protocol (IPsec) tests in dpdk-test.**
 174
 175   * Added known vector tests (AES-GCM 128, 192, 256).
 176   * Added tests to verify error reporting with ICV corruption.
 177   * Added tests to verify IV generation.
 178   * Added tests to verify UDP encapsulation.
 179   * Added tests to verify UDP encapsulation ports.
 180   * Added tests to validate packets soft expiry.
 181   * Added tests to validate packets hard expiry.
 182   * Added tests to verify tunnel header verification in IPsec inbound.
 183   * Added tests to verify inner checksum.
 184
 185
 186 Removed Items
 187 -------------
 188
 189 .. This section should contain removed items in this release. Sample format:
 190
 191    * Add a short 1-2 sentence description of the removed item
 192      in the past tense.
 193
 194    This section is a comment. Do not overwrite or remove it.
 195    Also, make sure to start the actual text at the margin.
 196    =======================================================
 197
 198 * eal: Removed the deprecated function ``rte_get_master_lcore()``
 199   and the iterator macro ``RTE_LCORE_FOREACH_SLAVE``.
 200
 201 * eal: The old api arguments that were deprecated for
 202   blacklist/whitelist are removed. Users must use the new
 203   block/allow list arguments.
 204
 205 * mbuf: Removed offload flag ``PKT_RX_EIP_CKSUM_BAD``.
 206   ``PKT_RX_OUTER_IP_CKSUM_BAD`` should be used as a replacement.
 207
 208 * ethdev: Removed the port mirroring API. A more fine-grain flow API
 209   action ``RTE_FLOW_ACTION_TYPE_SAMPLE`` should be used instead.
 210   The structures ``rte_eth_mirror_conf`` and ``rte_eth_vlan_mirror`` and
 211   the functions ``rte_eth_mirror_rule_set`` and
 212   ``rte_eth_mirror_rule_reset`` along with the associated macros
 213   ``ETH_MIRROR_*`` are removed.
 214
 215 * i40e: Removed i40evf driver.
 216   iavf already became the default VF driver for i40e devices,
 217   so there is no need to maintain i40evf.
 218
 219
 220 API Changes
 221 -----------
 222
 223 .. This section should contain API changes. Sample format:
 224
 225    * sample: Add a short 1-2 sentence description of the API change
 226      which was announced in the previous releases and made in this release.
 227      Start with a scope label like "ethdev:".
 228      Use fixed width quotes for ``function_names`` or ``struct_names``.
 229      Use the past tense.
 230
 231    This section is a comment. Do not overwrite or remove it.
 232    Also, make sure to start the actual text at the margin.
 233    =======================================================
 234
 235 * kvargs: The experimental function ``rte_kvargs_strcmp()`` has been
 236   removed. Its usages have been replaced by a new function
 237   ``rte_kvargs_get_with_value()``.
 238
 239 * mempool: Added ``RTE_MEMPOOL_F_NON_IO`` flag to give a hint to DPDK components
 240   that objects from this pool will not be used for device IO (e.g. DMA).
 241
 242 * mempool: The mempool flags ``MEMPOOL_F_*`` will be deprecated in the future.
 243   Newly added flags with ``RTE_MEMPOOL_F_`` prefix should be used instead.
 244
 245 * mempool: Helper macro ``MEMPOOL_HEADER_SIZE()`` is deprecated.
 246   The replacement macro ``RTE_MEMPOOL_HEADER_SIZE()`` is internal only.
 247
 248 * mempool: Macro to register mempool driver ``MEMPOOL_REGISTER_OPS()`` is
 249   deprecated.  Use replacement ``RTE_MEMPOOL_REGISTER_OPS()``.
 250
 251 * mempool: The mempool API macros ``MEMPOOL_PG_*`` are deprecated and
 252   will be removed in DPDK 22.11.
 253
 254 * net: Renamed ``s_addr`` and ``d_addr`` fields of ``rte_ether_hdr`` structure
 255   to ``src_addr`` and ``dst_addr``, respectively.
 256
 257 * cryptodev: The API rte_cryptodev_pmd_is_valid_dev is modified to
 258   rte_cryptodev_is_valid_dev as it can be used by the application as
 259   well as PMD to check whether the device is valid or not.
 260
 261 * cryptodev: The rte_cryptodev_pmd.* files are renamed as cryptodev_pmd.*
 262   as it is for drivers only and should be private to DPDK, and not
 263   installed for app use.
 264
 265 * cryptodev: A ``reserved`` byte from structure ``rte_crypto_op`` was
 266   renamed to ``aux_flags`` to indicate warnings and other information from
 267   the crypto/security operation. This field will be used to communicate
 268   events such as soft expiry with IPsec in lookaside mode.
 269
 270 * cryptodev: The field ``dataunit_len`` of the ``struct rte_crypto_cipher_xform``
 271   moved to the end of the structure and extended to ``uint32_t``.
 272
 273 * cryptodev: The structure ``rte_crypto_vec`` was updated to add ``tot_len``
 274   field to support total buffer length to facilitate protocol offload case.
 275
 276 * cryptodev: The structure ``rte_crypto_sym_vec`` was updated to add
 277   ``dest_sgl`` to support out of place processing.
 278
 279
 280 ABI Changes
 281 -----------
 282
 283 .. This section should contain ABI changes. Sample format:
 284
 285    * sample: Add a short 1-2 sentence description of the ABI change
 286      which was announced in the previous releases and made in this release.
 287      Start with a scope label like "ethdev:".
 288      Use fixed width quotes for ``function_names`` or ``struct_names``.
 289      Use the past tense.
 290
 291    This section is a comment. Do not overwrite or remove it.
 292    Also, make sure to start the actual text at the margin.
 293    =======================================================
 294
 295 * security: ``rte_security_set_pkt_metadata`` and ``rte_security_get_userdata``
 296   routines used by inline outbound and inline inbound security processing were
 297   made inline and enhanced to do simple 64-bit set/get for PMDs that do not
 298   have much processing in PMD specific callbacks but just 64-bit set/get.
 299   This avoids a per packet function pointer jump overhead for such PMDs.
 300
 301 * security: A new option ``iv_gen_disable`` was added in structure
 302   ``rte_security_ipsec_sa_options`` to disable IV generation inside PMD,
 303   so that application can provide its own IV and test known test vectors.
 304
 305 * security: A new option ``tunnel_hdr_verify`` was added in structure
 306   ``rte_security_ipsec_sa_options`` to indicate whether outer header
 307   verification need to be done as part of inbound IPsec processing.
 308
 309 * security: A new option ``udp_ports_verify`` was added in structure
 310   ``rte_security_ipsec_sa_options`` to indicate whether UDP ports
 311   verification need to be done as part of inbound IPsec processing.
 312
 313 * security: A new structure ``rte_security_ipsec_lifetime`` was added to
 314   replace ``esn_soft_limit`` in IPsec configuration structure
 315   ``rte_security_ipsec_xform`` to allow applications to configure SA soft
 316   and hard expiry limits. Limits can be either in number of packets or bytes.
 317
 318 * security: The new options ``ip_csum_enable`` and ``l4_csum_enable`` were added
 319   in structure ``rte_security_ipsec_sa_options`` to indicate whether inner
 320   packet IPv4 header checksum and L4 checksum need to be offloaded to
 321   security device.
 322
 323 * security: A new structure ``esn`` was added in structure
 324   ``rte_security_ipsec_xform`` to set an initial ESN value. This permits
 325   application to start from an arbitrary ESN value for debug and SA lifetime
 326   enforcement purposes.
 327
 328 * security: A new structure ``udp`` was added in structure
 329   ``rte_security_ipsec_xform`` to allow setting the source and destination ports
 330   for UDP encapsulated IPsec traffic.
 331
 332 * bbdev: Added capability related to more comprehensive CRC options,
 333   shifting values of the ``enum rte_bbdev_op_ldpcdec_flag_bitmasks``.
 334
 335
 336 Known Issues
 337 ------------
 338
 339 .. This section should contain new known issues in this release. Sample format:
 340
 341    * **Add title in present tense with full stop.**
 342
 343      Add a short 1-2 sentence description of the known issue
 344      in the present tense. Add information on any known workarounds.
 345
 346    This section is a comment. Do not overwrite or remove it.
 347    Also, make sure to start the actual text at the margin.
 348    =======================================================
 349
 350
 351 Tested Platforms
 352 ----------------
 353
 354 .. This section should contain a list of platforms that were tested
 355    with this release.
 356
 357    The format is:
 358
 359    * <vendor> platform with <vendor> <type of devices> combinations
 360
 361      * List of CPU
 362      * List of OS
 363      * List of devices
 364      * Other relevant details...
 365
 366    This section is a comment. Do not overwrite or remove it.
 367    Also, make sure to start the actual text at the margin.
 368    =======================================================