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