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 support for SW-assisted VDPA live migration.**
85 This SW-assisted VDPA live migration facility helps VDPA devices without
86 logging capability to perform live migration, a mediated SW relay can help
87 devices to track dirty pages caused by DMA. IFC driver has enabled this
88 SW-assisted live migration mode.
90 * **Added a compression performance test tool.**
92 Added a new performance test tool to test the compressdev PMD. The tool tests
93 compression ratio and compression throughput.
99 .. This section should contain removed items in this release. Sample format:
101 * Add a short 1-2 sentence description of the removed item
104 This section is a comment. Do not overwrite or remove it.
105 Also, make sure to start the actual text at the margin.
106 =========================================================
112 .. This section should contain API changes. Sample format:
114 * sample: Add a short 1-2 sentence description of the API change
115 which was announced in the previous releases and made in this release.
116 Start with a scope label like "ethdev:".
117 Use fixed width quotes for ``function_names`` or ``struct_names``.
120 This section is a comment. Do not overwrite or remove it.
121 Also, make sure to start the actual text at the margin.
122 =========================================================
124 * eal: Function ``rte_bsf64`` in ``rte_bitmap.h`` has been renamed to
125 ``rte_bsf64_safe`` and moved to ``rte_common.h``. A new ``rte_bsf64`` function
126 has been added in ``rte_common.h`` that follows convention set by existing
127 ``rte_bsf32`` function.
129 * eal: Segment fd API on Linux now sets error code to ``ENOTSUP`` in more cases
130 where segment fd API is not expected to be supported:
132 - On attempt to get segment fd for an externally allocated memory segment
133 - In cases where memfd support would have been required to provide segment
134 fd's (such as in-memory or no-huge mode)
136 * eal: Functions ``rte_malloc_dump_stats()``, ``rte_malloc_dump_heaps()`` and
137 ``rte_malloc_get_socket_stats()`` are no longer safe to call concurrently with
138 ``rte_malloc_heap_create()`` or ``rte_malloc_heap_destroy()`` function calls.
140 * pdump: The ``rte_pdump_set_socket_dir()``, the parameter ``path`` of
141 ``rte_pdump_init()`` and enum ``rte_pdump_socktype`` were deprecated
142 since 18.05 and are removed in this release.
148 .. This section should contain ABI changes. Sample format:
150 * sample: Add a short 1-2 sentence description of the ABI change
151 which was announced in the previous releases and made in this release.
152 Start with a scope label like "ethdev:".
153 Use fixed width quotes for ``function_names`` or ``struct_names``.
156 This section is a comment. Do not overwrite or remove it.
157 Also, make sure to start the actual text at the margin.
158 =========================================================
161 Shared Library Versions
162 -----------------------
164 .. Update any library version updated in this release
165 and prepend with a ``+`` sign, like this:
171 This section is a comment. Do not overwrite or remove it.
172 =========================================================
174 The libraries prepended with a plus sign were incremented in this version.
180 librte_bitratestats.so.2
183 librte_bus_fslmc.so.2
184 librte_bus_ifpga.so.2
187 librte_bus_vmbus.so.2
190 librte_compressdev.so.1
191 librte_cryptodev.so.5
192 librte_distributor.so.1
197 librte_flow_classify.so.1
205 librte_latencystats.so.1
219 librte_pmd_ixgbe.so.2
220 librte_pmd_dpaa2_qdma.so.1
222 librte_pmd_softnic.so.1
223 librte_pmd_vhost.so.2
239 .. This section should contain new known issues in this release. Sample format:
241 * **Add title in present tense with full stop.**
243 Add a short 1-2 sentence description of the known issue
244 in the present tense. Add information on any known workarounds.
246 This section is a comment. Do not overwrite or remove it.
247 Also, make sure to start the actual text at the margin.
248 =========================================================
254 .. This section should contain a list of platforms that were tested
259 * <vendor> platform with <vendor> <type of devices> combinations
264 * Other relevant details...
266 This section is a comment. Do not overwrite or remove it.
267 Also, make sure to start the actual text at the margin.
268 =========================================================