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