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.05.
  15
  16 * ``eth_driver`` is planned to be removed in 17.02. This currently serves as
  17   a placeholder for PMDs to register themselves. Changes for ``rte_bus`` will
  18   provide a way to handle device initialization currently being done in
  19   ``eth_driver``.
  20
  21 * ethdev: an API change is planned for 17.02 for the function
  22   ``_rte_eth_dev_callback_process``. In 17.02 the function will return an ``int``
  23   instead of ``void`` and a fourth parameter ``void *ret_param`` will be added.
  24
  25 * ABI changes are planned for 17.05 in the ``rte_mbuf`` structure: some fields
  26   may be reordered to facilitate the writing of ``data_off``, ``refcnt``, and
  27   ``nb_segs`` in one operation, because some platforms have an overhead if the
  28   store address is not naturally aligned. Other mbuf fields, such as the
  29   ``port`` field, may be moved or removed as part of this mbuf work. A
  30   ``timestamp`` will also be added.
  31
  32 * The mbuf flags PKT_RX_VLAN_PKT and PKT_RX_QINQ_PKT are deprecated and
  33   are respectively replaced by PKT_RX_VLAN_STRIPPED and
  34   PKT_RX_QINQ_STRIPPED, that are better described. The old flags and
  35   their behavior will be kept until 17.02 and will be removed in 17.05.
  36
  37 * mempool: The functions ``rte_mempool_count`` and ``rte_mempool_free_count``
  38   will be removed in 17.05.
  39   They are replaced by ``rte_mempool_avail_count`` and
  40   ``rte_mempool_in_use_count`` respectively.
  41
  42 * mempool: The functions for single/multi producer/consumer are deprecated
  43   and will be removed in 17.05.
  44   It is replaced by ``rte_mempool_generic_get/put`` functions.
  45
  46 * ethdev: the legacy filter API, including
  47   ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
  48   as filter types MACVLAN, ETHERTYPE, FLEXIBLE, SYN, NTUPLE, TUNNEL, FDIR,
  49   HASH and L2_TUNNEL, is superseded by the generic flow API (rte_flow) in
  50   PMDs that implement the latter.
  51   Target release for removal of the legacy API will be defined once most
  52   PMDs have switched to rte_flow.
  53
  54 * distributor: library API will be changed to incorporate a burst-oriented
  55   API. This will include a change to ``rte_distributor_create``
  56   to specify which type of instance to create (single or burst), and
  57   additional calls for ``rte_distributor_poll_pkt_burst`` and
  58   ``rte_distributor_return_pkt_burst``, among others.
  59
  60 * The architecture TILE-Gx and the associated mpipe driver are not
  61   maintained and will be removed in 17.05.