Deprecation Notices
-------------------
-* ring: Changes are planned to rte_ring APIs in release 17.05. Proposed
- changes include:
-
- - Removing build time options for the ring:
- CONFIG_RTE_RING_SPLIT_PROD_CONS
- CONFIG_RTE_RING_PAUSE_REP_COUNT
- - Adding an additional parameter to enqueue functions to return the
- amount of free space in the ring
- - Adding an additional parameter to dequeue functions to return the
- number of remaining elements in the ring
- - Removing direct support for watermarks in the rings, since the
- additional return value from the enqueue function makes it
- unneeded
- - Adjusting the return values of the bulk() enq/deq functions to
- make them consistent with the burst() equivalents. [Note, parameter
- to these functions are changing too, per points above, so compiler
- will flag them as needing update in legacy code]
- - Updates to some library functions e.g. rte_ring_get_memsize() to
- allow for variably-sized ring elements.
+* eal: the following functions are deprecated starting from 17.05 and will
+ be removed in 17.08:
+
+ - ``rte_set_log_level``, replaced by ``rte_log_set_global_level``
+ - ``rte_get_log_level``, replaced by ``rte_log_get_global_level``
+ - ``rte_set_log_type``, replaced by ``rte_log_set_level``
+ - ``rte_get_log_type``, replaced by ``rte_log_get_level``
* igb_uio: iomem mapping and sysfs files created for iomem and ioport in
igb_uio will be removed, because we are able to detect these from what Linux
``rte_pmd_ixgbe_bypass_wd_timeout_show``, ``rte_pmd_ixgbe_bypass_ver_show``,
``rte_pmd_ixgbe_bypass_wd_reset``.
-* ABI changes are planned for 17.05 in the ``rte_mbuf`` structure: some fields
- may be reordered to facilitate the writing of ``data_off``, ``refcnt``, and
- ``nb_segs`` in one operation, because some platforms have an overhead if the
- store address is not naturally aligned. Other mbuf fields, such as the
- ``port`` field, may be moved or removed as part of this mbuf work. A
- ``timestamp`` will also be added.
-
* The mbuf flags PKT_RX_VLAN_PKT and PKT_RX_QINQ_PKT are deprecated and
are respectively replaced by PKT_RX_VLAN_STRIPPED and
PKT_RX_QINQ_STRIPPED, that are better described. The old flags and
their behavior will be kept until 17.02 and will be removed in 17.05.
-* mempool: The functions ``rte_mempool_count`` and ``rte_mempool_free_count``
- will be removed in 17.05.
- They are replaced by ``rte_mempool_avail_count`` and
- ``rte_mempool_in_use_count`` respectively.
-
-* mempool: The functions for single/multi producer/consumer are deprecated
- and will be removed in 17.05.
- It is replaced by ``rte_mempool_generic_get/put`` functions.
-
* ethdev: the legacy filter API, including
``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
as filter types MACVLAN, ETHERTYPE, FLEXIBLE, SYN, NTUPLE, TUNNEL, FDIR,
PMDs that implement the latter.
Target release for removal of the legacy API will be defined once most
PMDs have switched to rte_flow.
-
-* vhost: API/ABI changes are planned for 17.05, for making DPDK vhost library
- generic enough so that applications can build different vhost-user drivers
- (instead of vhost-user net only) on top of that.
- Specifically, ``virtio_net_device_ops`` will be renamed to ``vhost_device_ops``.
- Correspondingly, some API's parameter need be changed. Few more functions also
- need be reworked to let it be device aware. For example, different virtio device
- has different feature set, meaning functions like ``rte_vhost_feature_disable``
- need be changed. Last, file rte_virtio_net.h will be renamed to rte_vhost.h.
-
-* kni: Remove :ref:`kni_vhost_backend-label` feature (KNI_VHOST) in 17.05 release.
- :doc:`Vhost Library </prog_guide/vhost_lib>` is currently preferred method for
- guest - host communication. Just for clarification, this is not to remove KNI
- or VHOST feature, but KNI_VHOST which is a KNI feature enabled via a compile
- time option, and disabled by default.
-
-* distributor: library API will be changed to incorporate a burst-oriented
- API. This will include a change to ``rte_distributor_create``
- to specify which type of instance to create (single or burst), and
- additional calls for ``rte_distributor_poll_pkt_burst`` and
- ``rte_distributor_return_pkt_burst``, among others.
-
-* The architecture TILE-Gx and the associated mpipe driver are not
- maintained and will be removed in 17.05.