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