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 * **Added hot-unplug handle mechanism.**
65 ``rte_dev_hotplug_handle_enable`` and ``rte_dev_hotplug_handle_disable`` are
66 for enabling or disabling hotplug handle mechanism.
68 * **Added new Flow API actions to rewrite fields in packet headers.**
70 Added new Flow API actions to:
72 * Modify source and destination IP addresses in the outermost IPv4/IPv6
74 * Modify source and destination port numbers in the outermost TCP/UDP
77 * **Added new Flow API action to swap MAC addresses in Ethernet header.**
79 Added new Flow API action to swap the source and destination MAC
80 addresses in the outermost Ethernet header.
82 * **Add support to offload more flow match and actions for CXGBE PMD**
84 Flow API support has been enhanced for CXGBE Poll Mode Driver to offload:
86 * Match items: destination MAC address.
87 * Action items: push/pop/rewrite vlan header,
88 rewrite IP addresses in outermost IPv4/IPv6 header,
89 rewrite port numbers in outermost TCP/UDP header.
91 * **Added a devarg to use the latest supported vector path in i40e.**
92 A new devarg ``use-latest-supported-vec`` was introduced to allow users to
93 choose the latest vector path that the platform supported. For example, users
94 can use AVX2 vector path on BDW/HSW to get better performance.
96 * **Added support for SR-IOV in netvsc PMD.**
98 The ``netvsc`` poll mode driver now supports the Accelerated Networking
99 SR-IOV option in Hyper-V and Azure. This is an alternative to the previous
100 vdev_netvsc, tap, and failsafe drivers combination.
102 * **Added a new net driver for Marvell Armada 3k device.**
104 Added the new ``mvneta`` net driver for Marvell Armada 3k device. See the
105 :doc:`../nics/mvneta` NIC guide for more details on this new driver.
107 * **Added NXP ENETC PMD.**
109 Added the new enetc driver for NXP enetc platform. See the
110 "ENETC Poll Mode Driver" document for more details on this new driver.
112 * **Updated Solarflare network PMD.**
114 Updated the sfc_efx driver including the following changes:
116 * Added support for Rx scatter in EF10 datapath implementation.
117 * Added support for Rx descriptor status API in EF10 datapath implementation.
118 * Added support for TSO in EF10 datapath implementation.
119 * Added support for Tx descriptor status API in EF10 (ef10 and ef10_simple)
120 datapaths implementation.
122 * **Updated failsafe driver.**
124 Updated the failsafe driver including the following changes:
126 * Support for Rx and Tx queues start and stop.
127 * Support for Rx and Tx queues deferred start.
128 * Support for runtime Rx and Tx queues setup.
129 * Support multicast MAC address set.
131 * **Added a devarg to use PCAP interface physical MAC address.**
132 A new devarg ``phy_mac`` was introduced to allow users to use physical
133 MAC address of the selected PCAP interface.
135 * **Added Event Ethernet Tx Adapter.**
137 Added event ethernet Tx adapter library that provides configuration and
138 data path APIs for the ethernet transmit stage of an event driven packet
139 processing application. These APIs abstract the implementation of the
140 transmit stage and allow the application to use eventdev PMD support or
141 a common implementation.
143 * **Added Distributed Software Eventdev PMD.**
145 Added the new Distributed Software Event Device (DSW), which is a
146 pure-software eventdev driver distributing the work of scheduling
147 among all eventdev ports and the lcores using them. DSW, compared to
148 the SW eventdev PMD, sacrifices load balancing performance to
149 gain better event scheduling throughput and scalability.
151 * **Added ability to switch queue deferred start flag on testpmd app.**
153 Added a console command to testpmd app, giving ability to switch
154 ``rx_deferred_start`` or ``tx_deferred_start`` flag of the specified queue of
155 the specified port. The port must be stopped before the command call in order
156 to reconfigure queues.
158 * **Add a new sample for vDPA**
160 The vdpa sample application creates vhost-user sockets by using the
161 vDPA backend. vDPA stands for vhost Data Path Acceleration which utilizes
162 virtio ring compatible devices to serve virtio driver directly to enable
163 datapath acceleration. As vDPA driver can help to set up vhost datapath,
164 this application doesn't need to launch dedicated worker threads for vhost
165 enqueue/dequeue operations.
171 .. This section should contain API changes. Sample format:
173 * Add a short 1-2 sentence description of the API change.
174 Use fixed width quotes for ``function_names`` or ``struct_names``.
177 This section is a comment. Do not overwrite or remove it.
178 Also, make sure to start the actual text at the margin.
179 =========================================================
181 * eal: ``rte_memseg_list`` structure now has an additional flag indicating
182 whether the memseg list is externally allocated. This will have implications
183 for any users of memseg-walk-related functions, as they will now have to skip
184 externally allocated segments in most cases if the intent is to only iterate
185 over internal DPDK memory.
186 ``socket_id`` parameter across the entire DPDK has gained additional meaning,
187 as some socket ID's will now be representing externally allocated memory. No
188 changes will be required for existing code as backwards compatibility will be
189 kept, and those who do not use this feature will not see these extra socket
190 ID's. Any new API's must not check socket ID parameters themselves, and must
191 instead leave it to the memory subsystem to decide whether socket ID is a
194 * eal: The following devargs functions, which were deprecated in 18.05,
195 were removed in 18.11:
196 ``rte_eal_parse_devargs_str()``, ``rte_eal_devargs_add()``,
197 ``rte_eal_devargs_type_count()``, and ``rte_eal_devargs_dump()``.
199 * eal: The parameters of the function ``rte_devargs_remove()`` have changed
200 from bus and device names to ``struct rte_devargs``.
202 * mbuf: The ``__rte_mbuf_raw_free()`` and ``__rte_pktmbuf_prefree_seg()``
203 functions were deprecated since 17.05 and are replaced by
204 ``rte_mbuf_raw_free()`` and ``rte_pktmbuf_prefree_seg()``.
206 * A new device flag, RTE_ETH_DEV_NOLIVE_MAC_ADDR, changes the order of
207 actions inside rte_eth_dev_start regarding MAC set. Some NICs do not
208 support MAC changes once the port has started and with this new device
209 flag the MAC can be properly configured in any case. This is particularly
210 important for bonding.
212 * The default behaviour of CRC strip offload changed. Without any specific Rx
213 offload flag, default behavior by PMD is now to strip CRC.
214 DEV_RX_OFFLOAD_CRC_STRIP offload flag has been removed.
215 To request keeping CRC, application should set ``DEV_RX_OFFLOAD_KEEP_CRC`` Rx
218 * eventdev: Type of 2nd parameter to ``rte_event_eth_rx_adapter_caps_get()``
219 has been changed from uint8_t to uint16_t.
225 .. This section should contain ABI changes. Sample format:
227 * Add a short 1-2 sentence description of the ABI change
228 that was announced in the previous releases and made in this release.
229 Use fixed width quotes for ``function_names`` or ``struct_names``.
232 This section is a comment. Do not overwrite or remove it.
233 Also, make sure to start the actual text at the margin.
234 =========================================================
236 * eal: added ``legacy_mem`` and ``single_file_segments`` values to
237 ``rte_config`` structure on account of improving DPDK usability when
238 using either ``--legacy-mem`` or ``--single-file-segments`` flags.
240 * eal: EAL library ABI version was changed due to previously announced work on
241 supporting external memory in DPDK:
242 - structure ``rte_memseg_list`` now has a new field indicating length
243 of memory addressed by the segment list
244 - structure ``rte_memseg_list`` now has a new flag indicating whether
245 the memseg list refers to external memory
246 - structure ``rte_malloc_heap`` now has a new field indicating socket
247 ID the malloc heap belongs to
248 - structure ``rte_mem_config`` has had its ``malloc_heaps`` array
249 resized from ``RTE_MAX_NUMA_NODES`` to ``RTE_MAX_HEAPS`` value
250 - structure ``rte_malloc_heap`` now has a ``heap_name`` member
251 - structure ``rte_eal_memconfig`` has been extended to contain next
252 socket ID for externally allocated segments
254 * eal: The structure ``rte_device`` got a new field to reference a ``rte_bus``.
255 It is changing the size of the ``struct rte_device`` and the inherited
256 device structures of all buses.
262 .. This section should contain removed items in this release. Sample format:
264 * Add a short 1-2 sentence description of the removed item
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 =========================================================
272 Shared Library Versions
273 -----------------------
275 .. Update any library version updated in this release
276 and prepend with a ``+`` sign, like this:
279 + librte_cfgfile.so.2
282 This section is a comment. Do not overwrite or remove it.
283 =========================================================
285 The libraries prepended with a plus sign were incremented in this version.
291 librte_bitratestats.so.2
293 + librte_bus_dpaa.so.2
294 + librte_bus_fslmc.so.2
295 + librte_bus_ifpga.so.2
296 + librte_bus_pci.so.2
297 + librte_bus_vdev.so.2
298 + librte_bus_vmbus.so.2
301 librte_common_octeontx.so.1
302 librte_compressdev.so.1
303 librte_cryptodev.so.5
304 librte_distributor.so.1
307 + librte_eventdev.so.6
308 librte_flow_classify.so.1
316 librte_latencystats.so.1
329 librte_pmd_ixgbe.so.2
330 librte_pmd_dpaa2_cmdif.so.1
331 librte_pmd_dpaa2_qdma.so.1
333 librte_pmd_softnic.so.1
334 librte_pmd_vhost.so.2
335 + librte_pmd_netvsc.so.1
351 .. This section should contain new known issues in this release. Sample format:
353 * **Add title in present tense with full stop.**
355 Add a short 1-2 sentence description of the known issue
356 in the present tense. Add information on any known workarounds.
358 This section is a comment. Do not overwrite or remove it.
359 Also, make sure to start the actual text at the margin.
360 =========================================================
362 * When using SR-IOV (VF) support with netvsc PMD and the Mellanox mlx5 bifurcated
363 driver; the Linux netvsc device must be brought up before the netvsc device is
364 unbound and passed to the DPDK.
370 .. This section should contain a list of platforms that were tested
375 * <vendor> platform with <vendor> <type of devices> combinations
380 * Other relevant details...
382 This section is a comment. Do not overwrite or remove it.
383 Also, make sure to start the actual text at the margin.
384 =========================================================