4 .. **Read this first.**
6 The text in the sections below explains how to update the release notes.
8 Use proper spelling, capitalization and punctuation in all sections.
10 Variable and config names should be quoted as fixed width text:
13 Build the docs and view the output file to ensure the changes are correct::
17 xdg-open build/doc/html/guides/rel_notes/release_17_11.html
23 .. This section should contain new features added in this release. Sample
26 * **Add a title in the past tense with a full stop.**
28 Add a short 1-2 sentence description in the past tense. The description
29 should be enough to allow someone scanning the release notes to
30 understand the new feature.
32 If the feature adds a lot of sub-features you can use a bullet list like
35 * Added feature foo to do something.
36 * Enhanced feature bar to do something else.
38 Refer to the previous release notes for examples.
40 This section is a comment. do not overwrite or remove it.
41 Also, make sure to start the actual text at the margin.
42 =========================================================
44 * **Extended port_id range from uint8_t to uint16_t.**
46 Increased port_id range from 8 bits to 16 bits in order to support more than
47 256 ports in dpdk. All ethdev APIs which have port_id as parameter are changed
50 * **Modified the return type of rte_eth_stats_reset.**
52 Changed return type of ``rte_eth_stats_reset`` from ``void`` to ``int``
53 so the caller may know whether a device supports the operation or not
54 and if the operation was carried out.
56 * **Added a new driver for Marvell Armada 7k/8k devices.**
58 Added the new mrvl net driver for Marvell Armada 7k/8k devices. See the
59 "Network Interface Controller Drivers" document for more details on this new
62 * **Updated mlx5 driver.**
64 Updated the mlx5 driver including the following changes:
66 * Enabled PMD to run on top of upstream linux kernel and rdma-core libs.
67 By that removed the dependency on specific Mellanox OFED libraries.
68 * Improved PMD latency performance.
69 * Improved PMD memory footprint.
70 * Supported vectorized Rx/Tx burst for ARMv8.
71 * Supported secondary process.
72 * Supported flow counters.
73 * Supported Rx hardware timestamp offload.
74 * Supported device removal event.
76 * **Added SoftNIC PMD.**
78 Added new SoftNIC PMD. This virtual device offers applications a software
79 fallback support for traffic management.
81 * **Added support for NXP DPAA Devices.**
83 Added support for NXP's DPAA devices - LS104x series. This includes:
86 * DPAA Mempool driver for supporting offloaded packet memory pool
87 * DPAA PMD for DPAA devices
89 See the "Network Interface Controller Drivers" document for more details of
92 * **Updated support for Cavium OCTEONTX Device.**
94 Updated support for Cavium's OCTEONTX device(CN83xx). This includes:
96 * OCTEONTX Mempool driver for supporting offloaded packet memory pool
98 * OCTEONTX Eventdev-Ethdev Rx adapter
100 See the "Network Interface Controller Drivers" document for more details of
103 * **nfp: Added PF support.**
105 Previously Netronome's NFP PMD had just support for VFs. PF support is
106 just as a basic DPDK port and has no VF management yet.
108 PF support comes with firmware upload support which allows the PMD to
109 independently work from kernel netdev NFP drivers.
111 NFP 4000 devices are also now supported along with previous 6000 devices.
113 * **Updated bnxt PMD.**
115 Major enhancements include:
117 * Support for Flow API
118 * Support for Tx and Rx descriptor status functions
120 * **Add bus agnostic functions to cryptodev for PMD initialisation**
122 Adds new PMD assist functions ``rte_cryptodev_pmd_parse_input_args()``,
123 ``rte_cryptodev_pmd_create()`` and ``rte_cryptodev_pmd_destroy()`` which
124 are bus independent for driver to manage creation and destruction of new
127 * **Updated QAT crypto PMD.**
129 Performance enhancements:
131 * Removed atomics from the internal queue pair structure.
132 * Coalesce writes to HEAD CSR on response processing.
133 * Coalesce writes to TAIL CSR on request processing.
135 Additional support for:
139 * **Updated the AESNI MB PMD.**
141 The AESNI MB PMD has been updated with additional support for:
144 * DES DOCSIS BPI algorithm.
146 This requires the IPSec Multi-buffer library 0.47. For more details,
147 check out the AESNI MB PMD documenation.
149 * **Updated the OpenSSL PMD.**
151 The OpenSSL PMD has been updated with additional support for:
156 * **Added NXP DPAA SEC crypto PMD.**
158 A new "dpaa_sec" hardware based crypto PMD for NXP DPAA devices has been
159 added. See the "Crypto Device Drivers" document for more details on this
162 * **Added MRVL crypto PMD.**
164 A new crypto PMD has been added, which provides several ciphering and hashing
165 algorithms. All cryptography operations use the MUSDK library crypto API.
167 * **Add new benchmarking mode to dpdk-test-crypto-perf application.**
169 Added new "PMD cyclecount" benchmark mode to dpdk-test-crypto-perf application
170 that displays more detailed breakdown of CPU cycles used by hardware
173 * **Added the Security Offload Library.**
175 Added an experimental library - rte_security. It provide security APIs for
176 protocols like IPSec using inline ipsec offload to ethernet device or full
177 protocol offload with lookaside crypto device.
179 See the "Security_Library" section of the DPDK Programmers Guide document,
180 for more information.
182 * **Updated DPAA2_SEC crypto driver.**
184 Updated dpaa2_sec crypto PMD to support rte_security lookaside protocol
187 * **Updated IXGBE ethernet driver.**
189 Updated ixgbe ethernet PMD to support rte_security inline IPSec offload.
191 * **Updated ipsec-secgw application**
193 Updated ipsec-secgw sample application to support rte_security actions for
194 ipsec inline and full protocol offload using lookaside crypto offload.
196 * **Added IOMMU support to libvhost-user**
198 Implemented device IOTLB in Vhost-user backend, and enabled Virtio's IOMMU
199 feature. The feature is disabled by default, and can be enabled by setting
200 RTE_VHOST_USER_IOMMU_SUPPORT flag at vhost device registration time.
202 * **Added the Event Ethernet Adapter Library.**
204 Added the Event Ethernet Adapter library. It provices APIs for
205 eventdev applications to configure the ethdev to eventdev packet flow.
207 * **Updated DPAA2 Event PMD.**
209 Added support for eventdev ethernet adapter for DPAA2.
211 * **Added Membership library (rte_member).**
213 Added membership library. It provides an API for DPDK applications to insert a
214 new member, delete an existing member, or query the existence of a member in a
215 given set, or a group of sets. For the case of a group of sets the library
216 will return not only whether the element has been inserted before in one of
217 the sets but also which set it belongs to.
219 The Membership Library is an extension and generalization of a traditional
220 filter (for example Bloom Filter) structure that has multiple usages in a wide
221 variety of workloads and applications. In general, the Membership Library is a
222 data structure that provides a “set-summary” and responds to set-membership
223 queries whether a certain member belongs to a set(s).
225 See the :ref:`Membership Library <Member_Library>` documentation in
226 the Programmers Guide document, for more information.
228 * **Added the Generic Segmentation Offload Library.**
230 Added the Generic Segmentation Offload (GSO) library to enable
231 applications to split large packets (e.g. MTU is 64KB) into small
232 ones (e.g. MTU is 1500B). Supported packet types are:
235 * VxLAN packets, which must have an outer IPv4 header, and contain
236 an inner TCP/IPv4 packet.
237 * GRE packets, which must contain an outer IPv4 header, and inner
240 The GSO library doesn't check if the input packets have correct
241 checksums, and doesn't update checksums for output packets.
242 Additionally, the GSO library doesn't process IP fragmented packets.
244 * **Added the Flow Classification Library.**
246 Added the Flow Classification library, it provides an API for DPDK
247 applications to classify an input packet by matching it against a set of flow
248 rules. It uses the librte_table API to manage the flow rules.
254 .. This section should contain bug fixes added to the relevant
255 sections. Sample format:
257 * **code/section Fixed issue in the past tense with a full stop.**
259 Add a short 1-2 sentence description of the resolved issue in the past
262 The title should contain the code/lib section like a commit message.
264 Add the entries in alphabetic order in the relevant sections below.
266 This section is a comment. do not overwrite or remove it.
267 Also, make sure to start the actual text at the margin.
268 =========================================================
274 * **Service core fails to call service callback due to atomic lock**
276 In a specific configuration of multi-thread unsafe services and service
277 cores, a service core previously did not correctly release the atomic lock
278 on the service. This would result in the cores polling the service, but it
279 looked like another thread was executing the service callback. The logic for
280 atomic locking of the services has been fixed and refactored for readability.
301 .. This section should contain new known issues in this release. Sample format:
303 * **Add title in present tense with full stop.**
305 Add a short 1-2 sentence description of the known issue in the present
306 tense. Add information on any known workarounds.
308 This section is a comment. do not overwrite or remove it.
309 Also, make sure to start the actual text at the margin.
310 =========================================================
316 .. This section should contain API changes. Sample format:
318 * Add a short 1-2 sentence description of the API change. Use fixed width
319 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
322 This section is a comment. do not overwrite or remove it.
323 Also, make sure to start the actual text at the margin.
324 =========================================================
326 * **Ethdev device name length increased**
328 The size of internal device name is increased to 64 characters
329 to allow for storing longer bus specific name.
331 * **Ethdev flag RTE_ETH_DEV_DETACHABLE was removed**
333 This flag is not necessary anymore, with the new hotplug implementation.
334 It is now removed from the ether library. Its semantic is expressed at the bus
337 * **Service cores API updated for usability**
339 The service cores API has been changed, removing pointers from the API
340 where possible, instead using integer IDs to identify each service. This
341 simplifed application code, aids debugging, and provides better
342 encapsulation. A summary of the main changes made is as follows:
344 * Services identified by ID not by ``rte_service_spec`` pointer
345 * Reduced API surface by using ``set`` functions instead of enable/disable
346 * Reworked ``rte_service_register`` to provide the service ID to registrar
347 * Rework start and stop APIs into ``rte_service_runstate_set``
348 * Added API to set runstate of service implementation to indicate readyness
350 * **The following changes made in mempool library**
352 * Moved ``flags`` datatype from int to unsigned int for ``rte_mempool``.
353 * Removed ``__rte_unused int flag`` param from ``rte_mempool_generic_put``
354 and ``rte_mempool_generic_get`` API.
355 * Added ``flags`` param in ``rte_mempool_xmem_size`` and
356 ``rte_mempool_xmem_usage``.
358 * ``rte_mem_phy2mch`` was used in Xen dom0 to obtain the physical address;
359 remove this API as Xen dom0 support was removed.
361 * **Some data type, structure members and functions related to physical address
362 are deprecated and have new alias with IOVA wording.**
364 * ``phys_addr_t`` can be often replaced by ``rte_iova_t`` of same size.
365 * ``RTE_BAD_PHYS_ADDR`` is often replaced by ``RTE_BAD_IOVA`` of same value.
366 * ``rte_memseg.phys_addr`` is aliased with ``rte_memseg.iova_addr``.
367 * ``rte_mem_virt2phy()`` can often be replaced by ``rte_mem_virt2iova``.
368 * ``rte_malloc_virt2phy`` is aliased with ``rte_malloc_virt2iova``.
369 * ``rte_memzone.phys_addr`` is aliased with ``rte_memzone.iova``.
370 * ``rte_mempool_objhdr.physaddr`` is aliased with ``rte_mempool_objhdr.iova``.
371 * ``rte_mempool_memhdr.phys_addr`` is aliased with ``rte_mempool_memhdr.iova``.
372 * ``rte_mempool_virt2phy()`` can be replaced by ``rte_mempool_virt2iova()``.
373 * ``rte_mempool_populate_phys*()`` are aliased with ``rte_mempool_populate_iova*()``
374 * ``rte_mbuf.buf_physaddr`` is aliased with ``rte_mbuf.buf_iova``.
375 * ``rte_mbuf_data_dma_addr*()`` are aliased with ``rte_mbuf_data_iova*()``.
376 * ``rte_pktmbuf_mtophys*`` are aliased with ``rte_pktmbuf_iova*()``.
378 * **PCI bus API moved outside of the EAL**
380 The PCI bus previously implemented within the EAL has been moved.
381 A first part has been added as an RTE library providing PCI helpers to
382 parse device locations or other such utilities.
383 A second part consisting in the actual bus driver has been moved to its
384 proper subdirectory, without changing its functionalities.
386 As such, several PCI-related functions are not proposed by the EAL anymore:
391 * rte_pci_ioport_read
392 * rte_pci_ioport_unmap
393 * rte_pci_ioport_write
397 * rte_pci_read_config
400 * rte_pci_unmap_device
402 * rte_pci_write_config
404 These functions are made available either as part of ``librte_pci`` or
407 * **Moved vdev bus APIs outside of the EAL**
409 Moved the following APIs from ``librte_eal`` to ``librte_bus_vdev``:
411 * ``rte_vdev_register``
412 * ``rte_vdev_uninit``
413 * ``rte_vdev_unregister``
415 * **Add return value to stats_get dev op API**
417 The ``stats_get`` dev op API return value has been changed to be int.
418 By this way PMDs can return an error value in case of failure at stats
419 getting process time.
421 * **Modified the rte_cryptodev_allocate_driver function in the cryptodev library.**
423 The function ``rte_cryptodev_allocate_driver()`` has been modified.
424 An extra parameter ``struct cryptodev_driver *crypto_drv`` has been added.
426 * **Removed virtual device bus specific functions from librte_cryptodev.**
428 The functions ``rte_cryptodev_vdev_parse_init_params()`` and
429 ``rte_cryptodev_vdev_pmd_init()`` have been removed from librte_cryptodev
430 and have been replaced by non bus specific functions
431 ``rte_cryptodev_pmd_parse_input_args()`` and ``rte_cryptodev_pmd_create()``.
433 * ``rte_cryptodev_create_vdev`` was removed to avoid the dependency on vdev
434 in librte_cryptodev; instead, users can call rte_vdev_init() directly.
436 * **Removed PCI device bus specific functions from librte_cryptodev.**
438 The functions ``rte_cryptodev_pci_generic_probe()`` and
439 ``rte_cryptodev_pci_generic_remove()`` have been removed from librte_cryptodev
440 and have been replaced by non bus specific functions
441 ``rte_cryptodev_pmd_create()`` and ``rte_cryptodev_pmd_destroy()``.
443 * **Removed deprecated functions to manage log level or type.**
445 The functions ``rte_set_log_level()``, ``rte_get_log_level()``,
446 ``rte_set_log_type()`` and ``rte_get_log_type()`` have been removed.
447 They are respectively replaced by ``rte_log_set_global_level()``,
448 ``rte_log_get_global_level()``, ``rte_log_set_level()`` and
449 ``rte_log_get_level()``.
451 * **Removed ``mbuf`` flags ``PKT_RX_VLAN_PKT`` and ``PKT_RX_QINQ_PKT``.**
453 The ``mbuf`` flags ``PKT_RX_VLAN_PKT`` and ``PKT_RX_QINQ_PKT`` have
454 been removed since their behavior were not properly described.
456 * **Added ``mbuf`` flags ``PKT_RX_VLAN`` and ``PKT_RX_QINQ``.**
458 Two ``mbuf`` flags have been added to indicate that the VLAN
459 identifier has been saved in in the ``mbuf`` structure. For instance:
461 - if VLAN is not stripped and TCI is saved: ``PKT_RX_VLAN``
462 - if VLAN is stripped and TCI is saved: ``PKT_RX_VLAN | PKT_RX_VLAN_STRIPPED``
464 * **Modified the vlan_offload_set_t function prototype in the ethdev library.**
466 Changed the function prototype of ``vlan_offload_set_t``. The return value
467 has been changed from ``void`` to ``int`` so the caller to knows whether
468 the backing device supports the operation or if the operation was
469 successfully performed.
475 .. This section should contain ABI changes. Sample format:
477 * Add a short 1-2 sentence description of the ABI change that was announced
478 in the previous releases and made in this release. Use fixed width quotes
479 for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
481 This section is a comment. do not overwrite or remove it.
482 Also, make sure to start the actual text at the margin.
483 =========================================================
485 * **Extended port_id range.**
487 The size of the field ``port_id`` in the ``rte_eth_dev_data`` structure
488 changed, as described in the `New Features` section.
490 * **New parameter added to rte_eth_dev.**
492 New parameter ``security_ctx`` added to ``rte_eth_dev`` to support security
493 operations like IPSec inline.
495 * **New parameter added to rte_cryptodev.**
497 New parameter ``security_ctx`` added to ``rte_cryptodev`` to support security
498 operations like lookaside crypto.
504 .. This section should contain removed items in this release. Sample format:
506 * Add a short 1-2 sentence description of the removed item in the past
509 This section is a comment. do not overwrite or remove it.
510 Also, make sure to start the actual text at the margin.
511 =========================================================
513 * Xen dom0 in EAL was removed, as well as xenvirt PMD and vhost_xen.
515 * The crypto performance unit tests have been removed,
516 replaced by the dpdk-test-crypto-perf application.
519 Shared Library Versions
520 -----------------------
522 .. Update any library version updated in this release and prepend with a ``+``
526 + librte_cfgfile.so.2
529 This section is a comment. do not overwrite or remove it.
530 =========================================================
533 The libraries prepended with a plus sign were incremented in this version.
538 + librte_bitratestats.so.2
539 + librte_bus_vdev.so.1
542 + librte_cryptodev.so.4
543 librte_distributor.so.1
546 + librte_eventdev.so.3
547 + librte_flow_classify.so.1
555 librte_latencystats.so.1
558 + librte_mempool.so.3
565 + librte_pmd_bnxt.so.2
566 + librte_pmd_bond.so.2
567 + librte_pmd_i40e.so.2
568 + librte_pmd_ixgbe.so.2
570 + librte_pmd_softnic.so.1
571 + librte_pmd_vhost.so.2
577 + librte_security.so.1
586 .. This section should contain a list of platforms that were tested with this
591 * <vendor> platform with <vendor> <type of devices> combinations
596 * Other relevant details...
598 This section is a comment. do not overwrite or remove it.
599 Also, make sure to start the actual text at the margin.
600 =========================================================