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