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