1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright 2019 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_19_11.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 * **FreeBSD now supports `--base-virtaddr` EAL option.**
61 FreeBSD version now also supports setting base virtual address for mapping
62 pages and resources into its address space.
64 * **Added Lock-free Stack for aarch64.**
66 The lock-free stack implementation is enabled for aarch64 platforms.
68 * **Changed mempool allocation behaviour.**
70 Objects are no longer across pages by default.
71 It may consume more memory when using small memory pages.
73 * **Added support of dynamic fields and flags in mbuf.**
75 This new feature adds the ability to dynamically register some room
76 for a field or a flag in the mbuf structure. This is typically used
77 for specific offload features, where adding a static field or flag
78 in the mbuf is not justified.
80 * **Updated the enic driver.**
82 * Added support for Geneve with options offload.
83 * Added flow API implementation based on VIC Flow Manager API.
85 * **Added Hisilicon hns3 PMD.**
87 Added the new ``hns3`` net driver for the inbuilt Hisilicon Network
88 Subsystem 3(HNS3) network engine found in the Hisilicon Kunpeng 920 SoC.
89 See the :doc:`../nics/hns3` guide for more details on this new driver.
91 * **Added NXP PFE PMD.**
93 Added the new PFE driver for the NXP LS1012A platform. See the
94 :doc:`../nics/pfe` NIC driver guide for more details on this new driver.
96 * **Updated iavf PMD.**
98 Enable AVX2 data path for iavf PMD.
100 * **Updated the Intel e1000 driver.**
102 Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
104 * **Updated the Intel ixgbe driver.**
106 Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
108 * **Updated the Intel i40e driver.**
110 Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
112 * **Updated the Intel fm10k driver.**
114 Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
116 * **Added RX/TX packet burst mode get API.**
118 Added two new functions ``rte_eth_rx_burst_mode_get`` and
119 ``rte_eth_tx_burst_mode_get`` that allow an application
120 to retrieve the mode information about RX/TX packet burst
121 such as Scalar or Vector, and Vector technology like AVX2.
122 Another new function ``rte_eth_burst_mode_option_name`` is
123 provided for burst mode options stringification.
125 * **Updated the Intel ice driver.**
127 Updated the Intel ice driver with new features and improvements, including:
129 * Added support for device-specific DDP package loading.
130 * Added support for handling Receive Flex Descriptor.
131 * Added support for protocol extraction on per Rx queue.
132 * Added support for Flow Director filter based on generic filter framework.
133 * Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
134 * Generic filter enhancement
135 - Supported pipeline mode.
136 - Supported new packet type like PPPoE for switch filter.
137 * Supported input set change and symmetric hash by rte_flow RSS action.
138 * Added support for GTP Tx checksum offload.
140 * **Added cryptodev asymmetric session-less operation.**
142 Added session-less option to cryptodev asymmetric structure. It works the same
143 way as symmetric crypto, corresponding xform is used directly by the crypto op.
145 * **Updated the Huawei hinic driver.**
147 Updated the Huawei hinic driver with new features and improvements, including:
149 * Enabled SR-IOV - Partially supported at this point, VFIO only.
150 * Supported VLAN filter and VLAN offload.
151 * Supported Unicast MAC filter and Multicast MAC filter.
152 * Supported Flow director for LACP, VRRP, BGP and so on.
153 * Supported FW version get.
155 * **Updated Mellanox mlx5 driver.**
157 Updated Mellanox mlx5 driver with new features and improvements, including:
159 * Added support for VLAN pop flow offload command.
160 * Added support for VLAN push flow offload command.
161 * Added support for VLAN set PCP offload command.
162 * Added support for VLAN set VID offload command.
163 * Added support for matching on packets withe Geneve tunnel header.
165 * **Updated the AF_XDP PMD.**
167 Updated the AF_XDP PMD. The new features include:
169 * Enabled zero copy between application mempools and UMEM by enabling the
170 XDP_UMEM_UNALIGNED_CHUNKS UMEM flag.
172 * **Added Marvell NITROX symmetric crypto PMD.**
174 Added a symmetric crypto PMD for Marvell NITROX V security processor.
175 See the :doc:`../cryptodevs/nitrox` guide for more details on this new
177 * **Added asymmetric support to Marvell OCTEON TX crypto PMD.**
179 Added support for asymmetric operations in Marvell OCTEON TX cypto PMD.
180 Supports RSA and modexp operations.
182 * **Added Marvell OCTEON TX2 crypto PMD**
184 Added a new PMD driver for h/w crypto offload block on ``OCTEON TX2`` SoC.
186 See :doc:`../cryptodevs/octeontx2` for more details
188 * **Updated NXP crypto PMDs for PDCP support.**
190 PDCP support is added to DPAA_SEC and DPAA2_SEC PMDs using rte_security APIs.
191 Support is added for all sequence number sizes for control and user plane.
192 Test application is updated for unit testing.
194 * **Enabled Single Pass GCM acceleration on QAT GEN3.**
196 Added support for Single Pass GCM, available on QAT GEN3 only (Intel
197 QuickAssist Technology C4xxx). It is automatically chosen instead of the
198 classic 2-pass mode when running on QAT GEN3, significantly improving
199 the performance of AES GCM operations.
201 * **Updated the Intel QuickAssist Technology (QAT) asymmetric crypto PMD.**
203 * Added support for asymmetric session-less operations.
204 * Added support for RSA algorithm with pair (n, d) private key representation.
205 * Added support for RSA algorithm with quintuple private key representation.
207 * **Updated the Intel QuickAssist Technology (QAT) compression PMD.**
209 Added stateful decompression support in the Intel QuickAssist Technology PMD.
210 Please note that stateful compression is not supported.
212 * **Added external buffers support for dpdk-test-compress-perf tool.**
214 Added a command line option to dpdk-test-compress-perf tool to allocate
215 and use memory zones as external buffers instead of keeping the data directly
218 * **Updated the IPSec library.**
220 Added SA Database API to ``librte_ipsec``. A new test-sad application is also
221 introduced to evaluate and perform custom functional and performance tests
222 for IPsec SAD implementation.
224 * **Introduced FIFO for NTB PMD.**
226 Introduced FIFO for NTB (Non-transparent Bridge) PMD to support
227 packet based processing.
229 * **Added eBPF JIT support for arm64.**
231 Added eBPF JIT support for arm64 architecture to improve the eBPF program
234 * **Added RIB and FIB (Routing/Forwarding Information Base) libraries.**
236 RIB and FIB can replace the LPM (Longest Prefix Match) library
237 with better control plane (RIB) performance.
238 The data plane (FIB) can be extended with new algorithms.
240 * **Updated testpmd.**
242 * Added a console command to testpmd app, ``show port (port_id) ptypes`` which
243 gives ability to print port supported ptypes in different protocol layers.
245 * **Added new example l2fwd-event application.**
247 Added an example application `l2fwd-event` that adds event device support to
248 traditional l2fwd example. It demonstrates usage of poll and event mode IO
249 mechanism under a single application.
251 * **Added build support for Link Time Optimization.**
253 LTO is an optimization technique used by the compiler to perform whole
254 program analysis and optimization at link time. In order to do that
255 compilers store their internal representation of the source code that
256 the linker uses at the final stage of compilation process.
258 See :doc:`../prog_guide/lto` for more information:
264 .. This section should contain removed items in this release. Sample format:
266 * Add a short 1-2 sentence description of the removed item
269 This section is a comment. Do not overwrite or remove it.
270 Also, make sure to start the actual text at the margin.
271 =========================================================
273 * Removed duplicated set of commands for Rx offload configuration from testpmd::
275 port config all crc-strip|scatter|rx-cksum|rx-timestamp|
276 hw-vlan|hw-vlan-filter|hw-vlan-strip|hw-vlan-extend on|off
278 The testpmd commands set that can be used instead
279 in order to enable or disable Rx offloading on all Rx queues of a port is::
281 port config <port_id> rx_offload crc_strip|scatter|
282 ipv4_cksum|udp_cksum|tcp_cksum|timestamp|
283 vlan_strip|vlan_filter|vlan_extend on|off
285 * Removed AF_XDP pmd_zero copy vdev argument. Support is now auto-detected.
287 * The following sample applications have been removed in this release:
290 * L3 Forwarding in a Virtualization Environment
292 * Netmap Compatibility
293 * Quota and Watermark
296 * Removed arm64-dpaa2-* build config. arm64-dpaa-* can now build for both
297 dpaa and dpaa2 platforms.
303 .. This section should contain API changes. Sample format:
305 * sample: Add a short 1-2 sentence description of the API change
306 which was announced in the previous releases and made in this release.
307 Start with a scope label like "ethdev:".
308 Use fixed width quotes for ``function_names`` or ``struct_names``.
311 This section is a comment. Do not overwrite or remove it.
312 Also, make sure to start the actual text at the margin.
313 =========================================================
315 * eal: made the ``lcore_config`` struct and global symbol private.
317 * eal: removed the ``rte_cpu_check_supported`` function, replaced by
318 ``rte_cpu_is_supported`` since dpdk v17.08.
320 * eal: removed the ``rte_malloc_virt2phy`` function, replaced by
321 ``rte_malloc_virt2iova`` since v17.11.
323 * eal: made the ``rte_config`` struct and ``rte_eal_get_configuration``
326 * mem: hid the internal ``malloc_heap`` structure and the
327 ``rte_malloc_heap.h`` header.
329 * vfio: removed ``rte_vfio_dma_map`` and ``rte_vfio_dma_unmap`` that have
330 been marked as deprecated in release 19.05.
331 ``rte_vfio_container_dma_map`` and ``rte_vfio_container_dma_unmap`` can
332 be used as substitutes.
334 * pci: removed the following functions deprecated since dpdk v17.11:
336 - ``eal_parse_pci_BDF`` replaced by ``rte_pci_addr_parse``
337 - ``eal_parse_pci_DomBDF`` replaced by ``rte_pci_addr_parse``
338 - ``rte_eal_compare_pci_addr`` replaced by ``rte_pci_addr_cmp``
340 * The network structure ``esp_tail`` has been prefixed by ``rte_``.
342 * The network definitions of PPPoE ethertypes have been prefixed by ``RTE_``.
344 * The network structure for MPLS has been prefixed by ``rte_``.
346 * ethdev: changed ``rte_eth_dev_infos_get`` return value from ``void`` to
347 ``int`` to provide a way to report various error conditions.
349 * ethdev: changed ``rte_eth_promiscuous_enable`` and
350 ``rte_eth_promiscuous_disable`` return value from ``void`` to ``int`` to
351 provide a way to report various error conditions.
353 * ethdev: changed ``rte_eth_allmulticast_enable`` and
354 ``rte_eth_allmulticast_disable`` return value from ``void`` to ``int`` to
355 provide a way to report various error conditions.
357 * ethdev: changed ``rte_eth_dev_xstats_reset`` return value from ``void`` to
358 ``int`` to provide a way to report various error conditions.
360 * ethdev: changed ``rte_eth_link_get`` and ``rte_eth_link_get_nowait``
361 return value from ``void`` to ``int`` to provide a way to report various
364 * ethdev: changed ``rte_eth_macaddr_get`` return value from ``void`` to
365 ``int`` to provide a way to report various error conditions.
367 * ethdev: changed ``rte_eth_dev_owner_delete`` return value from ``void`` to
368 ``int`` to provide a way to report various error conditions.
370 * event: The function ``rte_event_eth_tx_adapter_enqueue`` takes an additional
371 input as ``flags``. Flag ``RTE_EVENT_ETH_TX_ADAPTER_ENQUEUE_SAME_DEST`` which
372 has been introduced in this release is used when used when all the packets
373 enqueued in the tx adapter are destined for the same Ethernet port & Tx queue.
375 * sched: The pipe nodes configuration parameters such as number of pipes,
376 pipe queue sizes, pipe profiles, etc., are moved from port level structure
377 to subport level. This allows different subports of the same port to
378 have different configuration for the pipe nodes.
384 .. This section should contain ABI changes. Sample format:
386 * sample: Add a short 1-2 sentence description of the ABI change
387 which was announced in the previous releases and made in this release.
388 Start with a scope label like "ethdev:".
389 Use fixed width quotes for ``function_names`` or ``struct_names``.
392 This section is a comment. Do not overwrite or remove it.
393 Also, make sure to start the actual text at the margin.
394 =========================================================
396 * net: The Ethernet address and other header definitions have changed
397 attributes. They have been modified to be aligned on 2-byte boundaries.
398 These changes should not impact normal usage because drivers naturally
399 align the Ethernet header on receive and all known encapsulations
400 preserve the alignment of the header.
403 Shared Library Versions
404 -----------------------
406 .. Update any library version updated in this release
407 and prepend with a ``+`` sign, like this:
413 This section is a comment. Do not overwrite or remove it.
414 =========================================================
416 The libraries prepended with a plus sign were incremented in this version.
422 librte_bitratestats.so.2
425 librte_bus_fslmc.so.2
426 librte_bus_ifpga.so.2
429 librte_bus_vmbus.so.2
432 librte_compressdev.so.1
433 librte_cryptodev.so.8
434 librte_distributor.so.1
437 + librte_ethdev.so.13
438 + librte_eventdev.so.8
440 librte_flow_classify.so.1
449 librte_latencystats.so.1
463 librte_pmd_ixgbe.so.2
464 librte_pmd_dpaa2_qdma.so.1
466 librte_pmd_softnic.so.1
467 librte_pmd_vhost.so.2
486 .. This section should contain new known issues in this release. Sample format:
488 * **Add title in present tense with full stop.**
490 Add a short 1-2 sentence description of the known issue
491 in the present tense. Add information on any known workarounds.
493 This section is a comment. Do not overwrite or remove it.
494 Also, make sure to start the actual text at the margin.
495 =========================================================
501 .. This section should contain a list of platforms that were tested
506 * <vendor> platform with <vendor> <type of devices> combinations
511 * Other relevant details...
513 This section is a comment. Do not overwrite or remove it.
514 Also, make sure to start the actual text at the margin.
515 =========================================================