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