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