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 * **Added a new net driver for Marvell Armada 3k device.**
83 Added the new ``mvneta`` net driver for Marvell Armada 3k device. See the
84 :doc:`../nics/mvneta` NIC guide for more details on this new driver.
86 * **Added NXP ENETC PMD.**
88 Added the new enetc driver for NXP enetc platform. See the
89 "ENETC Poll Mode Driver" document for more details on this new driver.
91 * **Updated failsafe driver.**
93 Updated the failsafe driver including the following changes:
95 * Support for Rx and Tx queues start and stop.
96 * Support for Rx and Tx queues deferred start.
97 * Support for runtime Rx and Tx queues setup.
98 * Support multicast MAC address set.
100 * **Added Event Ethernet Tx Adapter.**
102 Added event ethernet Tx adapter library that provides configuration and
103 data path APIs for the ethernet transmit stage of an event driven packet
104 processing application. These APIs abstract the implementation of the
105 transmit stage and allow the application to use eventdev PMD support or
106 a common implementation.
108 * **Added Distributed Software Eventdev PMD.**
110 Added the new Distributed Software Event Device (DSW), which is a
111 pure-software eventdev driver distributing the work of scheduling
112 among all eventdev ports and the lcores using them. DSW, compared to
113 the SW eventdev PMD, sacrifices load balancing performance to
114 gain better event scheduling throughput and scalability.
116 * **Added ability to switch queue deferred start flag on testpmd app.**
118 Added a console command to testpmd app, giving ability to switch
119 ``rx_deferred_start`` or ``tx_deferred_start`` flag of the specified queue of
120 the specified port. The port must be stopped before the command call in order
121 to reconfigure queues.
127 .. This section should contain API changes. Sample format:
129 * Add a short 1-2 sentence description of the API change.
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: ``rte_memseg_list`` structure now has an additional flag indicating
138 whether the memseg list is externally allocated. This will have implications
139 for any users of memseg-walk-related functions, as they will now have to skip
140 externally allocated segments in most cases if the intent is to only iterate
141 over internal DPDK memory.
142 ``socket_id`` parameter across the entire DPDK has gained additional meaning,
143 as some socket ID's will now be representing externally allocated memory. No
144 changes will be required for existing code as backwards compatibility will be
145 kept, and those who do not use this feature will not see these extra socket
146 ID's. Any new API's must not check socket ID parameters themselves, and must
147 instead leave it to the memory subsystem to decide whether socket ID is a
150 * eal: The following devargs functions, which were deprecated in 18.05,
151 were removed in 18.11:
152 ``rte_eal_parse_devargs_str()``, ``rte_eal_devargs_add()``,
153 ``rte_eal_devargs_type_count()``, and ``rte_eal_devargs_dump()``.
155 * eal: The parameters of the function ``rte_devargs_remove()`` have changed
156 from bus and device names to ``struct rte_devargs``.
158 * mbuf: The ``__rte_mbuf_raw_free()`` and ``__rte_pktmbuf_prefree_seg()``
159 functions were deprecated since 17.05 and are replaced by
160 ``rte_mbuf_raw_free()`` and ``rte_pktmbuf_prefree_seg()``.
162 * A new device flag, RTE_ETH_DEV_NOLIVE_MAC_ADDR, changes the order of
163 actions inside rte_eth_dev_start regarding MAC set. Some NICs do not
164 support MAC changes once the port has started and with this new device
165 flag the MAC can be properly configured in any case. This is particularly
166 important for bonding.
168 * The default behaviour of CRC strip offload changed. Without any specific Rx
169 offload flag, default behavior by PMD is now to strip CRC.
170 DEV_RX_OFFLOAD_CRC_STRIP offload flag has been removed.
171 To request keeping CRC, application should set ``DEV_RX_OFFLOAD_KEEP_CRC`` Rx
174 * eventdev: Type of 2nd parameter to ``rte_event_eth_rx_adapter_caps_get()``
175 has been changed from uint8_t to uint16_t.
181 .. This section should contain ABI changes. Sample format:
183 * Add a short 1-2 sentence description of the ABI change
184 that was announced in the previous releases and made in this release.
185 Use fixed width quotes for ``function_names`` or ``struct_names``.
188 This section is a comment. Do not overwrite or remove it.
189 Also, make sure to start the actual text at the margin.
190 =========================================================
192 * eal: added ``legacy_mem`` and ``single_file_segments`` values to
193 ``rte_config`` structure on account of improving DPDK usability when
194 using either ``--legacy-mem`` or ``--single-file-segments`` flags.
196 * eal: EAL library ABI version was changed due to previously announced work on
197 supporting external memory in DPDK:
198 - structure ``rte_memseg_list`` now has a new field indicating length
199 of memory addressed by the segment list
200 - structure ``rte_memseg_list`` now has a new flag indicating whether
201 the memseg list refers to external memory
202 - structure ``rte_malloc_heap`` now has a new field indicating socket
203 ID the malloc heap belongs to
204 - structure ``rte_mem_config`` has had its ``malloc_heaps`` array
205 resized from ``RTE_MAX_NUMA_NODES`` to ``RTE_MAX_HEAPS`` value
206 - structure ``rte_malloc_heap`` now has a ``heap_name`` member
207 - structure ``rte_eal_memconfig`` has been extended to contain next
208 socket ID for externally allocated segments
210 * eal: The structure ``rte_device`` got a new field to reference a ``rte_bus``.
211 It is changing the size of the ``struct rte_device`` and the inherited
212 device structures of all buses.
218 .. This section should contain removed items in this release. Sample format:
220 * Add a short 1-2 sentence description of the removed item
223 This section is a comment. Do not overwrite or remove it.
224 Also, make sure to start the actual text at the margin.
225 =========================================================
228 Shared Library Versions
229 -----------------------
231 .. Update any library version updated in this release
232 and prepend with a ``+`` sign, like this:
235 + librte_cfgfile.so.2
238 This section is a comment. Do not overwrite or remove it.
239 =========================================================
241 The libraries prepended with a plus sign were incremented in this version.
247 librte_bitratestats.so.2
249 + librte_bus_dpaa.so.2
250 + librte_bus_fslmc.so.2
251 + librte_bus_ifpga.so.2
252 + librte_bus_pci.so.2
253 + librte_bus_vdev.so.2
254 + librte_bus_vmbus.so.2
257 librte_common_octeontx.so.1
258 librte_compressdev.so.1
259 librte_cryptodev.so.5
260 librte_distributor.so.1
263 + librte_eventdev.so.6
264 librte_flow_classify.so.1
272 librte_latencystats.so.1
285 librte_pmd_ixgbe.so.2
286 librte_pmd_dpaa2_cmdif.so.1
287 librte_pmd_dpaa2_qdma.so.1
289 librte_pmd_softnic.so.1
290 librte_pmd_vhost.so.2
291 + librte_pmd_netvsc.so.1
307 .. This section should contain new known issues in this release. Sample format:
309 * **Add title in present tense with full stop.**
311 Add a short 1-2 sentence description of the known issue
312 in the present tense. Add information on any known workarounds.
314 This section is a comment. Do not overwrite or remove it.
315 Also, make sure to start the actual text at the margin.
316 =========================================================
318 * When using SR-IOV (VF) support with netvsc PMD and the Mellanox mlx5 bifurcated
319 driver; the Linux netvsc device must be brought up before the netvsc device is
320 unbound and passed to the DPDK.
326 .. This section should contain a list of platforms that were tested
331 * <vendor> platform with <vendor> <type of devices> combinations
336 * Other relevant details...
338 This section is a comment. Do not overwrite or remove it.
339 Also, make sure to start the actual text at the margin.
340 =========================================================