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