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 * rte_atomicNN_xxx: These APIs do not take memory order parameter. This does
  21   not allow for writing optimized code for all the CPU architectures supported
  22   in DPDK. DPDK has adopted the atomic operations from
  23   https://gcc.gnu.org/onlinedocs/gcc/_005f_005fatomic-Builtins.html. These
  24   operations must be used for patches that need to be merged in 20.08 onwards.
  25   This change will not introduce any performance degradation.
  26
  27 * rte_smp_*mb: These APIs provide full barrier functionality. However, many
  28   use cases do not require full barriers. To support such use cases, DPDK has
  29   adopted atomic operations from
  30   https://gcc.gnu.org/onlinedocs/gcc/_005f_005fatomic-Builtins.html. These
  31   operations and a new wrapper ``rte_atomic_thread_fence`` instead of
  32   ``__atomic_thread_fence`` must be used for patches that need to be merged in
  33   20.08 onwards. This change will not introduce any performance degradation.
  34
  35 * lib: will fix extending some enum/define breaking the ABI. There are multiple
  36   samples in DPDK that enum/define terminated with a ``.*MAX.*`` value which is
  37   used by iterators, and arrays holding these values are sized with this
  38   ``.*MAX.*`` value. So extending this enum/define increases the ``.*MAX.*``
  39   value which increases the size of the array and depending on how/where the
  40   array is used this may break the ABI.
  41   ``RTE_ETH_FLOW_MAX`` is one sample of the mentioned case, adding a new flow
  42   type will break the ABI because of ``flex_mask[RTE_ETH_FLOW_MAX]`` array
  43   usage in following public struct hierarchy:
  44   ``rte_eth_fdir_flex_conf -> rte_fdir_conf -> rte_eth_conf (in the middle)``.
  45   Need to identify this kind of usages and fix in 20.11, otherwise this blocks
  46   us extending existing enum/define.
  47   One solution can be using a fixed size array instead of ``.*MAX.*`` value.
  48
  49 * ethdev: The flow director API, including ``rte_eth_conf.fdir_conf`` field,
  50   and the related structures (``rte_fdir_*`` and ``rte_eth_fdir_*``),
  51   will be removed in DPDK 20.11.
  52
  53 * ethdev: New offload flags ``DEV_RX_OFFLOAD_FLOW_MARK`` will be added in 19.11.
  54   This will allow application to enable or disable PMDs from updating
  55   ``rte_mbuf::hash::fdir``.
  56   This scheme will allow PMDs to avoid writes to ``rte_mbuf`` fields on Rx and
  57   thereby improve Rx performance if application wishes do so.
  58   In 19.11 PMDs will still update the field even when the offload is not
  59   enabled.
  60
  61 * ethdev: ``uint32_t max_rx_pkt_len`` field of ``struct rte_eth_rxmode``, will be
  62   replaced by a new ``uint32_t mtu`` field of ``struct rte_eth_conf`` in v21.11.
  63   The new ``mtu`` field will be used to configure the initial device MTU via
  64   ``rte_eth_dev_configure()`` API.
  65   Later MTU can be changed by ``rte_eth_dev_set_mtu()`` API as done now.
  66   The existing ``(struct rte_eth_dev)->data->mtu`` variable will be used to store
  67   the configured ``mtu`` value,
  68   and this new ``(struct rte_eth_dev)->data->dev_conf.mtu`` variable will
  69   be used to store the user configuration request.
  70   Unlike ``max_rx_pkt_len``, which was valid only when ``JUMBO_FRAME`` enabled,
  71   ``mtu`` field will be always valid.
  72   When ``mtu`` config is not provided by the application, default ``RTE_ETHER_MTU``
  73   value will be used.
  74   ``(struct rte_eth_dev)->data->mtu`` should be updated after MTU set successfully,
  75   either by ``rte_eth_dev_configure()`` or ``rte_eth_dev_set_mtu()``.
  76
  77   An application may need to configure device for a specific Rx packet size, like for
  78   cases ``DEV_RX_OFFLOAD_SCATTER`` is not supported and device received packet size
  79   can't be bigger than Rx buffer size.
  80   To cover these cases an application needs to know the device packet overhead to be
  81   able to calculate the ``mtu`` corresponding to a Rx buffer size, for this
  82   ``(struct rte_eth_dev_info).max_rx_pktlen`` will be kept,
  83   the device packet overhead can be calculated as:
  84   ``(struct rte_eth_dev_info).max_rx_pktlen - (struct rte_eth_dev_info).max_mtu``
  85
  86 * ethdev: ``rx_descriptor_done`` dev_ops and ``rte_eth_rx_descriptor_done``
  87   will be removed in 21.11.
  88   Existing ``rte_eth_rx_descriptor_status`` and ``rte_eth_tx_descriptor_status``
  89   APIs can be used as replacement.
  90
  91 * ethdev: The port mirroring API can be replaced with a more fine grain flow API.
  92   The structs ``rte_eth_mirror_conf``, ``rte_eth_vlan_mirror`` and the functions
  93   ``rte_eth_mirror_rule_set``, ``rte_eth_mirror_rule_reset`` will be marked
  94   as deprecated in DPDK 20.11, along with the associated macros ``ETH_MIRROR_*``.
  95   This API will be fully removed in DPDK 21.11.
  96
  97 * ethdev: Attribute ``shared`` of the ``struct rte_flow_action_count``
  98   is deprecated and will be removed in DPDK 21.11. Shared counters should
  99   be managed using shared actions API (``rte_flow_shared_action_create`` etc).
 100
 101 * ethdev: The flow API matching pattern structures, ``struct rte_flow_item_*``,
 102   should start with relevant protocol header.
 103   Some matching pattern structures implements this by duplicating protocol header
 104   fields in the struct. To clarify the intention and to be sure protocol header
 105   is intact, will replace those fields with relevant protocol header struct.
 106   In v21.02 both individual protocol header fields and the protocol header struct
 107   will be added as union, target is switch usage to the protocol header by time.
 108   In v21.11 LTS, protocol header fields will be cleaned and only protocol header
 109   struct will remain.
 110
 111 * ethdev: Queue specific stats fields will be removed from ``struct rte_eth_stats``.
 112   Mentioned fields are: ``q_ipackets``, ``q_opackets``, ``q_ibytes``, ``q_obytes``,
 113   ``q_errors``.
 114   Instead queue stats will be received via xstats API. Current method support
 115   will be limited to maximum 256 queues.
 116   Also compile time flag ``RTE_ETHDEV_QUEUE_STAT_CNTRS`` will be removed.
 117
 118 * ethdev: The offload flag ``PKT_RX_EIP_CKSUM_BAD`` will be removed and
 119   replaced by the new flag ``PKT_RX_OUTER_IP_CKSUM_BAD``. The new name is more
 120   consistent with existing outer header checksum status flag naming, which
 121   should help in reducing confusion about its usage.
 122
 123 * i40e: As there are both i40evf and iavf pmd, the functions of them are
 124   duplicated. And now more and more advanced features are developed on iavf.
 125   To keep consistent with kernel driver's name
 126   (https://patchwork.ozlabs.org/patch/970154/), i40evf is no need to maintain.
 127   Starting from 21.05, the default VF driver of i40e will be iavf, but i40evf
 128   can still be used if users specify the devarg "driver=i40evf". I40evf will
 129   be deleted in DPDK 21.11.
 130
 131 * eventdev: The structure ``rte_event_eth_rx_adapter_queue_conf`` will be
 132   extended to include ``rte_event_eth_rx_adapter_event_vector_config`` elements
 133   and the function ``rte_event_eth_rx_adapter_queue_event_vector_config`` will
 134   be removed in DPDK 21.11.
 135
 136   An application can enable event vectorization by passing the desired vector
 137   values to the function ``rte_event_eth_rx_adapter_queue_add`` using
 138   the structure ``rte_event_eth_rx_adapter_queue_add``.
 139
 140 * metrics: The function ``rte_metrics_init`` will have a non-void return
 141   in order to notify errors instead of calling ``rte_exit``.
 142
 143 * cmdline: ``cmdline`` structure will be made opaque to hide platform-specific
 144   content. On Linux and FreeBSD, supported prior to DPDK 20.11,
 145   original structure will be kept until DPDK 21.11.
 146
 147 * security: The functions ``rte_security_set_pkt_metadata`` and
 148   ``rte_security_get_userdata`` will be made inline functions and additional
 149   flags will be added in structure ``rte_security_ctx`` in DPDK 21.11.