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