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
 211   Updated Mellanox mlx5 vDPA driver:
 212
 213   * Added support of vDPA VirtQ error handling.
 214
 215 * **Updated Solarflare network PMD.**
 216
 217   Updated the Solarflare ``sfc_efx`` driver with changes including:
 218
 219   * Added SR-IOV PF support
 220   * Added Alveo SN1000 SmartNICs (EF100 architecture) support including
 221     flow API transfer rules for switch HW offload
 222   * Added ARMv8 support
 223   * Claimed flow API native thread safety
 224
 225 * **Added Wangxun txgbe PMD.**
 226
 227   Added a new PMD driver for Wangxun 10 Gigabit Ethernet NICs.
 228
 229   See the :doc:`../nics/txgbe` for more details.
 230
 231 * **Updated Virtio driver.**
 232
 233   * Added support for Vhost-vDPA backend to Virtio-user PMD.
 234   * Changed default link speed to unknown.
 235   * Added support for 200G link speed.
 236
 237 * **Updated Intel i40e driver.**
 238
 239   Updated the Intel i40e driver to use write combining stores.
 240
 241 * **Updated Intel ixgbe driver.**
 242
 243   Updated the Intel ixgbe driver to use write combining stores.
 244
 245 * **Updated Intel qat driver.**
 246
 247   Updated the Intel qat driver to use write combining stores.
 248
 249 * **Updated Memif PMD.**
 250
 251   * Added support for abstract socket address.
 252   * Changed default socket address type to abstract.
 253
 254 * **Added Ice Lake (Gen4) support for Intel NTB.**
 255
 256   Added NTB device support (4th generation) for Intel Ice Lake platform.
 257
 258 * **Added UDP/IPv4 GRO support for VxLAN and non-VxLAN packets.**
 259
 260   For VxLAN packets, added inner UDP/IPv4 support.
 261   For non-VxLAN packets, added UDP/IPv4 support.
 262
 263 * **Extended flow-perf application.**
 264
 265   * Started supporting user order instead of bit mask:
 266     Now the user can create any structure of rte_flow
 267     using flow performance application with any order,
 268     moreover the app also now starts to support inner
 269     items matching as well.
 270   * Added header modify actions.
 271   * Added flag action.
 272   * Added raw encap/decap actions.
 273   * Added VXLAN encap/decap actions.
 274   * Added ICMP(code/type/identifier/sequence number) and ICMP6(code/type) matching items.
 275   * Added option to set port mask for insertion/deletion:
 276     ``--portmask=N``
 277     where N represents the hexadecimal bitmask of ports used.
 278
 279 * **Added raw data-path APIs for cryptodev library.**
 280
 281   Cryptodev is added with raw data-path APIs to accelerate external
 282   libraries or applications which need to avail fast cryptodev
 283   enqueue/dequeue operations but does not necessarily depends on
 284   mbufs and cryptodev operation mempools.
 285
 286 * **Updated the aesni_mb crypto PMD.**
 287
 288   * Added support for intel-ipsec-mb version 0.55.
 289   * Added support for AES-ECB 128, 192 and 256.
 290   * Added support for ZUC-EEA3/EIA3 algorithms.
 291   * Added support for SNOW3G-UEA2/UIA2 algorithms.
 292   * Added support for KASUMI-F8/F9 algorithms.
 293   * Added support for Chacha20-Poly1305.
 294   * Added support for AES-256 CCM algorithm.
 295
 296 * **Updated the aesni_gcm crypto PMD.**
 297
 298   * Added SGL support for AES-GMAC.
 299
 300 * **Added Broadcom BCMFS symmetric crypto PMD.**
 301
 302   Added a symmetric crypto PMD for Broadcom FlexSparc crypto units.
 303   See :doc:`../cryptodevs/bcmfs` guide for more details on this new PMD.
 304
 305 * **Updated DPAA2_SEC crypto PMD.**
 306
 307   * Added DES-CBC support for cipher_only, chain and ipsec protocol.
 308   * Added support for non-HMAC auth algorithms
 309     (MD5, SHA1, SHA224, SHA256, SHA384, SHA512).
 310
 311 * **Updated Marvell NITROX symmetric crypto PMD.**
 312
 313   * Added AES-GCM support.
 314   * Added cipher only offload support.
 315
 316 * **Updated the OCTEON TX2 crypto PMD.**
 317
 318   * Updated the OCTEON TX2 crypto PMD lookaside protocol offload for IPsec with
 319     IPv6 support.
 320
 321 * **Updated QAT crypto PMD.**
 322
 323   * Added Raw Data-path APIs support.
 324
 325 * **Added Intel ACC100 bbdev PMD.**
 326
 327   Added a new ``acc100`` bbdev driver for the Intel\ |reg| ACC100 accelerator
 328   also known as Mount Bryce.  See the
 329   :doc:`../bbdevs/acc100` BBDEV guide for more details on this new driver.
 330
 331 * **Updated rte_security library to support SDAP.**
 332
 333   ``rte_security_pdcp_xform`` in ``rte_security`` lib is updated to enable
 334   5G NR processing of SDAP header in PMDs.
 335
 336 * **Added Marvell OCTEON TX2 regex PMD.**
 337
 338   Added a new PMD driver for hardware regex offload block for OCTEON TX2 SoC.
 339
 340   See the :doc:`../regexdevs/octeontx2` for more details.
 341
 342 * **Updated Software Eventdev driver.**
 343
 344   Added performance tuning arguments to allow tuning the scheduler for
 345   better throughtput in high core count use cases.
 346
 347 * **Added a new driver for the Intel Dynamic Load Balancer v1.0 device.**
 348
 349   Added the new ``dlb`` eventdev driver for the Intel DLB V1.0 device. See the
 350   :doc:`../eventdevs/dlb` eventdev guide for more details on this new driver.
 351
 352 * **Added a new driver for the Intel Dynamic Load Balancer v2.0 device.**
 353
 354   Added the new ``dlb2`` eventdev driver for the Intel DLB V2.0 device. See the
 355   :doc:`../eventdevs/dlb2` eventdev guide for more details on this new driver.
 356
 357 * **Updated ioat rawdev driver**
 358
 359   The ioat rawdev driver has been updated and enhanced. Changes include:
 360
 361   * Added support for Intel\ |reg| Data Streaming Accelerator hardware.
 362     For more information, see https://01.org/blogs/2019/introducing-intel-data-streaming-accelerator
 363   * Added support for the fill operation via the API ``rte_ioat_enqueue_fill()``,
 364     where the hardware fills an area of memory with a repeating pattern.
 365   * Added a per-device configuration flag to disable management
 366     of user-provided completion handles.
 367   * Renamed the ``rte_ioat_do_copies()`` API to ``rte_ioat_perform_ops()``,
 368     and renamed the ``rte_ioat_completed_copies()`` API to ``rte_ioat_completed_ops()``
 369     to better reflect the APIs' purposes, and remove the implication that
 370     they are limited to copy operations only.
 371     [Note: The old API is still provided but marked as deprecated in the code]
 372   * Added a new API ``rte_ioat_fence()`` to add a fence between operations.
 373     This API replaces the ``fence`` flag parameter in the ``rte_ioat_enqueue_copies()`` function,
 374     and is clearer as there is no ambiguity as to whether the flag should be
 375     set on the last operation before the fence or the first operation after it.
 376
 377 * **Updated the pipeline library for alignment with the P4 language.**
 378
 379   Added new Software Switch (SWX) pipeline type that provides more
 380   flexibility through API and feature alignment with the P4 language.
 381
 382   * The packet headers, meta-data, actions, tables and pipelines are
 383     dynamically defined instead of selected from pre-defined set.
 384   * The actions and the pipeline are defined with instructions.
 385   * Extern objects and functions can be plugged into the pipeline.
 386   * Transaction-oriented table updates.
 387
 388 * **Add new AVX512 specific classify algorithms for ACL library.**
 389
 390   * Added new ``RTE_ACL_CLASSIFY_AVX512X16`` vector implementation,
 391     which can process up to 16 flows in parallel. Requires AVX512 support.
 392
 393   * Added new ``RTE_ACL_CLASSIFY_AVX512X32`` vector implementation,
 394     which can process up to 32 flows in parallel. Requires AVX512 support.
 395
 396 * **Added AVX512 lookup implementation for FIB.**
 397
 398   Added a AVX512 lookup functions implementation into FIB and FIB6 libraries.
 399
 400 * **Added support to update subport bandwidth dynamically.**
 401
 402    * Added new API ``rte_sched_port_subport_profile_add`` to add new
 403      subport bandwidth profile to subport porfile table at runtime.
 404
 405    * Added support to update subport rate dynamically.
 406
 407 * **Updated FIPS validation sample application.**
 408
 409   * Added scatter gather support.
 410   * Added NIST GCMVS complaint GMAC test method support.
 411
 412 * **Updated l3wfd-acl sample application.**
 413
 414   * Added new optional parameter ``--eth-dest`` for the ``l3fwd-acl`` to allow
 415     the user to specify the destination mac address for each ethernet port
 416     used.
 417   * Replaced ``--scalar`` command-line option with ``--alg=<value>``, to allow
 418     the user to select the desired classify method.
 419
 420 * **Updated vhost sample application.**
 421
 422   Added vhost asynchronous APIs support, which demonstrated how the application
 423   leverage IOAT DMA channel with vhost asynchronous APIs.
 424   See the :doc:`../sample_app_ug/vhost` for more details.
 425
 426
 427 Removed Items
 428 -------------
 429
 430 .. This section should contain removed items in this release. Sample format:
 431
 432    * Add a short 1-2 sentence description of the removed item
 433      in the past tense.
 434
 435    This section is a comment. Do not overwrite or remove it.
 436    Also, make sure to start the actual text at the margin.
 437    =======================================================
 438
 439 * build: Support for the Make build system was removed for compiling DPDK,
 440   Meson is now the primary build system.
 441   Sample applications can still be built with Make standalone, using pkg-config.
 442
 443 * vhost: Dequeue zero-copy support has been removed.
 444
 445 * kernel: The module ``igb_uio`` has been moved to the git repository
 446   ``dpdk-kmods`` in a new directory ``linux/igb_uio``.
 447
 448 * Removed Python 2 support since it was EOL'd in January 2020.
 449
 450 * Removed TEP termination sample application.
 451
 452
 453 API Changes
 454 -----------
 455
 456 .. This section should contain API changes. Sample format:
 457
 458    * sample: Add a short 1-2 sentence description of the API change
 459      which was announced in the previous releases and made in this release.
 460      Start with a scope label like "ethdev:".
 461      Use fixed width quotes for ``function_names`` or ``struct_names``.
 462      Use the past tense.
 463
 464    This section is a comment. Do not overwrite or remove it.
 465    Also, make sure to start the actual text at the margin.
 466    =======================================================
 467
 468 * build macros: The macros defining ``RTE_MACHINE_CPUFLAG_*`` are removed.
 469   The information provided by these macros is available through standard
 470   compiler macros.
 471
 472 * eal: Replaced the function ``rte_get_master_lcore()`` to
 473   ``rte_get_main_lcore()``. The old function is deprecated.
 474
 475   The iterator for worker lcores is also changed:
 476   ``RTE_LCORE_FOREACH_SLAVE`` is replaced with
 477   ``RTE_LCORE_FOREACH_WORKER``.
 478
 479 * eal: The definitions related to including and excluding devices
 480   has been changed from blacklist/whitelist to block/allow list.
 481   There are compatibility macros and command line mapping to accept
 482   the old values but applications and scripts are strongly encouraged
 483   to migrate to the new names.
 484
 485 * eal: The ``rte_logs`` struct and global symbol was made private
 486   and is no longer part of the API.
 487
 488 * eal: Made the ``rte_dev_event`` structure private to the EAL as no public API
 489   used it.
 490
 491 * eal: ``rte_cio_rmb()`` and ``rte_cio_wmb()`` were deprecated since 20.08
 492   and are removed in this release.
 493
 494 * mem: Removed the unioned field ``phys_addr`` from
 495   the structures ``rte_memseg`` and ``rte_memzone``.
 496   The field ``iova`` is remaining from the old unions.
 497
 498 * mempool: Removed the unioned fields ``phys_addr`` and ``physaddr`` from
 499   the structures ``rte_mempool_memhdr`` and ``rte_mempool_objhdr``.
 500   The field ``iova`` is remaining from the old unions.
 501   The flag name ``MEMPOOL_F_NO_PHYS_CONTIG`` is removed,
 502   while the aliased flag ``MEMPOOL_F_NO_IOVA_CONTIG`` is kept.
 503
 504 * mbuf: Removed the functions ``rte_mbuf_data_dma_addr*``
 505   and the macros ``rte_pktmbuf_mtophys*``.
 506   The same functionality is still available with the functions and macros
 507   having ``iova`` in their names instead of ``dma_addr`` or ``mtophys``.
 508
 509 * mbuf: Removed the unioned field ``buf_physaddr`` from ``rte_mbuf``.
 510   The field ``buf_iova`` is remaining from the old union.
 511
 512 * mbuf: Removed the unioned field ``refcnt_atomic`` from
 513   the structures ``rte_mbuf`` and ``rte_mbuf_ext_shared_info``.
 514   The field ``refcnt`` is remaining from the old unions.
 515
 516 * mbuf: Removed the unioned fields ``userdata`` and ``udata64``
 517   from the structure ``rte_mbuf``. It is replaced with dynamic fields.
 518
 519 * mbuf: Removed the field ``seqn`` from the structure ``rte_mbuf``.
 520   It is replaced with dynamic fields.
 521
 522 * mbuf: Removed the field ``timestamp`` from the structure ``rte_mbuf``.
 523   It is replaced with the dynamic field RTE_MBUF_DYNFIELD_TIMESTAMP_NAME
 524   which was previously used only for Tx.
 525
 526 * pci: Removed the ``rte_kernel_driver`` enum defined in rte_dev.h and
 527   replaced with a private enum in the PCI subsystem.
 528
 529 * pci: Removed the PCI resources map API from the public API
 530   (``pci_map_resource`` and ``pci_unmap_resource``) and moved it to the
 531   PCI bus driver along with the PCI resources lists and associated structures
 532   (``pci_map``, ``pci_msix_table``, ``mapped_pci_resource`` and
 533   ``mapped_pci_res_list``).
 534
 535 * ethdev: Removed the ``kdrv`` field in the ethdev ``rte_eth_dev_data``
 536   structure as it gave no useful abstracted information to the applications.
 537
 538 * ethdev: ``rte_eth_rx_descriptor_done()`` API has been deprecated.
 539
 540 * ethdev: Renamed basic statistics per queue. An underscore is inserted
 541   between the queue number and the rest of the xstat name:
 542
 543   * ``rx_qN*`` -> ``rx_qN_*``
 544   * ``tx_qN*`` -> ``tx_qN_*``
 545
 546 * ethdev: Added capability to query age flow action.
 547
 548 * ethdev: Changed ``rte_eth_dev_stop`` return value from ``void`` to
 549   ``int`` to provide a way to report various error conditions.
 550
 551 * ethdev: Added ``int`` return type to ``rte_eth_dev_close()``.
 552
 553 * ethdev: Renamed internal functions:
 554
 555   * ``_rte_eth_dev_callback_process()`` -> ``rte_eth_dev_callback_process()``
 556   * ``_rte_eth_dev_reset`` -> ``rte_eth_dev_internal_reset()``
 557
 558 * ethdev: Modified field type of ``base`` and ``nb_queue`` in struct
 559   ``rte_eth_dcb_tc_queue_mapping`` from ``uint8_t`` to ``uint16_t``.
 560   As the data of ``uint8_t`` will be truncated when queue number under
 561   a TC is greater than 256.
 562
 563 * ethdev: Removed the legacy filter API, including
 564   ``rte_eth_dev_filter_supported()`` and ``rte_eth_dev_filter_ctrl()``.
 565
 566 * ethdev: Removed the legacy L2 tunnel configuration API, including
 567   ``rte_eth_dev_l2_tunnel_eth_type_conf()`` and
 568   ``rte_eth_dev_l2_tunnel_offload_set()``..
 569
 570 * vhost: Moved vDPA APIs from experimental to stable.
 571
 572 * vhost: Add a new function ``rte_vhost_crypto_driver_start`` to be called
 573   instead of ``rte_vhost_driver_start`` by crypto applications.
 574
 575 * cryptodev: The structure ``rte_crypto_sym_vec`` is updated to support both
 576   cpu_crypto synchrounous operation and asynchronous raw data-path APIs.
 577
 578 * cryptodev: ``RTE_CRYPTO_AEAD_LIST_END`` from ``enum rte_crypto_aead_algorithm``,
 579   ``RTE_CRYPTO_CIPHER_LIST_END`` from ``enum rte_crypto_cipher_algorithm`` and
 580   ``RTE_CRYPTO_AUTH_LIST_END`` from ``enum rte_crypto_auth_algorithm``
 581   are removed to avoid future ABI breakage while adding new algorithms.
 582
 583 * scheduler: Renamed functions ``rte_cryptodev_scheduler_slave_attach``,
 584   ``rte_cryptodev_scheduler_slave_detach`` and
 585   ``rte_cryptodev_scheduler_slaves_get`` to
 586   ``rte_cryptodev_scheduler_worker_attach``,
 587   ``rte_cryptodev_scheduler_worker_detach`` and
 588   ``rte_cryptodev_scheduler_workers_get`` accordingly.
 589
 590 * scheduler: Renamed the configuration value
 591   ``RTE_CRYPTODEV_SCHEDULER_MAX_NB_SLAVES`` to
 592   ``RTE_CRYPTODEV_SCHEDULER_MAX_NB_WORKERS``.
 593
 594 * security: ``hfn_ovrd`` field in ``rte_security_pdcp_xform`` is changed from
 595   ``uint32_t`` to ``uint8_t`` so that a new field ``sdap_enabled`` can be added
 596   to support SDAP.
 597
 598 * security: The API ``rte_security_session_create`` is updated to take two
 599   mempool objects one for session and other for session private data.
 600   So the application need to create two mempools and get the size of session
 601   private data using API ``rte_security_session_get_size`` for private session
 602   mempool.
 603
 604 * ipsec: ``RTE_SATP_LOG2_NUM`` has been dropped from ``enum`` and
 605   subsequently moved ``rte_ipsec`` lib from experimental to stable.
 606
 607 * baseband/fpga_lte_fec: Renamed function ``fpga_lte_fec_configure`` to
 608   ``rte_fpga_lte_fec_configure`` and structure ``fpga_lte_fec_conf`` to
 609   ``rte_fpga_lte_fec_conf``.
 610
 611 * baseband/fpga_5gnr_fec: Renamed function ``fpga_5gnr_fec_configure`` to
 612   ``rte_fpga_5gnr_fec_configure`` and structure ``fpga_5gnr_fec_conf`` to
 613   ``rte_fpga_5gnr_fec_conf``.
 614
 615 * rawdev: Added a structure size parameter to the functions
 616   ``rte_rawdev_queue_setup()``, ``rte_rawdev_queue_conf_get()``,
 617   ``rte_rawdev_info_get()`` and ``rte_rawdev_configure()``,
 618   allowing limited driver type-checking and ABI compatibility.
 619
 620 * rawdev: Changed the return type of the function ``rte_dev_info_get()``
 621   and the function ``rte_rawdev_queue_conf_get()``
 622   from ``void`` to ``int`` allowing the return of error codes from drivers.
 623
 624 * rawdev: The running of a drivers ``selftest()`` function can now be done
 625   using the ``rawdev_autotest`` command in the ``dpdk-test`` binary. This
 626   command now calls the self-test function for each rawdev found on the
 627   system, and does not require a specific command per device type.
 628   Following this change, the ``ioat_rawdev_autotest`` command has been
 629   removed as no longer needed.
 630
 631 * raw/ioat: As noted above, the ``rte_ioat_do_copies()`` and
 632   ``rte_ioat_completed_copies()`` functions have been renamed to
 633   ``rte_ioat_perform_ops()`` and ``rte_ioat_completed_ops()`` respectively.
 634
 635 * stack: the experimental tag has been dropped from the stack library, and its
 636   interfaces are considered stable as of DPDK 20.11.
 637
 638 * bpf: ``RTE_BPF_XTYPE_NUM`` has been dropped from ``rte_bpf_xtype``.
 639
 640 * gso: Changed ``rte_gso_segment`` behaviour and return value:
 641
 642   * ``pkt`` is not saved to ``pkts_out[0]`` if not GSOed.
 643   * Return 0 instead of 1 for the above case.
 644   * ``pkt`` is not freed, no matter whether it is GSOed, leaving to the caller.
 645
 646 * acl: ``RTE_ACL_CLASSIFY_NUM`` enum value has been removed.
 647   This enum value was not used inside DPDK, while it prevented to add new
 648   classify algorithms without causing an ABI breakage.
 649
 650 * sched: Added ``subport_profile_id`` as argument
 651   to function ``rte_sched_subport_config``.
 652
 653 * sched: Removed ``tb_rate``, ``tc_rate``, ``tc_period`` and ``tb_size``
 654   from ``struct rte_sched_subport_params``.
 655
 656
 657 ABI Changes
 658 -----------
 659
 660 .. This section should contain ABI changes. Sample format:
 661
 662    * sample: Add a short 1-2 sentence description of the ABI change
 663      which was announced in the previous releases and made in this release.
 664      Start with a scope label like "ethdev:".
 665      Use fixed width quotes for ``function_names`` or ``struct_names``.
 666      Use the past tense.
 667
 668    This section is a comment. Do not overwrite or remove it.
 669    Also, make sure to start the actual text at the margin.
 670    =======================================================
 671
 672 * eal: Removed the not implemented function ``rte_dump_registers()``.
 673
 674 * ``ethdev`` changes
 675
 676   * Following device operation function pointers moved
 677     from ``struct eth_dev_ops`` to ``struct rte_eth_dev``:
 678
 679     * ``eth_rx_queue_count_t       rx_queue_count;``
 680     * ``eth_rx_descriptor_done_t   rx_descriptor_done;``
 681     * ``eth_rx_descriptor_status_t rx_descriptor_status;``
 682     * ``eth_tx_descriptor_status_t tx_descriptor_status;``
 683
 684   * ``struct eth_dev_ops`` is no more accessible by applications,
 685     which was already internal data structure.
 686
 687   * ``ethdev`` internal functions are marked with ``__rte_internal`` tag.
 688
 689   * Added extensions' attributes to struct ``rte_flow_item_ipv6``.
 690     A set of additional values added to struct, indicating the existence of
 691     every defined extension header type.
 692     Applications should use the new values for identification of existing
 693     extensions in the packet header.
 694
 695   * Added fields ``rx_seg`` and ``rx_nseg`` to ``rte_eth_rxconf`` structure
 696     to provide extended description of the receiving buffer.
 697
 698   * ``struct rte_eth_hairpin_conf`` has two new members:
 699
 700     * ``uint32_t tx_explicit:1;``
 701     * ``uint32_t manual_bind:1;``
 702
 703   * Added new field ``has_vlan`` to structure ``rte_flow_item_eth``,
 704     indicating that packet header contains at least one VLAN.
 705
 706   * Added new field ``has_more_vlan`` to structure
 707     ``rte_flow_item_vlan``, indicating that packet header contains
 708     at least one more VLAN, after this VLAN.
 709
 710 * eventdev: Following structures are modified to support DLB/DLB2 PMDs
 711   and future extensions:
 712
 713   * ``rte_event_dev_info``
 714   * ``rte_event_dev_config``
 715   * ``rte_event_port_conf``
 716
 717 * sched: Added new fields to ``struct rte_sched_subport_port_params``.
 718
 719 * lpm: Removed fields other than ``tbl24`` and ``tbl8`` from the struct
 720   ``rte_lpm``. The removed fields were made internal.
 721
 722
 723 Known Issues
 724 ------------
 725
 726 .. This section should contain new known issues in this release. Sample format:
 727
 728    * **Add title in present tense with full stop.**
 729
 730      Add a short 1-2 sentence description of the known issue
 731      in the present tense. Add information on any known workarounds.
 732
 733    This section is a comment. Do not overwrite or remove it.
 734    Also, make sure to start the actual text at the margin.
 735    =======================================================
 736
 737
 738 Tested Platforms
 739 ----------------
 740
 741 .. This section should contain a list of platforms that were tested
 742    with this release.
 743
 744    The format is:
 745
 746    * <vendor> platform with <vendor> <type of devices> combinations
 747
 748      * List of CPU
 749      * List of OS
 750      * List of devices
 751      * Other relevant details...
 752
 753    This section is a comment. Do not overwrite or remove it.
 754    Also, make sure to start the actual text at the margin.
 755    =======================================================