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 check for ensuring allocated memory addressable by devices.**
65 Some devices can have addressing limitations so a new function,
66 ``rte_eal_check_dma_mask``, has been added for checking allocated memory is
67 not out of the device range. Because now memory can be dynamically allocated
68 after initialization, a dma mask is kept and any new allocated memory will be
69 checked out against that dma mask and rejected if out of range. If more than
70 one device has addressing limitations, the dma mask is the more restricted one.
72 * **Added hot-unplug handle mechanism.**
74 ``rte_dev_hotplug_handle_enable`` and ``rte_dev_hotplug_handle_disable`` are
75 for enabling or disabling hotplug handle mechanism.
77 * **Support device multi-process hotplug.**
79 Hotplug and hot-unplug for devices will now be supported in multiprocessing
80 scenario. Any ethdev devices created in the primary process will be regarded
81 as shared and will be available for all DPDK processes. Synchronization
82 between processes will be done using DPDK IPC.
84 * **Added new Flow API actions to rewrite fields in packet headers.**
86 Added new Flow API actions to:
88 * Modify source and destination IP addresses in the outermost IPv4/IPv6
90 * Modify source and destination port numbers in the outermost TCP/UDP
93 * **Added new Flow API action to swap MAC addresses in Ethernet header.**
95 Added new Flow API action to swap the source and destination MAC
96 addresses in the outermost Ethernet header.
98 * **Add support to offload more flow match and actions for CXGBE PMD**
100 Flow API support has been enhanced for CXGBE Poll Mode Driver to offload:
102 * Match items: destination MAC address.
103 * Action items: push/pop/rewrite vlan header,
104 rewrite IP addresses in outermost IPv4/IPv6 header,
105 rewrite port numbers in outermost TCP/UDP header,
106 swap MAC addresses in outermost Ethernet header.
108 * **Added a devarg to use the latest supported vector path in i40e.**
109 A new devarg ``use-latest-supported-vec`` was introduced to allow users to
110 choose the latest vector path that the platform supported. For example, users
111 can use AVX2 vector path on BDW/HSW to get better performance.
113 * **Added support for SR-IOV in netvsc PMD.**
115 The ``netvsc`` poll mode driver now supports the Accelerated Networking
116 SR-IOV option in Hyper-V and Azure. This is an alternative to the previous
117 vdev_netvsc, tap, and failsafe drivers combination.
119 * **Added a new net driver for Marvell Armada 3k device.**
121 Added the new ``mvneta`` net driver for Marvell Armada 3k device. See the
122 :doc:`../nics/mvneta` NIC guide for more details on this new driver.
124 * **Added NXP ENETC PMD.**
126 Added the new enetc driver for NXP enetc platform. See the
127 "ENETC Poll Mode Driver" document for more details on this new driver.
129 * **Added Ethernet poll mode driver for Aquantia aQtion family of 10G devices.**
131 Added the new ``atlantic`` ethernet poll mode driver for Aquantia XGBE devices.
132 See the :doc:`../nics/atlantic` nic driver guide for more details on this
135 * **Updated Solarflare network PMD.**
137 Updated the sfc_efx driver including the following changes:
139 * Added support for Rx scatter in EF10 datapath implementation.
140 * Added support for Rx descriptor status API in EF10 datapath implementation.
141 * Added support for TSO in EF10 datapath implementation.
142 * Added support for Tx descriptor status API in EF10 (ef10 and ef10_simple)
143 datapaths implementation.
145 * **Updated the enic driver.**
147 * Added AVX2-based vectorized Rx handler.
148 * Added VLAN and checksum offloads to the simple Tx handler.
149 * Added the count flow action.
150 * Enabled the virtual address IOVA mode.
152 * **Updated failsafe driver.**
154 Updated the failsafe driver including the following changes:
156 * Support for Rx and Tx queues start and stop.
157 * Support for Rx and Tx queues deferred start.
158 * Support for runtime Rx and Tx queues setup.
159 * Support multicast MAC address set.
161 * **Added a devarg to use PCAP interface physical MAC address.**
162 A new devarg ``phy_mac`` was introduced to allow users to use physical
163 MAC address of the selected PCAP interface.
165 * **Added TAP Rx/Tx queues sharing with a secondary process.**
167 A secondary process can attach a TAP device created in the primary process,
168 probe the queues, and process Rx/Tx in a secondary process.
170 * **Added classification and metering support to SoftNIC PMD.**
172 Added support for flow classification (rte_flow API), and metering and
173 policing (rte_mtr API) to the SoftNIC PMD.
175 * **Added Crypto support to Softnic PMD.**
177 The Softnic is now capable of processing symmetric crypto workloads such
178 as cipher, cipher-authentication chaining, and aead encryption and
179 decryption. This is achieved by calling DPDK Cryptodev APIs.
181 * **Added cryptodev port to port library.**
183 Cryptodev port is a shim layer in the port library that interacts with DPDK
184 Cryptodev PMDs including burst enqueuing and dequeuing crypto operations.
186 * **Added symmetric cryptographic actions to the pipeline library.**
188 In the pipeline library an added symmetric crypto action parsing and action
189 handler are implemented. The action allows automatically preparing the crypto
190 operation with the rules specified such as algorithm, key, and IV, etc for
191 the cryptodev port to process.
193 * **Added support for GEN3 devices to Intel QAT driver .**
195 Added support for the third generation of Intel QuickAssist devices.
197 * **Updated the QAT PMD.**
199 The QAT PMD was updated with additional support for:
201 * AES-CMAC algorithm.
203 * **Updated the AESNI MB PMD.**
205 The AESNI MB PMD has been updated with additional support for AES-GCM
208 * **Added NXP CAAM JR PMD.**
210 Added the new caam job ring driver for NXP platforms. See the
211 "NXP CAAM JOB RING (caam_jr)" document for more details on this new driver.
213 * **Added support for Dynamic Huffman Encoding to Intel QAT comp PMD.**
215 The Intel QuickAssist (QAT) compression PMD has been updated with support
216 for Dynamic Huffman Encoding for the Deflate algorithm.
218 * **Added Event Ethernet Tx Adapter.**
220 Added event ethernet Tx adapter library that provides configuration and
221 data path APIs for the ethernet transmit stage of an event driven packet
222 processing application. These APIs abstract the implementation of the
223 transmit stage and allow the application to use eventdev PMD support or
224 a common implementation.
226 * **Added Distributed Software Eventdev PMD.**
228 Added the new Distributed Software Event Device (DSW), which is a
229 pure-software eventdev driver distributing the work of scheduling
230 among all eventdev ports and the lcores using them. DSW, compared to
231 the SW eventdev PMD, sacrifices load balancing performance to
232 gain better event scheduling throughput and scalability.
234 * **Added extendable bucket feature to hash library (rte_hash).**
236 This new “extendable bucket” feature provides 100% insertion guarantee to
237 the capacity specified by the user by extending hash table with extra
238 buckets when needed to accommodate the unlikely event of intensive hash
239 collisions. In addition, the internal hashing algorithm was changed to use
240 partial-key hashing to improve memory efficiency and lookup performance.
242 * **Added lock free reader/writer concurrency to hash library (rte_hash).**
244 Lock free reader/writer concurrency prevents the readers from getting
245 blocked due to a pre-empted writer thread. This allows the hash library
246 to be used in scenarios where the writer thread runs on control plane.
248 * **Added Traffic Pattern Aware Power Control Library**
250 Added an experimental library. This extend Power Library and provide
251 empty_poll APIs. This feature measure how many times empty_poll are
252 executed per core, use the number of empty polls as a hint for system
255 See the :doc:`../prog_guide/power_man` section of the DPDK Programmers
256 Guide document for more information.
258 * **Added JSON power policy interface for containers.**
260 Extended the Power Library and vm_power_manager sample app to allow power
261 policies to be submitted via a FIFO using JSON formatted strings. Previously
262 limited to Virtual Machines, this feature extends power policy functionality
263 to containers and host applications that need to have their cores frequency
264 controlled based on the rules contained in the policy.
266 * **Added Telemetry API.**
268 Added the telemetry API which allows applications to transparently expose
269 their telemetry via a UNIX socket in JSON. The JSON can be consumed by any
270 Service Assurance agent, such as CollectD.
272 * **Added ability to switch queue deferred start flag on testpmd app.**
274 Added a console command to testpmd app, giving ability to switch
275 ``rx_deferred_start`` or ``tx_deferred_start`` flag of the specified queue of
276 the specified port. The port must be stopped before the command call in order
277 to reconfigure queues.
279 * **Add a new sample for vDPA**
281 The vdpa sample application creates vhost-user sockets by using the
282 vDPA backend. vDPA stands for vhost Data Path Acceleration which utilizes
283 virtio ring compatible devices to serve virtio driver directly to enable
284 datapath acceleration. As vDPA driver can help to set up vhost datapath,
285 this application doesn't need to launch dedicated worker threads for vhost
286 enqueue/dequeue operations.
292 .. This section should contain API changes. Sample format:
294 * Add a short 1-2 sentence description of the API change.
295 Use fixed width quotes for ``function_names`` or ``struct_names``.
298 This section is a comment. Do not overwrite or remove it.
299 Also, make sure to start the actual text at the margin.
300 =========================================================
302 * eal: ``rte_memseg_list`` structure now has an additional flag indicating
303 whether the memseg list is externally allocated. This will have implications
304 for any users of memseg-walk-related functions, as they will now have to skip
305 externally allocated segments in most cases if the intent is to only iterate
306 over internal DPDK memory.
307 ``socket_id`` parameter across the entire DPDK has gained additional meaning,
308 as some socket ID's will now be representing externally allocated memory. No
309 changes will be required for existing code as backwards compatibility will be
310 kept, and those who do not use this feature will not see these extra socket
311 ID's. Any new API's must not check socket ID parameters themselves, and must
312 instead leave it to the memory subsystem to decide whether socket ID is a
315 * eal: The following devargs functions, which were deprecated in 18.05,
316 were removed in 18.11:
317 ``rte_eal_parse_devargs_str()``, ``rte_eal_devargs_add()``,
318 ``rte_eal_devargs_type_count()``, and ``rte_eal_devargs_dump()``.
320 * eal: The parameters of the function ``rte_devargs_remove()`` have changed
321 from bus and device names to ``struct rte_devargs``.
323 * eal: The deprecated functions attach/detach were removed in 18.11.
324 ``rte_eal_dev_attach`` can be replaced by
325 ``rte_dev_probe`` or ``rte_eal_hotplug_add``.
326 ``rte_eal_dev_detach`` can be replaced by
327 ``rte_dev_remove`` or ``rte_eal_hotplug_remove``.
329 * eal: The scope of ``rte_eal_hotplug_add()``/``rte_dev_probe()``
330 and ``rte_eal_hotplug_remove()``/``rte_dev_remove()`` is extended.
331 In multi-process model, they will guarantee that the device is
332 attached or detached on all processes.
334 * mbuf: The ``__rte_mbuf_raw_free()`` and ``__rte_pktmbuf_prefree_seg()``
335 functions were deprecated since 17.05 and are replaced by
336 ``rte_mbuf_raw_free()`` and ``rte_pktmbuf_prefree_seg()``.
338 * ethdev: The deprecated functions attach/detach were removed in 18.11.
339 ``rte_eth_dev_attach`` can be replaced by ``RTE_ETH_FOREACH_MATCHING_DEV``
340 and ``rte_dev_probe`` or ``rte_eal_hotplug_add``.
341 ``rte_eth_dev_detach`` can be replaced by
342 ``rte_dev_remove`` or ``rte_eal_hotplug_remove``.
344 * ethdev: A call to ``rte_eth_dev_release_port()`` has been added in
345 ``rte_eth_dev_close()``. As a consequence, a closed port is freed
346 and seen as invalid because of its state ``RTE_ETH_DEV_UNUSED``.
347 This new behaviour is enabled per driver for a migration period.
349 * A new device flag, RTE_ETH_DEV_NOLIVE_MAC_ADDR, changes the order of
350 actions inside rte_eth_dev_start regarding MAC set. Some NICs do not
351 support MAC changes once the port has started and with this new device
352 flag the MAC can be properly configured in any case. This is particularly
353 important for bonding.
355 * The default behaviour of CRC strip offload changed. Without any specific Rx
356 offload flag, default behavior by PMD is now to strip CRC.
357 DEV_RX_OFFLOAD_CRC_STRIP offload flag has been removed.
358 To request keeping CRC, application should set ``DEV_RX_OFFLOAD_KEEP_CRC`` Rx
361 * eventdev: Type of 2nd parameter to ``rte_event_eth_rx_adapter_caps_get()``
362 has been changed from uint8_t to uint16_t.
368 .. This section should contain ABI changes. Sample format:
370 * Add a short 1-2 sentence description of the ABI change
371 that was announced in the previous releases and made in this release.
372 Use fixed width quotes for ``function_names`` or ``struct_names``.
375 This section is a comment. Do not overwrite or remove it.
376 Also, make sure to start the actual text at the margin.
377 =========================================================
379 * eal: added ``legacy_mem`` and ``single_file_segments`` values to
380 ``rte_config`` structure on account of improving DPDK usability when
381 using either ``--legacy-mem`` or ``--single-file-segments`` flags.
383 * eal: EAL library ABI version was changed due to previously announced work on
384 supporting external memory in DPDK:
385 - structure ``rte_memseg_list`` now has a new field indicating length
386 of memory addressed by the segment list
387 - structure ``rte_memseg_list`` now has a new flag indicating whether
388 the memseg list refers to external memory
389 - structure ``rte_malloc_heap`` now has a new field indicating socket
390 ID the malloc heap belongs to
391 - structure ``rte_mem_config`` has had its ``malloc_heaps`` array
392 resized from ``RTE_MAX_NUMA_NODES`` to ``RTE_MAX_HEAPS`` value
393 - structure ``rte_malloc_heap`` now has a ``heap_name`` member
394 - structure ``rte_eal_memconfig`` has been extended to contain next
395 socket ID for externally allocated segments
397 * eal: Added ``dma_maskbits`` to ``rte_mem_config`` for keeping more restricted
398 dma mask based on devices addressing limitations.
400 * eal: The structure ``rte_device`` got a new field to reference a ``rte_bus``.
401 It is changing the size of the ``struct rte_device`` and the inherited
402 device structures of all buses.
408 .. This section should contain removed items in this release. Sample format:
410 * Add a short 1-2 sentence description of the removed item
413 This section is a comment. Do not overwrite or remove it.
414 Also, make sure to start the actual text at the margin.
415 =========================================================
418 Shared Library Versions
419 -----------------------
421 .. Update any library version updated in this release
422 and prepend with a ``+`` sign, like this:
425 + librte_cfgfile.so.2
428 This section is a comment. Do not overwrite or remove it.
429 =========================================================
431 The libraries prepended with a plus sign were incremented in this version.
437 librte_bitratestats.so.2
439 + librte_bus_dpaa.so.2
440 + librte_bus_fslmc.so.2
441 + librte_bus_ifpga.so.2
442 + librte_bus_pci.so.2
443 + librte_bus_vdev.so.2
444 + librte_bus_vmbus.so.2
447 librte_compressdev.so.1
448 librte_cryptodev.so.5
449 librte_distributor.so.1
452 + librte_ethdev.so.11
453 + librte_eventdev.so.6
454 librte_flow_classify.so.1
462 librte_latencystats.so.1
476 librte_pmd_ixgbe.so.2
477 librte_pmd_dpaa2_qdma.so.1
479 librte_pmd_softnic.so.1
480 librte_pmd_vhost.so.2
496 .. This section should contain new known issues in this release. Sample format:
498 * **Add title in present tense with full stop.**
500 Add a short 1-2 sentence description of the known issue
501 in the present tense. Add information on any known workarounds.
503 This section is a comment. Do not overwrite or remove it.
504 Also, make sure to start the actual text at the margin.
505 =========================================================
507 * When using SR-IOV (VF) support with netvsc PMD and the Mellanox mlx5 bifurcated
508 driver; the Linux netvsc device must be brought up before the netvsc device is
509 unbound and passed to the DPDK.
515 .. This section should contain a list of platforms that were tested
520 * <vendor> platform with <vendor> <type of devices> combinations
525 * Other relevant details...
527 This section is a comment. Do not overwrite or remove it.
528 Also, make sure to start the actual text at the margin.
529 =========================================================