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
 230 * **Updated the ACC100 bbdev PMD.**
 231
 232   Added support for more comprehensive CRC options.
 233
 234 * **Updated the turbo_sw bbdev PMD.**
 235
 236   Added support for more comprehensive CRC options.
 237
 238 * **Added NXP LA12xx baseband PMD.**
 239
 240   * Added a new baseband PMD driver for NXP LA12xx Software defined radio.
 241   * See the :doc:`../bbdevs/la12xx` for more details.
 242
 243 * **Updated IPsec library.**
 244
 245   * Added support for more AEAD algorithms AES_CCM, CHACHA20_POLY1305
 246     and AES_GMAC.
 247   * Added support for NAT-T / UDP encapsulated ESP.
 248   * Added support for SA telemetry.
 249   * Added support for setting a non default starting ESN value.
 250
 251 * **Added multi-process support for testpmd.**
 252
 253   Added command-line options to specify total number of processes and
 254   current process ID. Each process owns subset of Rx and Tx queues.
 255
 256 * **Updated test-crypto-perf application with new cases.**
 257
 258   * Added support for asymmetric crypto throughput performance measurement.
 259     Only modex is supported for now.
 260   * Added support for lookaside IPsec protocol offload throughput measurement.
 261
 262 * **Added lookaside protocol (IPsec) tests in dpdk-test.**
 263
 264   * Added known vector tests (AES-GCM 128, 192, 256).
 265   * Added tests to verify error reporting with ICV corruption.
 266   * Added tests to verify IV generation.
 267   * Added tests to verify UDP encapsulation.
 268   * Added tests to verify UDP encapsulation ports.
 269   * Added tests to validate packets soft expiry.
 270   * Added tests to validate packets hard expiry.
 271   * Added tests to verify tunnel header verification in IPsec inbound.
 272   * Added tests to verify inner checksum.
 273
 274 * **Revised packet capture framework.**
 275
 276   * New dpdk-dumpcap program that has most of the features
 277     of the wireshark dumpcap utility including:
 278     capture of multiple interfaces, filtering,
 279     and stopping after number of bytes, packets.
 280   * New library for writing pcapng packet capture files.
 281   * Enhancements to the pdump library to support:
 282     * Packet filter with BPF.
 283     * Pcapng format with timestamps and meta-data.
 284     * Fixes packet capture with stripped VLAN tags.
 285
 286
 287 Removed Items
 288 -------------
 289
 290 .. This section should contain removed items in this release. Sample format:
 291
 292    * Add a short 1-2 sentence description of the removed item
 293      in the past tense.
 294
 295    This section is a comment. Do not overwrite or remove it.
 296    Also, make sure to start the actual text at the margin.
 297    =======================================================
 298
 299 * eal: Removed the deprecated function ``rte_get_master_lcore()``
 300   and the iterator macro ``RTE_LCORE_FOREACH_SLAVE``.
 301
 302 * eal: The old api arguments that were deprecated for
 303   blacklist/whitelist are removed. Users must use the new
 304   block/allow list arguments.
 305
 306 * mbuf: Removed offload flag ``PKT_RX_EIP_CKSUM_BAD``.
 307   ``PKT_RX_OUTER_IP_CKSUM_BAD`` should be used as a replacement.
 308
 309 * ethdev: Removed the port mirroring API. A more fine-grain flow API
 310   action ``RTE_FLOW_ACTION_TYPE_SAMPLE`` should be used instead.
 311   The structures ``rte_eth_mirror_conf`` and ``rte_eth_vlan_mirror`` and
 312   the functions ``rte_eth_mirror_rule_set`` and
 313   ``rte_eth_mirror_rule_reset`` along with the associated macros
 314   ``ETH_MIRROR_*`` are removed.
 315
 316 * ethdev: Removed ``rte_eth_rx_descriptor_done`` API function and its
 317   driver callback. It is replaced by the more complete function
 318   ``rte_eth_rx_descriptor_status``.
 319
 320 * ethdev: Removed deprecated ``shared`` attribute of the
 321   ``struct rte_flow_action_count``. Shared counters should be managed
 322   using indirect actions API (``rte_flow_action_handle_create`` etc).
 323
 324 * i40e: Removed i40evf driver.
 325   iavf already became the default VF driver for i40e devices,
 326   so there is no need to maintain i40evf.
 327
 328
 329 API Changes
 330 -----------
 331
 332 .. This section should contain API changes. Sample format:
 333
 334    * sample: Add a short 1-2 sentence description of the API change
 335      which was announced in the previous releases and made in this release.
 336      Start with a scope label like "ethdev:".
 337      Use fixed width quotes for ``function_names`` or ``struct_names``.
 338      Use the past tense.
 339
 340    This section is a comment. Do not overwrite or remove it.
 341    Also, make sure to start the actual text at the margin.
 342    =======================================================
 343
 344 * kvargs: The experimental function ``rte_kvargs_strcmp()`` has been
 345   removed. Its usages have been replaced by a new function
 346   ``rte_kvargs_get_with_value()``.
 347
 348 * cmdline: ``cmdline_stdin_exit()`` now frees the ``cmdline`` structure.
 349   Calls to ``cmdline_free()`` after it need to be deleted from applications.
 350
 351 * cmdline: Made ``cmdline`` structure definition hidden on Linux and FreeBSD.
 352
 353 * cmdline: Made ``rdline`` structure definition hidden. Functions are added
 354   to dynamically allocate and free it, and to access user data in callbacks.
 355
 356 * mempool: Added ``RTE_MEMPOOL_F_NON_IO`` flag to give a hint to DPDK components
 357   that objects from this pool will not be used for device IO (e.g. DMA).
 358
 359 * mempool: The mempool flags ``MEMPOOL_F_*`` will be deprecated in the future.
 360   Newly added flags with ``RTE_MEMPOOL_F_`` prefix should be used instead.
 361
 362 * mempool: Helper macro ``MEMPOOL_HEADER_SIZE()`` is deprecated.
 363   The replacement macro ``RTE_MEMPOOL_HEADER_SIZE()`` is internal only.
 364
 365 * mempool: Macro to register mempool driver ``MEMPOOL_REGISTER_OPS()`` is
 366   deprecated.  Use replacement ``RTE_MEMPOOL_REGISTER_OPS()``.
 367
 368 * mempool: The mempool API macros ``MEMPOOL_PG_*`` are deprecated and
 369   will be removed in DPDK 22.11.
 370
 371 * net: Renamed ``s_addr`` and ``d_addr`` fields of ``rte_ether_hdr`` structure
 372   to ``src_addr`` and ``dst_addr``, respectively.
 373
 374 * net: Added ``version`` and ``ihl`` bit-fields to ``struct rte_ipv4_hdr``.
 375   Existing ``version_ihl`` field is kept for backward compatibility.
 376
 377 * ethdev: Added items and actions ``PORT_REPRESENTOR``, ``REPRESENTED_PORT`` to
 378   flow API.
 379
 380 * ethdev: Deprecated items and actions ``PF``, ``VF``, ``PHY_PORT``, ``PORT_ID``.
 381   Suggested items and actions ``PORT_REPRESENTOR``, ``REPRESENTED_PORT`` instead.
 382
 383 * ethdev: Deprecated the use of attributes ``ingress`` / ``egress`` combined
 384   with ``transfer``. See items ``PORT_REPRESENTOR``, ``REPRESENTED_PORT``.
 385
 386 * ethdev: ``rte_flow_action_modify_data`` structure updated, immediate data
 387   array is extended, data pointer field is explicitly added to union, the
 388   action behavior is defined in more strict fashion and documentation updated.
 389   The immediate value behavior has been changed, the entire immediate field
 390   should be provided, and offset for immediate source bitfield is assigned
 391   from destination one.
 392
 393 * cryptodev: The API rte_cryptodev_pmd_is_valid_dev is modified to
 394   rte_cryptodev_is_valid_dev as it can be used by the application as
 395   well as PMD to check whether the device is valid or not.
 396
 397 * cryptodev: The rte_cryptodev_pmd.* files are renamed as cryptodev_pmd.*
 398   as it is for drivers only and should be private to DPDK, and not
 399   installed for app use.
 400
 401 * cryptodev: A ``reserved`` byte from structure ``rte_crypto_op`` was
 402   renamed to ``aux_flags`` to indicate warnings and other information from
 403   the crypto/security operation. This field will be used to communicate
 404   events such as soft expiry with IPsec in lookaside mode.
 405
 406 * cryptodev: The field ``dataunit_len`` of the ``struct rte_crypto_cipher_xform``
 407   moved to the end of the structure and extended to ``uint32_t``.
 408
 409 * cryptodev: The structure ``rte_crypto_vec`` was updated to add ``tot_len``
 410   field to support total buffer length to facilitate protocol offload case.
 411
 412 * cryptodev: The structure ``rte_crypto_sym_vec`` was updated to add
 413   ``dest_sgl`` to support out of place processing.
 414
 415 * bbdev: Added device info related to data byte endianness processing.
 416
 417 * eventdev: Moved memory used by timer adapters to hugepage. This will prevent
 418   TLB misses if any and aligns to memory structure of other subsystems.
 419
 420
 421 ABI Changes
 422 -----------
 423
 424 .. This section should contain ABI changes. Sample format:
 425
 426    * sample: Add a short 1-2 sentence description of the ABI change
 427      which was announced in the previous releases and made in this release.
 428      Start with a scope label like "ethdev:".
 429      Use fixed width quotes for ``function_names`` or ``struct_names``.
 430      Use the past tense.
 431
 432    This section is a comment. Do not overwrite or remove it.
 433    Also, make sure to start the actual text at the margin.
 434    =======================================================
 435
 436 * ethdev: All enums & macros updated to have ``RTE_ETH`` prefix and structures
 437   updated to have ``rte_eth`` prefix. DPDK components updated to use new names.
 438
 439 * ethdev: Input parameters for ``eth_rx_queue_count_t`` was changed.
 440   Instead of pointer to ``rte_eth_dev`` and queue index, now it accepts pointer
 441   to internal queue data as input parameter. While this change is transparent
 442   to user, it still counts as an ABI change, as ``eth_rx_queue_count_t``
 443   is used by  public inline function ``rte_eth_rx_queue_count``.
 444
 445 * ethdev: Made ``rte_eth_dev``, ``rte_eth_dev_data``, ``rte_eth_rxtx_callback``
 446   private data structures. ``rte_eth_devices[]`` can't be accessed directly
 447   by user any more. While it is an ABI breakage, this change is intended
 448   to be transparent for both users (no changes in user app is required) and
 449   PMD developers (no changes in PMD is required).
 450
 451 * security: ``rte_security_set_pkt_metadata`` and ``rte_security_get_userdata``
 452   routines used by inline outbound and inline inbound security processing were
 453   made inline and enhanced to do simple 64-bit set/get for PMDs that do not
 454   have much processing in PMD specific callbacks but just 64-bit set/get.
 455   This avoids a per packet function pointer jump overhead for such PMDs.
 456
 457 * security: A new option ``iv_gen_disable`` was added in structure
 458   ``rte_security_ipsec_sa_options`` to disable IV generation inside PMD,
 459   so that application can provide its own IV and test known test vectors.
 460
 461 * security: A new option ``tunnel_hdr_verify`` was added in structure
 462   ``rte_security_ipsec_sa_options`` to indicate whether outer header
 463   verification need to be done as part of inbound IPsec processing.
 464
 465 * security: A new option ``udp_ports_verify`` was added in structure
 466   ``rte_security_ipsec_sa_options`` to indicate whether UDP ports
 467   verification need to be done as part of inbound IPsec processing.
 468
 469 * security: A new structure ``rte_security_ipsec_lifetime`` was added to
 470   replace ``esn_soft_limit`` in IPsec configuration structure
 471   ``rte_security_ipsec_xform`` to allow applications to configure SA soft
 472   and hard expiry limits. Limits can be either in number of packets or bytes.
 473
 474 * security: The new options ``ip_csum_enable`` and ``l4_csum_enable`` were added
 475   in structure ``rte_security_ipsec_sa_options`` to indicate whether inner
 476   packet IPv4 header checksum and L4 checksum need to be offloaded to
 477   security device.
 478
 479 * security: A new structure ``esn`` was added in structure
 480   ``rte_security_ipsec_xform`` to set an initial ESN value. This permits
 481   application to start from an arbitrary ESN value for debug and SA lifetime
 482   enforcement purposes.
 483
 484 * security: A new structure ``udp`` was added in structure
 485   ``rte_security_ipsec_xform`` to allow setting the source and destination ports
 486   for UDP encapsulated IPsec traffic.
 487
 488 * bbdev: Added capability related to more comprehensive CRC options,
 489   shifting values of the ``enum rte_bbdev_op_ldpcdec_flag_bitmasks``.
 490
 491 * eventdev: New variables ``rx_event_buf_count`` and ``rx_event_buf_size``
 492   were added in structure ``rte_event_eth_rx_adapter_stats`` to get additional
 493   status.
 494
 495 * eventdev: A new structure ``rte_event_fp_ops`` has been added which is now used
 496   by the fastpath inline functions. The structures ``rte_eventdev``,
 497   ``rte_eventdev_data`` have been made internal. ``rte_eventdevs[]`` can't be
 498   accessed directly by user any more. This change is transparent to both
 499   applications and PMDs.
 500
 501 * eventdev: Re-arranged fields in ``rte_event_timer`` to remove holes.
 502
 503
 504 Known Issues
 505 ------------
 506
 507 .. This section should contain new known issues in this release. Sample format:
 508
 509    * **Add title in present tense with full stop.**
 510
 511      Add a short 1-2 sentence description of the known issue
 512      in the present tense. Add information on any known workarounds.
 513
 514    This section is a comment. Do not overwrite or remove it.
 515    Also, make sure to start the actual text at the margin.
 516    =======================================================
 517
 518
 519 Tested Platforms
 520 ----------------
 521
 522 .. This section should contain a list of platforms that were tested
 523    with this release.
 524
 525    The format is:
 526
 527    * <vendor> platform with <vendor> <type of devices> combinations
 528
 529      * List of CPU
 530      * List of OS
 531      * List of devices
 532      * Other relevant details...
 533
 534    This section is a comment. Do not overwrite or remove it.
 535    Also, make sure to start the actual text at the margin.
 536    =======================================================