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