1 ABI and API Deprecation
2 =======================
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.
11 * eal: the following functions are deprecated starting from 17.05 and will
14 - ``rte_set_log_level``, replaced by ``rte_log_set_global_level``
15 - ``rte_get_log_level``, replaced by ``rte_log_get_global_level``
16 - ``rte_set_log_type``, replaced by ``rte_log_set_level``
17 - ``rte_get_log_type``, replaced by ``rte_log_get_level``
19 * igb_uio: iomem mapping and sysfs files created for iomem and ioport in
20 igb_uio will be removed, because we are able to detect these from what Linux
21 has exposed, like the way we have done with uio-pci-generic. This change
22 targets release 17.05.
24 * vfio: Some functions are planned to be exported outside librte_eal in 17.05.
25 VFIO APIs like ``vfio_setup_device``, ``vfio_get_group_fd`` can be used by
26 subsystem other than EAL/PCI. For that, these need to be exported symbols.
27 Such APIs are planned to be renamed according to ``rte_*`` naming convention
28 and exported from librte_eal.
30 * The VDEV subsystem will be converted as driver of the new bus model.
31 It will imply some EAL API changes in 17.05.
33 * ``eth_driver`` is planned to be removed in 17.05. This currently serves as
34 a placeholder for PMDs to register themselves. Changes for ``rte_bus`` will
35 provide a way to handle device initialization currently being done in
36 ``eth_driver``. Similarly, ``rte_pci_driver`` is planned to be removed from
37 ``rte_cryptodev_driver`` in 17.05.
39 * ethdev: An API change is planned for 17.05 for the function
40 ``_rte_eth_dev_callback_process``. In 17.05 the function will return an ``int``
41 instead of ``void`` and a fourth parameter ``void *ret_param`` will be added.
43 * ethdev: for 17.05 it is planned to deprecate the following nine rte_eth_dev_*
44 functions and move them into the ixgbe PMD:
46 ``rte_eth_dev_bypass_init``, ``rte_eth_dev_bypass_state_set``,
47 ``rte_eth_dev_bypass_state_show``, ``rte_eth_dev_bypass_event_store``,
48 ``rte_eth_dev_bypass_event_show``, ``rte_eth_dev_wd_timeout_store``,
49 ``rte_eth_dev_bypass_wd_timeout_show``, ``rte_eth_dev_bypass_ver_show``,
50 ``rte_eth_dev_bypass_wd_reset``.
52 The following fields will be removed from ``struct eth_dev_ops``:
54 ``bypass_init_t``, ``bypass_state_set_t``, ``bypass_state_show_t``,
55 ``bypass_event_set_t``, ``bypass_event_show_t``, ``bypass_wd_timeout_set_t``,
56 ``bypass_wd_timeout_show_t``, ``bypass_ver_show_t``, ``bypass_wd_reset_t``.
58 The functions will be renamed to the following, and moved to the ``ixgbe`` PMD:
60 ``rte_pmd_ixgbe_bypass_init``, ``rte_pmd_ixgbe_bypass_state_set``,
61 ``rte_pmd_ixgbe_bypass_state_show``, ``rte_pmd_ixgbe_bypass_event_set``,
62 ``rte_pmd_ixgbe_bypass_event_show``, ``rte_pmd_ixgbe_bypass_wd_timeout_set``,
63 ``rte_pmd_ixgbe_bypass_wd_timeout_show``, ``rte_pmd_ixgbe_bypass_ver_show``,
64 ``rte_pmd_ixgbe_bypass_wd_reset``.
66 * The mbuf flags PKT_RX_VLAN_PKT and PKT_RX_QINQ_PKT are deprecated and
67 are respectively replaced by PKT_RX_VLAN_STRIPPED and
68 PKT_RX_QINQ_STRIPPED, that are better described. The old flags and
69 their behavior will be kept until 17.02 and will be removed in 17.05.
71 * ethdev: the legacy filter API, including
72 ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
73 as filter types MACVLAN, ETHERTYPE, FLEXIBLE, SYN, NTUPLE, TUNNEL, FDIR,
74 HASH and L2_TUNNEL, is superseded by the generic flow API (rte_flow) in
75 PMDs that implement the latter.
76 Target release for removal of the legacy API will be defined once most
77 PMDs have switched to rte_flow.
79 * crypto/scheduler: the following two functions are deprecated starting
80 from 17.05 and will be removed in 17.08:
82 - ``rte_crpytodev_scheduler_mode_get``, replaced by ``rte_cryptodev_scheduler_mode_get``
83 - ``rte_crpytodev_scheduler_mode_set``, replaced by ``rte_cryptodev_scheduler_mode_set``