net/vhost: support power monitor

[dpdk.git] / doc / guides / rel_notes / release_21_11.rst

diff --git a/doc/guides/rel_notes/release_21_11.rst b/doc/guides/rel_notes/release_21_11.rst
index 6fb3164..8f260d3 100644 (file)
--- a/doc/guides/rel_notes/release_21_11.rst
+++ b/doc/guides/rel_notes/release_21_11.rst
@@ -75,6 +75,17 @@ New Features
     operations.
   * Added multi-process support.
 
     operations.
   * Added multi-process support.
 

+* **Added IDXD dmadev driver implementation.**
+
+  The IDXD dmadev driver provide device drivers for the Intel DSA devices.
+  This device driver can be used through the generic dmadev API.
+
+* **Added IOAT dmadev driver implementation.**
+
+  The Intel I/O Acceleration Technology (IOAT) dmadev driver provides a device
+  driver for Intel IOAT devices such as Crystal Beach DMA (CBDMA) on Ice Lake,
+  Skylake and Broadwell. This device driver can be used through the generic dmadev API.
+

 * **Added support to get all MAC addresses of a device.**
 
   Added ``rte_eth_macaddrs_get`` to allow user to retrieve all Ethernet
 * **Added support to get all MAC addresses of a device.**
 
   Added ``rte_eth_macaddrs_get`` to allow user to retrieve all Ethernet


@@ -85,6 +96,17 @@ New Features
   Added macros ETH_RSS_IPV4_CHKSUM and ETH_RSS_L4_CHKSUM, now IPv4 and
   TCP/UDP/SCTP header checksum field can be used as input set for RSS.
 
   Added macros ETH_RSS_IPV4_CHKSUM and ETH_RSS_L4_CHKSUM, now IPv4 and
   TCP/UDP/SCTP header checksum field can be used as input set for RSS.
 

+* **Added L2TPv2 and PPP protocol support in flow API.**
+
+  Added flow pattern items and header formats of L2TPv2 and PPP protocol.
+
+* **Added flow flex item.**
+
+  The configurable flow flex item provides the capability to introduce
+  an arbitrary user-specified network protocol header,
+  configure the hardware accordingly, and perform match on this header
+  with desired patterns and masks.
+

 * **Added ethdev support to control delivery of Rx metadata from the HW to the PMD.**
 
   A new API, ``rte_eth_rx_metadata_negotiate()``, was added.
 * **Added ethdev support to control delivery of Rx metadata from the HW to the PMD.**
 
   A new API, ``rte_eth_rx_metadata_negotiate()``, was added.


@@ -94,25 +116,54 @@ New Features
   * ``RTE_ETH_RX_METADATA_USER_MARK``
   * ``RTE_ETH_RX_METADATA_TUNNEL_ID``
 
   * ``RTE_ETH_RX_METADATA_USER_MARK``
   * ``RTE_ETH_RX_METADATA_TUNNEL_ID``
 

+* **Added an API to get a proxy port to manage "transfer" flows.**
+
+  A new API, ``rte_flow_pick_transfer_proxy()``, was added.
+
+* **Added ethdev shared Rx queue support.**
+
+  * Added new device capability flag and Rx domain field to switch info.
+  * Added share group and share queue ID to Rx queue configuration.
+  * Added testpmd support and dedicate forwarding engine.
+

 * **Updated af_packet ethdev driver.**
 
   * Default VLAN strip behavior was changed. VLAN tag won't be stripped
     unless ``DEV_RX_OFFLOAD_VLAN_STRIP`` offload is enabled.
 
 * **Updated af_packet ethdev driver.**
 
   * Default VLAN strip behavior was changed. VLAN tag won't be stripped
     unless ``DEV_RX_OFFLOAD_VLAN_STRIP`` offload is enabled.
 

+* **Added API to get device configuration in ethdev.**
+
+  Added an ethdev API which can help users get device configuration.
+

 * **Updated AF_XDP PMD.**
 
   * Disabled secondary process support.
 
 * **Updated AF_XDP PMD.**
 
   * Disabled secondary process support.
 

+* **Updated Amazon ENA PMD.**
+
+  Updated the Amazon ENA PMD. The new driver version (v2.5.0) introduced
+  bug fixes and improvements, including:
+
+  * Support for the tx_free_thresh and rx_free_thresh configuration parameters.
+  * NUMA aware allocations for the queue helper structures.
+  * Watchdog's feature which is checking for missing Tx completions.
+

 * **Updated Broadcom bnxt PMD.**
 
   * Added flow offload support for Thor.
   * Implement support for tunnel offload.
   * Updated HWRM API to version 1.10.2.44
 
 * **Updated Broadcom bnxt PMD.**
 
   * Added flow offload support for Thor.
   * Implement support for tunnel offload.
   * Updated HWRM API to version 1.10.2.44
 

