1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright 2020 The DPDK contributors
4 .. include:: <isonum.txt>
9 .. **Read this first.**
11 The text in the sections below explains how to update the release notes.
13 Use proper spelling, capitalization and punctuation in all sections.
15 Variable and config names should be quoted as fixed width text:
18 Build the docs and view the output file to ensure the changes are correct::
21 xdg-open build/doc/html/guides/rel_notes/release_20_11.html
27 .. This section should contain new features added in this release.
30 * **Add a title in the past tense with a full stop.**
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.
36 If the feature adds a lot of sub-features you can use a bullet list
39 * Added feature foo to do something.
40 * Enhanced feature bar to do something else.
42 Refer to the previous release notes for examples.
44 Suggested order in release notes items:
45 * Core libs (EAL, mempool, ring, mbuf, buses)
46 * Device abstraction libs and PMDs
48 - cryptodev (lib, PMDs)
49 - eventdev (lib, PMDs)
52 * Apps, Examples, Tools (if significant)
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 =======================================================
58 * **Added write combining store APIs.**
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.
65 * **Added prefetch with intention to write APIs.**
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.
71 * **Added the rte_cldemote API.**
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
80 * **Added support for limiting maximum SIMD bitwidth.**
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``.
87 * **Updated CRC modules of the net library.**
89 * Added runtime selection of the optimal architecture-specific CRC path.
90 * Added optimized implementations of CRC32-Ethernet and CRC16-CCITT
91 using the AVX512 and VPCLMULQDQ instruction sets.
93 * **Introduced extended buffer description for receiving.**
95 Added the extended Rx buffer description for Rx queue setup routine
96 providing the individual settings for each Rx segment with maximal size,
97 buffer offset and memory pool to allocate data buffers from.
99 * **Added the FEC API, for a generic FEC query and config.**
101 Added the FEC API which provides functions for query FEC capabilities and
102 current FEC mode from device. Also, API for configuring FEC mode is also provided.
104 * **Added thread safety to rte_flow functions.**
106 Added ``RTE_ETH_DEV_FLOW_OPS_THREAD_SAFE`` device flag to indicate
107 whether PMD supports thread safe operations. If PMD doesn't set the flag,
108 rte_flow API level functions will protect the flow operations with mutex.
110 * **Added flow-based traffic sampling support.**
112 Added new action: ``RTE_FLOW_ACTION_TYPE_SAMPLE`` to duplicate the matching
113 packets with specified ratio, and apply with own set of actions with a fate
114 action. When the ratio is set to 1 then the packets will be 100% mirrored.
116 * **Added support of shared action in flow API.**
118 Added shared action support to utilize single flow action in multiple flow
119 rules. An update of shared action configuration alters the behavior of all
122 * Added new action: ``RTE_FLOW_ACTION_TYPE_SHARED`` to use shared action
124 * Added new flow APIs to create/update/destroy/query shared action.
126 * **Flow rules allowed to use private PMD items / actions.**
128 * Flow rule verification was updated to accept private PMD
131 * **Added generic API to offload tunneled traffic and restore missed packet.**
133 * Added a new hardware independent helper to flow API that
134 offloads tunneled traffic and restores missed packets.
136 * **Updated the ethdev library to support hairpin between two ports.**
138 New APIs are introduced to support binding / unbinding 2 ports hairpin.
139 Hairpin Tx part flow rules can be inserted explicitly.
140 New API is added to get the hairpin peer ports list.
142 * **Updated Broadcom bnxt driver.**
144 Updated the Broadcom bnxt driver with new features and improvements, including:
146 * Added support for 200G PAM4 link speed.
147 * Added support for RSS hash level selection.
148 * Updated HWRM structures to 1.10.1.70 version.
149 * Added TRUFLOW support for Stingray devices.
151 * **Updated Cisco enic driver.**
153 * Added support for VF representors with single-queue Tx/Rx and flow API
154 * Added support for egress PORT_ID action
155 * Added support for non-zero priorities for group 0 flows
156 * Added support for VXLAN decap combined with VLAN pop
158 * **Added hns3 FEC PMD, for supporting query and config FEC mode.**
160 Added the FEC PMD which provides functions for query FEC capabilities and
161 current FEC mode from device. Also, PMD for configuring FEC mode is also provided.
163 * **Updated Solarflare network PMD.**
165 Updated the Solarflare ``sfc_efx`` driver with changes including:
167 * Added SR-IOV PF support
168 * Added Alveo SN1000 SmartNICs (EF100 architecture) support
170 * **Updated Virtio driver.**
172 * Added support for Vhost-vDPA backend to Virtio-user PMD.
173 * Changed default link speed to unknown.
174 * Added support for 200G link speed.
176 * **Updated Intel i40e driver.**
178 Updated the Intel i40e driver to use write combining stores.
180 * **Updated Intel ixgbe driver.**
182 Updated the Intel ixgbe driver to use write combining stores.
184 * **Updated Intel ice driver.**
186 Updated the Intel ice driver to use write combining stores.
188 * **Updated Intel qat driver.**
190 Updated the Intel qat driver to use write combining stores.
192 * **Updated Memif PMD.**
194 * Added support for abstract socket address.
195 * Changed default socket address type to abstract.
197 * **Added Ice Lake (Gen4) support for Intel NTB.**
199 Added NTB device support (4th generation) for Intel Ice Lake platform.
201 * **Added UDP/IPv4 GRO support for VxLAN and non-VxLAN packets.**
203 For VxLAN packets, added inner UDP/IPv4 support.
204 For non-VxLAN packets, added UDP/IPv4 support.
206 * **Extended flow-perf application.**
208 * Started supporting user order instead of bit mask:
209 Now the user can create any structure of rte_flow
210 using flow performance application with any order,
211 moreover the app also now starts to support inner
212 items matching as well.
213 * Added header modify actions.
215 * Added raw encap/decap actions.
216 * Added VXLAN encap/decap actions.
217 * Added ICMP(code/type/identifier/sequence number) and ICMP6(code/type) matching items.
218 * Added option to set port mask for insertion/deletion:
220 where N represents the hexadecimal bitmask of ports used.
222 * **Added raw data-path APIs for cryptodev library.**
224 Cryptodev is added with raw data-path APIs to accelerate external
225 libraries or applications which need to avail fast cryptodev
226 enqueue/dequeue operations but does not necessarily depends on
227 mbufs and cryptodev operation mempools.
229 * **Updated the aesni_mb crypto PMD.**
231 * Added support for AES-ECB 128, 192 and 256.
232 * Added support for ZUC-EEA3/EIA3 algorithms.
233 * Added support for SNOW3G-UEA2/UIA2 algorithms.
234 * Added support for KASUMI-F8/F9 algorithms.
235 * Added support for Chacha20-Poly1305.
236 * Added support for AES-256 CCM algorithm.
238 * **Updated the aesni_gcm crypto PMD.**
240 * Added SGL support for AES-GMAC.
242 * **Added Broadcom BCMFS symmetric crypto PMD.**
244 Added a symmetric crypto PMD for Broadcom FlexSparc crypto units.
245 See :doc:`../cryptodevs/bcmfs` guide for more details on this new PMD.
247 * **Updated DPAA2_SEC crypto PMD.**
249 * Added DES-CBC support for cipher_only, chain and ipsec protocol.
250 * Added support for non-HMAC auth algorithms
251 (MD5, SHA1, SHA224, SHA256, SHA384, SHA512).
253 * **Updated Marvell NITROX symmetric crypto PMD.**
255 * Added AES-GCM support.
256 * Added cipher only offload support.
258 * **Updated the OCTEON TX2 crypto PMD.**
260 * Updated the OCTEON TX2 crypto PMD lookaside protocol offload for IPsec with
263 * **Updated QAT crypto PMD.**
265 * Added Raw Data-path APIs support.
267 * **Added Intel ACC100 bbdev PMD.**
269 Added a new ``acc100`` bbdev driver for the Intel\ |reg| ACC100 accelerator
270 also known as Mount Bryce. See the
271 :doc:`../bbdevs/acc100` BBDEV guide for more details on this new driver.
273 * **Updated rte_security library to support SDAP.**
275 ``rte_security_pdcp_xform`` in ``rte_security`` lib is updated to enable
276 5G NR processing of SDAP header in PMDs.
278 * **Added Marvell OCTEON TX2 regex PMD.**
280 Added a new PMD driver for hardware regex offload block for OCTEON TX2 SoC.
282 See the :doc:`../regexdevs/octeontx2` for more details.
284 * **Updated Software Eventdev driver.**
286 Added performance tuning arguments to allow tuning the scheduler for
287 better throughtput in high core count use cases.
289 * **Updated ioat rawdev driver**
291 The ioat rawdev driver has been updated and enhanced. Changes include:
293 * Added support for Intel\ |reg| Data Streaming Accelerator hardware.
294 For more information, see https://01.org/blogs/2019/introducing-intel-data-streaming-accelerator
295 * Added support for the fill operation via the API ``rte_ioat_enqueue_fill()``,
296 where the hardware fills an area of memory with a repeating pattern.
297 * Added a per-device configuration flag to disable management
298 of user-provided completion handles.
299 * Renamed the ``rte_ioat_do_copies()`` API to ``rte_ioat_perform_ops()``,
300 and renamed the ``rte_ioat_completed_copies()`` API to ``rte_ioat_completed_ops()``
301 to better reflect the APIs' purposes, and remove the implication that
302 they are limited to copy operations only.
303 [Note: The old API is still provided but marked as deprecated in the code]
304 * Added a new API ``rte_ioat_fence()`` to add a fence between operations.
305 This API replaces the ``fence`` flag parameter in the ``rte_ioat_enqueue_copies()`` function,
306 and is clearer as there is no ambiguity as to whether the flag should be
307 set on the last operation before the fence or the first operation after it.
309 * **Updated the pipeline library for alignment with the P4 language.**
311 Added new Software Switch (SWX) pipeline type that provides more
312 flexibility through API and feature alignment with the P4 language.
314 * The packet headers, meta-data, actions, tables and pipelines are
315 dynamically defined instead of selected from pre-defined set.
316 * The actions and the pipeline are defined with instructions.
317 * Extern objects and functions can be plugged into the pipeline.
318 * Transaction-oriented table updates.
320 * **Add new AVX512 specific classify algorithms for ACL library.**
322 * Added new ``RTE_ACL_CLASSIFY_AVX512X16`` vector implementation,
323 which can process up to 16 flows in parallel. Requires AVX512 support.
325 * Added new ``RTE_ACL_CLASSIFY_AVX512X32`` vector implementation,
326 which can process up to 32 flows in parallel. Requires AVX512 support.
328 * **Added AVX512 lookup implementation for FIB.**
330 Added a AVX512 lookup functions implementation into FIB and FIB6 libraries.
332 * **Added support to update subport bandwidth dynamically.**
334 * Added new API ``rte_sched_port_subport_profile_add`` to add new
335 subport bandwidth profile to subport porfile table at runtime.
337 * Added support to update subport rate dynamically.
339 * **Updated FIPS validation sample application.**
341 * Added scatter gather support.
342 * Added NIST GCMVS complaint GMAC test method support.
344 * **Updated l3wfd-acl sample application.**
346 * Added new optional parameter ``--eth-dest`` for the ``l3fwd-acl`` to allow
347 the user to specify the destination mac address for each ethernet port
349 * Replaced ``--scalar`` command-line option with ``--alg=<value>``, to allow
350 the user to select the desired classify method.
356 .. This section should contain removed items in this release. Sample format:
358 * Add a short 1-2 sentence description of the removed item
361 This section is a comment. Do not overwrite or remove it.
362 Also, make sure to start the actual text at the margin.
363 =======================================================
365 * build: Support for the Make build system was removed for compiling DPDK,
366 Meson is now the primary build system.
367 Sample applications can still be built with Make standalone, using pkg-config.
369 * vhost: Dequeue zero-copy support has been removed.
371 * kernel: The module ``igb_uio`` has been moved to the git repository
372 ``dpdk-kmods`` in a new directory ``linux/igb_uio``.
374 * Removed Python 2 support since it was EOL'd in January 2020.
379 .. This section should contain API changes. Sample format:
381 * sample: Add a short 1-2 sentence description of the API change
382 which was announced in the previous releases and made in this release.
383 Start with a scope label like "ethdev:".
384 Use fixed width quotes for ``function_names`` or ``struct_names``.
387 This section is a comment. Do not overwrite or remove it.
388 Also, make sure to start the actual text at the margin.
389 =======================================================
391 * build macros: The macros defining ``RTE_MACHINE_CPUFLAG_*`` are removed.
392 The information provided by these macros is available through standard
395 * eal: Replaced the function ``rte_get_master_lcore()`` to
396 ``rte_get_main_lcore()``. The old function is deprecated.
398 The iterator for worker lcores is also changed:
399 ``RTE_LCORE_FOREACH_SLAVE`` is replaced with
400 ``RTE_LCORE_FOREACH_WORKER``.
402 * eal: The ``rte_logs`` struct and global symbol was made private
403 and is no longer part of the API.
405 * eal: Made the ``rte_dev_event`` structure private to the EAL as no public API
408 * eal: ``rte_cio_rmb()`` and ``rte_cio_wmb()`` were deprecated since 20.08
409 and are removed in this release.
411 * mem: Removed the unioned field ``phys_addr`` from
412 the structures ``rte_memseg`` and ``rte_memzone``.
413 The field ``iova`` is remaining from the old unions.
415 * mempool: Removed the unioned fields ``phys_addr`` and ``physaddr`` from
416 the structures ``rte_mempool_memhdr`` and ``rte_mempool_objhdr``.
417 The field ``iova`` is remaining from the old unions.
418 The flag name ``MEMPOOL_F_NO_PHYS_CONTIG`` is removed,
419 while the aliased flag ``MEMPOOL_F_NO_IOVA_CONTIG`` is kept.
421 * mbuf: Removed the functions ``rte_mbuf_data_dma_addr*``
422 and the macros ``rte_pktmbuf_mtophys*``.
423 The same functionality is still available with the functions and macros
424 having ``iova`` in their names instead of ``dma_addr`` or ``mtophys``.
426 * mbuf: Removed the unioned field ``buf_physaddr`` from ``rte_mbuf``.
427 The field ``buf_iova`` is remaining from the old union.
429 * mbuf: Removed the unioned field ``refcnt_atomic`` from
430 the structures ``rte_mbuf`` and ``rte_mbuf_ext_shared_info``.
431 The field ``refcnt`` is remaining from the old unions.
433 * pci: Removed the ``rte_kernel_driver`` enum defined in rte_dev.h and
434 replaced with a private enum in the PCI subsystem.
436 * pci: Removed the PCI resources map API from the public API
437 (``pci_map_resource`` and ``pci_unmap_resource``) and moved it to the
438 PCI bus driver along with the PCI resources lists and associated structures
439 (``pci_map``, ``pci_msix_table``, ``mapped_pci_resource`` and
440 ``mapped_pci_res_list``).
442 * ethdev: Removed the ``kdrv`` field in the ethdev ``rte_eth_dev_data``
443 structure as it gave no useful abstracted information to the applications.
445 * ethdev: ``rte_eth_rx_descriptor_done()`` API has been deprecated.
447 * ethdev: Renamed basic statistics per queue. An underscore is inserted
448 between the queue number and the rest of the xstat name:
450 * ``rx_qN*`` -> ``rx_qN_*``
451 * ``tx_qN*`` -> ``tx_qN_*``
453 * ethdev: Added capability to query age flow action.
455 * ethdev: Changed ``rte_eth_dev_stop`` return value from ``void`` to
456 ``int`` to provide a way to report various error conditions.
458 * ethdev: Added ``int`` return type to ``rte_eth_dev_close()``.
460 * ethdev: Renamed internal functions:
462 * ``_rte_eth_dev_callback_process()`` -> ``rte_eth_dev_callback_process()``
463 * ``_rte_eth_dev_reset`` -> ``rte_eth_dev_internal_reset()``
465 * ethdev: Modified field type of ``base`` and ``nb_queue`` in struct
466 ``rte_eth_dcb_tc_queue_mapping`` from ``uint8_t`` to ``uint16_t``.
467 As the data of ``uint8_t`` will be truncated when queue number under
468 a TC is greater than 256.
470 * vhost: Moved vDPA APIs from experimental to stable.
472 * vhost: Add a new function ``rte_vhost_crypto_driver_start`` to be called
473 instead of ``rte_vhost_driver_start`` by crypto applications.
475 * cryptodev: The structure ``rte_crypto_sym_vec`` is updated to support both
476 cpu_crypto synchrounous operation and asynchronous raw data-path APIs.
478 * cryptodev: ``RTE_CRYPTO_AEAD_LIST_END`` from ``enum rte_crypto_aead_algorithm``,
479 ``RTE_CRYPTO_CIPHER_LIST_END`` from ``enum rte_crypto_cipher_algorithm`` and
480 ``RTE_CRYPTO_AUTH_LIST_END`` from ``enum rte_crypto_auth_algorithm``
481 are removed to avoid future ABI breakage while adding new algorithms.
483 * scheduler: Renamed functions ``rte_cryptodev_scheduler_slave_attach``,
484 ``rte_cryptodev_scheduler_slave_detach`` and
485 ``rte_cryptodev_scheduler_slaves_get`` to
486 ``rte_cryptodev_scheduler_worker_attach``,
487 ``rte_cryptodev_scheduler_worker_detach`` and
488 ``rte_cryptodev_scheduler_workers_get`` accordingly.
490 * scheduler: Renamed the configuration value
491 ``RTE_CRYPTODEV_SCHEDULER_MAX_NB_SLAVES`` to
492 ``RTE_CRYPTODEV_SCHEDULER_MAX_NB_WORKERS``.
494 * security: ``hfn_ovrd`` field in ``rte_security_pdcp_xform`` is changed from
495 ``uint32_t`` to ``uint8_t`` so that a new field ``sdap_enabled`` can be added
498 * security: The API ``rte_security_session_create`` is updated to take two
499 mempool objects one for session and other for session private data.
500 So the application need to create two mempools and get the size of session
501 private data using API ``rte_security_session_get_size`` for private session
504 * ipsec: ``RTE_SATP_LOG2_NUM`` has been dropped from ``enum`` and
505 subsequently moved ``rte_ipsec`` lib from experimental to stable.
507 * baseband/fpga_lte_fec: Renamed function ``fpga_lte_fec_configure`` to
508 ``rte_fpga_lte_fec_configure`` and structure ``fpga_lte_fec_conf`` to
509 ``rte_fpga_lte_fec_conf``.
511 * baseband/fpga_5gnr_fec: Renamed function ``fpga_5gnr_fec_configure`` to
512 ``rte_fpga_5gnr_fec_configure`` and structure ``fpga_5gnr_fec_conf`` to
513 ``rte_fpga_5gnr_fec_conf``.
515 * rawdev: Added a structure size parameter to the functions
516 ``rte_rawdev_queue_setup()``, ``rte_rawdev_queue_conf_get()``,
517 ``rte_rawdev_info_get()`` and ``rte_rawdev_configure()``,
518 allowing limited driver type-checking and ABI compatibility.
520 * rawdev: Changed the return type of the function ``rte_dev_info_get()``
521 and the function ``rte_rawdev_queue_conf_get()``
522 from ``void`` to ``int`` allowing the return of error codes from drivers.
524 * rawdev: The running of a drivers ``selftest()`` function can now be done
525 using the ``rawdev_autotest`` command in the ``dpdk-test`` binary. This
526 command now calls the self-test function for each rawdev found on the
527 system, and does not require a specific command per device type.
528 Following this change, the ``ioat_rawdev_autotest`` command has been
529 removed as no longer needed.
531 * raw/ioat: As noted above, the ``rte_ioat_do_copies()`` and
532 ``rte_ioat_completed_copies()`` functions have been renamed to
533 ``rte_ioat_perform_ops()`` and ``rte_ioat_completed_ops()`` respectively.
535 * stack: the experimental tag has been dropped from the stack library, and its
536 interfaces are considered stable as of DPDK 20.11.
538 * bpf: ``RTE_BPF_XTYPE_NUM`` has been dropped from ``rte_bpf_xtype``.
540 * acl: ``RTE_ACL_CLASSIFY_NUM`` enum value has been removed.
541 This enum value was not used inside DPDK, while it prevented to add new
542 classify algorithms without causing an ABI breakage.
544 * sched: Added ``subport_profile_id`` as argument
545 to function ``rte_sched_subport_config``.
547 * sched: Removed ``tb_rate``, ``tc_rate``, ``tc_period`` and ``tb_size``
548 from ``struct rte_sched_subport_params``.
554 .. This section should contain ABI changes. Sample format:
556 * sample: Add a short 1-2 sentence description of the ABI change
557 which was announced in the previous releases and made in this release.
558 Start with a scope label like "ethdev:".
559 Use fixed width quotes for ``function_names`` or ``struct_names``.
562 This section is a comment. Do not overwrite or remove it.
563 Also, make sure to start the actual text at the margin.
564 =======================================================
566 * eal: Removed the not implemented function ``rte_dump_registers()``.
570 * Following device operation function pointers moved
571 from ``struct eth_dev_ops`` to ``struct rte_eth_dev``:
573 * ``eth_rx_queue_count_t rx_queue_count;``
574 * ``eth_rx_descriptor_done_t rx_descriptor_done;``
575 * ``eth_rx_descriptor_status_t rx_descriptor_status;``
576 * ``eth_tx_descriptor_status_t tx_descriptor_status;``
578 * ``struct eth_dev_ops`` is no more accessible by applications,
579 which was already internal data structure.
581 * ``ethdev`` internal functions are marked with ``__rte_internal`` tag.
583 * Added extensions' attributes to struct ``rte_flow_item_ipv6``.
584 A set of additional values added to struct, indicating the existence of
585 every defined extension header type.
586 Applications should use the new values for identification of existing
587 extensions in the packet header.
589 * Added fields ``rx_seg`` and ``rx_nseg`` to ``rte_eth_rxconf`` structure
590 to provide extended description of the receiving buffer.
592 * ``struct rte_eth_hairpin_conf`` has two new members:
594 * ``uint32_t tx_explicit:1;``
595 * ``uint32_t manual_bind:1;``
597 * Added new field ``has_vlan`` to structure ``rte_flow_item_eth``,
598 indicating that packet header contains at least one VLAN.
600 * Added new field ``has_more_vlan`` to structure
601 ``rte_flow_item_vlan``, indicating that packet header contains
602 at least one more VLAN, after this VLAN.
604 * eventdev: Following structures are modified to support DLB/DLB2 PMDs
605 and future extensions:
607 * ``rte_event_dev_info``
608 * ``rte_event_dev_config``
609 * ``rte_event_port_conf``
611 * sched: Added new fields to ``struct rte_sched_subport_port_params``.
613 * lpm: Removed fields other than ``tbl24`` and ``tbl8`` from the struct
614 ``rte_lpm``. The removed fields were made internal.
620 .. This section should contain new known issues in this release. Sample format:
622 * **Add title in present tense with full stop.**
624 Add a short 1-2 sentence description of the known issue
625 in the present tense. Add information on any known workarounds.
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 =======================================================
635 .. This section should contain a list of platforms that were tested
640 * <vendor> platform with <vendor> <type of devices> combinations
645 * Other relevant details...
647 This section is a comment. Do not overwrite or remove it.
648 Also, make sure to start the actual text at the margin.
649 =======================================================