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