+* **Updated Intel e1000 emulated driver.**
+
+  * Added Intel e1000 support on Windows.
+

 * **Updated Intel iavf driver.**
 
   * Added Intel iavf support on Windows.
   * Added IPv4 and L4 (TCP/UDP/SCTP) checksum hash support in RSS flow.
 * **Updated Intel iavf driver.**
 
   * Added Intel iavf support on Windows.
   * Added IPv4 and L4 (TCP/UDP/SCTP) checksum hash support in RSS flow.

+  * Added PPPoL2TPv2oUDP RSS hash based on inner IP address and TCP/UDP port.
+  * Added Intel iavf inline crypto support.

 
 * **Updated Intel ice driver.**
 
 
 * **Updated Intel ice driver.**
 


@@ -131,6 +182,7 @@ New Features
   * Added rte_tm support.
   * Added support for Inline IPsec for CN9K event mode and CN10K
     poll mode and event mode.
   * Added rte_tm support.
   * Added support for Inline IPsec for CN9K event mode and CN10K
     poll mode and event mode.

+  * Added support for ingress meter for CN10K platform.

 
 * **Updated Mellanox mlx5 driver.**
 
 
 * **Updated Mellanox mlx5 driver.**
 


@@ -138,12 +190,30 @@ New Features
 
   * Added implicit mempool registration to avoid data path hiccups (opt-out).
   * Added NIC offloads for the PMD on Windows (TSO, VLAN strip, CRC keep).
 
   * Added implicit mempool registration to avoid data path hiccups (opt-out).
   * Added NIC offloads for the PMD on Windows (TSO, VLAN strip, CRC keep).

+  * Added socket direct mode bonding support.

 
 * **Updated Solarflare network PMD.**
 
   Updated the Solarflare ``sfc_efx`` driver with changes including:
 
   * Added port representors support on SN1000 SmartNICs
 
 * **Updated Solarflare network PMD.**
 
   Updated the Solarflare ``sfc_efx`` driver with changes including:
 
   * Added port representors support on SN1000 SmartNICs

+  * Added flow API transfer proxy support
+
+* **Added power monitor API in vhost library.**
+
+  Added an API to support power monitor in vhost library.
+
+* **Updated vhost PMD.**
+
+  Add power monitor support in vhost PMD.
+
+* **Updated virtio PMD.**
+
+  * Initial support for RSS receive mode has been added to the Virtio PMD,
+    with the capability for the application to configure the hash key,
+    the RETA and the hash types.
+    Virtio hash reporting is yet to be added.
+  * Added power monitor support in virtio PMD.

 
 * **Updated Marvell cnxk crypto PMD.**
 
 
 * **Updated Marvell cnxk crypto PMD.**
 


@@ -170,6 +240,32 @@ New Features
   * Added PDCP short MAC-I support.
   * Added raw vector datapath API support.
 
   * Added PDCP short MAC-I support.
   * Added raw vector datapath API support.
 

+* **Added framework for consolidation of IPsec_MB dependent SW Crypto PMDs.**
+
+  * The IPsec_MB framework was added to share common code between Intel
+    SW Crypto PMDs that depend on the intel-ipsec-mb library.
+  * Multiprocess support was added for the consolidated PMDs,
+    which requires v1.1 of the intel-ipsec-mb library.
+  * The following PMDs were moved into a single source folder,
+    however their usage and EAL options remain unchanged.
+    * AESNI_MB PMD.
+    * AESNI_GCM PMD.
+    * KASUMI PMD.
+    * SNOW3G PMD.
+    * ZUC PMD.
+    * CHACHA20_POLY1305 - A new PMD added.
+
+* **Updated the aesni_mb crypto PMD.**
+
+  * Added support for ZUC-EEA3-256 and ZUC-EIA3-256.
+
+* **Added digest appended ops support for Snow3G PMD.**
+
+  * Added support for out-of-place auth-cipher operations that encrypt
+    the digest along with the rest of the raw data.
+  * Added support for partially encrypted digest when using auth-cipher
+    operations.
+

 * **Updated the ACC100 bbdev PMD.**
 
   Added support for more comprehensive CRC options.
 * **Updated the ACC100 bbdev PMD.**
 
   Added support for more comprehensive CRC options.


@@ -183,6 +279,10 @@ New Features
   * Added a new baseband PMD driver for NXP LA12xx Software defined radio.
   * See the :doc:`../bbdevs/la12xx` for more details.
 
   * Added a new baseband PMD driver for NXP LA12xx Software defined radio.
   * See the :doc:`../bbdevs/la12xx` for more details.
 

