1 ABI and API Deprecation
2 =======================
4 See the :doc:`guidelines document for details of the ABI policy </contributing/versioning>`.
5 API and ABI deprecation notices are to be posted here.
11 * igb_uio: iomem mapping and sysfs files created for iomem and ioport in
12 igb_uio will be removed, because we are able to detect these from what Linux
13 has exposed, like the way we have done with uio-pci-generic. This change
14 targets release 17.05.
16 * ABI/API changes are planned for 17.02: ``rte_device``, ``rte_driver`` will be
17 impacted because of introduction of a new ``rte_bus`` hierarchy. This would
18 also impact the way devices are identified by EAL. A bus-device-driver model
19 will be introduced providing a hierarchical view of devices.
21 * ``eth_driver`` is planned to be removed in 17.02. This currently serves as
22 a placeholder for PMDs to register themselves. Changes for ``rte_bus`` will
23 provide a way to handle device initialization currently being done in
26 * ethdev: an API change is planned for 17.02 for the function
27 ``_rte_eth_dev_callback_process``. In 17.02 the function will return an ``int``
28 instead of ``void`` and a fourth parameter ``void *ret_param`` will be added.
30 * ABI changes are planned for 17.05 in the ``rte_mbuf`` structure: some fields
31 may be reordered to facilitate the writing of ``data_off``, ``refcnt``, and
32 ``nb_segs`` in one operation, because some platforms have an overhead if the
33 store address is not naturally aligned. Other mbuf fields, such as the
34 ``port`` field, may be moved or removed as part of this mbuf work. A
35 ``timestamp`` will also be added.
37 * The mbuf flags PKT_RX_VLAN_PKT and PKT_RX_QINQ_PKT are deprecated and
38 are respectively replaced by PKT_RX_VLAN_STRIPPED and
39 PKT_RX_QINQ_STRIPPED, that are better described. The old flags and
40 their behavior will be kept until 17.02 and will be removed in 17.05.
42 * mempool: The functions ``rte_mempool_count`` and ``rte_mempool_free_count``
43 will be removed in 17.05.
44 They are replaced by ``rte_mempool_avail_count`` and
45 ``rte_mempool_in_use_count`` respectively.
47 * mempool: The functions for single/multi producer/consumer are deprecated
48 and will be removed in 17.05.
49 It is replaced by ``rte_mempool_generic_get/put`` functions.
51 * ethdev: the legacy filter API, including
52 ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
53 as filter types MACVLAN, ETHERTYPE, FLEXIBLE, SYN, NTUPLE, TUNNEL, FDIR,
54 HASH and L2_TUNNEL, is superseded by the generic flow API (rte_flow) in
55 PMDs that implement the latter.
56 Target release for removal of the legacy API will be defined once most
57 PMDs have switched to rte_flow.