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