+* **Updated Mellanox regex driver.**
+
+  * Added support for new ROF file format.
+

 * **Updated IPsec library.**
 
   * Added support for more AEAD algorithms AES_CCM, CHACHA20_POLY1305
 * **Updated IPsec library.**
 
   * Added support for more AEAD algorithms AES_CCM, CHACHA20_POLY1305


@@ -191,6 +291,10 @@ New Features
   * Added support for SA telemetry.
   * Added support for setting a non default starting ESN value.
 
   * Added support for SA telemetry.
   * Added support for setting a non default starting ESN value.
 

+* **Added optimized Toeplitz hash implementation.**
+
+  Added optimized Toeplitz hash implementation using Galois Fields New Instructions.
+

 * **Added multi-process support for testpmd.**
 
   Added command-line options to specify total number of processes and
 * **Added multi-process support for testpmd.**
 
   Added command-line options to specify total number of processes and


@@ -213,6 +317,28 @@ New Features
   * Added tests to validate packets hard expiry.
   * Added tests to verify tunnel header verification in IPsec inbound.
   * Added tests to verify inner checksum.
   * Added tests to validate packets hard expiry.
   * Added tests to verify tunnel header verification in IPsec inbound.
   * Added tests to verify inner checksum.

+  * Added tests for CHACHA20_POLY1305 PMD, including a new testcase for SGL OOP.
+
+* **Revised packet capture framework.**
+
+  * New dpdk-dumpcap program that has most of the features
+    of the wireshark dumpcap utility including:
+    capture of multiple interfaces, filtering,
+    and stopping after number of bytes, packets.
+  * New library for writing pcapng packet capture files.
+  * Enhancements to the pdump library to support:
+    * Packet filter with BPF.
+    * Pcapng format with timestamps and meta-data.
+    * Fixes packet capture with stripped VLAN tags.
+
+* **Added ASan support.**
+
+  `AddressSanitizer
+  <https://github.com/google/sanitizers/wiki/AddressSanitizer>`_ (ASan)
+  is a widely-used debugging tool to detect memory access errors.
+  It helps to detect issues like use-after-free, various kinds of buffer
+  overruns in C/C++ programs, and other similar errors, as well as
+  printing out detailed debug information whenever an error is detected.

 
 
 Removed Items
 
 
 Removed Items


@@ -272,10 +398,22 @@ API Changes
    Also, make sure to start the actual text at the margin.
    =======================================================
 
    Also, make sure to start the actual text at the margin.
    =======================================================
 

+* eal: The lcore state ``FINISHED`` is removed from
+  the ``enum rte_lcore_state_t``.
+  The lcore state ``WAIT`` is enough to represent the same state.
+

 * kvargs: The experimental function ``rte_kvargs_strcmp()`` has been
   removed. Its usages have been replaced by a new function
   ``rte_kvargs_get_with_value()``.
 
 * kvargs: The experimental function ``rte_kvargs_strcmp()`` has been
   removed. Its usages have been replaced by a new function
   ``rte_kvargs_get_with_value()``.
 

+* cmdline: ``cmdline_stdin_exit()`` now frees the ``cmdline`` structure.
+  Calls to ``cmdline_free()`` after it need to be deleted from applications.
+
+* cmdline: Made ``cmdline`` structure definition hidden on Linux and FreeBSD.
+
+* cmdline: Made ``rdline`` structure definition hidden. Functions are added
+  to dynamically allocate and free it, and to access user data in callbacks.
+

 * mempool: Added ``RTE_MEMPOOL_F_NON_IO`` flag to give a hint to DPDK components
   that objects from this pool will not be used for device IO (e.g. DMA).
 
 * mempool: Added ``RTE_MEMPOOL_F_NON_IO`` flag to give a hint to DPDK components
   that objects from this pool will not be used for device IO (e.g. DMA).
 


@@ -291,10 +429,29 @@ API Changes
 * mempool: The mempool API macros ``MEMPOOL_PG_*`` are deprecated and
   will be removed in DPDK 22.11.
 
 * mempool: The mempool API macros ``MEMPOOL_PG_*`` are deprecated and
   will be removed in DPDK 22.11.
 

+* mbuf: The mbuf offload flags ``PKT_*`` are renamed as ``RTE_MBUF_F_*``. A
+  compatibility layer will be kept until DPDK 22.11.

 * net: Renamed ``s_addr`` and ``d_addr`` fields of ``rte_ether_hdr`` structure
   to ``src_addr`` and ``dst_addr``, respectively.
 
 * net: Renamed ``s_addr`` and ``d_addr`` fields of ``rte_ether_hdr`` structure
   to ``src_addr`` and ``dst_addr``, respectively.
 

