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