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 * **nfp: Added PF support.**
94 Previously Netronome's NFP PMD had just support for VFs. PF support is
95 just as a basic DPDK port and has no VF management yet.
97 PF support comes with firmware upload support which allows the PMD to
98 independently work from kernel netdev NFP drivers.
100 NFP 4000 devices are also now supported along with previous 6000 devices.
102 * **Updated bnxt PMD.**
104 Major enhancements include:
106 * Support for Flow API
107 * Support for Tx and Rx descriptor status functions
109 * **Add bus agnostic functions to cryptodev for PMD initialisation**
111 Adds new PMD assist functions ``rte_cryptodev_pmd_parse_input_args()``,
112 ``rte_cryptodev_pmd_create()`` and ``rte_cryptodev_pmd_destroy()`` which
113 are bus independent for driver to manage creation and destruction of new
116 * **Updated QAT crypto PMD.**
118 Performance enhancements:
120 * Removed atomics from the internal queue pair structure.
121 * Coalesce writes to HEAD CSR on response processing.
122 * Coalesce writes to TAIL CSR on request processing.
124 Additional support for:
128 * **Updated the AESNI MB PMD.**
130 The AESNI MB PMD has been updated with additional support for:
133 * DES DOCSIS BPI algorithm.
135 This requires the IPSec Multi-buffer library 0.47. For more details,
136 check out the AESNI MB PMD documenation.
138 * **Updated the OpenSSL PMD.**
140 The OpenSSL PMD has been updated with additional support for:
145 * **Added NXP DPAA SEC crypto PMD.**
147 A new "dpaa_sec" hardware based crypto PMD for NXP DPAA devices has been
148 added. See the "Crypto Device Drivers" document for more details on this
151 * **Added MRVL crypto PMD.**
153 A new crypto PMD has been added, which provides several ciphering and hashing
154 algorithms. All cryptography operations use the MUSDK library crypto API.
156 * **Add new benchmarking mode to dpdk-test-crypto-perf application.**
158 Added new "PMD cyclecount" benchmark mode to dpdk-test-crypto-perf application
159 that displays more detailed breakdown of CPU cycles used by hardware
162 * **Added IOMMU support to libvhost-user**
164 Implemented device IOTLB in Vhost-user backend, and enabled Virtio's IOMMU
167 * **Added the Event Ethernet Adapter Library.**
169 Added the Event Ethernet Adapter library. It provices APIs for
170 eventdev applications to configure the ethdev to eventdev packet flow.
172 * **Added Membership library (rte_member).**
174 Added membership library. It provides an API for DPDK applications to insert a
175 new member, delete an existing member, or query the existence of a member in a
176 given set, or a group of sets. For the case of a group of sets the library
177 will return not only whether the element has been inserted before in one of
178 the sets but also which set it belongs to.
180 The Membership Library is an extension and generalization of a traditional
181 filter (for example Bloom Filter) structure that has multiple usages in a wide
182 variety of workloads and applications. In general, the Membership Library is a
183 data structure that provides a “set-summary” and responds to set-membership
184 queries whether a certain member belongs to a set(s).
186 See the :ref:`Membership Library <Member_Library>` documentation in
187 the Programmers Guide document, for more information.
189 * **Added the Generic Segmentation Offload Library.**
191 Added the Generic Segmentation Offload (GSO) library to enable
192 applications to split large packets (e.g. MTU is 64KB) into small
193 ones (e.g. MTU is 1500B). Supported packet types are:
196 * VxLAN packets, which must have an outer IPv4 header, and contain
197 an inner TCP/IPv4 packet.
198 * GRE packets, which must contain an outer IPv4 header, and inner
201 The GSO library doesn't check if the input packets have correct
202 checksums, and doesn't update checksums for output packets.
203 Additionally, the GSO library doesn't process IP fragmented packets.
205 * **Added the Flow Classification Library.**
207 Added the Flow Classification library, it provides an API for DPDK
208 applications to classify an input packet by matching it against a set of flow
209 rules. It uses the librte_table API to manage the flow rules.
215 .. This section should contain bug fixes added to the relevant
216 sections. Sample format:
218 * **code/section Fixed issue in the past tense with a full stop.**
220 Add a short 1-2 sentence description of the resolved issue in the past
223 The title should contain the code/lib section like a commit message.
225 Add the entries in alphabetic order in the relevant sections below.
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 =========================================================
235 * **Service core fails to call service callback due to atomic lock**
237 In a specific configuration of multi-thread unsafe services and service
238 cores, a service core previously did not correctly release the atomic lock
239 on the service. This would result in the cores polling the service, but it
240 looked like another thread was executing the service callback. The logic for
241 atomic locking of the services has been fixed and refactored for readability.
262 .. This section should contain new known issues in this release. Sample format:
264 * **Add title in present tense with full stop.**
266 Add a short 1-2 sentence description of the known issue in the present
267 tense. Add information on any known workarounds.
269 This section is a comment. do not overwrite or remove it.
270 Also, make sure to start the actual text at the margin.
271 =========================================================
277 .. This section should contain API changes. Sample format:
279 * Add a short 1-2 sentence description of the API change. Use fixed width
280 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
283 This section is a comment. do not overwrite or remove it.
284 Also, make sure to start the actual text at the margin.
285 =========================================================
287 * **Ethdev device name length increased**
289 The size of internal device name is increased to 64 characters
290 to allow for storing longer bus specific name.
292 * **Ethdev flag RTE_ETH_DEV_DETACHABLE was removed**
294 This flag is not necessary anymore, with the new hotplug implementation.
295 It is now removed from the ether library. Its semantic is expressed at the bus
298 * **Service cores API updated for usability**
300 The service cores API has been changed, removing pointers from the API
301 where possible, instead using integer IDs to identify each service. This
302 simplifed application code, aids debugging, and provides better
303 encapsulation. A summary of the main changes made is as follows:
305 * Services identified by ID not by ``rte_service_spec`` pointer
306 * Reduced API surface by using ``set`` functions instead of enable/disable
307 * Reworked ``rte_service_register`` to provide the service ID to registrar
308 * Rework start and stop APIs into ``rte_service_runstate_set``
309 * Added API to set runstate of service implementation to indicate readyness
311 * **The following changes made in mempool library**
313 * Moved ``flags`` datatype from int to unsigned int for ``rte_mempool``.
314 * Removed ``__rte_unused int flag`` param from ``rte_mempool_generic_put``
315 and ``rte_mempool_generic_get`` API.
316 * Added ``flags`` param in ``rte_mempool_xmem_size`` and
317 ``rte_mempool_xmem_usage``.
319 * Xen dom0 in EAL was removed, as well as xenvirt PMD and vhost_xen.
321 * ``rte_mem_phy2mch`` was used in Xen dom0 to obtain the physical address;
322 remove this API as Xen dom0 support was removed.
324 * **Some data type, structure members and functions related to physical address
325 are deprecated and have new alias with IOVA wording.**
327 * ``phys_addr_t`` can be often replaced by ``rte_iova_t`` of same size.
328 * ``RTE_BAD_PHYS_ADDR`` is often replaced by ``RTE_BAD_IOVA`` of same value.
329 * ``rte_memseg.phys_addr`` is aliased with ``rte_memseg.iova_addr``.
330 * ``rte_mem_virt2phy()`` can often be replaced by ``rte_mem_virt2iova``.
331 * ``rte_malloc_virt2phy`` is aliased with ``rte_malloc_virt2iova``.
332 * ``rte_memzone.phys_addr`` is aliased with ``rte_memzone.iova``.
333 * ``rte_mempool_objhdr.physaddr`` is aliased with ``rte_mempool_objhdr.iova``.
334 * ``rte_mempool_memhdr.phys_addr`` is aliased with ``rte_mempool_memhdr.iova``.
335 * ``rte_mempool_virt2phy()`` can be replaced by ``rte_mempool_virt2iova()``.
336 * ``rte_mempool_populate_phys*()`` are aliased with ``rte_mempool_populate_iova*()``
337 * ``rte_mbuf.buf_physaddr`` is aliased with ``rte_mbuf.buf_iova``.
338 * ``rte_mbuf_data_dma_addr*()`` are aliased with ``rte_mbuf_data_iova*()``.
339 * ``rte_pktmbuf_mtophys*`` are aliased with ``rte_pktmbuf_iova*()``.
341 * **PCI bus API moved outside of the EAL**
343 The PCI bus previously implemented within the EAL has been moved.
344 A first part has been added as an RTE library providing PCI helpers to
345 parse device locations or other such utilities.
346 A second part consisting in the actual bus driver has been moved to its
347 proper subdirectory, without changing its functionalities.
349 As such, several PCI-related functions are not proposed by the EAL anymore:
354 * rte_pci_ioport_read
355 * rte_pci_ioport_unmap
356 * rte_pci_ioport_write
360 * rte_pci_read_config
363 * rte_pci_unmap_device
365 * rte_pci_write_config
367 These functions are made available either as part of ``librte_pci`` or
370 * **Add return value to stats_get dev op API**
372 The ``stats_get`` dev op API return value has been changed to be int.
373 By this way PMDs can return an error value in case of failure at stats
374 getting process time.
376 * **Modified the rte_cryptodev_allocate_driver function in the cryptodev library.**
378 The function ``rte_cryptodev_allocate_driver()`` has been modified.
379 An extra parameter ``struct cryptodev_driver *crypto_drv`` has been added.
381 * **Removed virtual device bus specific functions from librte_cryptodev.**
383 The functions ``rte_cryptodev_vdev_parse_init_params()`` and
384 ``rte_cryptodev_vdev_pmd_init()`` have been removed from librte_cryptodev
385 and have been replaced by non bus specific functions
386 ``rte_cryptodev_pmd_parse_input_args()`` and ``rte_cryptodev_pmd_create()``.
388 * **Removed PCI device bus specific functions from librte_cryptodev.**
390 The functions ``rte_cryptodev_pci_generic_probe()`` and
391 ``rte_cryptodev_pci_generic_remove()`` have been removed from librte_cryptodev
392 and have been replaced by non bus specific functions
393 ``rte_cryptodev_pmd_create()`` and ``rte_cryptodev_pmd_destroy()``.
395 * **Removed deprecated functions to manage log level or type.**
397 The functions ``rte_set_log_level()``, ``rte_get_log_level()``,
398 ``rte_set_log_type()`` and ``rte_get_log_type()`` have been removed.
399 They are respectively replaced by ``rte_log_set_global_level()``,
400 ``rte_log_get_global_level()``, ``rte_log_set_level()`` and
401 ``rte_log_get_level()``.
403 * **Removed ``mbuf`` flags ``PKT_RX_VLAN_PKT`` and ``PKT_RX_QINQ_PKT``.**
405 The ``mbuf`` flags ``PKT_RX_VLAN_PKT`` and ``PKT_RX_QINQ_PKT`` have
406 been removed since their behavior were not properly described.
408 * **Added ``mbuf`` flags ``PKT_RX_VLAN`` and ``PKT_RX_QINQ``.**
410 Two ``mbuf`` flags have been added to indicate that the VLAN
411 identifier has been saved in in the ``mbuf`` structure. For instance:
413 - if VLAN is not stripped and TCI is saved: ``PKT_RX_VLAN``
414 - if VLAN is stripped and TCI is saved: ``PKT_RX_VLAN | PKT_RX_VLAN_STRIPPED``
416 * **Modified the vlan_offload_set_t function prototype in the ethdev library.**
418 Changed the function prototype of ``vlan_offload_set_t``. The return value
419 has been changed from ``void`` to ``int`` so the caller to knows whether
420 the backing device supports the operation or if the operation was
421 successfully performed.
427 .. This section should contain ABI changes. Sample format:
429 * Add a short 1-2 sentence description of the ABI change that was announced
430 in the previous releases and made in this release. Use fixed width quotes
431 for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
433 This section is a comment. do not overwrite or remove it.
434 Also, make sure to start the actual text at the margin.
435 =========================================================
437 * **Extended port_id range.**
439 The size of the field ``port_id`` in the ``rte_eth_dev_data`` structure
440 changed, as described in the `New Features` section.
446 .. This section should contain removed items in this release. Sample format:
448 * Add a short 1-2 sentence description of the removed item in the past
451 This section is a comment. do not overwrite or remove it.
452 Also, make sure to start the actual text at the margin.
453 =========================================================
455 * The crypto performance unit tests have been removed,
456 replaced by the dpdk-test-crypto-perf application.
459 Shared Library Versions
460 -----------------------
462 .. Update any library version updated in this release and prepend with a ``+``
466 + librte_cfgfile.so.2
469 This section is a comment. do not overwrite or remove it.
470 =========================================================
473 The libraries prepended with a plus sign were incremented in this version.
478 + librte_bitratestats.so.2
481 + librte_cryptodev.so.4
482 librte_distributor.so.1
485 + librte_eventdev.so.3
486 + librte_flow_classify.so.1
494 librte_latencystats.so.1
504 + librte_pmd_bnxt.so.2
505 + librte_pmd_bond.so.2
506 + librte_pmd_i40e.so.2
507 + librte_pmd_ixgbe.so.2
509 + librte_pmd_softnic.so.1
510 + librte_pmd_vhost.so.2
516 + librte_security.so.1
525 .. This section should contain a list of platforms that were tested with this
530 * <vendor> platform with <vendor> <type of devices> combinations
535 * Other relevant details...
537 This section is a comment. do not overwrite or remove it.
538 Also, make sure to start the actual text at the margin.
539 =========================================================