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.
  34
  35 * The rte_mempool struct will be changed in 16.07 to facilitate the new
  36   external mempool manager functionality.
  37   The ring element will be replaced with a more generic 'pool' opaque pointer
  38   to allow new mempool handlers to use their own user-defined mempool
  39   layout. Also newly added to rte_mempool is a handler index.
  40   The existing API will be backward compatible, but there will be new API
  41   functions added to facilitate the creation of mempools using an external
  42   handler. The 16.07 release will contain these changes.
  43
  44 * The rte_mempool allocation will be changed in 16.07:
  45   allocation of large mempool in several virtual memory chunks, new API
  46   to populate a mempool, new API to free a mempool, allocation in
  47   anonymous mapping, drop of specific dom0 code. These changes will
  48   induce a modification of the rte_mempool structure, plus a
  49   modification of the API of rte_mempool_obj_iter(), implying a breakage
  50   of the ABI.