+.. SPDX-License-Identifier: BSD-3-Clause
+ Copyright 2018 The DPDK contributors
+
ABI and API Deprecation
=======================
Deprecation Notices
-------------------
-* Significant ABI changes are planned for struct rte_eth_dev to support up to
- 1024 queues per port. This change will be in release 2.2.
- There is no backward compatibility planned from release 2.2.
- All binaries will need to be rebuilt from release 2.2.
-
-* The following fields have been deprecated in rte_eth_stats:
- imissed, ibadcrc, ibadlen, imcasts, fdirmatch, fdirmiss,
- tx_pause_xon, rx_pause_xon, tx_pause_xoff, rx_pause_xoff
-
-* ABI changes are planned for struct rte_eth_fdir_flow_ext in order to support
- flow director filtering in VF. The release 2.1 does not contain these ABI
- changes, but release 2.2 will, and no backwards compatibility is planned.
-
-* ABI changes are planned for struct rte_eth_fdir_filter and
- rte_eth_fdir_masks in order to support new flow director modes,
- MAC VLAN and Cloud, on x550. The MAC VLAN mode means the MAC and
- VLAN are monitored. The Cloud mode is for VxLAN and NVGRE, and
- the tunnel type, TNI/VNI, inner MAC and inner VLAN are monitored.
- The release 2.2 will contain these changes without backwards compatibility.
-
-* ABI changes are planned for struct virtio_net in order to support vhost-user
- multiple queues feature.
- It should be integrated in release 2.2 without backward compatibility.
-
-* The scheduler hierarchy structure (rte_sched_port_hierarchy) will change to
- allow for a larger number of subport entries.
- The number of available traffic_classes and queues may also change.
- The mbuf structure element for sched hierarchy will also change from a single
- 32 bit to a 64 bit structure.
-
-* The scheduler statistics structure will change to allow keeping track of
- RED actions.
-
-* librte_cfgfile: In order to allow for longer names and values,
- the value of macros CFG_NAME_LEN and CFG_NAME_VAL will be increased.
- Most likely, the new values will be 64 and 256, respectively.
-
-* librte_table: New functions for table entry bulk add/delete will be added
- to the table operations structure.
-
-* librte_table hash: Key mask parameter will be added to the hash table
- parameter structure for 8-byte key and 16-byte key extendible bucket and
- LRU tables.
-
-* librte_pipeline: The prototype for the pipeline input port, output port
- and table action handlers will be updated:
- the pipeline parameter will be added, the packets mask parameter will be
- either removed (for input port action handler) or made input-only.
+* meson: The minimum supported version of meson for configuring and building
+ DPDK will be increased to v0.47.1 (from 0.41) from DPDK 19.05 onwards. For
+ those users with a version earlier than 0.47.1, an updated copy of meson
+ can be got using the ``pip``, or ``pip3``, tool for downloading python
+ packages.
+
+* kvargs: The function ``rte_kvargs_process`` will get a new parameter
+ for returning key match count. It will ease handling of no-match case.
+
+* eal: both declaring and identifying devices will be streamlined in v18.11.
+ New functions will appear to query a specific port from buses, classes of
+ device and device drivers. Device declaration will be made coherent with the
+ new scheme of device identification.
+ As such, ``rte_devargs`` device representation will change.
+
+ - The enum ``rte_devtype`` was used to identify a bus and will disappear.
+ - Functions previously deprecated will change or disappear:
+
+ + ``rte_eal_devargs_type_count``
+
+* vfio: removal of ``rte_vfio_dma_map`` and ``rte_vfio_dma_unmap`` APIs which
+ have been replaced with ``rte_dev_dma_map`` and ``rte_dev_dma_unmap``
+ functions. The due date for the removal targets DPDK 20.02.
+
+* pci: Several exposed functions are misnamed.
+ The following functions are deprecated starting from v17.11 and are replaced:
+
+ - ``eal_parse_pci_BDF`` replaced by ``rte_pci_addr_parse``
+ - ``eal_parse_pci_DomBDF`` replaced by ``rte_pci_addr_parse``
+ - ``rte_eal_compare_pci_addr`` replaced by ``rte_pci_addr_cmp``
+
+* dpaa2: removal of ``rte_dpaa2_memsegs`` structure which has been replaced
+ by a pa-va search library. This structure was earlier being used for holding
+ memory segments used by dpaa2 driver for faster pa->va translation. This
+ structure would be made internal (or removed if all dependencies are cleared)
+ in future releases.
+
+* ethdev: the legacy filter API, including
+ ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
+ as filter types MACVLAN, ETHERTYPE, FLEXIBLE, SYN, NTUPLE, TUNNEL, FDIR,
+ HASH and L2_TUNNEL, is superseded by the generic flow API (rte_flow) in
+ PMDs that implement the latter.
+ Target release for removal of the legacy API will be defined once most
+ PMDs have switched to rte_flow.
+
+* kni: remove KNI ethtool support. To clarify, this is not to remove the KNI,
+ but only to remove ethtool support of it that is disabled by default and
+ can be enabled via ``CONFIG_RTE_KNI_KMOD_ETHTOOL`` config option.
+ Existing KNI ethtool implementation is only supported by ``igb`` & ``ixgbe``
+ drivers, by using a copy of kernel drivers in DPDK. This model cannot be
+ extended to all drivers in DPDK and it is too much effort to maintain
+ kernel modules in DPDK. As a result users won't be able to use ``ethtool``
+ via ``igb`` & ``ixgbe`` anymore.
+
+* cryptodev: New member in ``rte_cryptodev_config`` to allow applications to
+ disable features supported by the crypto device. Only the following features
+ would be allowed to be disabled this way,
+
+ - ``RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO``
+ - ``RTE_CRYPTODEV_FF_ASYMMETRIC_CRYPTO``
+ - ``RTE_CRYPTODEV_FF_SECURITY``
+
+ Disabling unused features would facilitate efficient usage of HW/SW offload.
+
+ - Member ``uint64_t ff_disable`` in ``rte_cryptodev_config``
+
+ The field would be added in v19.08.
+
+* cryptodev: the ``uint8_t *data`` member of ``key`` structure in the xforms
+ structure (``rte_crypto_cipher_xform``, ``rte_crypto_auth_xform``, and
+ ``rte_crypto_aead_xform``) will be changed to ``const uint8_t *data``.