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 * ring: Changes are planned to rte_ring APIs in release 17.05. Proposed
  12   changes include:
  13
  14     - Removing build time options for the ring:
  15       CONFIG_RTE_RING_SPLIT_PROD_CONS
  16       CONFIG_RTE_RING_PAUSE_REP_COUNT
  17     - Adding an additional parameter to enqueue functions to return the
  18       amount of free space in the ring
  19     - Adding an additional parameter to dequeue functions to return the
  20       number of remaining elements in the ring
  21     - Removing direct support for watermarks in the rings, since the
  22       additional return value from the enqueue function makes it
  23       unneeded
  24     - Adjusting the return values of the bulk() enq/deq functions to
  25       make them consistent with the burst() equivalents. [Note, parameter
  26       to these functions are changing too, per points above, so compiler
  27       will flag them as needing update in legacy code]
  28     - Updates to some library functions e.g. rte_ring_get_memsize() to
  29       allow for variably-sized ring elements.
  30
  31 * igb_uio: iomem mapping and sysfs files created for iomem and ioport in
  32   igb_uio will be removed, because we are able to detect these from what Linux
  33   has exposed, like the way we have done with uio-pci-generic. This change
  34   targets release 17.05.
  35
  36 * ``eth_driver`` is planned to be removed in 17.02. This currently serves as
  37   a placeholder for PMDs to register themselves. Changes for ``rte_bus`` will
  38   provide a way to handle device initialization currently being done in
  39   ``eth_driver``.
  40
  41 * ethdev: an API change is planned for 17.02 for the function
  42   ``_rte_eth_dev_callback_process``. In 17.02 the function will return an ``int``
  43   instead of ``void`` and a fourth parameter ``void *ret_param`` will be added.
  44
  45 * ABI changes are planned for 17.05 in the ``rte_mbuf`` structure: some fields
  46   may be reordered to facilitate the writing of ``data_off``, ``refcnt``, and
  47   ``nb_segs`` in one operation, because some platforms have an overhead if the
  48   store address is not naturally aligned. Other mbuf fields, such as the
  49   ``port`` field, may be moved or removed as part of this mbuf work. A
  50   ``timestamp`` will also be added.
  51
  52 * The mbuf flags PKT_RX_VLAN_PKT and PKT_RX_QINQ_PKT are deprecated and
  53   are respectively replaced by PKT_RX_VLAN_STRIPPED and
  54   PKT_RX_QINQ_STRIPPED, that are better described. The old flags and
  55   their behavior will be kept until 17.02 and will be removed in 17.05.
  56
  57 * mempool: The functions ``rte_mempool_count`` and ``rte_mempool_free_count``
  58   will be removed in 17.05.
  59   They are replaced by ``rte_mempool_avail_count`` and
  60   ``rte_mempool_in_use_count`` respectively.
  61
  62 * mempool: The functions for single/multi producer/consumer are deprecated
  63   and will be removed in 17.05.
  64   It is replaced by ``rte_mempool_generic_get/put`` functions.
  65
  66 * ethdev: the legacy filter API, including
  67   ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
  68   as filter types MACVLAN, ETHERTYPE, FLEXIBLE, SYN, NTUPLE, TUNNEL, FDIR,
  69   HASH and L2_TUNNEL, is superseded by the generic flow API (rte_flow) in
  70   PMDs that implement the latter.
  71   Target release for removal of the legacy API will be defined once most
  72   PMDs have switched to rte_flow.
  73
  74 * distributor: library API will be changed to incorporate a burst-oriented
  75   API. This will include a change to ``rte_distributor_create``
  76   to specify which type of instance to create (single or burst), and
  77   additional calls for ``rte_distributor_poll_pkt_burst`` and
  78   ``rte_distributor_return_pkt_burst``, among others.
  79
  80 * The architecture TILE-Gx and the associated mpipe driver are not
  81   maintained and will be removed in 17.05.