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