doc/guides/rel_notes/release_21_05.rst

   1 .. SPDX-License-Identifier: BSD-3-Clause
   2    Copyright 2021 The DPDK contributors
   3
   4 .. include:: <isonum.txt>
   5
   6 DPDK Release 21.05
   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       make doc-guides-html
  21       xdg-open build/doc/html/guides/rel_notes/release_21_05.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
  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 * **Added phase-fair lock.**
  59
  60   Phase-fair lock provides fairness guarantees.
  61   It has two ticket pools, one for readers and one for writers.
  62
  63 * **Added support for Marvell CN10K SoC drivers.**
  64
  65   Added Marvell CN10K SoC support. Marvell CN10K SoC are based on Octeon 10
  66   family of ARM64 processors with ARM Neoverse N2 core with accelerators for
  67   packet processing, timers, cryptography, etc.
  68
  69   * Added common/cnxk driver consisting of common API to be used by
  70     net, crypto and event PMD's.
  71   * Added mempool/cnxk driver which provides the support for the integrated
  72     mempool device.
  73
  74 * **Enhanced ethdev representor syntax.**
  75
  76   * Introduced representor type of VF, SF and PF.
  77   * Supported sub-function and multi-host in representor syntax::
  78
  79       representor=#            [0,2-4]      /* Legacy VF compatible.         */
  80       representor=[[c#]pf#]vf# c1pf2vf3     /* VF 3 on PF 2 of controller 1. */
  81       representor=[[c#]pf#]sf# sf[0,2-1023] /* 1023 SFs.                     */
  82       representor=[c#]pf#      c2pf[0,1]    /* 2 PFs on controller 2.        */
  83
  84 * **Added queue state in queried Rx/Tx queue info.**
  85
  86   * Added new field ``queue_state`` to ``rte_eth_rxq_info`` structure to
  87     provide indicated Rx queue state.
  88   * Added new field ``queue_state`` to ``rte_eth_txq_info`` structure to
  89     provide indicated Tx queue state.
  90
  91 * **Added support for meter PPS profile.**
  92
  93   Added packet mode in the meter profile parameters data structures
  94   to support metering traffic by packet per second (PPS),
  95   in addition to the initial bytes per second (BPS) mode (value 0).
  96
  97 * **Added packet integrity match to flow rules.**
  98
  99   * Added ``RTE_FLOW_ITEM_TYPE_INTEGRITY`` flow item.
 100   * Added ``rte_flow_item_integrity`` data structure.
 101
 102 * **Added TCP connection tracking offload in flow API.**
 103
 104   * Added conntrack item and action for stateful connection offload.
 105
 106 * **Updated Arkville PMD driver.**
 107
 108   Updated Arkville net driver with new features and improvements, including:
 109
 110   * Generalized passing meta data between PMD and FPGA, allowing up to 20
 111     bytes of user specified information in RX and TX paths.
 112
 113   * Updated dynamic PMD extensions API using standardized names.
 114
 115   * Added support for new Atomic Rules PCI device IDs ``0x100f, 0x1010, 0x1017,
 116     0x1018, 0x1019``.
 117
 118 * **Updated Broadcom bnxt driver.**
 119
 120   * Updated HWRM structures to 1.10.2.15 version.
 121
 122 * **Updated Hisilicon hns3 driver.**
 123
 124   * Added support for module EEPROM dumping.
 125   * Added support for freeing Tx mbuf on demand.
 126   * Added support for copper port in Kunpeng930.
 127   * Added support for runtime config to select IO burst function.
 128   * Added support for outer UDP checksum in Kunpeng930.
 129   * Added support for query Tx descriptor status.
 130   * Added support for query Rx descriptor status.
 131   * Added support for IEEE 1588 PTP.
 132
 133 * **Updated Intel iavf driver.**
 134
 135   Updated the Intel iavf driver with new features and improvements, including:
 136
 137   * Added flow filter to support GTPU inner L3/L4 fields matching.
 138   * In AVX512 code, added the new RX and TX paths to use the HW offload
 139     features. When the HW offload features are configured to be used, the
 140     offload paths are chosen automatically. In parallel the support of HW
 141     offload features was removed from the legacy AVX512 paths.
 142
 143 * **Updated Intel ice driver.**
 144
 145   * Added Intel ice support on Windows.
 146   * Added GTPU TEID support for DCF switch filter.
 147   * Added flow priority support for DCF switch filter.
 148
 149 * **Updated Marvell OCTEON TX2 ethdev driver.**
 150
 151   * Added support for flow action port id.
 152
 153 * **Updated Mellanox mlx5 driver.**
 154
 155   Updated the Mellanox mlx5 driver with new features and improvements, including:
 156
 157   * Added support for VXLAN and NVGRE encap as sample actions.
 158   * Support push VLAN on ingress traffic and pop VLAN on egress traffic in E-Switch mode.
 159
 160 * **Updated NXP DPAA driver.**
 161
 162   * Added support for shared ethernet interface.
 163   * Added support for external buffers in Tx.
 164
 165 * **Updated NXP DPAA2 driver.**
 166
 167   * Added support for traffic management.
 168   * Added support for configurable Tx confirmation.
 169   * Added support for external buffers in Tx.
 170
 171 * **Updated Wangxun txgbe driver.**
 172
 173   * Added support for txgbevf PMD.
 174   * Support device arguments to handle AN training for backplane NICs.
 175
 176 * **Enabled vmxnet3 PMD on Windows.**
 177
 178 * **Updated the AF_XDP driver.**
 179
 180   * Added support for preferred busy polling.
 181
 182 * **Added support of multiple data-units in cryptodev API.**
 183
 184   The cryptodev library has been enhanced to allow operations on multiple
 185   data-units for AES-XTS algorithm, the data-unit length should be set in the
 186   transformation. A capability for it was added too.
 187
 188 * **Added a cryptodev feature flag to support cipher wrapped keys.**
 189
 190   A new feature flag has been added to allow application to provide
 191   cipher wrapped keys in session xforms.
 192
 193 * **Updated the OCTEON TX crypto PMD.**
 194
 195   * Added support for DIGEST_ENCRYPTED mode in OCTEON TX crypto PMD.
 196
 197 * **Updated the OCTEON TX2 crypto PMD.**
 198
 199   * Added support for DIGEST_ENCRYPTED mode in OCTEON TX2 crypto PMD.
 200   * Added support in lookaside protocol offload mode for IPsec with
 201     UDP encapsulation support for NAT Traversal.
 202   * Added support in lookaside protocol offload mode for IPsec with
 203     IPv4 transport mode.
 204
 205 * **Updated Mellanox RegEx PMD.**
 206
 207   * Added support for multi-segments mbuf.
 208
 209 * **Introduced period timer mode in eventdev timer adapter.**
 210
 211   * Added support for periodic timer mode in eventdev timer adapter.
 212   * Added support for periodic timer mode in octeontx2 event device driver.
 213
 214 * **Added event device vector capability.**
 215
 216   * Added ``rte_event_vector`` data structure which is capable of holding
 217     multiple ``uintptr_t`` of the same flow thereby allowing applications
 218     to vectorize their pipelines and also reduce the complexity of pipelining
 219     the events across multiple stages.
 220   * This also reduced the scheduling overhead on a event device.
 221
 222 * **Added Predictable RSS functionality to the Toeplitz hash library.**
 223
 224   Added feature for finding collisions of the Toeplitz hash function -
 225   the hash function used in NICs to spread the traffic among the queues.
 226   It can be used to get predictable mapping of the flows.
 227
 228 * **Updated testpmd.**
 229
 230   * Added a command line option to configure forced speed for Ethernet port.
 231     ``dpdk-testpmd -- --eth-link-speed N``
 232   * Added command to display Rx queue used descriptor count.
 233     ``show port (port_id) rxq (queue_id) desc used count``
 234   * Added command to dump internal representation information of single flow.
 235     ``flow dump (port_id) rule (rule_id)``
 236
 237 * **Added support for the FIB lookup method in the l3fwd example app.**
 238
 239   Previously the l3fwd sample app only supported LPM and EM lookup methods,
 240   the app now supports the Forwarding Information Base (FIB) lookup method.
 241
 242 * **Updated ipsec-secgw sample application.**
 243
 244   * Updated the ``ipsec-secgw`` sample application with UDP encapsulation
 245     support for NAT Traversal.
 246
 247 * **Enhanced crypto adapter forward mode.**
 248
 249   * Added ``rte_event_crypto_adapter_enqueue()`` API to enqueue events to crypto
 250     adapter if forward mode is supported by driver.
 251   * Added support for crypto adapter forward mode in octeontx2 event and crypto
 252     device driver.
 253
 254
 255 Removed Items
 256 -------------
 257
 258 .. This section should contain removed items in this release. Sample format:
 259
 260    * Add a short 1-2 sentence description of the removed item
 261      in the past tense.
 262
 263    This section is a comment. Do not overwrite or remove it.
 264    Also, make sure to start the actual text at the margin.
 265    =======================================================
 266
 267 * Removed support for Intel DLB V1 hardware. This is not a broad market device,
 268   and existing customers already obtain the source code directly from Intel.
 269
 270
 271 API Changes
 272 -----------
 273
 274 .. This section should contain API changes. Sample format:
 275
 276    * sample: Add a short 1-2 sentence description of the API change
 277      which was announced in the previous releases and made in this release.
 278      Start with a scope label like "ethdev:".
 279      Use fixed width quotes for ``function_names`` or ``struct_names``.
 280      Use the past tense.
 281
 282    This section is a comment. Do not overwrite or remove it.
 283    Also, make sure to start the actual text at the margin.
 284    =======================================================
 285
 286 * eal: The experimental TLS API added in ``rte_thread.h`` has been renamed
 287   from ``rte_thread_tls_*`` to ``rte_thread_*`` to avoid naming redundancy
 288   and confusion with the transport layer security term.
 289
 290 * pci: The value ``PCI_ANY_ID`` is marked as deprecated
 291   and can be replaced with ``RTE_PCI_ANY_ID``.
 292
 293 * ethdev: Added a ``rte_flow`` pointer parameter to the function
 294   ``rte_flow_dev_dump()`` allowing dump for single flow.
 295
 296 * cryptodev: The experimental raw data path API for dequeue
 297   ``rte_cryptodev_raw_dequeue_burst`` got a new parameter
 298   ``max_nb_to_dequeue`` to provide flexible control on dequeue.
 299
 300 * ethdev: The experimental flow API for shared action has been generalized
 301   as a flow action handle used in rules through an indirect action.
 302   The functions ``rte_flow_shared_action_*`` manipulating the action object
 303   are replaced with ``rte_flow_action_handle_*``.
 304   The action ``RTE_FLOW_ACTION_TYPE_SHARED`` is deprecated and can be
 305   replaced with ``RTE_FLOW_ACTION_TYPE_INDIRECT``.
 306
 307
 308 ABI Changes
 309 -----------
 310
 311 .. This section should contain ABI changes. Sample format:
 312
 313    * sample: Add a short 1-2 sentence description of the ABI change
 314      which was announced in the previous releases and made in this release.
 315      Start with a scope label like "ethdev:".
 316      Use fixed width quotes for ``function_names`` or ``struct_names``.
 317      Use the past tense.
 318
 319    This section is a comment. Do not overwrite or remove it.
 320    Also, make sure to start the actual text at the margin.
 321    =======================================================
 322
 323 * No ABI change that would break compatibility with 20.11.
 324
 325 * The experimental function ``rte_telemetry_legacy_register`` has been
 326   removed from the public API and is now an internal-only function. This
 327   function was already marked as internal in the API documentation for it,
 328   and was not for use by external applications.
 329
 330
 331 Known Issues
 332 ------------
 333
 334 .. This section should contain new known issues in this release. Sample format:
 335
 336    * **Add title in present tense with full stop.**
 337
 338      Add a short 1-2 sentence description of the known issue
 339      in the present tense. Add information on any known workarounds.
 340
 341    This section is a comment. Do not overwrite or remove it.
 342    Also, make sure to start the actual text at the margin.
 343    =======================================================
 344
 345
 346 Tested Platforms
 347 ----------------
 348
 349 .. This section should contain a list of platforms that were tested
 350    with this release.
 351
 352    The format is:
 353
 354    * <vendor> platform with <vendor> <type of devices> combinations
 355
 356      * List of CPU
 357      * List of OS
 358      * List of devices
 359      * Other relevant details...
 360
 361    This section is a comment. Do not overwrite or remove it.
 362    Also, make sure to start the actual text at the margin.
 363    =======================================================