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 * 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.
  21
  22 * meson: The minimum supported version of meson for configuring and building
  23   DPDK will be increased to v0.47.1 (from 0.41) from DPDK 19.05 onwards. For
  24   those users with a version earlier than 0.47.1, an updated copy of meson
  25   can be got using the ``pip3`` tool (or ``python3 -m pip``) for downloading
  26   python packages.
  27
  28 * kvargs: The function ``rte_kvargs_process`` will get a new parameter
  29   for returning key match count. It will ease handling of no-match case.
  30
  31 * eal: The terms blacklist and whitelist to describe devices used
  32   by DPDK will be replaced in the 20.11 relase.
  33   This will apply to command line arguments.
  34
  35   The command line arguments to ``rte_eal_init`` will change from
  36   ``-b, --pci-blacklist`` to ``-x, --exclude`` and
  37   ``-w, --pci-whitelist`` to ``-i, --include``.
  38   The old command line arguments will continue to be accepted in 20.11
  39   but will cause a runtime warning message. The old arguments will
  40   be removed in a future release.
  41
  42 * eal: The function ``rte_eal_remote_launch`` will return new error codes
  43   after read or write error on the pipe, instead of calling ``rte_panic``.
  44
  45 * rte_atomicNN_xxx: These APIs do not take memory order parameter. This does
  46   not allow for writing optimized code for all the CPU architectures supported
  47   in DPDK. DPDK will adopt C11 atomic operations semantics and provide wrappers
  48   using C11 atomic built-ins. These wrappers must be used for patches that
  49   need to be merged in 20.08 onwards. This change will not introduce any
  50   performance degradation.
  51
  52 * rte_smp_*mb: These APIs provide full barrier functionality. However, many
  53   use cases do not require full barriers. To support such use cases, DPDK will
  54   adopt C11 barrier semantics and provide wrappers using C11 atomic built-ins.
  55   These wrappers must be used for patches that need to be merged in 20.08
  56   onwards. This change will not introduce any performance degradation.
  57
  58 * lib: will fix extending some enum/define breaking the ABI. There are multiple
  59   samples in DPDK that enum/define terminated with a ``.*MAX.*`` value which is
  60   used by iterators, and arrays holding these values are sized with this
  61   ``.*MAX.*`` value. So extending this enum/define increases the ``.*MAX.*``
  62   value which increases the size of the array and depending on how/where the
  63   array is used this may break the ABI.
  64   ``RTE_ETH_FLOW_MAX`` is one sample of the mentioned case, adding a new flow
  65   type will break the ABI because of ``flex_mask[RTE_ETH_FLOW_MAX]`` array
  66   usage in following public struct hierarchy:
  67   ``rte_eth_fdir_flex_conf -> rte_fdir_conf -> rte_eth_conf (in the middle)``.
  68   Need to identify this kind of usages and fix in 20.11, otherwise this blocks
  69   us extending existing enum/define.
  70   One solution can be using a fixed size array instead of ``.*MAX.*`` value.
  71
  72 * ethdev: The flow director API, including ``rte_eth_conf.fdir_conf`` field,
  73   and the related structures (``rte_fdir_*`` and ``rte_eth_fdir_*``),
  74   will be removed in DPDK 20.11.
  75
  76 * ethdev: New offload flags ``DEV_RX_OFFLOAD_FLOW_MARK`` will be added in 19.11.
  77   This will allow application to enable or disable PMDs from updating
  78   ``rte_mbuf::hash::fdir``.
  79   This scheme will allow PMDs to avoid writes to ``rte_mbuf`` fields on Rx and
  80   thereby improve Rx performance if application wishes do so.
  81   In 19.11 PMDs will still update the field even when the offload is not
  82   enabled.
  83
  84 * ethdev: ``rx_descriptor_done`` dev_ops and ``rte_eth_rx_descriptor_done``
  85   will be removed in 21.11.
  86   Existing ``rte_eth_rx_descriptor_status`` and ``rte_eth_tx_descriptor_status``
  87   APIs can be used as replacement.
  88
  89 * ethdev: The port mirroring API can be replaced with a more fine grain flow API.
  90   The structs ``rte_eth_mirror_conf``, ``rte_eth_vlan_mirror`` and the functions
  91   ``rte_eth_mirror_rule_set``, ``rte_eth_mirror_rule_reset`` will be marked
  92   as deprecated in DPDK 20.11, along with the associated macros ``ETH_MIRROR_*``.
  93   This API will be fully removed in DPDK 21.11.
  94
  95 * ethdev: Queue specific stats fields will be removed from ``struct rte_eth_stats``.
  96   Mentioned fields are: ``q_ipackets``, ``q_opackets``, ``q_ibytes``, ``q_obytes``,
  97   ``q_errors``.
  98   Instead queue stats will be received via xstats API. Current method support
  99   will be limited to maximum 256 queues.
 100   Also compile time flag ``RTE_ETHDEV_QUEUE_STAT_CNTRS`` will be removed.
 101
 102 * sched: To allow more traffic classes, flexible mapping of pipe queues to
 103   traffic classes, and subport level configuration of pipes and queues
 104   changes will be made to macros, data structures and API functions defined
 105   in "rte_sched.h". These changes are aligned to improvements suggested in the
 106   RFC https://mails.dpdk.org/archives/dev/2018-November/120035.html.
 107
 108 * metrics: The function ``rte_metrics_init`` will have a non-void return
 109   in order to notify errors instead of calling ``rte_exit``.
 110
 111 * cmdline: ``cmdline`` structure will be made opaque to hide platform-specific
 112   content. On Linux and FreeBSD, supported prior to DPDK 20.11,
 113   original structure will be kept until DPDK 21.11.
 114
 115 * dpdk-setup.sh: This old script relies on deprecated stuff, and especially
 116   ``make``. Given environments are too much variables for such a simple script,
 117   it will be removed in DPDK 20.11.
 118   Some useful parts may be converted into specific scripts.