doc/guides/rel_notes/release_20_11.rst

   1 .. SPDX-License-Identifier: BSD-3-Clause
   2    Copyright 2020 The DPDK contributors
   3
   4 .. include:: <isonum.txt>
   5
   6 DPDK Release 20.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       make doc-guides-html
  21       xdg-open build/doc/html/guides/rel_notes/release_20_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
  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 write combining store APIs.**
  59
  60   Added ``rte_write32_wc`` and ``rte_write32_wc_relaxed`` APIs
  61   that enable write combining stores (depending on architecture).
  62   The functions are provided as a generic stubs and
  63   x86 specific implementation.
  64
  65 * **Added prefetch with intention to write APIs.**
  66
  67   Added new prefetch function variants e.g. ``rte_prefetch0_write``,
  68   which allow the programmer to prefetch a cache line and also indicate
  69   the intention to write.
  70
  71 * **Added the rte_cldemote API.**
  72
  73   Added a hardware hint CLDEMOTE, which is similar to prefetch in reverse.
  74   CLDEMOTE moves the cache line to the more remote cache, where it expects
  75   sharing to be efficient. Moving the cache line to a level more distant from
  76   the processor helps to accelerate core-to-core communication.
  77   This API is specific to x86 and implemented as a stub for other
  78   architectures.
  79
  80 * **Added support for limiting maximum SIMD bitwidth.**
  81
  82   Added a new EAL config setting ``max_simd_bitwidth`` to limit the vector
  83   path selection at runtime. This value can be set by apps using the
  84   ``rte_vect_set_max_simd_bitwidth`` function, or by the user with EAL flag
  85   ``--force-max-simd-bitwidth``.
  86
  87 * **Added zero copy APIs for rte_ring.**
  88
  89   For rings with producer/consumer in ``RTE_RING_SYNC_ST``, ``RTE_RING_SYNC_MT_HTS``
  90   modes, these APIs split enqueue/dequeue operation into three phases
  91   (enqueue/dequeue start, copy data to/from ring, enqueue/dequeue finish).
  92   Along with the advantages of the peek APIs, these provide the ability to
  93   copy the data to the ring memory directly without the need for temporary
  94   storage.
  95
  96 * **Updated CRC modules of the net library.**
  97
  98   * Added runtime selection of the optimal architecture-specific CRC path.
  99   * Added optimized implementations of CRC32-Ethernet and CRC16-CCITT
 100     using the AVX512 and VPCLMULQDQ instruction sets.
 101
 102 * **Introduced extended buffer description for receiving.**
 103
 104   Added the extended Rx buffer description for Rx queue setup routine
 105   providing the individual settings for each Rx segment with maximal size,
 106   buffer offset and memory pool to allocate data buffers from.
 107
 108 * **Added the FEC API, for a generic FEC query and config.**
 109
 110   Added the FEC API which provides functions for query FEC capabilities and
 111   current FEC mode from device. Also, API for configuring FEC mode is also provided.
 112
 113 * **Added thread safety to rte_flow functions.**
 114
 115   Added ``RTE_ETH_DEV_FLOW_OPS_THREAD_SAFE`` device flag to indicate
 116   whether PMD supports thread safe operations. If PMD doesn't set the flag,
 117   rte_flow API level functions will protect the flow operations with mutex.
 118
 119 * **Added flow-based traffic sampling support.**
 120
 121   Added new action: ``RTE_FLOW_ACTION_TYPE_SAMPLE`` to duplicate the matching
 122   packets with specified ratio, and apply with own set of actions with a fate
 123   action. When the ratio is set to 1 then the packets will be 100% mirrored.
 124
 125 * **Added support of shared action in flow API.**
 126
 127   Added shared action support to utilize single flow action in multiple flow
 128   rules. An update of shared action configuration alters the behavior of all
 129   flow rules using it.
 130
 131   * Added new action: ``RTE_FLOW_ACTION_TYPE_SHARED`` to use shared action
 132     as flow action.
 133   * Added new flow APIs to create/update/destroy/query shared action.
 134
 135 * **Flow rules allowed to use private PMD items / actions.**
 136
 137   * Flow rule verification was updated to accept private PMD
 138     items and actions.
 139
 140 * **Added generic API to offload tunneled traffic and restore missed packet.**
 141
 142   * Added a new hardware independent helper to flow API that
 143     offloads tunneled traffic and restores missed packets.
 144
 145 * **Updated the ethdev library to support hairpin between two ports.**
 146
 147   New APIs are introduced to support binding / unbinding 2 ports hairpin.
 148   Hairpin Tx part flow rules can be inserted explicitly.
 149   New API is added to get the hairpin peer ports list.
 150
 151 * **Updated the Amazon ena driver.**
 152
 153   Updated the ena PMD with new features and improvements, including:
 154
 155   * Added network interface metrics which can be read using xstats.
 156
 157 * **Updated Broadcom bnxt driver.**
 158
 159   Updated the Broadcom bnxt driver with new features and improvements, including:
 160
 161   * Added support for 200G PAM4 link speed.
 162   * Added support for RSS hash level selection.
 163   * Updated HWRM structures to 1.10.1.70 version.
 164   * Added TRUFLOW support for Stingray devices.
 165   * Added support for representors on MAIA cores of SR.
 166   * Added support for VXLAN decap offload using rte_flow.
 167   * Added support to indicate native rte_flow API thread safety.
 168
 169 * **Updated Cisco enic driver.**
 170
 171   * Added support for VF representors with single-queue Tx/Rx and flow API
 172   * Added support for egress PORT_ID action
 173   * Added support for non-zero priorities for group 0 flows
 174   * Added support for VXLAN decap combined with VLAN pop
 175
 176 * **Added hns3 FEC PMD, for supporting query and config FEC mode.**
 177
 178   Added the FEC PMD which provides functions for query FEC capabilities and
 179   current FEC mode from device. Also, PMD for configuring FEC mode is also provided.
 180
 181 * **Updated Intel iavf driver.**
 182
 183   Updated iavf PMD with new features and improvements, including:
 184
 185   * Added support for flexible descriptor metadata extraction.
 186   * Added support for outer IP hash of GTPC and GTPU.
 187   * Added support of AVX512 instructions in Rx and Tx path.
 188   * Added support for up to 256 queue pairs per VF.
 189
 190 * **Updated Intel ice driver.**
 191
 192   * Used write combining stores.
 193   * Added ACL filter support for Intel DCF.
 194
 195 * **Updated Mellanox mlx5 driver.**
 196
 197   Updated Mellanox mlx5 driver with new features and improvements, including:
 198
 199   * Added vectorized Multi-Packet Rx Queue burst.
 200   * Added support for 2 new miniCQE formats: Flow Tag and L3/L4 header.
 201   * Added support for PMD level multiple-thread flow insertion.
 202   * Added support for matching on fragmented/non-fragmented IPv4/IPv6 packets.
 203   * Added support for QinQ packets matching.
 204   * Added support for the new VLAN fields ``has_vlan`` in the Ethernet item
 205     and ``has_more_vlan`` in the VLAN item.
 206   * Updated the supported timeout for Age action to the maximal value supported
 207     by rte_flow API.
 208   * Added support of Age action query.
 209   * Added support of multi-ports hairpin.
 210   * Allow unknown link speed.
 211
 212   Updated Mellanox mlx5 vDPA driver:
 213
 214   * Added support of vDPA VirtQ error handling.
 215
 216 * **Updated Solarflare network PMD.**
 217
 218   Updated the Solarflare ``sfc_efx`` driver with changes including:
 219
 220   * Added SR-IOV PF support
 221   * Added Alveo SN1000 SmartNICs (EF100 architecture) support including
 222     flow API transfer rules for switch HW offload
 223   * Added ARMv8 support
 224   * Claimed flow API native thread safety
 225
 226 * **Added Wangxun txgbe PMD.**
 227
 228   Added a new PMD driver for Wangxun 10 Gigabit Ethernet NICs.
 229
 230   See the :doc:`../nics/txgbe` for more details.
 231
 232 * **Updated Virtio driver.**
 233
 234   * Added support for Vhost-vDPA backend to Virtio-user PMD.
 235   * Changed default link speed to unknown.
 236   * Added support for 200G link speed.
 237
 238 * **Updated Intel i40e driver.**
 239
 240   Updated the Intel i40e driver to use write combining stores.
 241
 242 * **Updated Intel ixgbe driver.**
 243
 244   Updated the Intel ixgbe driver to use write combining stores.
 245
 246 * **Updated Intel qat driver.**
 247
 248   Updated the Intel qat driver to use write combining stores.
 249
 250 * **Updated Memif PMD.**
 251
 252   * Added support for abstract socket address.
 253   * Changed default socket address type to abstract.
 254
 255 * **Added Ice Lake (Gen4) support for Intel NTB.**
 256
 257   Added NTB device support (4th generation) for Intel Ice Lake platform.
 258
 259 * **Added UDP/IPv4 GRO support for VxLAN and non-VxLAN packets.**
 260
 261   For VxLAN packets, added inner UDP/IPv4 support.
 262   For non-VxLAN packets, added UDP/IPv4 support.
 263
 264 * **Extended flow-perf application.**
 265
 266   * Started supporting user order instead of bit mask:
 267     Now the user can create any structure of rte_flow
 268     using flow performance application with any order,
 269     moreover the app also now starts to support inner
 270     items matching as well.
 271   * Added header modify actions.
 272   * Added flag action.
 273   * Added raw encap/decap actions.
 274   * Added VXLAN encap/decap actions.
 275   * Added ICMP(code/type/identifier/sequence number) and ICMP6(code/type) matching items.
 276   * Added option to set port mask for insertion/deletion:
 277     ``--portmask=N``
 278     where N represents the hexadecimal bitmask of ports used.
 279
 280 * **Added raw data-path APIs for cryptodev library.**
 281
 282   Cryptodev is added with raw data-path APIs to accelerate external
 283   libraries or applications which need to avail fast cryptodev
 284   enqueue/dequeue operations but does not necessarily depends on
 285   mbufs and cryptodev operation mempools.
 286
 287 * **Updated the aesni_mb crypto PMD.**
 288
 289   * Added support for intel-ipsec-mb version 0.55.
 290   * Added support for AES-ECB 128, 192 and 256.
 291   * Added support for ZUC-EEA3/EIA3 algorithms.
 292   * Added support for SNOW3G-UEA2/UIA2 algorithms.
 293   * Added support for KASUMI-F8/F9 algorithms.
 294   * Added support for Chacha20-Poly1305.
 295   * Added support for AES-256 CCM algorithm.
 296
 297 * **Updated the aesni_gcm crypto PMD.**
 298
 299   * Added SGL support for AES-GMAC.
 300
 301 * **Added Broadcom BCMFS symmetric crypto PMD.**
 302
 303   Added a symmetric crypto PMD for Broadcom FlexSparc crypto units.
 304   See :doc:`../cryptodevs/bcmfs` guide for more details on this new PMD.
 305
 306 * **Updated DPAA2_SEC crypto PMD.**
 307
 308   * Added DES-CBC support for cipher_only, chain and ipsec protocol.
 309   * Added support for non-HMAC auth algorithms
 310     (MD5, SHA1, SHA224, SHA256, SHA384, SHA512).
 311
 312 * **Updated Marvell NITROX symmetric crypto PMD.**
 313
 314   * Added AES-GCM support.
 315   * Added cipher only offload support.
 316
 317 * **Updated the OCTEON TX2 crypto PMD.**
 318
 319   * Updated the OCTEON TX2 crypto PMD lookaside protocol offload for IPsec with
 320     IPv6 support.
 321
 322 * **Updated QAT crypto PMD.**
 323
 324   * Added Raw Data-path APIs support.
 325
 326 * **Added Intel ACC100 bbdev PMD.**
 327
 328   Added a new ``acc100`` bbdev driver for the Intel\ |reg| ACC100 accelerator
 329   also known as Mount Bryce.  See the
 330   :doc:`../bbdevs/acc100` BBDEV guide for more details on this new driver.
 331
 332 * **Updated rte_security library to support SDAP.**
 333
 334   ``rte_security_pdcp_xform`` in ``rte_security`` lib is updated to enable
 335   5G NR processing of SDAP header in PMDs.
 336
 337 * **Added Marvell OCTEON TX2 regex PMD.**
 338
 339   Added a new PMD driver for hardware regex offload block for OCTEON TX2 SoC.
 340
 341   See the :doc:`../regexdevs/octeontx2` for more details.
 342
 343 * **Updated Software Eventdev driver.**
 344
 345   Added performance tuning arguments to allow tuning the scheduler for
 346   better throughtput in high core count use cases.
 347
 348 * **Added a new driver for the Intel Dynamic Load Balancer v1.0 device.**
 349
 350   Added the new ``dlb`` eventdev driver for the Intel DLB V1.0 device. See the
 351   :doc:`../eventdevs/dlb` eventdev guide for more details on this new driver.
 352
 353 * **Added a new driver for the Intel Dynamic Load Balancer v2.0 device.**
 354
 355   Added the new ``dlb2`` eventdev driver for the Intel DLB V2.0 device. See the
 356   :doc:`../eventdevs/dlb2` eventdev guide for more details on this new driver.
 357
 358 * **Updated ioat rawdev driver**
 359
 360   The ioat rawdev driver has been updated and enhanced. Changes include:
 361
 362   * Added support for Intel\ |reg| Data Streaming Accelerator hardware.
 363     For more information, see https://01.org/blogs/2019/introducing-intel-data-streaming-accelerator
 364   * Added support for the fill operation via the API ``rte_ioat_enqueue_fill()``,
 365     where the hardware fills an area of memory with a repeating pattern.
 366   * Added a per-device configuration flag to disable management
 367     of user-provided completion handles.
 368   * Renamed the ``rte_ioat_do_copies()`` API to ``rte_ioat_perform_ops()``,
 369     and renamed the ``rte_ioat_completed_copies()`` API to ``rte_ioat_completed_ops()``
 370     to better reflect the APIs' purposes, and remove the implication that
 371     they are limited to copy operations only.
 372     [Note: The old API is still provided but marked as deprecated in the code]
 373   * Added a new API ``rte_ioat_fence()`` to add a fence between operations.
 374     This API replaces the ``fence`` flag parameter in the ``rte_ioat_enqueue_copies()`` function,
 375     and is clearer as there is no ambiguity as to whether the flag should be
 376     set on the last operation before the fence or the first operation after it.
 377
 378 * **Updated the pipeline library for alignment with the P4 language.**
 379
 380   Added new Software Switch (SWX) pipeline type that provides more
 381   flexibility through API and feature alignment with the P4 language.
 382
 383   * The packet headers, meta-data, actions, tables and pipelines are
 384     dynamically defined instead of selected from pre-defined set.
 385   * The actions and the pipeline are defined with instructions.
 386   * Extern objects and functions can be plugged into the pipeline.
 387   * Transaction-oriented table updates.
 388
 389 * **Add new AVX512 specific classify algorithms for ACL library.**
 390
 391   * Added new ``RTE_ACL_CLASSIFY_AVX512X16`` vector implementation,
 392     which can process up to 16 flows in parallel. Requires AVX512 support.
 393
 394   * Added new ``RTE_ACL_CLASSIFY_AVX512X32`` vector implementation,
 395     which can process up to 32 flows in parallel. Requires AVX512 support.
 396
 397 * **Added AVX512 lookup implementation for FIB.**
 398
 399   Added a AVX512 lookup functions implementation into FIB and FIB6 libraries.
 400
 401 * **Added support to update subport bandwidth dynamically.**
 402
 403    * Added new API ``rte_sched_port_subport_profile_add`` to add new
 404      subport bandwidth profile to subport porfile table at runtime.
 405
 406    * Added support to update subport rate dynamically.
 407
 408 * **Updated FIPS validation sample application.**
 409
 410   * Added scatter gather support.
 411   * Added NIST GCMVS complaint GMAC test method support.
 412
 413 * **Updated l3wfd-acl sample application.**
 414
 415   * Added new optional parameter ``--eth-dest`` for the ``l3fwd-acl`` to allow
 416     the user to specify the destination mac address for each ethernet port
 417     used.
 418   * Replaced ``--scalar`` command-line option with ``--alg=<value>``, to allow
 419     the user to select the desired classify method.
 420
 421 * **Updated vhost sample application.**
 422
 423   Added vhost asynchronous APIs support, which demonstrated how the application
 424   leverage IOAT DMA channel with vhost asynchronous APIs.
 425   See the :doc:`../sample_app_ug/vhost` for more details.
 426
 427
 428 Removed Items
 429 -------------
 430
 431 .. This section should contain removed items in this release. Sample format:
 432
 433    * Add a short 1-2 sentence description of the removed item
 434      in the past tense.
 435
 436    This section is a comment. Do not overwrite or remove it.
 437    Also, make sure to start the actual text at the margin.
 438    =======================================================
 439
 440 * build: Support for the Make build system was removed for compiling DPDK,
 441   Meson is now the primary build system.
 442   Sample applications can still be built with Make standalone, using pkg-config.
 443
 444 * vhost: Dequeue zero-copy support has been removed.
 445
 446 * kernel: The module ``igb_uio`` has been moved to the git repository
 447   ``dpdk-kmods`` in a new directory ``linux/igb_uio``.
 448
 449 * Removed Python 2 support since it was EOL'd in January 2020.
 450
 451 * Removed TEP termination sample application.
 452
 453
 454 API Changes
 455 -----------
 456
 457 .. This section should contain API changes. Sample format:
 458
 459    * sample: Add a short 1-2 sentence description of the API change
 460      which was announced in the previous releases and made in this release.
 461      Start with a scope label like "ethdev:".
 462      Use fixed width quotes for ``function_names`` or ``struct_names``.
 463      Use the past tense.
 464
 465    This section is a comment. Do not overwrite or remove it.
 466    Also, make sure to start the actual text at the margin.
 467    =======================================================
 468
 469 * build macros: The macros defining ``RTE_MACHINE_CPUFLAG_*`` are removed.
 470   The information provided by these macros is available through standard
 471   compiler macros.
 472
 473 * eal: Replaced the function ``rte_get_master_lcore()`` to
 474   ``rte_get_main_lcore()``. The old function is deprecated.
 475
 476   The iterator for worker lcores is also changed:
 477   ``RTE_LCORE_FOREACH_SLAVE`` is replaced with
 478   ``RTE_LCORE_FOREACH_WORKER``.
 479
 480 * eal: The definitions related to including and excluding devices
 481   has been changed from blacklist/whitelist to block/allow list.
 482   There are compatibility macros and command line mapping to accept
 483   the old values but applications and scripts are strongly encouraged
 484   to migrate to the new names.
 485
 486 * eal: The ``rte_logs`` struct and global symbol was made private
 487   and is no longer part of the API.
 488
 489 * eal: Made the ``rte_dev_event`` structure private to the EAL as no public API
 490   used it.
 491
 492 * eal: ``rte_cio_rmb()`` and ``rte_cio_wmb()`` were deprecated since 20.08
 493   and are removed in this release.
 494
 495 * mem: Removed the unioned field ``phys_addr`` from
 496   the structures ``rte_memseg`` and ``rte_memzone``.
 497   The field ``iova`` is remaining from the old unions.
 498
 499 * mempool: Removed the unioned fields ``phys_addr`` and ``physaddr`` from
 500   the structures ``rte_mempool_memhdr`` and ``rte_mempool_objhdr``.
 501   The field ``iova`` is remaining from the old unions.
 502   The flag name ``MEMPOOL_F_NO_PHYS_CONTIG`` is removed,
 503   while the aliased flag ``MEMPOOL_F_NO_IOVA_CONTIG`` is kept.
 504
 505 * mbuf: Removed the functions ``rte_mbuf_data_dma_addr*``
 506   and the macros ``rte_pktmbuf_mtophys*``.
 507   The same functionality is still available with the functions and macros
 508   having ``iova`` in their names instead of ``dma_addr`` or ``mtophys``.
 509
 510 * mbuf: Removed the unioned field ``buf_physaddr`` from ``rte_mbuf``.
 511   The field ``buf_iova`` is remaining from the old union.
 512
 513 * mbuf: Removed the unioned field ``refcnt_atomic`` from
 514   the structures ``rte_mbuf`` and ``rte_mbuf_ext_shared_info``.
 515   The field ``refcnt`` is remaining from the old unions.
 516
 517 * mbuf: Removed the unioned fields ``userdata`` and ``udata64``
 518   from the structure ``rte_mbuf``. It is replaced with dynamic fields.
 519
 520 * mbuf: Removed the field ``seqn`` from the structure ``rte_mbuf``.
 521   It is replaced with dynamic fields.
 522
 523 * mbuf: Removed the field ``timestamp`` from the structure ``rte_mbuf``.
 524   It is replaced with the dynamic field RTE_MBUF_DYNFIELD_TIMESTAMP_NAME
 525   which was previously used only for Tx.
 526
 527 * pci: Removed the ``rte_kernel_driver`` enum defined in rte_dev.h and
 528   replaced with a private enum in the PCI subsystem.
 529
 530 * pci: Removed the PCI resources map API from the public API
 531   (``pci_map_resource`` and ``pci_unmap_resource``) and moved it to the
 532   PCI bus driver along with the PCI resources lists and associated structures
 533   (``pci_map``, ``pci_msix_table``, ``mapped_pci_resource`` and
 534   ``mapped_pci_res_list``).
 535
 536 * ethdev: Removed the ``kdrv`` field in the ethdev ``rte_eth_dev_data``
 537   structure as it gave no useful abstracted information to the applications.
 538
 539 * ethdev: ``rte_eth_rx_descriptor_done()`` API has been deprecated.
 540
 541 * ethdev: Renamed basic statistics per queue. An underscore is inserted
 542   between the queue number and the rest of the xstat name:
 543
 544   * ``rx_qN*`` -> ``rx_qN_*``
 545   * ``tx_qN*`` -> ``tx_qN_*``
 546
 547 * ethdev: Added capability to query age flow action.
 548
 549 * ethdev: Changed ``rte_eth_dev_stop`` return value from ``void`` to
 550   ``int`` to provide a way to report various error conditions.
 551
 552 * ethdev: Added ``int`` return type to ``rte_eth_dev_close()``.
 553
 554 * ethdev: Renamed internal functions:
 555
 556   * ``_rte_eth_dev_callback_process()`` -> ``rte_eth_dev_callback_process()``
 557   * ``_rte_eth_dev_reset`` -> ``rte_eth_dev_internal_reset()``
 558
 559 * ethdev: Modified field type of ``base`` and ``nb_queue`` in struct
 560   ``rte_eth_dcb_tc_queue_mapping`` from ``uint8_t`` to ``uint16_t``.
 561   As the data of ``uint8_t`` will be truncated when queue number under
 562   a TC is greater than 256.
 563
 564 * ethdev: Removed the legacy filter API, including
 565   ``rte_eth_dev_filter_supported()`` and ``rte_eth_dev_filter_ctrl()``.
 566
 567 * ethdev: Removed the legacy L2 tunnel configuration API, including
 568   ``rte_eth_dev_l2_tunnel_eth_type_conf()`` and
 569   ``rte_eth_dev_l2_tunnel_offload_set()``..
 570
 571 * vhost: Moved vDPA APIs from experimental to stable.
 572
 573 * vhost: Add a new function ``rte_vhost_crypto_driver_start`` to be called
 574   instead of ``rte_vhost_driver_start`` by crypto applications.
 575
 576 * cryptodev: The structure ``rte_crypto_sym_vec`` is updated to support both
 577   cpu_crypto synchrounous operation and asynchronous raw data-path APIs.
 578
 579 * cryptodev: ``RTE_CRYPTO_AEAD_LIST_END`` from ``enum rte_crypto_aead_algorithm``,
 580   ``RTE_CRYPTO_CIPHER_LIST_END`` from ``enum rte_crypto_cipher_algorithm`` and
 581   ``RTE_CRYPTO_AUTH_LIST_END`` from ``enum rte_crypto_auth_algorithm``
 582   are removed to avoid future ABI breakage while adding new algorithms.
 583
 584 * scheduler: Renamed functions ``rte_cryptodev_scheduler_slave_attach``,
 585   ``rte_cryptodev_scheduler_slave_detach`` and
 586   ``rte_cryptodev_scheduler_slaves_get`` to
 587   ``rte_cryptodev_scheduler_worker_attach``,
 588   ``rte_cryptodev_scheduler_worker_detach`` and
 589   ``rte_cryptodev_scheduler_workers_get`` accordingly.
 590
 591 * scheduler: Renamed the configuration value
 592   ``RTE_CRYPTODEV_SCHEDULER_MAX_NB_SLAVES`` to
 593   ``RTE_CRYPTODEV_SCHEDULER_MAX_NB_WORKERS``.
 594
 595 * security: ``hfn_ovrd`` field in ``rte_security_pdcp_xform`` is changed from
 596   ``uint32_t`` to ``uint8_t`` so that a new field ``sdap_enabled`` can be added
 597   to support SDAP.
 598
 599 * security: The API ``rte_security_session_create`` is updated to take two
 600   mempool objects one for session and other for session private data.
 601   So the application need to create two mempools and get the size of session
 602   private data using API ``rte_security_session_get_size`` for private session
 603   mempool.
 604
 605 * ipsec: ``RTE_SATP_LOG2_NUM`` has been dropped from ``enum`` and
 606   subsequently moved ``rte_ipsec`` lib from experimental to stable.
 607
 608 * baseband/fpga_lte_fec: Renamed function ``fpga_lte_fec_configure`` to
 609   ``rte_fpga_lte_fec_configure`` and structure ``fpga_lte_fec_conf`` to
 610   ``rte_fpga_lte_fec_conf``.
 611
 612 * baseband/fpga_5gnr_fec: Renamed function ``fpga_5gnr_fec_configure`` to
 613   ``rte_fpga_5gnr_fec_configure`` and structure ``fpga_5gnr_fec_conf`` to
 614   ``rte_fpga_5gnr_fec_conf``.
 615
 616 * rawdev: Added a structure size parameter to the functions
 617   ``rte_rawdev_queue_setup()``, ``rte_rawdev_queue_conf_get()``,
 618   ``rte_rawdev_info_get()`` and ``rte_rawdev_configure()``,
 619   allowing limited driver type-checking and ABI compatibility.
 620
 621 * rawdev: Changed the return type of the function ``rte_dev_info_get()``
 622   and the function ``rte_rawdev_queue_conf_get()``
 623   from ``void`` to ``int`` allowing the return of error codes from drivers.
 624
 625 * rawdev: The running of a drivers ``selftest()`` function can now be done
 626   using the ``rawdev_autotest`` command in the ``dpdk-test`` binary. This
 627   command now calls the self-test function for each rawdev found on the
 628   system, and does not require a specific command per device type.
 629   Following this change, the ``ioat_rawdev_autotest`` command has been
 630   removed as no longer needed.
 631
 632 * raw/ioat: As noted above, the ``rte_ioat_do_copies()`` and
 633   ``rte_ioat_completed_copies()`` functions have been renamed to
 634   ``rte_ioat_perform_ops()`` and ``rte_ioat_completed_ops()`` respectively.
 635
 636 * stack: the experimental tag has been dropped from the stack library, and its
 637   interfaces are considered stable as of DPDK 20.11.
 638
 639 * bpf: ``RTE_BPF_XTYPE_NUM`` has been dropped from ``rte_bpf_xtype``.
 640
 641 * gso: Changed ``rte_gso_segment`` behaviour and return value:
 642
 643   * ``pkt`` is not saved to ``pkts_out[0]`` if not GSOed.
 644   * Return 0 instead of 1 for the above case.
 645   * ``pkt`` is not freed, no matter whether it is GSOed, leaving to the caller.
 646
 647 * acl: ``RTE_ACL_CLASSIFY_NUM`` enum value has been removed.
 648   This enum value was not used inside DPDK, while it prevented to add new
 649   classify algorithms without causing an ABI breakage.
 650
 651 * sched: Added ``subport_profile_id`` as argument
 652   to function ``rte_sched_subport_config``.
 653
 654 * sched: Removed ``tb_rate``, ``tc_rate``, ``tc_period`` and ``tb_size``
 655   from ``struct rte_sched_subport_params``.
 656
 657
 658 ABI Changes
 659 -----------
 660
 661 .. This section should contain ABI changes. Sample format:
 662
 663    * sample: Add a short 1-2 sentence description of the ABI change
 664      which was announced in the previous releases and made in this release.
 665      Start with a scope label like "ethdev:".
 666      Use fixed width quotes for ``function_names`` or ``struct_names``.
 667      Use the past tense.
 668
 669    This section is a comment. Do not overwrite or remove it.
 670    Also, make sure to start the actual text at the margin.
 671    =======================================================
 672
 673 * eal: Removed the not implemented function ``rte_dump_registers()``.
 674
 675 * ``ethdev`` changes
 676
 677   * Following device operation function pointers moved
 678     from ``struct eth_dev_ops`` to ``struct rte_eth_dev``:
 679
 680     * ``eth_rx_queue_count_t       rx_queue_count;``
 681     * ``eth_rx_descriptor_done_t   rx_descriptor_done;``
 682     * ``eth_rx_descriptor_status_t rx_descriptor_status;``
 683     * ``eth_tx_descriptor_status_t tx_descriptor_status;``
 684
 685   * ``struct eth_dev_ops`` is no more accessible by applications,
 686     which was already internal data structure.
 687
 688   * ``ethdev`` internal functions are marked with ``__rte_internal`` tag.
 689
 690   * Added extensions' attributes to struct ``rte_flow_item_ipv6``.
 691     A set of additional values added to struct, indicating the existence of
 692     every defined extension header type.
 693     Applications should use the new values for identification of existing
 694     extensions in the packet header.
 695
 696   * Added fields ``rx_seg`` and ``rx_nseg`` to ``rte_eth_rxconf`` structure
 697     to provide extended description of the receiving buffer.
 698
 699   * ``struct rte_eth_hairpin_conf`` has two new members:
 700
 701     * ``uint32_t tx_explicit:1;``
 702     * ``uint32_t manual_bind:1;``
 703
 704   * Added new field ``has_vlan`` to structure ``rte_flow_item_eth``,
 705     indicating that packet header contains at least one VLAN.
 706
 707   * Added new field ``has_more_vlan`` to structure
 708     ``rte_flow_item_vlan``, indicating that packet header contains
 709     at least one more VLAN, after this VLAN.
 710
 711 * eventdev: Following structures are modified to support DLB/DLB2 PMDs
 712   and future extensions:
 713
 714   * ``rte_event_dev_info``
 715   * ``rte_event_dev_config``
 716   * ``rte_event_port_conf``
 717
 718 * sched: Added new fields to ``struct rte_sched_subport_port_params``.
 719
 720 * lpm: Removed fields other than ``tbl24`` and ``tbl8`` from the struct
 721   ``rte_lpm``. The removed fields were made internal.
 722
 723
 724 Known Issues
 725 ------------
 726
 727 .. This section should contain new known issues in this release. Sample format:
 728
 729    * **Add title in present tense with full stop.**
 730
 731      Add a short 1-2 sentence description of the known issue
 732      in the present tense. Add information on any known workarounds.
 733
 734    This section is a comment. Do not overwrite or remove it.
 735    Also, make sure to start the actual text at the margin.
 736    =======================================================
 737
 738
 739 Tested Platforms
 740 ----------------
 741
 742 .. This section should contain a list of platforms that were tested
 743    with this release.
 744
 745    The format is:
 746
 747    * <vendor> platform with <vendor> <type of devices> combinations
 748
 749      * List of CPU
 750      * List of OS
 751      * List of devices
 752      * Other relevant details...
 753
 754    This section is a comment. Do not overwrite or remove it.
 755    Also, make sure to start the actual text at the margin.
 756    =======================================================