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 * eal: several API and ABI changes are planned for ``rte_devargs`` in v17.11.
20 The format of device command line parameters will change. The bus will need
21 to be explicitly stated in the device declaration. The enum ``rte_devtype``
22 was used to identify a bus and will disappear.
23 The structure ``rte_devargs`` will change.
24 The ``rte_devargs_list`` will be made private.
25 The following functions are deprecated starting from 17.08 and will either be
26 modified or removed in 17.11:
28 - ``rte_eal_devargs_add``
29 - ``rte_eal_devargs_type_count``
30 - ``rte_eal_parse_devargs_str``, replaced by ``rte_eal_devargs_parse``
32 * eal: An ABI change is planned for 17.11 to make DPDK aware of IOVA address
34 Reference to phys address in EAL data-structure or functions may change to
35 IOVA address or more appropriate name.
36 The change will be only for the name.
37 Functional aspects of the API or data-structure will remain same.
39 * The mbuf flags PKT_RX_VLAN_PKT and PKT_RX_QINQ_PKT are deprecated and
40 are respectively replaced by PKT_RX_VLAN_STRIPPED and
41 PKT_RX_QINQ_STRIPPED, that are better described. The old flags and
42 their behavior will be kept until 17.08 and will be removed in 17.11.
44 * ethdev: Tx offloads will no longer be enabled by default in 17.11.
45 Instead, the ``rte_eth_txmode`` structure will be extended with
46 bit field to enable each Tx offload.
47 Besides of making the Rx/Tx configuration API more consistent for the
48 application, PMDs will be able to provide a better out of the box performance.
49 As part of the work, ``ETH_TXQ_FLAGS_NO*`` will be superseded as well.
51 * ethdev: the legacy filter API, including
52 ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
53 as filter types MACVLAN, ETHERTYPE, FLEXIBLE, SYN, NTUPLE, TUNNEL, FDIR,
54 HASH and L2_TUNNEL, is superseded by the generic flow API (rte_flow) in
55 PMDs that implement the latter.
56 Target release for removal of the legacy API will be defined once most
57 PMDs have switched to rte_flow.
59 * ethdev: The device flag advertizing hotplug capability
60 ``RTE_ETH_DEV_DETACHABLE`` is not needed anymore and will be removed in
62 This capability is verified upon calling the relevant hotplug functions in EAL
63 by checking that the ``unplug`` ops is set in the bus. This verification is
64 done by the EAL and not by the ``ethdev`` layer anymore. Users relying on this
65 flag being present only have to remove their checks to follow the change.
67 * ethdev: An ABI change is planned for 17.11 for the structure rte_eth_dev_data.
68 The size of the unique name will increase RTE_ETH_NAME_MAX_LEN from 32 to
69 64 characters to allow using a globally unique identifier (GUID) in this field.
71 * ethdev: new parameters - ``rte_security_capabilities`` and
72 ``rte_security_ops`` will be added to ``rte_eth_dev_info`` and
73 ``rte_eth_dev`` respectively to support security operations like
76 * cryptodev: new parameters - ``rte_security_capabilities`` and
77 ``rte_security_ops`` will be added to ``rte_cryptodev_info`` and
78 ``rte_cryptodev`` respectively to support security protocol offloaded
81 * cryptodev: the following function is deprecated starting from 17.08 and will
84 - ``rte_cryptodev_create_vdev``
86 * cryptodev: the following function will be static in 17.11 and included
87 by all crypto drivers, therefore, will not be public:
89 - ``rte_cryptodev_vdev_pmd_init``
91 * cryptodev: the following function will have an extra parameter, passing a
92 statically allocated crypto driver structure, instead of calling malloc,
95 - ``rte_cryptodev_allocate_driver``
97 * librte_meter: The API will change to accommodate configuration profiles.
98 Most of the API functions will have an additional opaque parameter.
100 * librte_table: The ``key_mask`` parameter will be added to all the hash tables
101 that currently do not have it, as well as to the hash compute function prototype.
102 The non-"do-sig" versions of the hash tables will be removed
103 (including the ``signature_offset`` parameter)
104 and the "do-sig" versions renamed accordingly.