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 log history is deprecated.
  12   It is voided in 16.07 and will be removed in release 16.11.
  13
  14 * The ethdev hotplug API is going to be moved to EAL with a notification
  15   mechanism added to crypto and ethdev libraries so that hotplug is now
  16   available to both of them. This API will be stripped of the device arguments
  17   so that it only cares about hotplugging.
  18
  19 * Structures embodying pci and vdev devices are going to be reworked to
  20   integrate new common rte_device / rte_driver objects (see
  21   http://dpdk.org/ml/archives/dev/2016-January/031390.html).
  22   ethdev and crypto libraries will then only handle those objects so that they
  23   do not need to care about the kind of devices that are being used, making it
  24   easier to add new buses later.
  25
  26 * The xstats API and rte_eth_xstats struct will be changed to allow retrieval
  27   of values without any string copies or parsing.
  28   No backwards compatibility is planned, as it would require code duplication
  29   in every PMD that supports xstats.
  30
  31 * ABI changes are planned for adding four new flow types. This impacts
  32   RTE_ETH_FLOW_MAX. The release 2.2 does not contain these ABI changes,
  33   but release 2.3 will. [postponed]
  34
  35 * ABI will change for rte_mempool struct to move the cache-related fields
  36   to the more appropriate rte_mempool_cache struct. The mempool API is
  37   also changed to enable external cache management that is not tied to EAL
  38   threads. Some mempool get and put calls are removed in favor of a more
  39   compact API. The ones that remain are backwards compatible and use the
  40   per-lcore default cache if available. This change targets release 16.07.
  41
  42 * The rte_mempool struct will be changed in 16.07 to facilitate the new
  43   external mempool manager functionality.
  44   The ring element will be replaced with a more generic 'pool' opaque pointer
  45   to allow new mempool handlers to use their own user-defined mempool
  46   layout. Also newly added to rte_mempool is a handler index.
  47   The existing API will be backward compatible, but there will be new API
  48   functions added to facilitate the creation of mempools using an external
  49   handler. The 16.07 release will contain these changes.
  50
  51 * A librte_vhost public structures refactor is planned for DPDK 16.07
  52   that requires both ABI and API change.
  53   The proposed refactor would expose DPDK vhost dev to applications as
  54   a handle, like the way kernel exposes an fd to user for locating a
  55   specific file, and to keep all major structures internally, so that
  56   we are likely to be free from ABI violations in future.
  57
  58 * The mbuf flags PKT_RX_VLAN_PKT and PKT_RX_QINQ_PKT are deprecated and
  59   are respectively replaced by PKT_RX_VLAN_STRIPPED and
  60   PKT_RX_QINQ_STRIPPED, that are better described. The old flags and
  61   their behavior will be kept in 16.07 and will be removed in 16.11.