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 * 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.
  15
  16 * ABI/API changes are planned for 17.02: ``rte_device``, ``rte_driver`` will be
  17   impacted because of introduction of a new ``rte_bus`` hierarchy. This would
  18   also impact the way devices are identified by EAL. A bus-device-driver model
  19   will be introduced providing a hierarchical view of devices.
  20
  21 * ``eth_driver`` is planned to be removed in 17.02. This currently serves as
  22   a placeholder for PMDs to register themselves. Changes for ``rte_bus`` will
  23   provide a way to handle device initialization currently being done in
  24   ``eth_driver``.
  25
  26 * In 17.02 ABI changes are planned: the ``rte_eth_dev`` structure will be
  27   extended with new function pointer ``tx_pkt_prepare`` allowing verification
  28   and processing of packet burst to meet HW specific requirements before
  29   transmit. Also new fields will be added to the ``rte_eth_desc_lim`` structure:
  30   ``nb_seg_max`` and ``nb_mtu_seg_max`` providing information about number of
  31   segments limit to be transmitted by device for TSO/non-TSO packets.
  32
  33 * ethdev: an API change is planned for 17.02 for the function
  34   ``_rte_eth_dev_callback_process``. In 17.02 the function will return an ``int``
  35   instead of ``void`` and a fourth parameter ``void *ret_param`` will be added.
  36
  37 * ABI changes are planned for 17.02 in the ``rte_mbuf`` structure: some fields
  38   may be reordered to facilitate the writing of ``data_off``, ``refcnt``, and
  39   ``nb_segs`` in one operation, because some platforms have an overhead if the
  40   store address is not naturally aligned. Other mbuf fields, such as the
  41   ``port`` field, may be moved or removed as part of this mbuf work. A
  42   ``timestamp`` will also be added.
  43
  44 * The mbuf flags PKT_RX_VLAN_PKT and PKT_RX_QINQ_PKT are deprecated and
  45   are respectively replaced by PKT_RX_VLAN_STRIPPED and
  46   PKT_RX_QINQ_STRIPPED, that are better described. The old flags and
  47   their behavior will be kept until 16.11 and will be removed in 17.02.
  48
  49 * mempool: The functions ``rte_mempool_count`` and ``rte_mempool_free_count``
  50   will be removed in 17.02.
  51   They are replaced by ``rte_mempool_avail_count`` and
  52   ``rte_mempool_in_use_count`` respectively.
  53
  54 * mempool: The functions for single/multi producer/consumer are deprecated
  55   and will be removed in 17.02.
  56   It is replaced by ``rte_mempool_generic_get/put`` functions.
  57
  58 * ethdev: the legacy filter API, including
  59   ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
  60   as filter types MACVLAN, ETHERTYPE, FLEXIBLE, SYN, NTUPLE, TUNNEL, FDIR,
  61   HASH and L2_TUNNEL, is superseded by the generic flow API (rte_flow) in
  62   PMDs that implement the latter.
  63   Target release for removal of the legacy API will be defined once most
  64   PMDs have switched to rte_flow.