1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright 2018 The DPDK contributors
4 ABI and API Deprecation
5 =======================
7 See the guidelines document for details of the :doc:`ABI policy
8 <../contributing/abi_policy>`. API and ABI deprecation notices are to be posted
14 * build: The macros defined to indicate which DPDK libraries and drivers
15 are included in the meson build are changing to a standardized format of
16 ``RTE_LIB_<NAME>`` and ``RTE_<CLASS>_<NAME>``, where ``NAME`` is the
17 upper-case component name, e.g. EAL, ETHDEV, IXGBE, and ``CLASS`` is the
18 upper-case name of the device class to which a driver belongs e.g.
19 ``NET``, ``CRYPTO``, ``VDPA``. The old macros are deprecated and will be
20 removed in a future release.
22 * kvargs: The function ``rte_kvargs_process`` will get a new parameter
23 for returning key match count. It will ease handling of no-match case.
25 * eal: The function ``rte_eal_remote_launch`` will return new error codes
26 after read or write error on the pipe, instead of calling ``rte_panic``.
28 * rte_atomicNN_xxx: These APIs do not take memory order parameter. This does
29 not allow for writing optimized code for all the CPU architectures supported
30 in DPDK. DPDK will adopt C11 atomic operations semantics and provide wrappers
31 using C11 atomic built-ins. These wrappers must be used for patches that
32 need to be merged in 20.08 onwards. This change will not introduce any
33 performance degradation.
35 * rte_smp_*mb: These APIs provide full barrier functionality. However, many
36 use cases do not require full barriers. To support such use cases, DPDK will
37 adopt C11 barrier semantics and provide wrappers using C11 atomic built-ins.
38 These wrappers must be used for patches that need to be merged in 20.08
39 onwards. This change will not introduce any performance degradation.
41 * lib: will fix extending some enum/define breaking the ABI. There are multiple
42 samples in DPDK that enum/define terminated with a ``.*MAX.*`` value which is
43 used by iterators, and arrays holding these values are sized with this
44 ``.*MAX.*`` value. So extending this enum/define increases the ``.*MAX.*``
45 value which increases the size of the array and depending on how/where the
46 array is used this may break the ABI.
47 ``RTE_ETH_FLOW_MAX`` is one sample of the mentioned case, adding a new flow
48 type will break the ABI because of ``flex_mask[RTE_ETH_FLOW_MAX]`` array
49 usage in following public struct hierarchy:
50 ``rte_eth_fdir_flex_conf -> rte_fdir_conf -> rte_eth_conf (in the middle)``.
51 Need to identify this kind of usages and fix in 20.11, otherwise this blocks
52 us extending existing enum/define.
53 One solution can be using a fixed size array instead of ``.*MAX.*`` value.
55 * ethdev: The flow director API, including ``rte_eth_conf.fdir_conf`` field,
56 and the related structures (``rte_fdir_*`` and ``rte_eth_fdir_*``),
57 will be removed in DPDK 20.11.
59 * ethdev: New offload flags ``DEV_RX_OFFLOAD_FLOW_MARK`` will be added in 19.11.
60 This will allow application to enable or disable PMDs from updating
61 ``rte_mbuf::hash::fdir``.
62 This scheme will allow PMDs to avoid writes to ``rte_mbuf`` fields on Rx and
63 thereby improve Rx performance if application wishes do so.
64 In 19.11 PMDs will still update the field even when the offload is not
67 * ethdev: ``rx_descriptor_done`` dev_ops and ``rte_eth_rx_descriptor_done``
68 will be removed in 21.11.
69 Existing ``rte_eth_rx_descriptor_status`` and ``rte_eth_tx_descriptor_status``
70 APIs can be used as replacement.
72 * ethdev: The port mirroring API can be replaced with a more fine grain flow API.
73 The structs ``rte_eth_mirror_conf``, ``rte_eth_vlan_mirror`` and the functions
74 ``rte_eth_mirror_rule_set``, ``rte_eth_mirror_rule_reset`` will be marked
75 as deprecated in DPDK 20.11, along with the associated macros ``ETH_MIRROR_*``.
76 This API will be fully removed in DPDK 21.11.
78 * ethdev: Attribute ``shared`` of the ``struct rte_flow_action_count``
79 is deprecated and will be removed in DPDK 21.11. Shared counters should
80 be managed using shared actions API (``rte_flow_shared_action_create`` etc).
82 * ethdev: The flow API matching pattern structures, ``struct rte_flow_item_*``,
83 should start with relevant protocol header.
84 Some matching pattern structures implements this by duplicating protocol header
85 fields in the struct. To clarify the intention and to be sure protocol header
86 is intact, will replace those fields with relevant protocol header struct.
87 In v21.02 both individual protocol header fields and the protocol header struct
88 will be added as union, target is switch usage to the protocol header by time.
89 In v21.11 LTS, protocol header fields will be cleaned and only protocol header
92 * ethdev: Queue specific stats fields will be removed from ``struct rte_eth_stats``.
93 Mentioned fields are: ``q_ipackets``, ``q_opackets``, ``q_ibytes``, ``q_obytes``,
95 Instead queue stats will be received via xstats API. Current method support
96 will be limited to maximum 256 queues.
97 Also compile time flag ``RTE_ETHDEV_QUEUE_STAT_CNTRS`` will be removed.
99 * Broadcom bnxt PMD: NetXtreme devices belonging to the ``BCM573xx and
100 BCM5740x`` families will no longer be supported as of DPDK 21.02.
101 Specifically the support for the following Broadcom PCI IDs will be removed
102 from the release: ``0x16c8, 0x16c9, 0x16ca, 0x16ce, 0x16cf, 0x16df,``
103 ``0x16d0, 0x16d1, 0x16d2, 0x16d4, 0x16d5, 0x16e7, 0x16e8, 0x16e9``.
105 * sched: To allow more traffic classes, flexible mapping of pipe queues to
106 traffic classes, and subport level configuration of pipes and queues
107 changes will be made to macros, data structures and API functions defined
108 in "rte_sched.h". These changes are aligned to improvements suggested in the
109 RFC https://mails.dpdk.org/archives/dev/2018-November/120035.html.
111 * metrics: The function ``rte_metrics_init`` will have a non-void return
112 in order to notify errors instead of calling ``rte_exit``.
114 * cmdline: ``cmdline`` structure will be made opaque to hide platform-specific
115 content. On Linux and FreeBSD, supported prior to DPDK 20.11,
116 original structure will be kept until DPDK 21.11.