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 * ring: Changes are planned to rte_ring APIs in release 17.05. Proposed
22 - Removing build time options for the ring:
23 CONFIG_RTE_RING_SPLIT_PROD_CONS
24 CONFIG_RTE_RING_PAUSE_REP_COUNT
25 - Adding an additional parameter to enqueue functions to return the
26 amount of free space in the ring
27 - Adding an additional parameter to dequeue functions to return the
28 number of remaining elements in the ring
29 - Removing direct support for watermarks in the rings, since the
30 additional return value from the enqueue function makes it
32 - Adjusting the return values of the bulk() enq/deq functions to
33 make them consistent with the burst() equivalents. [Note, parameter
34 to these functions are changing too, per points above, so compiler
35 will flag them as needing update in legacy code]
36 - Updates to some library functions e.g. rte_ring_get_memsize() to
37 allow for variably-sized ring elements.
39 * igb_uio: iomem mapping and sysfs files created for iomem and ioport in
40 igb_uio will be removed, because we are able to detect these from what Linux
41 has exposed, like the way we have done with uio-pci-generic. This change
42 targets release 17.05.
44 * vfio: Some functions are planned to be exported outside librte_eal in 17.05.
45 VFIO APIs like ``vfio_setup_device``, ``vfio_get_group_fd`` can be used by
46 subsystem other than EAL/PCI. For that, these need to be exported symbols.
47 Such APIs are planned to be renamed according to ``rte_*`` naming convention
48 and exported from librte_eal.
50 * The PCI and VDEV subsystems will be converted as drivers of the new bus model.
51 It will imply some EAL API changes in 17.05.
53 * ``eth_driver`` is planned to be removed in 17.05. This currently serves as
54 a placeholder for PMDs to register themselves. Changes for ``rte_bus`` will
55 provide a way to handle device initialization currently being done in
56 ``eth_driver``. Similarly, ``rte_pci_driver`` is planned to be removed from
57 ``rte_cryptodev_driver`` in 17.05.
59 * ethdev: An API change is planned for 17.05 for the function
60 ``_rte_eth_dev_callback_process``. In 17.05 the function will return an ``int``
61 instead of ``void`` and a fourth parameter ``void *ret_param`` will be added.
63 * ethdev: for 17.05 it is planned to deprecate the following nine rte_eth_dev_*
64 functions and move them into the ixgbe PMD:
66 ``rte_eth_dev_bypass_init``, ``rte_eth_dev_bypass_state_set``,
67 ``rte_eth_dev_bypass_state_show``, ``rte_eth_dev_bypass_event_store``,
68 ``rte_eth_dev_bypass_event_show``, ``rte_eth_dev_wd_timeout_store``,
69 ``rte_eth_dev_bypass_wd_timeout_show``, ``rte_eth_dev_bypass_ver_show``,
70 ``rte_eth_dev_bypass_wd_reset``.
72 The following fields will be removed from ``struct eth_dev_ops``:
74 ``bypass_init_t``, ``bypass_state_set_t``, ``bypass_state_show_t``,
75 ``bypass_event_set_t``, ``bypass_event_show_t``, ``bypass_wd_timeout_set_t``,
76 ``bypass_wd_timeout_show_t``, ``bypass_ver_show_t``, ``bypass_wd_reset_t``.
78 The functions will be renamed to the following, and moved to the ``ixgbe`` PMD:
80 ``rte_pmd_ixgbe_bypass_init``, ``rte_pmd_ixgbe_bypass_state_set``,
81 ``rte_pmd_ixgbe_bypass_state_show``, ``rte_pmd_ixgbe_bypass_event_set``,
82 ``rte_pmd_ixgbe_bypass_event_show``, ``rte_pmd_ixgbe_bypass_wd_timeout_set``,
83 ``rte_pmd_ixgbe_bypass_wd_timeout_show``, ``rte_pmd_ixgbe_bypass_ver_show``,
84 ``rte_pmd_ixgbe_bypass_wd_reset``.
86 * The mbuf flags PKT_RX_VLAN_PKT and PKT_RX_QINQ_PKT are deprecated and
87 are respectively replaced by PKT_RX_VLAN_STRIPPED and
88 PKT_RX_QINQ_STRIPPED, that are better described. The old flags and
89 their behavior will be kept until 17.02 and will be removed in 17.05.
91 * ethdev: the legacy filter API, including
92 ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
93 as filter types MACVLAN, ETHERTYPE, FLEXIBLE, SYN, NTUPLE, TUNNEL, FDIR,
94 HASH and L2_TUNNEL, is superseded by the generic flow API (rte_flow) in
95 PMDs that implement the latter.
96 Target release for removal of the legacy API will be defined once most
97 PMDs have switched to rte_flow.
99 * ABI changes are planned for 17.05 in the ``rte_cryptodev_ops`` structure.
100 A pointer to a rte_cryptodev_config structure will be added to the
101 function prototype ``cryptodev_configure_t``, as a new parameter.
103 * cryptodev: A new parameter ``max_nb_sessions_per_qp`` will be added to
104 ``rte_cryptodev_info.sym``. Some drivers may support limited number of
105 sessions per queue_pair. With this new parameter application will know
106 how many sessions can be mapped to each queue_pair of a device.
108 * distributor: library API will be changed to incorporate a burst-oriented
109 API. This will include a change to ``rte_distributor_create``
110 to specify which type of instance to create (single or burst), and
111 additional calls for ``rte_distributor_poll_pkt_burst`` and
112 ``rte_distributor_return_pkt_burst``, among others.