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 * kvargs: The function ``rte_kvargs_process`` will get a new parameter
21 for returning key match count. It will ease handling of no-match case.
23 * eal: The function ``rte_eal_remote_launch`` will return new error codes
24 after read or write error on the pipe, instead of calling ``rte_panic``.
26 * eal: the ``rte_mem_config`` struct will be made private to remove it from the
27 externally visible ABI and allow it to be updated in the future.
29 * eal: both declaring and identifying devices will be streamlined in v18.11.
30 New functions will appear to query a specific port from buses, classes of
31 device and device drivers. Device declaration will be made coherent with the
32 new scheme of device identification.
33 As such, ``rte_devargs`` device representation will change.
35 - The enum ``rte_devtype`` was used to identify a bus and will disappear.
36 - Functions previously deprecated will change or disappear:
38 + ``rte_eal_devargs_type_count``
40 * vfio: removal of ``rte_vfio_dma_map`` and ``rte_vfio_dma_unmap`` APIs which
41 have been replaced with ``rte_dev_dma_map`` and ``rte_dev_dma_unmap``
42 functions. The due date for the removal targets DPDK 20.02.
44 * pci: Several exposed functions are misnamed.
45 The following functions are deprecated starting from v17.11 and are replaced:
47 - ``eal_parse_pci_BDF`` replaced by ``rte_pci_addr_parse``
48 - ``eal_parse_pci_DomBDF`` replaced by ``rte_pci_addr_parse``
49 - ``rte_eal_compare_pci_addr`` replaced by ``rte_pci_addr_cmp``
51 * dpaa2: removal of ``rte_dpaa2_memsegs`` structure which has been replaced
52 by a pa-va search library. This structure was earlier being used for holding
53 memory segments used by dpaa2 driver for faster pa->va translation. This
54 structure would be made internal (or removed if all dependencies are cleared)
57 * ethdev: the legacy filter API, including
58 ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
59 as filter types MACVLAN, ETHERTYPE, FLEXIBLE, SYN, NTUPLE, TUNNEL, FDIR,
60 HASH and L2_TUNNEL, is superseded by the generic flow API (rte_flow) in
61 PMDs that implement the latter.
62 Target release for removal of the legacy API will be defined once most
63 PMDs have switched to rte_flow.
65 * cryptodev: New member in ``rte_cryptodev_config`` to allow applications to
66 disable features supported by the crypto device. Only the following features
67 would be allowed to be disabled this way,
69 - ``RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO``
70 - ``RTE_CRYPTODEV_FF_ASYMMETRIC_CRYPTO``
71 - ``RTE_CRYPTODEV_FF_SECURITY``
73 Disabling unused features would facilitate efficient usage of HW/SW offload.
75 - Member ``uint64_t ff_disable`` in ``rte_cryptodev_config``
77 The field would be added in v19.08.
79 * cryptodev: the ``uint8_t *data`` member of ``key`` structure in the xforms
80 structure (``rte_crypto_cipher_xform``, ``rte_crypto_auth_xform``, and
81 ``rte_crypto_aead_xform``) will be changed to ``const uint8_t *data``.
83 * cryptodev: support for using IV with all sizes is added, J0 still can
84 be used but only when IV length in following structs ``rte_crypto_auth_xform``,
85 ``rte_crypto_aead_xform`` is set to zero. When IV length is greater or equal
86 to one it means it represents IV, when is set to zero it means J0 is used
87 directly, in this case 16 bytes of J0 need to be passed.
89 * sched: To allow more traffic classes, flexible mapping of pipe queues to
90 traffic classes, and subport level configuration of pipes and queues
91 changes will be made to macros, data structures and API functions defined
92 in "rte_sched.h". These changes are aligned to improvements suggested in the
93 RFC https://mails.dpdk.org/archives/dev/2018-November/120035.html.
95 * metrics: The function ``rte_metrics_init`` will have a non-void return
96 in order to notify errors instead of calling ``rte_exit``.
98 * power: ``rte_power_set_env`` function will no longer return 0 on attempt
99 to set new power environment if power environment was already initialized.
100 In this case the function will return -1 unless the environment is unset first
101 (using ``rte_power_unset_env``). Other function usage scenarios will not change.