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::
22 xdg-open build/doc/html/guides/rel_notes/release_20_05.html
28 .. This section should contain new features added in this release.
31 * **Add a title in the past tense with a full stop.**
33 Add a short 1-2 sentence description in the past tense.
34 The description should be enough to allow someone scanning
35 the release notes to understand the new feature.
37 If the feature adds a lot of sub-features you can use a bullet list
40 * Added feature foo to do something.
41 * Enhanced feature bar to do something else.
43 Refer to the previous release notes for examples.
45 Suggested order in release notes items:
46 * Core libs (EAL, mempool, ring, mbuf, buses)
47 * Device abstraction libs and PMDs
49 - cryptodev (lib, PMDs)
50 - eventdev (lib, PMDs)
53 * Apps, Examples, Tools (if significant)
55 This section is a comment. Do not overwrite or remove it.
56 Also, make sure to start the actual text at the margin.
57 =========================================================
59 * **Added Trace Library and Tracepoints.**
61 Added a native implementation of the "common trace format" (CTF) based trace
62 library. This allows the user add tracepoints in an application/library to
63 get runtime trace/debug information for control, and fast APIs with minimum
64 impact on fast path performance. Typical trace overhead is ~20 cycles and
65 instrumentation overhead is 1 cycle. Added tracepoints in ``EAL``,
66 ``ethdev``, ``cryptodev``, ``eventdev`` and ``mempool`` libraries for
69 * **Added APIs for RCU defer queues.**
71 Added APIs to create and delete defer queues. Additional APIs are provided
72 to enqueue a deleted resource and reclaim the resource in the future.
73 These APIs help an application use lock-free data structures with
76 * **Added new API for rte_ring.**
78 * Introduced new synchronization modes for ``rte_ring``.
80 Introduced new optional MT synchronization modes for ``rte_ring``:
81 Relaxed Tail Sync (RTS) mode and Head/Tail Sync (HTS) mode.
82 With these modes selected, ``rte_ring`` shows significant improvements for
83 average enqueue/dequeue times on overcommitted systems.
85 * Added peek style API for ``rte_ring``.
87 For rings with producer/consumer in ``RTE_RING_SYNC_ST``, ``RTE_RING_SYNC_MT_HTS``
88 mode, provide the ability to split enqueue/dequeue operation into two phases
89 (enqueue/dequeue start and enqueue/dequeue finish). This allows the user to inspect
90 objects in the ring without removing them (aka MT safe peek).
92 * **Added flow aging support.**
94 Added flow aging support to detect and report aged-out flows, including:
96 * Added new action: ``RTE_FLOW_ACTION_TYPE_AGE`` to set the timeout
97 and the application flow context for each flow.
98 * Added new event: ``RTE_ETH_EVENT_FLOW_AGED`` for the driver to report
99 that there are new aged-out flows.
100 * Added new query: ``rte_flow_get_aged_flows`` to get the aged-out flows
101 contexts from the port.
103 * **ethdev: Added a new value to link speed for 200Gbps.**
105 Added a new ethdev value to for link speeds of 200Gbps.
107 * **Updated the Amazon ena driver.**
109 Updated the ena PMD with new features and improvements, including:
111 * Added support for large LLQ (Low-latency queue) headers.
112 * Added Tx drops as a new extended driver statistic.
113 * Added support for accelerated LLQ mode.
114 * Handling of the 0 length descriptors on the Rx path.
116 * **Updated Broadcom bnxt driver.**
118 Updated the Broadcom bnxt driver with new features and improvements, including:
120 * Added support for host based flow table management.
121 * Added flow counters to extended stats.
122 * Added PCI function stats to extended stats.
124 * **Updated Hisilicon hns3 driver.**
126 Updated Hisilicon hns3 driver with new features and improvements, including:
128 * Added support for TSO.
129 * Added support for configuring promiscuous and allmulticast mode for VF.
131 * **Added a new driver for Intel Foxville I225 devices.**
133 Added the new ``igc`` net driver for Intel Foxville I225 devices. See the
134 :doc:`../nics/igc` NIC guide for more details on this new driver.
136 * **Updated Intel i40e driver.**
138 Updated i40e PMD with new features and improvements, including:
140 * Enabled MAC address as FDIR input set for ipv4-other, ipv4-udp and ipv4-tcp.
141 * Added support for RSS using L3/L4 source/destination only.
142 * Added support for setting hash function in rte flow.
144 * **Updated the Intel iavf driver.**
146 Update the Intel iavf driver with new features and improvements, including:
148 * Added generic filter support.
149 * Added advanced iavf with FDIR capability.
150 * Added advanced RSS configuration for VFs.
152 * **Updated the Intel ice driver.**
154 Updated the Intel ice driver with new features and improvements, including:
156 * Added support for DCF (Device Config Function) feature.
157 * Added switch filter support for Intel DCF.
159 * **Updated Marvell OCTEON TX2 ethdev driver.**
161 Updated Marvell OCTEON TX2 ethdev driver with traffic manager support,
164 * Hierarchical Scheduling with DWRR and SP.
165 * Single rate - Two color, Two rate - Three color shaping.
167 * **Updated Mellanox mlx5 driver.**
169 Updated Mellanox mlx5 driver with new features and improvements, including:
171 * Added support for matching on IPv4 Time To Live and IPv6 Hop Limit.
172 * Added support for creating Relaxed Ordering Memory Regions.
173 * Added support for configuring Hairpin queue data buffer size.
174 * Added support for jumbo frame size (9K MTU) in Multi-Packet RQ mode.
175 * Removed flow rules caching for memory saving and compliance with ethdev API.
176 * Optimized the memory consumption of flows.
177 * Added support for flow aging based on hardware counters.
178 * Added support for flow patterns with wildcard VLAN items (without VID value).
179 * Updated support for matching on GTP headers, added match on GTP flags.
181 * **Added Chacha20-Poly1305 algorithm to Cryptodev API.**
183 Added support for Chacha20-Poly1305 AEAD algorithm in Cryptodev.
185 * **Updated the AESNI MB crypto PMD.**
187 * Added support for intel-ipsec-mb version 0.54.
188 * Updated the AESNI MB PMD with AES-256 DOCSIS algorithm.
189 * Added support for synchronous Crypto burst API.
191 * **Updated the AESNI GCM crypto PMD.**
193 Added support for intel-ipsec-mb version 0.54.
195 * **Updated the ZUC crypto PMD.**
197 * Added support for intel-ipsec-mb version 0.54.
198 * Updated the PMD to support Multi-buffer ZUC-EIA3,
199 improving performance significantly, when using
200 intel-ipsec-mb version 0.54
202 * **Updated the SNOW3G crypto PMD.**
204 Added support for intel-ipsec-mb version 0.54.
206 * **Updated the KASUMI crypto PMD.**
208 Added support for intel-ipsec-mb version 0.54.
210 * **Updated the QuickAssist Technology (QAT) Crypto PMD.**
212 * Added handling of mixed crypto algorithms in QAT PMD for GEN2.
214 Enabled handling of mixed algorithms in encrypted digest hash-cipher
215 (generation) and cipher-hash (verification) requests in QAT PMD when
216 running on GEN2 QAT hardware with particular firmware versions (GEN3
217 support was added in DPDK 20.02).
219 * Added plain SHA-1, 224, 256, 384, 512 support to QAT PMD.
221 Added support for plain SHA-1, SHA-224, SHA-256, SHA-384 and SHA-512
224 * Added AES-GCM/GMAC J0 support to QAT PMD.
226 Added support for AES-GCM/GMAC J0 to Intel QuickAssist Technology PMD. The
227 user can use this feature by passing a zero length IV in the appropriate
228 xform. For more information refer to the doxygen comments in
229 ``rte_crypto_sym.h`` for ``J0``.
231 * Updated the QAT PMD for AES-256 DOCSIS.
233 Added AES-256 DOCSIS algorithm support to the QAT PMD.
235 * **Updated the QuickAssist Technology (QAT) Compression PMD.**
237 Added special buffer handling when the internal QAT intermediate buffer is
238 too small for the Huffman dynamic compression operation. Instead of falling
239 back to fixed compression, the operation is now split into multiple smaller
240 dynamic compression requests (which are possible to execute on QAT) and
241 their results are then combined and copied into the output buffer. This is
242 not possible if any checksum calculation was requested - in such cases the
243 code falls back to fixed compression as before.
245 * **Updated the turbo_sw bbdev PMD.**
247 Added support for large size code blocks which do not fit in one mbuf
250 * **Added Intel FPGA_5GNR_FEC bbdev PMD.**
252 Added a new ``fpga_5gnr_fec`` bbdev driver for the Intel\ |reg| FPGA PAC
253 (Programmable Acceleration Card) N3000. See the
254 :doc:`../bbdevs/fpga_5gnr_fec` BBDEV guide for more details on this new driver.
256 * **Updated the DSW event device.**
258 Updated the DSW PMD with new features and improvements, including:
260 * Improved flow migration mechanism, allowing faster and more
261 accurate load balancing.
262 * Improved behavior on high-core count systems.
263 * Reduced latency in low-load situations.
264 * Extended DSW xstats with migration and load-related statistics.
266 * **Updated ipsec-secgw sample application.**
268 Updated the ``ipsec-secgw`` sample application with the following features:
270 * Updated the application to add event based packet processing. The worker
271 thread(s) would receive events and submit them back to the event device
272 after the processing. This way, multicore scaling and HW assisted
273 scheduling is achieved by making use of the event device capabilities. The
274 event mode currently only supports inline IPsec protocol offload.
276 * Updated the application to support key sizes for AES-192-CBC, AES-192-GCM,
277 AES-256-GCM algorithms.
279 * Added IPsec inbound load-distribution support for the application using
280 NIC load distribution feature (Flow Director).
282 * **Updated Telemetry Library.**
284 The updated Telemetry library has been significantly improved in relation to
285 the original version to make it more accessible and scalable:
287 * It now enables DPDK libraries and applications to provide their own
288 specific telemetry information, rather than being limited to what could be
289 reported through the metrics library.
291 * It is no longer dependent on the external Jansson library, which allows
292 Telemetry be enabled by default.
294 * The socket handling has been simplified making it easier for clients to
295 connect and retrieve information.
297 * **Added the rte_graph library.**
299 The Graph architecture abstracts the data processing functions as ``nodes``
300 and ``links`` them together to create a complex ``graph`` to enable
301 reusable/modular data processing functions. The graph library provides APIs
302 to enable graph framework operations such as create, lookup, dump and
303 destroy on graph and node operations such as clone, edge update, and edge
304 shrink, etc. The API also allows the creation of a stats cluster to monitor
305 per graph and per node statistics.
307 * **Added the rte_node library.**
309 Added the ``rte_node`` library that consists of nodes used by the
310 ``rte_graph`` library. Each node performs a specific packet processing
311 function based on the application configuration.
313 The following nodes are added:
315 * Null node: A skeleton node that defines the general structure of a node.
316 * Ethernet device node: Consists of Ethernet Rx/Tx nodes as well as Ethernet
318 * IPv4 lookup node: Consists of IPv4 extract and LPM lookup node. Routes can
319 be configured by the application through the ``rte_node_ip4_route_add``
321 * IPv4 rewrite node: Consists of IPv4 and Ethernet header rewrite
322 functionality that can be configured through the
323 ``rte_node_ip4_rewrite_add`` function.
324 * Packet drop node: Frees the packets received to their respective mempool.
326 * **Added new l3fwd-graph sample application.**
328 Added an example application ``l3fwd-graph``. This demonstrates the usage of
329 the graph library and node library for packet processing. In addition to the
330 library usage demonstration, this application can be used for performance
331 comparison of the existing ``l3fwd`` (static code without any nodes) with
332 the modular ``l3fwd-graph`` approach.
334 * **Updated the testpmd application.**
336 Added a new cmdline option ``--rx-mq-mode`` which can be used to test PMD's
337 behaviour on handling Rx mq mode.
339 * **Added support for GCC 10.**
341 Added support for building with GCC 10.1.
347 .. This section should contain API changes. Sample format:
349 * sample: Add a short 1-2 sentence description of the API change
350 which was announced in the previous releases and made in this release.
351 Start with a scope label like "ethdev:".
352 Use fixed width quotes for ``function_names`` or ``struct_names``.
355 This section is a comment. Do not overwrite or remove it.
356 Also, make sure to start the actual text at the margin.
357 =========================================================
359 * mempool: The API of ``rte_mempool_populate_iova()`` and
360 ``rte_mempool_populate_virt()`` changed to return 0 instead of ``-EINVAL``
361 when there is not enough room to store one object.
367 .. This section should contain ABI changes. Sample format:
369 * sample: Add a short 1-2 sentence description of the ABI change
370 which was announced in the previous releases and made in this release.
371 Start with a scope label like "ethdev:".
372 Use fixed width quotes for ``function_names`` or ``struct_names``.
375 This section is a comment. Do not overwrite or remove it.
376 Also, make sure to start the actual text at the margin.
377 =========================================================
379 * No ABI change that would break compatibility with DPDK 20.02 and 19.11.
385 .. This section should contain a list of platforms that were tested
390 * <vendor> platform with <vendor> <type of devices> combinations
395 * Other relevant details...
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 =========================================================
401 * Intel\ |reg| platforms with Broadcom\ |reg| NICs combinations
405 * Intel\ |reg| Xeon\ |reg| Gold 6154 CPU @ 3.00GHz
406 * Intel\ |reg| Xeon\ |reg| CPU E5-2650 v2 @ 2.60GHz
407 * Intel\ |reg| Xeon\ |reg| CPU E5-2667 v3 @ 3.20GHz
408 * Intel\ |reg| Xeon\ |reg| Gold 6142 CPU @ 2.60GHz
409 * Intel\ |reg| Xeon\ |reg| Silver 4110 CPU @ 2.10GHz
413 * Red Hat Enterprise Linux Server release 8.1
414 * Red Hat Enterprise Linux Server release 7.6
415 * Red Hat Enterprise Linux Server release 7.5
426 * Broadcom\ |reg| NetXtreme-E\ |reg| Series P225p (2x25G)
428 * Host interface: PCI Express 3.0 x8
429 * Firmware version: 214.4.81.0 and above
431 * Broadcom\ |reg| NetXtreme-E\ |reg| Series P425p (4x25G)
433 * Host interface: PCI Express 3.0 x16
434 * Firmware version: 216.4.259.0 and above
436 * Broadcom\ |reg| NetXtreme-E\ |reg| Series P2100G (2x100G)
438 * Host interface: PCI Express 3.0 x16
439 * Firmware version: 216.1.259.0 and above
441 * Broadcom\ |reg| NetXtreme-E\ |reg| Series P425p (4x25G)
443 * Host interface: PCI Express 4.0 x16
444 * Firmware version: 216.1.259.0 and above
446 * Broadcom\ |reg| NetXtreme-E\ |reg| Series P2100G (2x100G)
448 * Host interface: PCI Express 4.0 x16
449 * Firmware version: 216.1.259.0 and above
451 * Intel\ |reg| platforms with Intel\ |reg| NICs combinations
455 * Intel\ |reg| Atom\ |trade| CPU C3758 @ 2.20GHz
456 * Intel\ |reg| Atom\ |trade| CPU C3858 @ 2.00GHz
457 * Intel\ |reg| Atom\ |trade| CPU C3958 @ 2.00GHz
458 * Intel\ |reg| Xeon\ |reg| CPU D-1541 @ 2.10GHz
459 * Intel\ |reg| Xeon\ |reg| CPU D-1553N @ 2.30GHz
460 * Intel\ |reg| Xeon\ |reg| CPU E5-2680 0 @ 2.70GHz
461 * Intel\ |reg| Xeon\ |reg| CPU E5-2680 v2 @ 2.80GHz
462 * Intel\ |reg| Xeon\ |reg| CPU E5-2699 v3 @ 2.30GHz
463 * Intel\ |reg| Xeon\ |reg| CPU E5-2699 v4 @ 2.20GHz
464 * Intel\ |reg| Xeon\ |reg| Gold 5218N CPU @ 2.30GHz
465 * Intel\ |reg| Xeon\ |reg| Gold 6139 CPU @ 2.30GHz
466 * Intel\ |reg| Xeon\ |reg| Gold 6252N CPU @ 2.30GHz
467 * Intel\ |reg| Xeon\ |reg| Platinum 8180 CPU @ 2.50GHz
468 * Intel\ |reg| Xeon\ |reg| Platinum 8280M CPU @ 2.70GHz
477 * Red Hat Enterprise Linux Server release 8.0
478 * Red Hat Enterprise Linux Server release 7.7
486 * Intel\ |reg| 82599ES 10 Gigabit Ethernet Controller
488 * Firmware version: 0x61bf0001
489 * Device id (pf/vf): 8086:10fb / 8086:10ed
490 * Driver version: 5.6.5 (ixgbe)
492 * Intel\ |reg| Corporation Ethernet Connection X552/X557-AT 10GBASE-T
494 * Firmware version: 0x800003e7
495 * Device id (pf/vf): 8086:15ad / 8086:15a8
496 * Driver version: 5.1.0-k (ixgbe)
498 * Intel\ |reg| Corporation Ethernet Controller 10G X550T
500 * Firmware version: 0x80000482
501 * Device id (pf): 8086:1563
502 * Driver version: 5.6.5 (ixgbe)
504 * Intel\ |reg| Ethernet Converged Network Adapter X710-DA4 (4x10G)
506 * Firmware version: 7.20 0x800079e8 1.2585.0
507 * Device id (pf/vf): 8086:1572 / 8086:154c
508 * Driver version: 2.11.29 (i40e)
510 * Intel\ |reg| Corporation Ethernet Connection X722 for 10GbE SFP+ (4x10G)
512 * Firmware version: 4.11 0x80001def 1.1999.0
513 * Device id (pf/vf): 8086:37d0 / 8086:37cd
514 * Driver version: 2.11.29 (i40e)
516 * Intel\ |reg| Corporation Ethernet Connection X722 for 10GBASE-T (2x10G)
518 * Firmware version: 4.10 0x80001a7a
519 * Device id (pf/vf): 8086:37d2 / 8086:37cd
520 * Driver version: 2.11.29 (i40e)
522 * Intel\ |reg| Ethernet Converged Network Adapter XXV710-DA2 (2x25G)
524 * Firmware version: 7.30 0x800080a2 1.2658.0
525 * Device id (pf/vf): 8086:158b / 8086:154c
526 * Driver version: 2.11.27_rc13 (i40e)
528 * Intel\ |reg| Ethernet Converged Network Adapter XL710-QDA2 (2X40G)
530 * Firmware version: 7.30 0x800080ab 1.2658.0
531 * Device id (pf/vf): 8086:1583 / 8086:154c
532 * Driver version: 2.11.27_rc13 (i40e)
534 * Intel\ |reg| Corporation I350 Gigabit Network Connection
536 * Firmware version: 1.63, 0x80000cbc
537 * Device id (pf/vf): 8086:1521 / 8086:1520
538 * Driver version: 5.4.0-k (igb)
540 * Intel\ |reg| Corporation I210 Gigabit Network Connection
542 * Firmware version: 3.25, 0x800006eb
543 * Device id (pf): 8086:1533
544 * Driver version: 5.6.5(igb)
546 * Intel\ |reg| Ethernet Controller 10-Gigabit X540-AT2
548 * Firmware version: 0x800005f9
549 * Device id (pf): 8086:1528
550 * Driver version: 5.1.0-k(ixgbe)
552 * Intel\ |reg| Ethernet Converged Network Adapter X710-T2L
554 * Firmware version: 7.30 0x80008061 1.2585.0
555 * Device id (pf): 8086:15ff
556 * Driver version: 2.11.27_rc13(i40e)
558 * Intel\ |reg| platforms with Mellanox\ |reg| NICs combinations
562 * Intel\ |reg| Xeon\ |reg| Gold 6154 CPU @ 3.00GHz
563 * Intel\ |reg| Xeon\ |reg| CPU E5-2697A v4 @ 2.60GHz
564 * Intel\ |reg| Xeon\ |reg| CPU E5-2697 v3 @ 2.60GHz
565 * Intel\ |reg| Xeon\ |reg| CPU E5-2680 v2 @ 2.80GHz
566 * Intel\ |reg| Xeon\ |reg| CPU E5-2650 v4 @ 2.20GHz
567 * Intel\ |reg| Xeon\ |reg| CPU E5-2640 @ 2.50GHz
568 * Intel\ |reg| Xeon\ |reg| CPU E5-2620 v4 @ 2.10GHz
572 * Red Hat Enterprise Linux Server release 7.5 (Maipo)
573 * Red Hat Enterprise Linux Server release 7.4 (Maipo)
574 * Red Hat Enterprise Linux Server release 7.3 (Maipo)
575 * Red Hat Enterprise Linux Server release 7.2 (Maipo)
581 * MLNX_OFED 4.7-3.2.9.0
582 * MLNX_OFED 5.0-2.1.8.0 and above
586 * Linux 5.7.0-rc5 and above
590 * rdma-core-29.0-1 and above
594 * Mellanox\ |reg| ConnectX\ |reg|-3 Pro 40G MCX354A-FCC_Ax (2x40G)
596 * Host interface: PCI Express 3.0 x8
597 * Device ID: 15b3:1007
598 * Firmware version: 2.42.5000
600 * Mellanox\ |reg| ConnectX\ |reg|-3 Pro 40G MCX354A-FCCT (2x40G)
602 * Host interface: PCI Express 3.0 x8
603 * Device ID: 15b3:1007
604 * Firmware version: 2.42.5000
606 * Mellanox\ |reg| ConnectX\ |reg|-4 Lx 25G MCX4121A-ACAT (2x25G)
608 * Host interface: PCI Express 3.0 x8
609 * Device ID: 15b3:1015
610 * Firmware version: 14.27.2008 and above
612 * Mellanox\ |reg| ConnectX\ |reg|-4 Lx 50G MCX4131A-GCAT (1x50G)
614 * Host interface: PCI Express 3.0 x8
615 * Device ID: 15b3:1015
616 * Firmware version: 14.27.2008 and above
618 * Mellanox\ |reg| ConnectX\ |reg|-5 100G MCX516A-CCAT (2x100G)
620 * Host interface: PCI Express 3.0 x16
621 * Device ID: 15b3:1017
622 * Firmware version: 16.27.2008 and above
624 * Mellanox\ |reg| ConnectX\ |reg|-5 100G MCX556A-ECAT (2x100G)
626 * Host interface: PCI Express 3.0 x16
627 * Device ID: 15b3:1017
628 * Firmware version: 16.27.2008 and above
630 * Mellanox\ |reg| ConnectX\ |reg|-5 100G MCX556A-EDAT (2x100G)
632 * Host interface: PCI Express 3.0 x16
633 * Device ID: 15b3:1017
634 * Firmware version: 16.27.2008 and above
636 * Mellanox\ |reg| ConnectX\ |reg|-5 Ex EN 100G MCX516A-CDAT (2x100G)
638 * Host interface: PCI Express 4.0 x16
639 * Device ID: 15b3:1019
640 * Firmware version: 16.27.2008 and above
642 * Mellanox\ |reg| ConnectX\ |reg|-6 Dx EN 100G MCX623106AN-CDAT (2x100G)
644 * Host interface: PCI Express 4.0 x16
645 * Device ID: 15b3:101d
646 * Firmware version: 22.27.2008 and above
648 * IBM Power 9 platforms with Mellanox\ |reg| NICs combinations
652 * POWER9 2.2 (pvr 004e 1202) 2300MHz
656 * Red Hat Enterprise Linux Server release 7.6
660 * Mellanox\ |reg| ConnectX\ |reg|-5 100G MCX556A-ECAT (2x100G)
662 * Host interface: PCI Express 4.0 x16
663 * Device ID: 15b3:1017
664 * Firmware version: 16.27.2008
666 * Mellanox\ |reg| ConnectX\ |reg|-6 Dx 100G MCX623106AN-CDAT (2x100G)
668 * Host interface: PCI Express 4.0 x16
669 * Device ID: 15b3:101d
670 * Firmware version: 22.27.2008
674 * MLNX_OFED 5.0-2.1.8.0
676 * ARMv8 SoC combinations from Marvell (with integrated NICs)
680 * CN83xx, CN96xx, CN93xx
682 * OS (Based on Marvell OCTEON TX SDK-10.3.2.0-PR12):