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 * eal: function ``rte_bsf64`` in ``rte_bitmap.h`` has been renamed to
15 ``rte_bsf64_safe`` and moved to ``rte_common.h``. A new ``rte_bsf64`` function
16 will be added in the next release in ``rte_common.h`` that follows convention
17 set by existing ``rte_bsf32`` function.
19 * eal: both declaring and identifying devices will be streamlined in v18.11.
20 New functions will appear to query a specific port from buses, classes of
21 device and device drivers. Device declaration will be made coherent with the
22 new scheme of device identification.
23 As such, ``rte_devargs`` device representation will change.
25 - The enum ``rte_devtype`` was used to identify a bus and will disappear.
26 - Functions previously deprecated will change or disappear:
28 + ``rte_eal_devargs_type_count``
30 * pci: Several exposed functions are misnamed.
31 The following functions are deprecated starting from v17.11 and are replaced:
33 - ``eal_parse_pci_BDF`` replaced by ``rte_pci_addr_parse``
34 - ``eal_parse_pci_DomBDF`` replaced by ``rte_pci_addr_parse``
35 - ``rte_eal_compare_pci_addr`` replaced by ``rte_pci_addr_cmp``
37 * mbuf: The opaque ``mbuf->hash.sched`` field will be updated to support generic
38 definition in line with the ethdev TM and MTR APIs. Currently, this field
39 is defined in librte_sched in a non-generic way. The new generic format
40 will contain: queue ID, traffic class, color. Field size will not change.
42 * mbuf: the macro ``RTE_MBUF_INDIRECT()`` will be removed in v18.08 or later and
43 replaced with ``RTE_MBUF_CLONED()`` which is already added in v18.05. As
44 ``EXT_ATTACHED_MBUF`` is newly introduced in v18.05, ``RTE_MBUF_INDIRECT()``
45 can no longer be mutually exclusive with ``RTE_MBUF_DIRECT()`` if the new
46 experimental API ``rte_pktmbuf_attach_extbuf()`` is used. Removal of the macro
47 is to fix this semantic inconsistency.
49 * ethdev: the legacy filter API, including
50 ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
51 as filter types MACVLAN, ETHERTYPE, FLEXIBLE, SYN, NTUPLE, TUNNEL, FDIR,
52 HASH and L2_TUNNEL, is superseded by the generic flow API (rte_flow) in
53 PMDs that implement the latter.
54 Target release for removal of the legacy API will be defined once most
55 PMDs have switched to rte_flow.
57 * pdump: As we changed to use generic IPC, some changes in APIs and structure
58 are expected in subsequent release.
60 - ``rte_pdump_set_socket_dir`` will be removed;
61 - The parameter, ``path``, of ``rte_pdump_init`` will be removed;
62 - The enum ``rte_pdump_socktype`` will be removed.