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