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