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