1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright 2018 The DPDK contributors
4 ABI and API Deprecation
5 =======================
7 See the :doc:`guidelines document for details of the ABI policy </contributing/versioning>`.
8 API and ABI deprecation notices are to be posted here.
14 * meson: The minimum supported version of meson for configuring and building
15 DPDK will be increased to v0.47.1 (from 0.41) from DPDK 19.05 onwards. For
16 those users with a version earlier than 0.47.1, an updated copy of meson
17 can be got using the ``pip``, or ``pip3``, tool for downloading python
20 * network includes: Network structures, definitions and functions will
21 be prefixed by ``rte_`` to resolve conflicts with libc headers.
22 This change will break many DPDK APIs.
24 * kvargs: The function ``rte_kvargs_process`` will get a new parameter
25 for returning key match count. It will ease handling of no-match case.
27 * eal: The function ``rte_eal_remote_launch`` will return new error codes
28 after read or write error on the pipe, instead of calling ``rte_panic``.
30 * eal: the ``rte_mem_config`` struct will be made private to remove it from the
31 externally visible ABI and allow it to be updated in the future.
33 * eal: both declaring and identifying devices will be streamlined in v18.11.
34 New functions will appear to query a specific port from buses, classes of
35 device and device drivers. Device declaration will be made coherent with the
36 new scheme of device identification.
37 As such, ``rte_devargs`` device representation will change.
39 - The enum ``rte_devtype`` was used to identify a bus and will disappear.
40 - Functions previously deprecated will change or disappear:
42 + ``rte_eal_devargs_type_count``
44 * vfio: removal of ``rte_vfio_dma_map`` and ``rte_vfio_dma_unmap`` APIs which
45 have been replaced with ``rte_dev_dma_map`` and ``rte_dev_dma_unmap``
46 functions. The due date for the removal targets DPDK 20.02.
48 * pci: Several exposed functions are misnamed.
49 The following functions are deprecated starting from v17.11 and are replaced:
51 - ``eal_parse_pci_BDF`` replaced by ``rte_pci_addr_parse``
52 - ``eal_parse_pci_DomBDF`` replaced by ``rte_pci_addr_parse``
53 - ``rte_eal_compare_pci_addr`` replaced by ``rte_pci_addr_cmp``
55 * dpaa2: removal of ``rte_dpaa2_memsegs`` structure which has been replaced
56 by a pa-va search library. This structure was earlier being used for holding
57 memory segments used by dpaa2 driver for faster pa->va translation. This
58 structure would be made internal (or removed if all dependencies are cleared)
61 * ethdev: the legacy filter API, including
62 ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
63 as filter types MACVLAN, ETHERTYPE, FLEXIBLE, SYN, NTUPLE, TUNNEL, FDIR,
64 HASH and L2_TUNNEL, is superseded by the generic flow API (rte_flow) in
65 PMDs that implement the latter.
66 Target release for removal of the legacy API will be defined once most
67 PMDs have switched to rte_flow.
69 * kni: remove KNI ethtool support. To clarify, this is not to remove the KNI,
70 but only to remove ethtool support of it that is disabled by default and
71 can be enabled via ``CONFIG_RTE_KNI_KMOD_ETHTOOL`` config option.
72 Existing KNI ethtool implementation is only supported by ``igb`` & ``ixgbe``
73 drivers, by using a copy of kernel drivers in DPDK. This model cannot be
74 extended to all drivers in DPDK and it is too much effort to maintain
75 kernel modules in DPDK. As a result users won't be able to use ``ethtool``
76 via ``igb`` & ``ixgbe`` anymore.
78 * cryptodev: New member in ``rte_cryptodev_config`` to allow applications to
79 disable features supported by the crypto device. Only the following features
80 would be allowed to be disabled this way,
82 - ``RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO``
83 - ``RTE_CRYPTODEV_FF_ASYMMETRIC_CRYPTO``
84 - ``RTE_CRYPTODEV_FF_SECURITY``
86 Disabling unused features would facilitate efficient usage of HW/SW offload.
88 - Member ``uint64_t ff_disable`` in ``rte_cryptodev_config``
90 The field would be added in v19.08.
92 * cryptodev: the ``uint8_t *data`` member of ``key`` structure in the xforms
93 structure (``rte_crypto_cipher_xform``, ``rte_crypto_auth_xform``, and
94 ``rte_crypto_aead_xform``) will be changed to ``const uint8_t *data``.
96 * cryptodev: support for using IV with all sizes is added, J0 still can
97 be used but only when IV length in following structs ``rte_crypto_auth_xform``,
98 ``rte_crypto_aead_xform`` is set to zero. When IV length is greater or equal
99 to one it means it represents IV, when is set to zero it means J0 is used
100 directly, in this case 16 bytes of J0 need to be passed.
102 * sched: To allow more traffic classes, flexible mapping of pipe queues to
103 traffic classes, and subport level configuration of pipes and queues
104 changes will be made to macros, data structures and API functions defined
105 in "rte_sched.h". These changes are aligned to improvements suggested in the
106 RFC https://mails.dpdk.org/archives/dev/2018-November/120035.html.
108 * metrics: The function ``rte_metrics_init`` will have a non-void return
109 in order to notify errors instead of calling ``rte_exit``.