doc/guides/rel_notes/deprecation.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright 2018 The DPDK contributors
   3
   4 ABI and API Deprecation
   5 =======================
   6
   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
   9 here.
  10
  11 Deprecation Notices
  12 -------------------
  13
  14 * kvargs: The function ``rte_kvargs_process`` will get a new parameter
  15   for returning key match count. It will ease handling of no-match case.
  16
  17 * eal: The function ``rte_eal_remote_launch`` will return new error codes
  18   after read or write error on the pipe, instead of calling ``rte_panic``.
  19
  20 * eal: Making ``struct rte_intr_handle`` internal to avoid any ABI breakages
  21   in future.
  22
  23 * rte_atomicNN_xxx: These APIs do not take memory order parameter. This does
  24   not allow for writing optimized code for all the CPU architectures supported
  25   in DPDK. DPDK has adopted the atomic operations from
  26   https://gcc.gnu.org/onlinedocs/gcc/_005f_005fatomic-Builtins.html. These
  27   operations must be used for patches that need to be merged in 20.08 onwards.
  28   This change will not introduce any performance degradation.
  29
  30 * rte_smp_*mb: These APIs provide full barrier functionality. However, many
  31   use cases do not require full barriers. To support such use cases, DPDK has
  32   adopted atomic operations from
  33   https://gcc.gnu.org/onlinedocs/gcc/_005f_005fatomic-Builtins.html. These
  34   operations and a new wrapper ``rte_atomic_thread_fence`` instead of
  35   ``__atomic_thread_fence`` must be used for patches that need to be merged in
  36   20.08 onwards. This change will not introduce any performance degradation.
  37
  38 * mbuf: The mbuf offload flags ``PKT_*`` will be renamed as ``RTE_MBUF_F_*``.
  39   A compatibility layer will be kept until DPDK 22.11, except for the flags
  40   that are already deprecated (``PKT_RX_L4_CKSUM_BAD``, ``PKT_RX_IP_CKSUM_BAD``,
  41   ``PKT_RX_EIP_CKSUM_BAD``, ``PKT_TX_QINQ_PKT``) which will be removed.
  42
  43 * pci: To reduce unnecessary ABIs exposed by DPDK bus driver, "rte_bus_pci.h"
  44   will be made internal in 21.11 and macros/data structures/functions defined
  45   in the header will not be considered as ABI anymore. This change is inspired
  46   by the RFC https://patchwork.dpdk.org/project/dpdk/list/?series=17176.
  47
  48 * lib: will fix extending some enum/define breaking the ABI. There are multiple
  49   samples in DPDK that enum/define terminated with a ``.*MAX.*`` value which is
  50   used by iterators, and arrays holding these values are sized with this
  51   ``.*MAX.*`` value. So extending this enum/define increases the ``.*MAX.*``
  52   value which increases the size of the array and depending on how/where the
  53   array is used this may break the ABI.
  54   ``RTE_ETH_FLOW_MAX`` is one sample of the mentioned case, adding a new flow
  55   type will break the ABI because of ``flex_mask[RTE_ETH_FLOW_MAX]`` array
  56   usage in following public struct hierarchy:
  57   ``rte_eth_fdir_flex_conf -> rte_fdir_conf -> rte_eth_conf (in the middle)``.
  58   Need to identify this kind of usages and fix in 20.11, otherwise this blocks
  59   us extending existing enum/define.
  60   One solution can be using a fixed size array instead of ``.*MAX.*`` value.
  61
  62 * ethdev: Will add ``RTE_ETH_`` prefix to all ethdev macros/enums in v21.11.
  63   Macros will be added for backward compatibility.
  64   Backward compatibility macros will be removed on v22.11.
  65   A few old backward compatibility macros from 2013 that does not have
  66   proper prefix will be removed on v21.11.
  67
  68 * ethdev: The flow director API, including ``rte_eth_conf.fdir_conf`` field,
  69   and the related structures (``rte_fdir_*`` and ``rte_eth_fdir_*``),
  70   will be removed in DPDK 20.11.
  71
  72 * ethdev: New offload flags ``DEV_RX_OFFLOAD_FLOW_MARK`` will be added in 19.11.
  73   This will allow application to enable or disable PMDs from updating
  74   ``rte_mbuf::hash::fdir``.
  75   This scheme will allow PMDs to avoid writes to ``rte_mbuf`` fields on Rx and
  76   thereby improve Rx performance if application wishes do so.
  77   In 19.11 PMDs will still update the field even when the offload is not
  78   enabled.
  79
  80 * ethdev: ``uint32_t max_rx_pkt_len`` field of ``struct rte_eth_rxmode``, will be
  81   replaced by a new ``uint32_t mtu`` field of ``struct rte_eth_conf`` in v21.11.
  82   The new ``mtu`` field will be used to configure the initial device MTU via
  83   ``rte_eth_dev_configure()`` API.
  84   Later MTU can be changed by ``rte_eth_dev_set_mtu()`` API as done now.
  85   The existing ``(struct rte_eth_dev)->data->mtu`` variable will be used to store
  86   the configured ``mtu`` value,
  87   and this new ``(struct rte_eth_dev)->data->dev_conf.mtu`` variable will
  88   be used to store the user configuration request.
  89   Unlike ``max_rx_pkt_len``, which was valid only when ``JUMBO_FRAME`` enabled,
  90   ``mtu`` field will be always valid.
  91   When ``mtu`` config is not provided by the application, default ``RTE_ETHER_MTU``
  92   value will be used.
  93   ``(struct rte_eth_dev)->data->mtu`` should be updated after MTU set successfully,
  94   either by ``rte_eth_dev_configure()`` or ``rte_eth_dev_set_mtu()``.
  95
  96   An application may need to configure device for a specific Rx packet size, like for
  97   cases ``DEV_RX_OFFLOAD_SCATTER`` is not supported and device received packet size
  98   can't be bigger than Rx buffer size.
  99   To cover these cases an application needs to know the device packet overhead to be
 100   able to calculate the ``mtu`` corresponding to a Rx buffer size, for this
 101   ``(struct rte_eth_dev_info).max_rx_pktlen`` will be kept,
 102   the device packet overhead can be calculated as:
 103   ``(struct rte_eth_dev_info).max_rx_pktlen - (struct rte_eth_dev_info).max_mtu``
 104
 105 * ethdev: ``rx_descriptor_done`` dev_ops and ``rte_eth_rx_descriptor_done``
 106   will be removed in 21.11.
 107   Existing ``rte_eth_rx_descriptor_status`` and ``rte_eth_tx_descriptor_status``
 108   APIs can be used as replacement.
 109
 110 * ethdev: The port mirroring API can be replaced with a more fine grain flow API.
 111   The structs ``rte_eth_mirror_conf``, ``rte_eth_vlan_mirror`` and the functions
 112   ``rte_eth_mirror_rule_set``, ``rte_eth_mirror_rule_reset`` will be marked
 113   as deprecated in DPDK 20.11, along with the associated macros ``ETH_MIRROR_*``.
 114   This API will be fully removed in DPDK 21.11.
 115
 116 * ethdev: Attribute ``shared`` of the ``struct rte_flow_action_count``
 117   is deprecated and will be removed in DPDK 21.11. Shared counters should
 118   be managed using shared actions API (``rte_flow_shared_action_create`` etc).
 119
 120 * ethdev: The flow API matching pattern structures, ``struct rte_flow_item_*``,
 121   should start with relevant protocol header.
 122   Some matching pattern structures implements this by duplicating protocol header
 123   fields in the struct. To clarify the intention and to be sure protocol header
 124   is intact, will replace those fields with relevant protocol header struct.
 125   In v21.02 both individual protocol header fields and the protocol header struct
 126   will be added as union, target is switch usage to the protocol header by time.
 127   In v21.11 LTS, protocol header fields will be cleaned and only protocol header
 128   struct will remain.
 129
 130 * ethdev: Queue specific stats fields will be removed from ``struct rte_eth_stats``.
 131   Mentioned fields are: ``q_ipackets``, ``q_opackets``, ``q_ibytes``, ``q_obytes``,
 132   ``q_errors``.
 133   Instead queue stats will be received via xstats API. Current method support
 134   will be limited to maximum 256 queues.
 135   Also compile time flag ``RTE_ETHDEV_QUEUE_STAT_CNTRS`` will be removed.
 136
 137 * ethdev: The offload flag ``PKT_RX_EIP_CKSUM_BAD`` will be removed and
 138   replaced by the new flag ``PKT_RX_OUTER_IP_CKSUM_BAD``. The new name is more
 139   consistent with existing outer header checksum status flag naming, which
 140   should help in reducing confusion about its usage.
 141
 142 * i40e: As there are both i40evf and iavf pmd, the functions of them are
 143   duplicated. And now more and more advanced features are developed on iavf.
 144   To keep consistent with kernel driver's name
 145   (https://patchwork.ozlabs.org/patch/970154/), i40evf is no need to maintain.
 146   Starting from 21.05, the default VF driver of i40e will be iavf, but i40evf
 147   can still be used if users specify the devarg "driver=i40evf". I40evf will
 148   be deleted in DPDK 21.11.
 149
 150 * net: ``s_addr`` and ``d_addr`` fields of ``rte_ether_hdr`` structure
 151   will be renamed in DPDK 21.11 to avoid conflict with Windows Sockets headers.
 152
 153 * net: The structure ``rte_ipv4_hdr`` will have two unions.
 154   The first union is for existing ``version_ihl`` byte
 155   and new bitfield for version and IHL.
 156   The second union is for existing ``fragment_offset``
 157   and new bitfield for fragment flags and offset.
 158
 159 * compressdev: ``min`` and ``max`` fields of ``rte_param_log2_range`` structure
 160   will be renamed in DPDK 21.11 to avoid conflict with Windows Sockets headers.
 161
 162 * cryptodev: ``min`` and ``max`` fields of ``rte_crypto_param_range`` structure
 163   will be renamed in DPDK 21.11 to avoid conflict with Windows Sockets headers.
 164
 165 * cryptodev: The field ``dataunit_len`` of the ``struct rte_crypto_cipher_xform``
 166   has a limited size ``uint16_t``.
 167   It will be moved and extended as ``uint32_t`` in DPDK 21.11.
 168
 169 * cryptodev: The interface between library and drivers will be marked
 170   as internal in DPDK 21.11.
 171
 172 * eventdev: The structure ``rte_event_eth_rx_adapter_queue_conf`` will be
 173   extended to include ``rte_event_eth_rx_adapter_event_vector_config`` elements
 174   and the function ``rte_event_eth_rx_adapter_queue_event_vector_config`` will
 175   be removed in DPDK 21.11.
 176
 177   An application can enable event vectorization by passing the desired vector
 178   values to the function ``rte_event_eth_rx_adapter_queue_add`` using
 179   the structure ``rte_event_eth_rx_adapter_queue_add``.
 180
 181 * metrics: The function ``rte_metrics_init`` will have a non-void return
 182   in order to notify errors instead of calling ``rte_exit``.
 183
 184 * cmdline: ``cmdline`` structure will be made opaque to hide platform-specific
 185   content. On Linux and FreeBSD, supported prior to DPDK 20.11,
 186   original structure will be kept until DPDK 21.11.
 187
 188 * security: The functions ``rte_security_set_pkt_metadata`` and
 189   ``rte_security_get_userdata`` will be made inline functions and additional
 190   flags will be added in structure ``rte_security_ctx`` in DPDK 21.11.
 191
 192 * cryptodev: The structure ``rte_crypto_op`` would be updated to reduce
 193   reserved bytes to 2 (from 3), and use 1 byte to indicate warnings and other
 194   information from the crypto/security operation. This field will be used to
 195   communicate events such as soft expiry with IPsec in lookaside mode.