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 * devargs: An ABI change is planned for 17.08 for the structure ``rte_devargs``.
20 The current version is dependent on bus-specific device identifier, which will
21 be made generic and abstracted, in order to make the EAL bus-agnostic.
23 Accompanying this evolution, device command line parameters will thus support
24 explicit bus definition in a device declaration.
26 * igb_uio: iomem mapping and sysfs files created for iomem and ioport in
27 igb_uio will be removed, because we are able to detect these from what Linux
28 has exposed, like the way we have done with uio-pci-generic. This change
29 targets release 17.05.
31 * The VDEV subsystem will be converted as driver of the new bus model.
32 It may imply some EAL API changes in 17.08.
34 * The struct ``rte_pci_driver`` is planned to be removed from
35 ``rte_cryptodev_driver`` and ``rte_eventdev_driver`` in 17.08.
37 * The mbuf flags PKT_RX_VLAN_PKT and PKT_RX_QINQ_PKT are deprecated and
38 are respectively replaced by PKT_RX_VLAN_STRIPPED and
39 PKT_RX_QINQ_STRIPPED, that are better described. The old flags and
40 their behavior will be kept until 17.05 and will be removed in 17.08.
42 * ethdev: Tx offloads will no longer be enabled by default in 17.08.
43 Instead, the ``rte_eth_txmode`` structure will be extended with
44 bit field to enable each Tx offload.
45 Besides of making the Rx/Tx configuration API more consistent for the
46 application, PMDs will be able to provide a better out of the box performance.
47 As part of the work, ``ETH_TXQ_FLAGS_NO*`` will be superseded as well.
49 * ethdev: the legacy filter API, including
50 ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
51 as filter types MACVLAN, ETHERTYPE, FLEXIBLE, SYN, NTUPLE, TUNNEL, FDIR,
52 HASH and L2_TUNNEL, is superseded by the generic flow API (rte_flow) in
53 PMDs that implement the latter.
54 Target release for removal of the legacy API will be defined once most
55 PMDs have switched to rte_flow.
57 * cryptodev: API changes are planned for 17.08 for the sessions management
58 to make it agnostic to the underlying devices, removing coupling with
59 crypto PMDs, so a single session can be used on multiple devices.
61 An API of followed functions will be changed to allow operate on multiple
62 devices with one session:
64 - ``rte_cryptodev_sym_session_create``
65 - ``rte_cryptodev_sym_session_free``
66 - ``rte_cryptodev_sym_session_pool_create``
68 While dev_id will not be stored in the ``struct rte_cryptodev_sym_session``,
69 directly, the change of followed API is required:
71 - ``rte_cryptodev_queue_pair_attach_sym_session``
72 - ``rte_cryptodev_queue_pair_detach_sym_session``
74 * librte_table: The ``key_mask`` parameter will be added to all the hash tables
75 that currently do not have it, as well as to the hash compute function prototype.
76 The non-"do-sig" versions of the hash tables will be removed
77 (including the ``signature_offset`` parameter)
78 and the "do-sig" versions renamed accordingly.