1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright 2018 The DPDK contributors
4 ABI and API Deprecation
5 =======================
7 See the :doc:`guidelines document for details of the ABI policy </contributing/versioning>`.
8 API and ABI deprecation notices are to be posted here.
14 * meson: The minimum supported version of meson for configuring and building
15 DPDK will be increased to v0.47.1 (from 0.41) from DPDK 19.05 onwards. For
16 those users with a version earlier than 0.47.1, an updated copy of meson
17 can be got using the ``pip``, or ``pip3``, tool for downloading python
20 * kvargs: The function ``rte_kvargs_process`` will get a new parameter
21 for returning key match count. It will ease handling of no-match case.
23 * eal: The function ``rte_eal_remote_launch`` will return new error codes
24 after read or write error on the pipe, instead of calling ``rte_panic``.
26 * eal: both declaring and identifying devices will be streamlined in v18.11.
27 New functions will appear to query a specific port from buses, classes of
28 device and device drivers. Device declaration will be made coherent with the
29 new scheme of device identification.
30 As such, ``rte_devargs`` device representation will change.
32 - The enum ``rte_devtype`` was used to identify a bus and will disappear.
33 - Functions previously deprecated will change or disappear:
35 + ``rte_eal_devargs_type_count``
37 * eal: The ``rte_cpu_check_supported`` function has been deprecated since
38 v17.08 and will be removed.
40 * eal: The ``rte_malloc_virt2phy`` function has been deprecated and replaced
41 by ``rte_malloc_virt2iova`` since v17.11 and will be removed.
43 * vfio: removal of ``rte_vfio_dma_map`` and ``rte_vfio_dma_unmap`` APIs which
44 have been replaced with ``rte_dev_dma_map`` and ``rte_dev_dma_unmap``
45 functions. The due date for the removal targets DPDK 20.02.
47 * pci: Several exposed functions are misnamed.
48 The following functions are deprecated starting from v17.11 and are replaced:
50 - ``eal_parse_pci_BDF`` replaced by ``rte_pci_addr_parse``
51 - ``eal_parse_pci_DomBDF`` replaced by ``rte_pci_addr_parse``
52 - ``rte_eal_compare_pci_addr`` replaced by ``rte_pci_addr_cmp``
54 * dpaa2: removal of ``rte_dpaa2_memsegs`` structure which has been replaced
55 by a pa-va search library. This structure was earlier being used for holding
56 memory segments used by dpaa2 driver for faster pa->va translation. This
57 structure would be made internal (or removed if all dependencies are cleared)
60 * net: The Ethernet address and header definitions will change
61 attributes. The Ethernet address struct will no longer be marked as
62 packed since the packed attribute is meaningless on a byte
63 array. The Ethernet header will be marked as aligned on a 2-byte
64 boundary and will no longer have the packed attribute. This allows
65 for efficient access on CPU architectures where unaligned access is
66 expensive. These changes should not impact normal usage because drivers
67 naturally align the Ethernet header on receive and all known
68 encapsulations preserve the alignment of the header.
70 * ethdev: The function ``rte_eth_dev_count`` will be removed in DPDK 20.02.
71 It is replaced by the function ``rte_eth_dev_count_avail``.
72 If the intent is to iterate over ports, ``RTE_ETH_FOREACH_*`` macros
73 are better port iterators.
75 * ethdev: the legacy filter API, including
76 ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
77 as filter types MACVLAN, ETHERTYPE, FLEXIBLE, SYN, NTUPLE, TUNNEL, FDIR,
78 HASH and L2_TUNNEL, is superseded by the generic flow API (rte_flow) in
79 PMDs that implement the latter.
80 Target release for removal of the legacy API will be defined once most
81 PMDs have switched to rte_flow.
83 * ethdev: Update API functions returning ``void`` to return ``int`` with
84 negative errno values to indicate various error conditions (e.g.
85 invalid port ID, unsupported operation, failed operation):
87 - ``rte_eth_dev_stop``
88 - ``rte_eth_dev_close``
90 * ethdev: New offload flags ``DEV_RX_OFFLOAD_RSS_HASH`` and
91 ``DEV_RX_OFFLOAD_FLOW_MARK`` will be added in 19.11.
92 This will allow application to enable or disable PMDs from updating
93 ``rte_mbuf::hash::rss`` and ``rte_mbuf::hash::fdir`` respectively.
94 This scheme will allow PMDs to avoid writes to ``rte_mbuf`` fields on Rx and
95 thereby improve Rx performance if application wishes do so.
96 In 19.11 PMDs will still update the fields even when the offloads are not
99 * ethdev: New function ``rte_eth_dev_set_supported_ptypes`` will be added in
101 This will allow application to request PMD to set specific ptypes defined
102 through ``rte_eth_dev_set_supported_ptypes`` in ``rte_mbuf::packet_type``.
103 If application doesn't want any ptype information it can call
104 ``rte_eth_dev_set_supported_ptypes(ethdev_id, RTE_PTYPE_UNKNOWN)`` and PMD
105 will set ``rte_mbuf::packet_type`` to ``0``.
106 If application doesn't call ``rte_eth_dev_set_supported_ptypes`` PMD can
107 return ``rte_mbuf::packet_type`` with ``rte_eth_dev_get_supported_ptypes``.
108 If application is interested only in L2/L3 layer, it can inform the PMD
109 to update ``rte_mbuf::packet_type`` with L2/L3 ptype by calling
110 ``rte_eth_dev_set_supported_ptypes(ethdev_id, RTE_PTYPE_L2_MASK | RTE_PTYPE_L3_MASK)``.
111 This scheme will allow PMDs to avoid lookup to internal ptype table on Rx and
112 thereby improve Rx performance if application wishes do so.
114 * ethdev: New 32-bit fields may be added for maximum LRO session size, in
115 struct ``rte_eth_dev_info`` for the port capability and in struct
116 ``rte_eth_rxmode`` for the port configuration.
118 * cryptodev: support for using IV with all sizes is added, J0 still can
119 be used but only when IV length in following structs ``rte_crypto_auth_xform``,
120 ``rte_crypto_aead_xform`` is set to zero. When IV length is greater or equal
121 to one it means it represents IV, when is set to zero it means J0 is used
122 directly, in this case 16 bytes of J0 need to be passed.
124 * sched: To allow more traffic classes, flexible mapping of pipe queues to
125 traffic classes, and subport level configuration of pipes and queues
126 changes will be made to macros, data structures and API functions defined
127 in "rte_sched.h". These changes are aligned to improvements suggested in the
128 RFC https://mails.dpdk.org/archives/dev/2018-November/120035.html.
130 * metrics: The function ``rte_metrics_init`` will have a non-void return
131 in order to notify errors instead of calling ``rte_exit``.
133 * power: ``rte_power_set_env`` function will no longer return 0 on attempt
134 to set new power environment if power environment was already initialized.
135 In this case the function will return -1 unless the environment is unset first
136 (using ``rte_power_unset_env``). Other function usage scenarios will not change.