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