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