doc: announce ABI change for mempool cache
[dpdk.git] / doc / guides / rel_notes / deprecation.rst
1 ABI and API Deprecation
2 =======================
3
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.
6
7
8 Deprecation Notices
9 -------------------
10
11 * The EAL function pci_config_space_set is deprecated in release 16.04
12   and will be removed from 16.07.
13   Macros CONFIG_RTE_PCI_CONFIG, CONFIG_RTE_PCI_EXTENDED_TAG and
14   CONFIG_RTE_PCI_MAX_READ_REQUEST_SIZE will be removed.
15   The /sys entries extended_tag and max_read_request_size created by igb_uio
16   will be removed.
17
18 * The following fields have been deprecated in rte_eth_stats:
19   ibadcrc, ibadlen, imcasts, fdirmatch, fdirmiss,
20   tx_pause_xon, rx_pause_xon, tx_pause_xoff, rx_pause_xoff
21
22 * ABI changes are planned for adding four new flow types. This impacts
23   RTE_ETH_FLOW_MAX. The release 2.2 does not contain these ABI changes,
24   but release 2.3 will. [postponed]
25
26 * ABI change is planned for the rte_mempool structure to allow mempool
27   cache support to be dynamic depending on the mempool being created
28   needing cache support. Saves about 1.5M of memory per rte_mempool structure
29   by removing the per lcore cache memory. Change will occur in DPDK 16.07
30   release and will skip the define RTE_NEXT_ABI in DPDK 16.04 release. The
31   code affected is app/test/test_mempool.c and librte_mempool/rte_mempool.[ch].
32   The rte_mempool.local_cache will be converted from an array to a pointer to
33   allow for dynamic allocation of the per lcore cache memory.