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