-* ethdev: Added item ``PORT_REPRESENTOR`` to flow API.
+* net: Added ``version`` and ``ihl`` bit-fields to ``struct rte_ipv4_hdr``.
+  Existing ``version_ihl`` field is kept for backward compatibility.
+
+* ethdev: Added items and actions ``PORT_REPRESENTOR``, ``REPRESENTED_PORT`` to
+  flow API.
+
+* ethdev: Deprecated items and actions ``PF``, ``VF``, ``PHY_PORT``, ``PORT_ID``.
+  Suggested items and actions ``PORT_REPRESENTOR``, ``REPRESENTED_PORT`` instead.
+
+* ethdev: Deprecated the use of attributes ``ingress`` / ``egress`` combined
+  with ``transfer``. See items ``PORT_REPRESENTOR``, ``REPRESENTED_PORT``.
+
+* ethdev: ``rte_flow_action_modify_data`` structure updated, immediate data
+  array is extended, data pointer field is explicitly added to union, the
+  action behavior is defined in more strict fashion and documentation updated.
+  The immediate value behavior has been changed, the entire immediate field
+  should be provided, and offset for immediate source bitfield is assigned
+  from destination one.

 
 * cryptodev: The API rte_cryptodev_pmd_is_valid_dev is modified to
   rte_cryptodev_is_valid_dev as it can be used by the application as
 
 * cryptodev: The API rte_cryptodev_pmd_is_valid_dev is modified to
   rte_cryptodev_is_valid_dev as it can be used by the application as


@@ -320,6 +477,12 @@ API Changes
 
 * bbdev: Added device info related to data byte endianness processing.
 
 
 * bbdev: Added device info related to data byte endianness processing.
 

+* eventdev: Moved memory used by timer adapters to hugepage. This will prevent
+  TLB misses if any and aligns to memory structure of other subsystems.
+
+* fib: Added the ``rib_ext_sz`` field to ``rte_fib_conf`` and ``rte_fib6_conf``
+  so that user can specify the size of the RIB extension inside the FIB.
+

 
 ABI Changes
 -----------
 
 ABI Changes
 -----------


@@ -336,6 +499,9 @@ ABI Changes
    Also, make sure to start the actual text at the margin.
    =======================================================
 
    Also, make sure to start the actual text at the margin.
    =======================================================
 

+* ethdev: All enums & macros updated to have ``RTE_ETH`` prefix and structures
+  updated to have ``rte_eth`` prefix. DPDK components updated to use new names.
+

 * ethdev: Input parameters for ``eth_rx_queue_count_t`` was changed.
   Instead of pointer to ``rte_eth_dev`` and queue index, now it accepts pointer
   to internal queue data as input parameter. While this change is transparent
 * ethdev: Input parameters for ``eth_rx_queue_count_t`` was changed.
   Instead of pointer to ``rte_eth_dev`` and queue index, now it accepts pointer
   to internal queue data as input parameter. While this change is transparent


@@ -348,6 +514,12 @@ ABI Changes
   to be transparent for both users (no changes in user app is required) and
   PMD developers (no changes in PMD is required).
 
   to be transparent for both users (no changes in user app is required) and
   PMD developers (no changes in PMD is required).
 

+* cryptodev: Made ``rte_cryptodev``, ``rte_cryptodev_data`` private
+  structures internal to DPDK. ``rte_cryptodevs`` can't be accessed directly
+  by user any more. While it is an ABI breakage, this change is intended
+  to be transparent for both users (no changes in user app is required) and
+  PMD developers (no changes in PMD is required).
+

 * security: ``rte_security_set_pkt_metadata`` and ``rte_security_get_userdata``
   routines used by inline outbound and inline inbound security processing were
   made inline and enhanced to do simple 64-bit set/get for PMDs that do not
 * security: ``rte_security_set_pkt_metadata`` and ``rte_security_get_userdata``
   routines used by inline outbound and inline inbound security processing were
   made inline and enhanced to do simple 64-bit set/get for PMDs that do not


@@ -388,6 +560,18 @@ ABI Changes
 * bbdev: Added capability related to more comprehensive CRC options,
   shifting values of the ``enum rte_bbdev_op_ldpcdec_flag_bitmasks``.
 
 * bbdev: Added capability related to more comprehensive CRC options,
   shifting values of the ``enum rte_bbdev_op_ldpcdec_flag_bitmasks``.
 

+* eventdev: New variables ``rx_event_buf_count`` and ``rx_event_buf_size``
+  were added in structure ``rte_event_eth_rx_adapter_stats`` to get additional
+  status.
+
+* eventdev: A new structure ``rte_event_fp_ops`` has been added which is now used
+  by the fastpath inline functions. The structures ``rte_eventdev``,
+  ``rte_eventdev_data`` have been made internal. ``rte_eventdevs[]`` can't be
+  accessed directly by user any more. This change is transparent to both
+  applications and PMDs.
+
+* eventdev: Re-arranged fields in ``rte_event_timer`` to remove holes.
+

 
 Known Issues
 ------------
 
 Known Issues
 ------------