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 * In 17.02 ABI changes are planned: the ``rte_eth_dev`` structure will be
17 extended with new function pointer ``tx_pkt_prepare`` allowing verification
18 and processing of packet burst to meet HW specific requirements before
19 transmit. Also new fields will be added to the ``rte_eth_desc_lim`` structure:
20 ``nb_seg_max`` and ``nb_mtu_seg_max`` providing information about number of
21 segments limit to be transmitted by device for TSO/non-TSO packets.
23 * ABI changes are planned for 17.02 in the ``rte_mbuf`` structure: some fields
24 may be reordered to facilitate the writing of ``data_off``, ``refcnt``, and
25 ``nb_segs`` in one operation, because some platforms have an overhead if the
26 store address is not naturally aligned. Other mbuf fields, such as the
27 ``port`` field, may be moved or removed as part of this mbuf work. A
28 ``timestamp`` will also be added.
30 * The mbuf flags PKT_RX_VLAN_PKT and PKT_RX_QINQ_PKT are deprecated and
31 are respectively replaced by PKT_RX_VLAN_STRIPPED and
32 PKT_RX_QINQ_STRIPPED, that are better described. The old flags and
33 their behavior will be kept until 16.11 and will be removed in 17.02.
35 * mempool: The functions ``rte_mempool_count`` and ``rte_mempool_free_count``
36 will be removed in 17.02.
37 They are replaced by ``rte_mempool_avail_count`` and
38 ``rte_mempool_in_use_count`` respectively.
40 * mempool: The functions for single/multi producer/consumer are deprecated
41 and will be removed in 17.02.
42 It is replaced by ``rte_mempool_generic_get/put`` functions.