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: The lcore state ``FINISHED`` will be removed from
  21   the ``enum rte_lcore_state_t``.
  22   The lcore state ``WAIT`` is enough to represent the same state.
  23
  24 * eal: Making ``struct rte_intr_handle`` internal to avoid any ABI breakages
  25   in future.
  26
  27 * rte_atomicNN_xxx: These APIs do not take memory order parameter. This does
  28   not allow for writing optimized code for all the CPU architectures supported
  29   in DPDK. DPDK has adopted the atomic operations from
  30   https://gcc.gnu.org/onlinedocs/gcc/_005f_005fatomic-Builtins.html. These
  31   operations must be used for patches that need to be merged in 20.08 onwards.
  32   This change will not introduce any performance degradation.
  33
  34 * rte_smp_*mb: These APIs provide full barrier functionality. However, many
  35   use cases do not require full barriers. To support such use cases, DPDK has
  36   adopted atomic operations from
  37   https://gcc.gnu.org/onlinedocs/gcc/_005f_005fatomic-Builtins.html. These
  38   operations and a new wrapper ``rte_atomic_thread_fence`` instead of
  39   ``__atomic_thread_fence`` must be used for patches that need to be merged in
  40   20.08 onwards. This change will not introduce any performance degradation.
  41
  42 * mempool: Helper macro ``MEMPOOL_HEADER_SIZE()`` is deprecated and will
  43   be removed in DPDK 22.11. The replacement macro
  44   ``RTE_MEMPOOL_HEADER_SIZE()`` is internal only.
  45
  46 * mempool: Macro to register mempool driver ``MEMPOOL_REGISTER_OPS()`` is
  47   deprecated and will be removed in DPDK 22.11. Use replacement macro
  48   ``RTE_MEMPOOL_REGISTER_OPS()``.
  49
  50 * mempool: The mempool API macros ``MEMPOOL_PG_*`` are deprecated and
  51   will be removed in DPDK 22.11.
  52
  53 * mbuf: The mbuf offload flags ``PKT_*`` will be renamed as ``RTE_MBUF_F_*``.
  54   A compatibility layer will be kept until DPDK 22.11, except for the flags
  55   that are already deprecated (``PKT_RX_L4_CKSUM_BAD``, ``PKT_RX_IP_CKSUM_BAD``,
  56   ``PKT_RX_EIP_CKSUM_BAD``, ``PKT_TX_QINQ_PKT``) which will be removed.
  57
  58 * pci: To reduce unnecessary ABIs exposed by DPDK bus driver, "rte_bus_pci.h"
  59   will be made internal in 21.11 and macros/data structures/functions defined
  60   in the header will not be considered as ABI anymore. This change is inspired
  61   by the RFC https://patchwork.dpdk.org/project/dpdk/list/?series=17176.
  62
  63 * lib: will fix extending some enum/define breaking the ABI. There are multiple
  64   samples in DPDK that enum/define terminated with a ``.*MAX.*`` value which is
  65   used by iterators, and arrays holding these values are sized with this
  66   ``.*MAX.*`` value. So extending this enum/define increases the ``.*MAX.*``
  67   value which increases the size of the array and depending on how/where the
  68   array is used this may break the ABI.
  69   ``RTE_ETH_FLOW_MAX`` is one sample of the mentioned case, adding a new flow
  70   type will break the ABI because of ``flex_mask[RTE_ETH_FLOW_MAX]`` array
  71   usage in following public struct hierarchy:
  72   ``rte_eth_fdir_flex_conf -> rte_eth_fdir_conf -> rte_eth_conf (in the middle)``.
  73   Need to identify this kind of usages and fix in 20.11, otherwise this blocks
  74   us extending existing enum/define.
  75   One solution can be using a fixed size array instead of ``.*MAX.*`` value.
  76
  77 * ethdev: The flow director API, including ``rte_eth_conf.fdir_conf`` field,
  78   and the related structures (``rte_fdir_*`` and ``rte_eth_fdir_*``),
  79   will be removed in DPDK 20.11.
  80
  81 * ethdev: New offload flags ``RTE_ETH_RX_OFFLOAD_FLOW_MARK`` will be added in 19.11.
  82   This will allow application to enable or disable PMDs from updating
  83   ``rte_mbuf::hash::fdir``.
  84   This scheme will allow PMDs to avoid writes to ``rte_mbuf`` fields on Rx and
  85   thereby improve Rx performance if application wishes do so.
  86   In 19.11 PMDs will still update the field even when the offload is not
  87   enabled.
  88
  89 * ethdev: Announce moving from dedicated modify function for each field,
  90   to using the general ``rte_flow_modify_field`` action.
  91
  92 * ethdev: The flow API matching pattern structures, ``struct rte_flow_item_*``,
  93   should start with relevant protocol header.
  94   Some matching pattern structures implements this by duplicating protocol header
  95   fields in the struct. To clarify the intention and to be sure protocol header
  96   is intact, will replace those fields with relevant protocol header struct.
  97   In v21.02 both individual protocol header fields and the protocol header struct
  98   will be added as union, target is switch usage to the protocol header by time.
  99   In v21.11 LTS, protocol header fields will be cleaned and only protocol header
 100   struct will remain.
 101
 102 * ethdev: Add new Rx queue offload flag ``RTE_ETH_RX_OFFLOAD_SHARED_RXQ`` and
 103   ``shared_group`` field to ``struct rte_eth_rxconf``.
 104
 105 * ethdev: Queue specific stats fields will be removed from ``struct rte_eth_stats``.
 106   Mentioned fields are: ``q_ipackets``, ``q_opackets``, ``q_ibytes``, ``q_obytes``,
 107   ``q_errors``.
 108   Instead queue stats will be received via xstats API. Current method support
 109   will be limited to maximum 256 queues.
 110   Also compile time flag ``RTE_ETHDEV_QUEUE_STAT_CNTRS`` will be removed.
 111
 112 * ethdev: Items and actions ``PF``, ``VF``, ``PHY_PORT``, ``PORT_ID`` are
 113   deprecated as hard-to-use / ambiguous and will be removed in DPDK 22.11.
 114
 115 * ethdev: The use of attributes ``ingress`` / ``egress`` in "transfer" flows
 116   is deprecated as ambiguous with respect to the embedded switch. The use of
 117   these attributes will become invalid starting from DPDK 22.11.
 118
 119 * vhost: ``rte_vdpa_register_device``, ``rte_vdpa_unregister_device``,
 120   ``rte_vhost_host_notifier_ctrl`` and ``rte_vdpa_relay_vring_used`` vDPA
 121   driver interface will be marked as internal in DPDK v21.11.
 122
 123 * vhost: rename ``struct vhost_device_ops`` to ``struct rte_vhost_device_ops``
 124   in DPDK v21.11.
 125
 126 * vhost: The experimental tags of ``rte_vhost_driver_get_protocol_features``,
 127   ``rte_vhost_driver_get_queue_num``, ``rte_vhost_crypto_create``,
 128   ``rte_vhost_crypto_free``, ``rte_vhost_crypto_fetch_requests``,
 129   ``rte_vhost_crypto_finalize_requests``, ``rte_vhost_crypto_set_zero_copy``,
 130   ``rte_vhost_va_from_guest_pa``, ``rte_vhost_extern_callback_register``,
 131   and ``rte_vhost_driver_set_protocol_features`` functions will be removed
 132   and the API functions will be made stable in DPDK 21.11.
 133
 134 * cryptodev: Hide structures ``rte_cryptodev_sym_session`` and
 135   ``rte_cryptodev_asym_session`` to remove unnecessary indirection between
 136   session and the private data of session. An opaque pointer can be exposed
 137   directly to application which can be attached to the ``rte_crypto_op``.
 138
 139 * security: Hide structure ``rte_security_session`` and expose an opaque
 140   pointer for the private data to the application which can be attached
 141   to the packet while enqueuing.
 142
 143 * eventdev: The file ``rte_eventdev_pmd.h`` will be renamed to ``eventdev_driver.h``
 144   to make the driver interface as internal and the structures ``rte_eventdev_data``,
 145   ``rte_eventdev`` and ``rte_eventdevs`` will be moved to a new file named
 146   ``rte_eventdev_core.h`` in DPDK 21.11.
 147   The ``rte_`` prefix for internal structures and functions will be removed across the
 148   library.
 149   The experimental eventdev trace APIs and ``rte_event_vector_pool_create``,
 150   ``rte_event_eth_rx_adapter_vector_limits_get`` will be promoted to stable.
 151   An 8-byte reserved field will be added to the structure ``rte_event_timer`` to
 152   support future extensions.
 153
 154 * eventdev: The structure ``rte_event_eth_rx_adapter_queue_conf`` will be
 155   extended to include ``rte_event_eth_rx_adapter_event_vector_config`` elements
 156   and the function ``rte_event_eth_rx_adapter_queue_event_vector_config`` will
 157   be removed in DPDK 21.11.
 158
 159   An application can enable event vectorization by passing the desired vector
 160   values to the function ``rte_event_eth_rx_adapter_queue_add`` using
 161   the structure ``rte_event_eth_rx_adapter_queue_add``.
 162
 163 * eventdev: Reserved bytes of ``rte_event_crypto_request`` is a space holder
 164   for ``response_info``. Both should be decoupled for better clarity in
 165   DPDK 21.11.
 166   New space for ``response_info`` can be made by changing
 167   ``rte_event_crypto_metadata`` type to structure from union.
 168
 169 * metrics: The function ``rte_metrics_init`` will have a non-void return
 170   in order to notify errors instead of calling ``rte_exit``.
 171
 172 * raw/ioat: The ``ioat`` rawdev driver has been deprecated, since it's
 173   functionality is provided through the new ``dmadev`` infrastructure.
 174   To continue to use hardware previously supported by the ``ioat`` rawdev driver,
 175   applications should be updated to use the ``dmadev`` library instead,
 176   with the underlying HW-functionality being provided by the ``ioat`` or
 177   ``idxd`` dma drivers