1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright 2018 The DPDK contributors
4 ABI and API Deprecation
5 =======================
7 See the guidelines document for details of the :doc:`ABI policy
8 <../contributing/abi_policy>`. API and ABI deprecation notices are to be posted
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: both declaring and identifying devices will be streamlined in v18.11.
27 New functions will appear to query a specific port from buses, classes of
28 device and device drivers. Device declaration will be made coherent with the
29 new scheme of device identification.
30 As such, ``rte_devargs`` device representation will change.
32 - The enum ``rte_devtype`` was used to identify a bus and will disappear.
33 - Functions previously deprecated will change or disappear:
35 + ``rte_eal_devargs_type_count``
37 * eal: The ``rte_logs`` struct and global symbol will be made private to
38 remove it from the externally visible ABI and allow it to be updated in the
41 * igb_uio: In the view of reducing the kernel dependency from the main tree,
42 as a first step, the Technical Board decided to move ``igb_uio``
43 kernel module to the dpdk-kmods repository in the /linux/igb_uio/ directory
45 Minutes of Technical Board Meeting of `2019-11-06
46 <http://mails.dpdk.org/archives/dev/2019-November/151763.html>`_.
48 * lib: will fix extending some enum/define breaking the ABI. There are multiple
49 samples in DPDK that enum/define terminated with a ``.*MAX.*`` value which is
50 used by iterators, and arrays holding these values are sized with this
51 ``.*MAX.*`` value. So extending this enum/define increases the ``.*MAX.*``
52 value which increases the size of the array and depending on how/where the
53 array is used this may break the ABI.
54 ``RTE_ETH_FLOW_MAX`` is one sample of the mentioned case, adding a new flow
55 type will break the ABI because of ``flex_mask[RTE_ETH_FLOW_MAX]`` array
56 usage in following public struct hierarchy:
57 ``rte_eth_fdir_flex_conf -> rte_fdir_conf -> rte_eth_conf (in the middle)``.
58 Need to identify this kind of usages and fix in 20.11, otherwise this blocks
59 us extending existing enum/define.
60 One solution can be using a fixed size array instead of ``.*MAX.*`` value.
62 * dpaa2: removal of ``rte_dpaa2_memsegs`` structure which has been replaced
63 by a pa-va search library. This structure was earlier being used for holding
64 memory segments used by dpaa2 driver for faster pa->va translation. This
65 structure would be made internal (or removed if all dependencies are cleared)
68 * mempool: starting from v20.05, the API of rte_mempool_populate_iova()
69 and rte_mempool_populate_virt() will change to return 0 instead
70 of -EINVAL when there is not enough room to store one object. The ABI
71 will be preserved until 20.11.
73 * ethdev: the legacy filter API, including
74 ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
75 as filter types MACVLAN, ETHERTYPE, FLEXIBLE, SYN, NTUPLE, TUNNEL, FDIR,
76 HASH and L2_TUNNEL, is superseded by the generic flow API (rte_flow) in
77 PMDs that implement the latter.
78 Target release for removal of the legacy API will be defined once most
79 PMDs have switched to rte_flow.
81 * ethdev: Update API functions returning ``void`` to return ``int`` with
82 negative errno values to indicate various error conditions (e.g.
83 invalid port ID, unsupported operation, failed operation):
85 - ``rte_eth_dev_stop``
86 - ``rte_eth_dev_close``
88 * ethdev: New offload flags ``DEV_RX_OFFLOAD_FLOW_MARK`` will be added in 19.11.
89 This will allow application to enable or disable PMDs from updating
90 ``rte_mbuf::hash::fdir``.
91 This scheme will allow PMDs to avoid writes to ``rte_mbuf`` fields on Rx and
92 thereby improve Rx performance if application wishes do so.
93 In 19.11 PMDs will still update the field even when the offload is not
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``.
111 * power: ``rte_power_set_env`` function will no longer return 0 on attempt
112 to set new power environment if power environment was already initialized.
113 In this case the function will return -1 unless the environment is unset first
114 (using ``rte_power_unset_env``). Other function usage scenarios will not change.
116 * python: Since the beginning of 2020, Python 2 has officially reached
117 end-of-support: https://www.python.org/doc/sunset-python-2/.
118 Python 2 support will be completely removed in 20.11.
119 In 20.08, explicit deprecation warnings will be displayed when running
120 scripts with Python 2.