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