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_18_11.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 significative)
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 for using externally allocated memory in DPDK.**
59 DPDK has gained support for creating new ``rte_malloc`` heaps referencing
60 memory that was created outside of DPDK's own page allocator, and using that
61 memory natively with any other DPDK library or data structure.
63 * **Add support to offload more flow match and actions for CXGBE PMD**
65 Flow API support has been enhanced for CXGBE Poll Mode Driver to offload:
67 * Match items: destination MAC address.
68 * Action items: push/pop/rewrite vlan header.
70 * **Added a devarg to use the latest supported vector path in i40e.**
71 A new devarg ``use-latest-supported-vec`` was introduced to allow users to
72 choose the latest vector path that the platform supported. For example, users
73 can use AVX2 vector path on BDW/HSW to get better performance.
75 * **Added support for SR-IOV in netvsc PMD.**
77 The ``netvsc`` poll mode driver now supports the Accelerated Networking
78 SR-IOV option in Hyper-V and Azure. This is an alternative to the previous
79 vdev_netvsc, tap, and failsafe drivers combination.
81 * **Updated failsafe driver.**
83 Updated the failsafe driver including the following changes:
85 * Support for Rx and Tx queues start and stop.
86 * Support for Rx and Tx queues deferred start.
87 * Support for runtime Rx and Tx queues setup.
88 * Support multicast MAC address set.
90 * **Added Event Ethernet Tx Adapter.**
92 Added event ethernet Tx adapter library that provides configuration and
93 data path APIs for the ethernet transmit stage of an event driven packet
94 processing application. These APIs abstract the implementation of the
95 transmit stage and allow the application to use eventdev PMD support or
96 a common implementation.
98 * **Added Distributed Software Eventdev PMD.**
100 Added the new Distributed Software Event Device (DSW), which is a
101 pure-software eventdev driver distributing the work of scheduling
102 among all eventdev ports and the lcores using them. DSW, compared to
103 the SW eventdev PMD, sacrifices load balancing performance to
104 gain better event scheduling throughput and scalability.
106 * **Added ability to switch queue deferred start flag on testpmd app.**
108 Added a console command to testpmd app, giving ability to switch
109 ``rx_deferred_start`` or ``tx_deferred_start`` flag of the specified queue of
110 the specified port. The port must be stopped before the command call in order
111 to reconfigure queues.
117 .. This section should contain API changes. Sample format:
119 * Add a short 1-2 sentence description of the API change.
120 Use fixed width quotes for ``function_names`` or ``struct_names``.
123 This section is a comment. Do not overwrite or remove it.
124 Also, make sure to start the actual text at the margin.
125 =========================================================
127 * eal: ``rte_memseg_list`` structure now has an additional flag indicating
128 whether the memseg list is externally allocated. This will have implications
129 for any users of memseg-walk-related functions, as they will now have to skip
130 externally allocated segments in most cases if the intent is to only iterate
131 over internal DPDK memory.
132 ``socket_id`` parameter across the entire DPDK has gained additional meaning,
133 as some socket ID's will now be representing externally allocated memory. No
134 changes will be required for existing code as backwards compatibility will be
135 kept, and those who do not use this feature will not see these extra socket
136 ID's. Any new API's must not check socket ID parameters themselves, and must
137 instead leave it to the memory subsystem to decide whether socket ID is a
140 * eal: The following devargs functions, which were deprecated in 18.05,
141 were removed in 18.11:
142 ``rte_eal_parse_devargs_str()``, ``rte_eal_devargs_add()``,
143 ``rte_eal_devargs_type_count()``, and ``rte_eal_devargs_dump()``.
145 * eal: The parameters of the function ``rte_devargs_remove()`` have changed
146 from bus and device names to ``struct rte_devargs``.
148 * mbuf: The ``__rte_mbuf_raw_free()`` and ``__rte_pktmbuf_prefree_seg()``
149 functions were deprecated since 17.05 and are replaced by
150 ``rte_mbuf_raw_free()`` and ``rte_pktmbuf_prefree_seg()``.
152 * A new device flag, RTE_ETH_DEV_NOLIVE_MAC_ADDR, changes the order of
153 actions inside rte_eth_dev_start regarding MAC set. Some NICs do not
154 support MAC changes once the port has started and with this new device
155 flag the MAC can be properly configured in any case. This is particularly
156 important for bonding.
158 * The default behaviour of CRC strip offload changed. Without any specific Rx
159 offload flag, default behavior by PMD is now to strip CRC.
160 DEV_RX_OFFLOAD_CRC_STRIP offload flag has been removed.
161 To request keeping CRC, application should set ``DEV_RX_OFFLOAD_KEEP_CRC`` Rx
164 * eventdev: Type of 2nd parameter to ``rte_event_eth_rx_adapter_caps_get()``
165 has been changed from uint8_t to uint16_t.
171 .. This section should contain ABI changes. Sample format:
173 * Add a short 1-2 sentence description of the ABI change
174 that was announced in the previous releases and made in this release.
175 Use fixed width quotes for ``function_names`` or ``struct_names``.
178 This section is a comment. Do not overwrite or remove it.
179 Also, make sure to start the actual text at the margin.
180 =========================================================
182 * eal: added ``legacy_mem`` and ``single_file_segments`` values to
183 ``rte_config`` structure on account of improving DPDK usability when
184 using either ``--legacy-mem`` or ``--single-file-segments`` flags.
186 * eal: EAL library ABI version was changed due to previously announced work on
187 supporting external memory in DPDK:
188 - structure ``rte_memseg_list`` now has a new field indicating length
189 of memory addressed by the segment list
190 - structure ``rte_memseg_list`` now has a new flag indicating whether
191 the memseg list refers to external memory
192 - structure ``rte_malloc_heap`` now has a new field indicating socket
193 ID the malloc heap belongs to
194 - structure ``rte_mem_config`` has had its ``malloc_heaps`` array
195 resized from ``RTE_MAX_NUMA_NODES`` to ``RTE_MAX_HEAPS`` value
196 - structure ``rte_malloc_heap`` now has a ``heap_name`` member
197 - structure ``rte_eal_memconfig`` has been extended to contain next
198 socket ID for externally allocated segments
204 .. This section should contain removed items in this release. Sample format:
206 * Add a short 1-2 sentence description of the removed item
209 This section is a comment. Do not overwrite or remove it.
210 Also, make sure to start the actual text at the margin.
211 =========================================================
214 Shared Library Versions
215 -----------------------
217 .. Update any library version updated in this release
218 and prepend with a ``+`` sign, like this:
221 + librte_cfgfile.so.2
224 This section is a comment. Do not overwrite or remove it.
225 =========================================================
227 The libraries prepended with a plus sign were incremented in this version.
233 librte_bitratestats.so.2
236 librte_bus_fslmc.so.1
239 + librte_bus_vmbus.so.1
242 librte_common_octeontx.so.1
243 librte_compressdev.so.1
244 librte_cryptodev.so.5
245 librte_distributor.so.1
248 + librte_eventdev.so.6
249 librte_flow_classify.so.1
257 librte_latencystats.so.1
270 librte_pmd_ixgbe.so.2
271 librte_pmd_dpaa2_cmdif.so.1
272 librte_pmd_dpaa2_qdma.so.1
274 librte_pmd_softnic.so.1
275 librte_pmd_vhost.so.2
276 + librte_pmd_netvsc.so.1
292 .. This section should contain new known issues in this release. Sample format:
294 * **Add title in present tense with full stop.**
296 Add a short 1-2 sentence description of the known issue
297 in the present tense. Add information on any known workarounds.
299 This section is a comment. Do not overwrite or remove it.
300 Also, make sure to start the actual text at the margin.
301 =========================================================
303 * When using SR-IOV (VF) support with netvsc PMD and the Mellanox mlx5 bifurcated
304 driver; the Linux netvsc device must be brought up before the netvsc device is
305 unbound and passed to the DPDK.
311 .. This section should contain a list of platforms that were tested
316 * <vendor> platform with <vendor> <type of devices> combinations
321 * Other relevant details...
323 This section is a comment. Do not overwrite or remove it.
324 Also, make sure to start the actual text at the margin.
325 =========================================================