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 * kvargs: The function ``rte_kvargs_process`` will get a new parameter
15 for returning key match count. It will ease handling of no-match case.
17 * eal: function ``rte_bsf64`` in ``rte_bitmap.h`` has been renamed to
18 ``rte_bsf64_safe`` and moved to ``rte_common.h``. A new ``rte_bsf64`` function
19 will be added in the next release in ``rte_common.h`` that follows convention
20 set by existing ``rte_bsf32`` function.
22 * eal: both declaring and identifying devices will be streamlined in v18.11.
23 New functions will appear to query a specific port from buses, classes of
24 device and device drivers. Device declaration will be made coherent with the
25 new scheme of device identification.
26 As such, ``rte_devargs`` device representation will change.
28 - The enum ``rte_devtype`` was used to identify a bus and will disappear.
29 - Functions previously deprecated will change or disappear:
31 + ``rte_eal_devargs_type_count``
33 * pci: Several exposed functions are misnamed.
34 The following functions are deprecated starting from v17.11 and are replaced:
36 - ``eal_parse_pci_BDF`` replaced by ``rte_pci_addr_parse``
37 - ``eal_parse_pci_DomBDF`` replaced by ``rte_pci_addr_parse``
38 - ``rte_eal_compare_pci_addr`` replaced by ``rte_pci_addr_cmp``
40 * dpaa2: removal of ``rte_dpaa2_memsegs`` structure which has been replaced
41 by a pa-va search library. This structure was earlier being used for holding
42 memory segments used by dpaa2 driver for faster pa->va translation. This
43 structure would be made internal (or removed if all dependencies are cleared)
46 * mbuf: The opaque ``mbuf->hash.sched`` field will be updated to support generic
47 definition in line with the ethdev TM and MTR APIs. Currently, this field
48 is defined in librte_sched in a non-generic way. The new generic format
49 will contain: queue ID, traffic class, color. Field size will not change.
51 * mbuf: the macro ``RTE_MBUF_INDIRECT()`` will be removed in v18.08 or later and
52 replaced with ``RTE_MBUF_CLONED()`` which is already added in v18.05. As
53 ``EXT_ATTACHED_MBUF`` is newly introduced in v18.05, ``RTE_MBUF_INDIRECT()``
54 can no longer be mutually exclusive with ``RTE_MBUF_DIRECT()`` if the new
55 experimental API ``rte_pktmbuf_attach_extbuf()`` is used. Removal of the macro
56 is to fix this semantic inconsistency.
58 * ethdev: the legacy filter API, including
59 ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
60 as filter types MACVLAN, ETHERTYPE, FLEXIBLE, SYN, NTUPLE, TUNNEL, FDIR,
61 HASH and L2_TUNNEL, is superseded by the generic flow API (rte_flow) in
62 PMDs that implement the latter.
63 Target release for removal of the legacy API will be defined once most
64 PMDs have switched to rte_flow.
66 * ethdev: Maximum and minimum MTU values vary between hardware devices. In
67 hardware agnostic DPDK applications access to such information would allow
68 a more accurate way of validating and setting supported MTU values on a per
69 device basis rather than using a defined default for all devices. To
70 resolve this, the following members will be added to ``rte_eth_dev_info``.
71 Note: these can be added to fit a hole in the existing structure for amd64
72 but not for 32-bit, as such ABI change will occur as size of the structure
75 - Member ``uint16_t min_mtu`` the minimum MTU allowed.
76 - Member ``uint16_t max_mtu`` the maximum MTU allowed.
78 * pdump: As we changed to use generic IPC, some changes in APIs and structure
79 are expected in subsequent release.
81 - ``rte_pdump_set_socket_dir`` will be removed;
82 - The parameter, ``path``, of ``rte_pdump_init`` will be removed;
83 - The enum ``rte_pdump_socktype`` will be removed.