1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright 2021 The DPDK contributors
4 .. include:: <isonum.txt>
9 .. **Read this first.**
11 The text in the sections below explains how to update the release notes.
13 Use proper spelling, capitalization and punctuation in all sections.
15 Variable and config names should be quoted as fixed width text:
18 Build the docs and view the output file to ensure the changes are correct::
21 xdg-open build/doc/guides/html/rel_notes/release_21_11.html
27 .. This section should contain new features added in this release.
30 * **Add a title in the past tense with a full stop.**
32 Add a short 1-2 sentence description in the past tense.
33 The description should be enough to allow someone scanning
34 the release notes to understand the new feature.
36 If the feature adds a lot of sub-features you can use a bullet list
39 * Added feature foo to do something.
40 * Enhanced feature bar to do something else.
42 Refer to the previous release notes for examples.
44 Suggested order in release notes items:
45 * Core libs (EAL, mempool, ring, mbuf, buses)
46 * Device abstraction libs and PMDs (ordered alphabetically by vendor name)
48 - cryptodev (lib, PMDs)
49 - eventdev (lib, PMDs)
52 * Apps, Examples, Tools (if significant)
54 This section is a comment. Do not overwrite or remove it.
55 Also, make sure to start the actual text at the margin.
56 =======================================================
58 * **Enabled new devargs parser.**
60 * Enabled devargs syntax
61 ``bus=X,paramX=x/class=Y,paramY=y/driver=Z,paramZ=z``
62 * Added bus-level parsing of the devargs syntax.
63 * Kept compatibility with the legacy syntax as parsing fallback.
65 * **Updated EAL hugetlbfs mount handling for Linux.**
67 * Modified to allow ``--huge-dir`` option to specify a sub-directory
68 within a hugetlbfs mountpoint.
70 * **Added dmadev library.**
72 * Added a DMA device framework for management and provision of
73 hardware and software DMA devices.
74 * Added generic API which support a number of different DMA
76 * Added multi-process support.
78 * **Added IDXD dmadev driver implementation.**
80 The IDXD dmadev driver provide device drivers for the Intel DSA devices.
81 This device driver can be used through the generic dmadev API.
83 * **Added IOAT dmadev driver implementation.**
85 The Intel I/O Acceleration Technology (IOAT) dmadev driver provides a device
86 driver for Intel IOAT devices such as Crystal Beach DMA (CBDMA) on Ice Lake,
87 Skylake and Broadwell. This device driver can be used through the generic dmadev API.
89 * **Added support to get all MAC addresses of a device.**
91 Added ``rte_eth_macaddrs_get`` to allow user to retrieve all Ethernet
92 addresses assigned to given ethernet port.
94 * **Added new RSS offload types for IPv4/L4 checksum in RSS flow.**
96 Added macros ETH_RSS_IPV4_CHKSUM and ETH_RSS_L4_CHKSUM, now IPv4 and
97 TCP/UDP/SCTP header checksum field can be used as input set for RSS.
99 * **Added L2TPv2 and PPP protocol support in flow API.**
101 Added flow pattern items and header formats of L2TPv2 and PPP protocol.
103 * **Added flow flex item.**
105 The configurable flow flex item provides the capability to introduce
106 an arbitrary user-specified network protocol header,
107 configure the hardware accordingly, and perform match on this header
108 with desired patterns and masks.
110 * **Added ethdev support to control delivery of Rx metadata from the HW to the PMD.**
112 A new API, ``rte_eth_rx_metadata_negotiate()``, was added.
113 The following parts of Rx metadata were defined:
115 * ``RTE_ETH_RX_METADATA_USER_FLAG``
116 * ``RTE_ETH_RX_METADATA_USER_MARK``
117 * ``RTE_ETH_RX_METADATA_TUNNEL_ID``
119 * **Added an API to get a proxy port to manage "transfer" flows.**
121 A new API, ``rte_flow_pick_transfer_proxy()``, was added.
123 * **Added ethdev shared Rx queue support.**
125 * Added new device capability flag and Rx domain field to switch info.
126 * Added share group and share queue ID to Rx queue configuration.
127 * Added testpmd support and dedicate forwarding engine.
129 * **Updated af_packet ethdev driver.**
131 * Default VLAN strip behavior was changed. VLAN tag won't be stripped
132 unless ``DEV_RX_OFFLOAD_VLAN_STRIP`` offload is enabled.
134 * **Added API to get device configuration in ethdev.**
136 Added an ethdev API which can help users get device configuration.
138 * **Updated AF_XDP PMD.**
140 * Disabled secondary process support.
142 * **Updated Amazon ENA PMD.**
144 Updated the Amazon ENA PMD. The new driver version (v2.5.0) introduced
145 bug fixes and improvements, including:
147 * Support for the tx_free_thresh and rx_free_thresh configuration parameters.
148 * NUMA aware allocations for the queue helper structures.
149 * Watchdog's feature which is checking for missing Tx completions.
151 * **Updated Broadcom bnxt PMD.**
153 * Added flow offload support for Thor.
154 * Implement support for tunnel offload.
155 * Updated HWRM API to version 1.10.2.44
157 * **Updated Intel e1000 emulated driver.**
159 * Added Intel e1000 support on Windows.
161 * **Updated Intel iavf driver.**
163 * Added Intel iavf support on Windows.
164 * Added IPv4 and L4 (TCP/UDP/SCTP) checksum hash support in RSS flow.
165 * Added PPPoL2TPv2oUDP RSS hash based on inner IP address and TCP/UDP port.
166 * Added Intel iavf inline crypto support.
168 * **Updated Intel ice driver.**
170 * Added protocol agnostic flow offloading support in Flow Director.
171 * Added protocol agnostic flow offloading support in RSS hash.
172 * Added 1PPS out support by a devargs.
173 * Added IPv4 and L4 (TCP/UDP/SCTP) checksum hash support in RSS flow.
174 * Added DEV_RX_OFFLOAD_TIMESTAMP support.
175 * Added timesync API support under scalar path.
177 * **Updated Intel ixgbe driver.**
179 * Added Intel ixgbe support on Windows.
181 * **Updated Marvell cnxk ethdev driver.**
183 * Added rte_flow support for dual VLAN insert and strip actions.
184 * Added rte_tm support.
185 * Added support for Inline IPsec for CN9K event mode and CN10K
186 poll mode and event mode.
187 * Added support for ingress meter for CN10K platform.
189 * **Updated Mellanox mlx5 driver.**
191 Updated the Mellanox mlx5 driver with new features and improvements, including:
193 * Added implicit mempool registration to avoid data path hiccups (opt-out).
194 * Added NIC offloads for the PMD on Windows (TSO, VLAN strip, CRC keep).
195 * Added socket direct mode bonding support.
197 * **Updated Solarflare network PMD.**
199 Updated the Solarflare ``sfc_efx`` driver with changes including:
201 * Added port representors support on SN1000 SmartNICs
202 * Added flow API transfer proxy support
204 * **Added power monitor API in vhost library.**
206 Added an API to support power monitor in vhost library.
208 * **Updated vhost PMD.**
210 Add power monitor support in vhost PMD.
212 * **Updated virtio PMD.**
214 * Initial support for RSS receive mode has been added to the Virtio PMD,
215 with the capability for the application to configure the hash key,
216 the RETA and the hash types.
217 Virtio hash reporting is yet to be added.
218 * Added power monitor support in virtio PMD.
220 * **Updated Wangxun ngbe driver.**
222 * Added offloads and packet type on RxTx.
223 * Added VLAN and MAC filters.
224 * Added device basic statistics and extended stats.
225 * Added multi-queue and RSS.
227 * Added flow control.
230 * **Updated Marvell cnxk crypto PMD.**
232 * Added AES-CBC SHA1-HMAC support in lookaside protocol (IPsec) for CN10K.
233 * Added Transport mode support in lookaside protocol (IPsec) for CN10K.
234 * Added UDP encapsulation support in lookaside protocol (IPsec) for CN10K.
235 * Added support for lookaside protocol (IPsec) offload for CN9K.
236 * Added support for ZUC algorithm with 256-bit key length for CN10K.
237 * Added support for CN98xx dual block.
238 * Added inner checksum support in lookaside protocol (IPsec) for CN10K.
240 * **Added support for event crypto adapter on Marvell CN10K and CN9K.**
242 * Added event crypto adapter OP_FORWARD mode support.
244 * **Updated NXP dpaa_sec crypto PMD.**
246 * Added DES-CBC, AES-XCBC-MAC, AES-CMAC and non-HMAC algo support.
247 * Added PDCP short MAC-I support.
248 * Added raw vector datapath API support.
250 * **Updated NXP dpaa2_sec crypto PMD.**
252 * Added PDCP short MAC-I support.
253 * Added raw vector datapath API support.
255 * **Added framework for consolidation of IPsec_MB dependent SW Crypto PMDs.**
257 * The IPsec_MB framework was added to share common code between Intel
258 SW Crypto PMDs that depend on the intel-ipsec-mb library.
259 * Multiprocess support was added for the consolidated PMDs,
260 which requires v1.1 of the intel-ipsec-mb library.
261 * The following PMDs were moved into a single source folder,
262 however their usage and EAL options remain unchanged.
268 * CHACHA20_POLY1305 - A new PMD added.
270 * **Updated the aesni_mb crypto PMD.**
272 * Added support for ZUC-EEA3-256 and ZUC-EIA3-256.
274 * **Added digest appended ops support for Snow3G PMD.**
276 * Added support for out-of-place auth-cipher operations that encrypt
277 the digest along with the rest of the raw data.
278 * Added support for partially encrypted digest when using auth-cipher
281 * **Updated the ACC100 bbdev PMD.**
283 Added support for more comprehensive CRC options.
285 * **Updated the turbo_sw bbdev PMD.**
287 Added support for more comprehensive CRC options.
289 * **Added NXP LA12xx baseband PMD.**
291 * Added a new baseband PMD driver for NXP LA12xx Software defined radio.
292 * See the :doc:`../bbdevs/la12xx` for more details.
294 * **Updated Mellanox regex driver.**
296 * Added support for new ROF file format.
298 * **Updated IPsec library.**
300 * Added support for more AEAD algorithms AES_CCM, CHACHA20_POLY1305
302 * Added support for NAT-T / UDP encapsulated ESP.
303 * Added support for SA telemetry.
304 * Added support for setting a non default starting ESN value.
306 * **Added optimized Toeplitz hash implementation.**
308 Added optimized Toeplitz hash implementation using Galois Fields New Instructions.
310 * **Added multi-process support for testpmd.**
312 Added command-line options to specify total number of processes and
313 current process ID. Each process owns subset of Rx and Tx queues.
315 * **Updated test-crypto-perf application with new cases.**
317 * Added support for asymmetric crypto throughput performance measurement.
318 Only modex is supported for now.
319 * Added support for lookaside IPsec protocol offload throughput measurement.
321 * **Added lookaside protocol (IPsec) tests in dpdk-test.**
323 * Added known vector tests (AES-GCM 128, 192, 256).
324 * Added tests to verify error reporting with ICV corruption.
325 * Added tests to verify IV generation.
326 * Added tests to verify UDP encapsulation.
327 * Added tests to verify UDP encapsulation ports.
328 * Added tests to validate packets soft expiry.
329 * Added tests to validate packets hard expiry.
330 * Added tests to verify tunnel header verification in IPsec inbound.
331 * Added tests to verify inner checksum.
332 * Added tests for CHACHA20_POLY1305 PMD, including a new testcase for SGL OOP.
334 * **Revised packet capture framework.**
336 * New dpdk-dumpcap program that has most of the features
337 of the wireshark dumpcap utility including:
338 capture of multiple interfaces, filtering,
339 and stopping after number of bytes, packets.
340 * New library for writing pcapng packet capture files.
341 * Enhancements to the pdump library to support:
342 * Packet filter with BPF.
343 * Pcapng format with timestamps and meta-data.
344 * Fixes packet capture with stripped VLAN tags.
346 * **Added ASan support.**
349 <https://github.com/google/sanitizers/wiki/AddressSanitizer>`_ (ASan)
350 is a widely-used debugging tool to detect memory access errors.
351 It helps to detect issues like use-after-free, various kinds of buffer
352 overruns in C/C++ programs, and other similar errors, as well as
353 printing out detailed debug information whenever an error is detected.
359 .. This section should contain removed items in this release. Sample format:
361 * Add a short 1-2 sentence description of the removed item
364 This section is a comment. Do not overwrite or remove it.
365 Also, make sure to start the actual text at the margin.
366 =======================================================
368 * eal: Removed the deprecated function ``rte_get_master_lcore()``
369 and the iterator macro ``RTE_LCORE_FOREACH_SLAVE``.
371 * eal: The old api arguments that were deprecated for
372 blacklist/whitelist are removed. Users must use the new
373 block/allow list arguments.
375 * mbuf: Removed offload flag ``PKT_RX_EIP_CKSUM_BAD``.
376 ``PKT_RX_OUTER_IP_CKSUM_BAD`` should be used as a replacement.
378 * ethdev: Removed the port mirroring API. A more fine-grain flow API
379 action ``RTE_FLOW_ACTION_TYPE_SAMPLE`` should be used instead.
380 The structures ``rte_eth_mirror_conf`` and ``rte_eth_vlan_mirror`` and
381 the functions ``rte_eth_mirror_rule_set`` and
382 ``rte_eth_mirror_rule_reset`` along with the associated macros
383 ``ETH_MIRROR_*`` are removed.
385 * ethdev: Removed ``rte_eth_rx_descriptor_done`` API function and its
386 driver callback. It is replaced by the more complete function
387 ``rte_eth_rx_descriptor_status``.
389 * ethdev: Removed deprecated ``shared`` attribute of the
390 ``struct rte_flow_action_count``. Shared counters should be managed
391 using indirect actions API (``rte_flow_action_handle_create`` etc).
393 * i40e: Removed i40evf driver.
394 iavf already became the default VF driver for i40e devices,
395 so there is no need to maintain i40evf.
401 .. This section should contain API changes. Sample format:
403 * sample: Add a short 1-2 sentence description of the API change
404 which was announced in the previous releases and made in this release.
405 Start with a scope label like "ethdev:".
406 Use fixed width quotes for ``function_names`` or ``struct_names``.
409 This section is a comment. Do not overwrite or remove it.
410 Also, make sure to start the actual text at the margin.
411 =======================================================
413 * eal: The lcore state ``FINISHED`` is removed from
414 the ``enum rte_lcore_state_t``.
415 The lcore state ``WAIT`` is enough to represent the same state.
417 * kvargs: The experimental function ``rte_kvargs_strcmp()`` has been
418 removed. Its usages have been replaced by a new function
419 ``rte_kvargs_get_with_value()``.
421 * cmdline: ``cmdline_stdin_exit()`` now frees the ``cmdline`` structure.
422 Calls to ``cmdline_free()`` after it need to be deleted from applications.
424 * cmdline: Made ``cmdline`` structure definition hidden on Linux and FreeBSD.
426 * cmdline: Made ``rdline`` structure definition hidden. Functions are added
427 to dynamically allocate and free it, and to access user data in callbacks.
429 * mempool: Added ``RTE_MEMPOOL_F_NON_IO`` flag to give a hint to DPDK components
430 that objects from this pool will not be used for device IO (e.g. DMA).
432 * mempool: The mempool flags ``MEMPOOL_F_*`` will be deprecated in the future.
433 Newly added flags with ``RTE_MEMPOOL_F_`` prefix should be used instead.
435 * mempool: Helper macro ``MEMPOOL_HEADER_SIZE()`` is deprecated.
436 The replacement macro ``RTE_MEMPOOL_HEADER_SIZE()`` is internal only.
438 * mempool: Macro to register mempool driver ``MEMPOOL_REGISTER_OPS()`` is
439 deprecated. Use replacement ``RTE_MEMPOOL_REGISTER_OPS()``.
441 * mempool: The mempool API macros ``MEMPOOL_PG_*`` are deprecated and
442 will be removed in DPDK 22.11.
444 * mbuf: The mbuf offload flags ``PKT_*`` are renamed as ``RTE_MBUF_F_*``. A
445 compatibility layer will be kept until DPDK 22.11.
446 * net: Renamed ``s_addr`` and ``d_addr`` fields of ``rte_ether_hdr`` structure
447 to ``src_addr`` and ``dst_addr``, respectively.
449 * net: Added ``version`` and ``ihl`` bit-fields to ``struct rte_ipv4_hdr``.
450 Existing ``version_ihl`` field is kept for backward compatibility.
452 * ethdev: Added items and actions ``PORT_REPRESENTOR``, ``REPRESENTED_PORT`` to
455 * ethdev: Deprecated items and actions ``PF``, ``VF``, ``PHY_PORT``, ``PORT_ID``.
456 Suggested items and actions ``PORT_REPRESENTOR``, ``REPRESENTED_PORT`` instead.
458 * ethdev: Deprecated the use of attributes ``ingress`` / ``egress`` combined
459 with ``transfer``. See items ``PORT_REPRESENTOR``, ``REPRESENTED_PORT``.
461 * ethdev: ``rte_flow_action_modify_data`` structure updated, immediate data
462 array is extended, data pointer field is explicitly added to union, the
463 action behavior is defined in more strict fashion and documentation updated.
464 The immediate value behavior has been changed, the entire immediate field
465 should be provided, and offset for immediate source bitfield is assigned
466 from destination one.
468 * vhost: ``rte_vdpa_register_device``, ``rte_vdpa_unregister_device``,
469 ``rte_vhost_host_notifier_ctrl`` and ``rte_vdpa_relay_vring_used`` vDPA
470 driver interface are marked as internal.
472 * cryptodev: The API rte_cryptodev_pmd_is_valid_dev is modified to
473 rte_cryptodev_is_valid_dev as it can be used by the application as
474 well as PMD to check whether the device is valid or not.
476 * cryptodev: The rte_cryptodev_pmd.* files are renamed as cryptodev_pmd.*
477 as it is for drivers only and should be private to DPDK, and not
478 installed for app use.
480 * cryptodev: A ``reserved`` byte from structure ``rte_crypto_op`` was
481 renamed to ``aux_flags`` to indicate warnings and other information from
482 the crypto/security operation. This field will be used to communicate
483 events such as soft expiry with IPsec in lookaside mode.
485 * cryptodev: The field ``dataunit_len`` of the ``struct rte_crypto_cipher_xform``
486 moved to the end of the structure and extended to ``uint32_t``.
488 * cryptodev: The structure ``rte_crypto_vec`` was updated to add ``tot_len``
489 field to support total buffer length to facilitate protocol offload case.
491 * cryptodev: The structure ``rte_crypto_sym_vec`` was updated to add
492 ``dest_sgl`` to support out of place processing.
494 * bbdev: Added device info related to data byte endianness processing.
496 * eventdev: Moved memory used by timer adapters to hugepage. This will prevent
497 TLB misses if any and aligns to memory structure of other subsystems.
499 * fib: Added the ``rib_ext_sz`` field to ``rte_fib_conf`` and ``rte_fib6_conf``
500 so that user can specify the size of the RIB extension inside the FIB.
506 .. This section should contain ABI changes. Sample format:
508 * sample: Add a short 1-2 sentence description of the ABI change
509 which was announced in the previous releases and made in this release.
510 Start with a scope label like "ethdev:".
511 Use fixed width quotes for ``function_names`` or ``struct_names``.
514 This section is a comment. Do not overwrite or remove it.
515 Also, make sure to start the actual text at the margin.
516 =======================================================
518 * ethdev: All enums & macros updated to have ``RTE_ETH`` prefix and structures
519 updated to have ``rte_eth`` prefix. DPDK components updated to use new names.
521 * ethdev: Input parameters for ``eth_rx_queue_count_t`` was changed.
522 Instead of pointer to ``rte_eth_dev`` and queue index, now it accepts pointer
523 to internal queue data as input parameter. While this change is transparent
524 to user, it still counts as an ABI change, as ``eth_rx_queue_count_t``
525 is used by public inline function ``rte_eth_rx_queue_count``.
527 * ethdev: Made ``rte_eth_dev``, ``rte_eth_dev_data``, ``rte_eth_rxtx_callback``
528 private data structures. ``rte_eth_devices[]`` can't be accessed directly
529 by user any more. While it is an ABI breakage, this change is intended
530 to be transparent for both users (no changes in user app is required) and
531 PMD developers (no changes in PMD is required).
533 * vhost: rename ``struct vhost_device_ops`` to ``struct rte_vhost_device_ops``.
535 * cryptodev: Made ``rte_cryptodev``, ``rte_cryptodev_data`` private
536 structures internal to DPDK. ``rte_cryptodevs`` can't be accessed directly
537 by user any more. While it is an ABI breakage, this change is intended
538 to be transparent for both users (no changes in user app is required) and
539 PMD developers (no changes in PMD is required).
541 * security: ``rte_security_set_pkt_metadata`` and ``rte_security_get_userdata``
542 routines used by inline outbound and inline inbound security processing were
543 made inline and enhanced to do simple 64-bit set/get for PMDs that do not
544 have much processing in PMD specific callbacks but just 64-bit set/get.
545 This avoids a per packet function pointer jump overhead for such PMDs.
547 * security: A new option ``iv_gen_disable`` was added in structure
548 ``rte_security_ipsec_sa_options`` to disable IV generation inside PMD,
549 so that application can provide its own IV and test known test vectors.
551 * security: A new option ``tunnel_hdr_verify`` was added in structure
552 ``rte_security_ipsec_sa_options`` to indicate whether outer header
553 verification need to be done as part of inbound IPsec processing.
555 * security: A new option ``udp_ports_verify`` was added in structure
556 ``rte_security_ipsec_sa_options`` to indicate whether UDP ports
557 verification need to be done as part of inbound IPsec processing.
559 * security: A new structure ``rte_security_ipsec_lifetime`` was added to
560 replace ``esn_soft_limit`` in IPsec configuration structure
561 ``rte_security_ipsec_xform`` to allow applications to configure SA soft
562 and hard expiry limits. Limits can be either in number of packets or bytes.
564 * security: The new options ``ip_csum_enable`` and ``l4_csum_enable`` were added
565 in structure ``rte_security_ipsec_sa_options`` to indicate whether inner
566 packet IPv4 header checksum and L4 checksum need to be offloaded to
569 * security: A new structure ``esn`` was added in structure
570 ``rte_security_ipsec_xform`` to set an initial ESN value. This permits
571 application to start from an arbitrary ESN value for debug and SA lifetime
572 enforcement purposes.
574 * security: A new structure ``udp`` was added in structure
575 ``rte_security_ipsec_xform`` to allow setting the source and destination ports
576 for UDP encapsulated IPsec traffic.
578 * bbdev: Added capability related to more comprehensive CRC options,
579 shifting values of the ``enum rte_bbdev_op_ldpcdec_flag_bitmasks``.
581 * eventdev: New variables ``rx_event_buf_count`` and ``rx_event_buf_size``
582 were added in structure ``rte_event_eth_rx_adapter_stats`` to get additional
585 * eventdev: A new structure ``rte_event_fp_ops`` has been added which is now used
586 by the fastpath inline functions. The structures ``rte_eventdev``,
587 ``rte_eventdev_data`` have been made internal. ``rte_eventdevs[]`` can't be
588 accessed directly by user any more. This change is transparent to both
589 applications and PMDs.
591 * eventdev: Re-arranged fields in ``rte_event_timer`` to remove holes.
597 .. This section should contain new known issues in this release. Sample format:
599 * **Add title in present tense with full stop.**
601 Add a short 1-2 sentence description of the known issue
602 in the present tense. Add information on any known workarounds.
604 This section is a comment. Do not overwrite or remove it.
605 Also, make sure to start the actual text at the margin.
606 =======================================================
612 .. This section should contain a list of platforms that were tested
617 * <vendor> platform with <vendor> <type of devices> combinations
622 * Other relevant details...
624 This section is a comment. Do not overwrite or remove it.
625 Also, make sure to start the actual text at the margin.
626 =======================================================