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