1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright 2018 The DPDK contributors
7 .. **Read this first.**
9 The text in the sections below explains how to update the release notes.
11 Use proper spelling, capitalization and punctuation in all sections.
13 Variable and config names should be quoted as fixed width text:
16 Build the docs and view the output file to ensure the changes are correct::
20 xdg-open build/doc/html/guides/rel_notes/release_19_02.html
26 .. This section should contain new features added in this release.
29 * **Add a title in the past tense with a full stop.**
31 Add a short 1-2 sentence description in the past tense.
32 The description should be enough to allow someone scanning
33 the release notes to understand the new feature.
35 If the feature adds a lot of sub-features you can use a bullet list
38 * Added feature foo to do something.
39 * Enhanced feature bar to do something else.
41 Refer to the previous release notes for examples.
43 Suggested order in release notes items:
44 * Core libs (EAL, mempool, ring, mbuf, buses)
45 * Device abstraction libs and PMDs
47 - cryptodev (lib, PMDs)
48 - eventdev (lib, PMDs)
51 * Apps, Examples, Tools (if significant)
53 This section is a comment. Do not overwrite or remove it.
54 Also, make sure to start the actual text at the margin.
55 =========================================================
57 * **Added support to free hugepages exactly as originally allocated.**
59 Some applications using memory event callbacks (especially for managing
60 RDMA memory regions) require that memory be freed back to the system
61 exactly as it was originally allocated. These applications typically
62 also require that a malloc allocation not span across two separate
63 hugepage allocations. A new ``--match-allocations`` EAL init flag has
64 been added to fulfill both of these requirements.
66 * **Added API to register external memory in DPDK.**
68 A new ``rte_extmem_register``/``rte_extmem_unregister`` API was added to allow
69 chunks of external memory to be registered with DPDK without adding them to
72 * **Support for using virtio-user without hugepages**
74 The --no-huge mode was augmented to use memfd-backed memory (on systems that
75 support memfd), to allow using virtio-user-based NICs without hugepages.
77 * **Updated the enic driver.**
79 * Added support for ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
80 * Added the handler to get firmware version string.
81 * Added support for multicast filtering.
83 * **Added dynamic queues allocation support for i40e VF.**
85 Previously, available queues of VF is reserved by PF at initialize stage.
86 Now both DPDK PF and Kernel PF (>=2.1.14) will support dynamic queue
87 allocation. At runtime, when VF request more queue number exceed the initial
88 reserved amount, PF can allocate up to 16 queues as the request after a VF
91 * **Added ICE net PMD**
93 Added the new ``ice`` net driver for IntelĀ® Ethernet Network Adapters E810.
94 See the :doc:`../nics/ice` NIC guide for more details on this new driver.
96 * **Added support for SW-assisted VDPA live migration.**
98 This SW-assisted VDPA live migration facility helps VDPA devices without
99 logging capability to perform live migration, a mediated SW relay can help
100 devices to track dirty pages caused by DMA. IFC driver has enabled this
101 SW-assisted live migration mode.
103 * **Added a compression performance test tool.**
105 Added a new performance test tool to test the compressdev PMD. The tool tests
106 compression ratio and compression throughput.
112 .. This section should contain removed items in this release. Sample format:
114 * Add a short 1-2 sentence description of the removed item
117 This section is a comment. Do not overwrite or remove it.
118 Also, make sure to start the actual text at the margin.
119 =========================================================
125 .. This section should contain API changes. Sample format:
127 * sample: Add a short 1-2 sentence description of the API change
128 which was announced in the previous releases and made in this release.
129 Start with a scope label like "ethdev:".
130 Use fixed width quotes for ``function_names`` or ``struct_names``.
133 This section is a comment. Do not overwrite or remove it.
134 Also, make sure to start the actual text at the margin.
135 =========================================================
137 * eal: Function ``rte_bsf64`` in ``rte_bitmap.h`` has been renamed to
138 ``rte_bsf64_safe`` and moved to ``rte_common.h``. A new ``rte_bsf64`` function
139 has been added in ``rte_common.h`` that follows convention set by existing
140 ``rte_bsf32`` function.
142 * eal: Segment fd API on Linux now sets error code to ``ENOTSUP`` in more cases
143 where segment fd API is not expected to be supported:
145 - On attempt to get segment fd for an externally allocated memory segment
146 - In cases where memfd support would have been required to provide segment
147 fd's (such as in-memory or no-huge mode)
149 * eal: Functions ``rte_malloc_dump_stats()``, ``rte_malloc_dump_heaps()`` and
150 ``rte_malloc_get_socket_stats()`` are no longer safe to call concurrently with
151 ``rte_malloc_heap_create()`` or ``rte_malloc_heap_destroy()`` function calls.
153 * sched: As result of the new format of the mbuf sched field, the
154 functions ``rte_sched_port_pkt_write()`` and
155 ``rte_sched_port_pkt_read_tree_path()`` got an additional parameter of
156 type ``struct rte_sched_port``.
158 * pdump: The ``rte_pdump_set_socket_dir()``, the parameter ``path`` of
159 ``rte_pdump_init()`` and enum ``rte_pdump_socktype`` were deprecated
160 since 18.05 and are removed in this release.
166 .. This section should contain ABI changes. Sample format:
168 * sample: Add a short 1-2 sentence description of the ABI change
169 which was announced in the previous releases and made in this release.
170 Start with a scope label like "ethdev:".
171 Use fixed width quotes for ``function_names`` or ``struct_names``.
174 This section is a comment. Do not overwrite or remove it.
175 Also, make sure to start the actual text at the margin.
176 =========================================================
178 * mbuf: The format of the sched field of ``rte_mbuf`` has been changed
179 to include the following fields: ``queue ID``, ``traffic class``, ``color``.
182 Shared Library Versions
183 -----------------------
185 .. Update any library version updated in this release
186 and prepend with a ``+`` sign, like this:
192 This section is a comment. Do not overwrite or remove it.
193 =========================================================
195 The libraries prepended with a plus sign were incremented in this version.
201 librte_bitratestats.so.2
204 librte_bus_fslmc.so.2
205 librte_bus_ifpga.so.2
208 librte_bus_vmbus.so.2
211 librte_compressdev.so.1
212 librte_cryptodev.so.5
213 librte_distributor.so.1
218 librte_flow_classify.so.1
226 librte_latencystats.so.1
240 librte_pmd_ixgbe.so.2
241 librte_pmd_dpaa2_qdma.so.1
243 librte_pmd_softnic.so.1
244 librte_pmd_vhost.so.2
260 .. This section should contain new known issues in this release. Sample format:
262 * **Add title in present tense with full stop.**
264 Add a short 1-2 sentence description of the known issue
265 in the present tense. Add information on any known workarounds.
267 This section is a comment. Do not overwrite or remove it.
268 Also, make sure to start the actual text at the margin.
269 =========================================================
275 .. This section should contain a list of platforms that were tested
280 * <vendor> platform with <vendor> <type of devices> combinations
285 * Other relevant details...
287 This section is a comment. Do not overwrite or remove it.
288 Also, make sure to start the actual text at the margin.
289 =========================================================