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 * mempool: Helper macro ``MEMPOOL_HEADER_SIZE()`` is deprecated and will
  36   be removed in DPDK 22.11. The replacement macro
  37   ``RTE_MEMPOOL_HEADER_SIZE()`` is internal only.
  38
  39 * mempool: Macro to register mempool driver ``MEMPOOL_REGISTER_OPS()`` is
  40   deprecated and will be removed in DPDK 22.11. Use replacement macro
  41   ``RTE_MEMPOOL_REGISTER_OPS()``.
  42
  43 * mempool: The mempool API macros ``MEMPOOL_PG_*`` are deprecated and
  44   will be removed in DPDK 22.11.
  45
  46 * pci: To reduce unnecessary ABIs exposed by DPDK bus driver, "rte_bus_pci.h"
  47   will be made internal in 21.11 and macros/data structures/functions defined
  48   in the header will not be considered as ABI anymore. This change is inspired
  49   by the RFC https://patchwork.dpdk.org/project/dpdk/list/?series=17176.
  50
  51 * lib: will fix extending some enum/define breaking the ABI. There are multiple
  52   samples in DPDK that enum/define terminated with a ``.*MAX.*`` value which is
  53   used by iterators, and arrays holding these values are sized with this
  54   ``.*MAX.*`` value. So extending this enum/define increases the ``.*MAX.*``
  55   value which increases the size of the array and depending on how/where the
  56   array is used this may break the ABI.
  57   ``RTE_ETH_FLOW_MAX`` is one sample of the mentioned case, adding a new flow
  58   type will break the ABI because of ``flex_mask[RTE_ETH_FLOW_MAX]`` array
  59   usage in following public struct hierarchy:
  60   ``rte_eth_fdir_flex_conf -> rte_eth_fdir_conf -> rte_eth_conf (in the middle)``.
  61   Need to identify this kind of usages and fix in 20.11, otherwise this blocks
  62   us extending existing enum/define.
  63   One solution can be using a fixed size array instead of ``.*MAX.*`` value.
  64
  65 * ethdev: The flow director API, including ``rte_eth_conf.fdir_conf`` field,
  66   and the related structures (``rte_fdir_*`` and ``rte_eth_fdir_*``),
  67   will be removed in DPDK 20.11.
  68
  69 * ethdev: New offload flags ``RTE_ETH_RX_OFFLOAD_FLOW_MARK`` will be added in 19.11.
  70   This will allow application to enable or disable PMDs from updating
  71   ``rte_mbuf::hash::fdir``.
  72   This scheme will allow PMDs to avoid writes to ``rte_mbuf`` fields on Rx and
  73   thereby improve Rx performance if application wishes do so.
  74   In 19.11 PMDs will still update the field even when the offload is not
  75   enabled.
  76
  77 * ethdev: Announce moving from dedicated modify function for each field,
  78   to using the general ``rte_flow_modify_field`` action.
  79
  80 * ethdev: The flow API matching pattern structures, ``struct rte_flow_item_*``,
  81   should start with relevant protocol header.
  82   Some matching pattern structures implements this by duplicating protocol header
  83   fields in the struct. To clarify the intention and to be sure protocol header
  84   is intact, will replace those fields with relevant protocol header struct.
  85   In v21.02 both individual protocol header fields and the protocol header struct
  86   will be added as union, target is switch usage to the protocol header by time.
  87   In v21.11 LTS, protocol header fields will be cleaned and only protocol header
  88   struct will remain.
  89
  90 * ethdev: Queue specific stats fields will be removed from ``struct rte_eth_stats``.
  91   Mentioned fields are: ``q_ipackets``, ``q_opackets``, ``q_ibytes``, ``q_obytes``,
  92   ``q_errors``.
  93   Instead queue stats will be received via xstats API. Current method support
  94   will be limited to maximum 256 queues.
  95   Also compile time flag ``RTE_ETHDEV_QUEUE_STAT_CNTRS`` will be removed.
  96
  97 * ethdev: Items and actions ``PF``, ``VF``, ``PHY_PORT``, ``PORT_ID`` are
  98   deprecated as hard-to-use / ambiguous and will be removed in DPDK 22.11.
  99
 100 * ethdev: The use of attributes ``ingress`` / ``egress`` in "transfer" flows
 101   is deprecated as ambiguous with respect to the embedded switch. The use of
 102   these attributes will become invalid starting from DPDK 22.11.
 103
 104 * cryptodev: Hide structures ``rte_cryptodev_sym_session`` and
 105   ``rte_cryptodev_asym_session`` to remove unnecessary indirection between
 106   session and the private data of session. An opaque pointer can be exposed
 107   directly to application which can be attached to the ``rte_crypto_op``.
 108
 109 * security: Hide structure ``rte_security_session`` and expose an opaque
 110   pointer for the private data to the application which can be attached
 111   to the packet while enqueuing.
 112
 113 * eventdev: The file ``rte_eventdev_pmd.h`` will be renamed to ``eventdev_driver.h``
 114   to make the driver interface as internal and the structures ``rte_eventdev_data``,
 115   ``rte_eventdev`` and ``rte_eventdevs`` will be moved to a new file named
 116   ``rte_eventdev_core.h`` in DPDK 21.11.
 117   The ``rte_`` prefix for internal structures and functions will be removed across the
 118   library.
 119   The experimental eventdev trace APIs and ``rte_event_vector_pool_create``,
 120   ``rte_event_eth_rx_adapter_vector_limits_get`` will be promoted to stable.
 121   An 8-byte reserved field will be added to the structure ``rte_event_timer`` to
 122   support future extensions.
 123
 124 * eventdev: The structure ``rte_event_eth_rx_adapter_queue_conf`` will be
 125   extended to include ``rte_event_eth_rx_adapter_event_vector_config`` elements
 126   and the function ``rte_event_eth_rx_adapter_queue_event_vector_config`` will
 127   be removed in DPDK 21.11.
 128
 129   An application can enable event vectorization by passing the desired vector
 130   values to the function ``rte_event_eth_rx_adapter_queue_add`` using
 131   the structure ``rte_event_eth_rx_adapter_queue_add``.
 132
 133 * eventdev: Reserved bytes of ``rte_event_crypto_request`` is a space holder
 134   for ``response_info``. Both should be decoupled for better clarity in
 135   DPDK 21.11.
 136   New space for ``response_info`` can be made by changing
 137   ``rte_event_crypto_metadata`` type to structure from union.
 138
 139 * metrics: The function ``rte_metrics_init`` will have a non-void return
 140   in order to notify errors instead of calling ``rte_exit``.
 141
 142 * raw/ioat: The ``ioat`` rawdev driver has been deprecated, since it's
 143   functionality is provided through the new ``dmadev`` infrastructure.
 144   To continue to use hardware previously supported by the ``ioat`` rawdev driver,
 145   applications should be updated to use the ``dmadev`` library instead,
 146   with the underlying HW-functionality being provided by the ``ioat`` or
 147   ``idxd`` dma drivers