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