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