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.02.
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 * In 17.02 ABI changes are planned: the ``rte_eth_dev`` structure will be
27 extended with new function pointer ``tx_pkt_prepare`` allowing verification
28 and processing of packet burst to meet HW specific requirements before
29 transmit. Also new fields will be added to the ``rte_eth_desc_lim`` structure:
30 ``nb_seg_max`` and ``nb_mtu_seg_max`` providing information about number of
31 segments limit to be transmitted by device for TSO/non-TSO packets.
33 * ethdev: an API change is planned for 17.02 for the function
34 ``_rte_eth_dev_callback_process``. In 17.02 the function will return an ``int``
35 instead of ``void`` and a fourth parameter ``void *ret_param`` will be added.
37 * ethdev: for 17.02 it is planned to deprecate the following five functions
38 and move them in ixgbe:
40 ``rte_eth_dev_set_vf_rxmode``
42 ``rte_eth_dev_set_vf_rx``
44 ``rte_eth_dev_set_vf_tx``
46 ``rte_eth_dev_set_vf_vlan_filter``
48 ``rte_eth_set_vf_rate_limit``
50 * ABI changes are planned for 17.02 in the ``rte_mbuf`` structure: some fields
51 may be reordered to facilitate the writing of ``data_off``, ``refcnt``, and
52 ``nb_segs`` in one operation, because some platforms have an overhead if the
53 store address is not naturally aligned. Other mbuf fields, such as the
54 ``port`` field, may be moved or removed as part of this mbuf work. A
55 ``timestamp`` will also be added.
57 * The mbuf flags PKT_RX_VLAN_PKT and PKT_RX_QINQ_PKT are deprecated and
58 are respectively replaced by PKT_RX_VLAN_STRIPPED and
59 PKT_RX_QINQ_STRIPPED, that are better described. The old flags and
60 their behavior will be kept until 16.11 and will be removed in 17.02.
62 * mempool: The functions ``rte_mempool_count`` and ``rte_mempool_free_count``
63 will be removed in 17.02.
64 They are replaced by ``rte_mempool_avail_count`` and
65 ``rte_mempool_in_use_count`` respectively.
67 * mempool: The functions for single/multi producer/consumer are deprecated
68 and will be removed in 17.02.
69 It is replaced by ``rte_mempool_generic_get/put`` functions.