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