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