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 * make: Support for building DPDK with "make" has been deprecated and
  15   support will be removed in the 20.11 release. From 20.11 onwards, DPDK
  16   should be built using meson and ninja. For basic instructions see the
  17   `Quick-start Guide <https://core.dpdk.org/doc/quick-start/>`_ on the
  18   website or the `Getting Started Guide
  19   <https://doc.dpdk.org/guides/linux_gsg/build_dpdk.html>`_ document.
  20
  21 * meson: The minimum supported version of meson for configuring and building
  22   DPDK will be increased to v0.47.1 (from 0.41) from DPDK 19.05 onwards. For
  23   those users with a version earlier than 0.47.1, an updated copy of meson
  24   can be got using the ``pip``, or ``pip3``, tool for downloading python
  25   packages.
  26
  27 * kvargs: The function ``rte_kvargs_process`` will get a new parameter
  28   for returning key match count. It will ease handling of no-match case.
  29
  30 * eal: The function ``rte_eal_remote_launch`` will return new error codes
  31   after read or write error on the pipe, instead of calling ``rte_panic``.
  32
  33 * eal: The ``rte_logs`` struct and global symbol will be made private to
  34   remove it from the externally visible ABI and allow it to be updated in the
  35   future.
  36
  37 * rte_atomicNN_xxx: These APIs do not take memory order parameter. This does
  38   not allow for writing optimized code for all the CPU architectures supported
  39   in DPDK. DPDK will adopt C11 atomic operations semantics and provide wrappers
  40   using C11 atomic built-ins. These wrappers must be used for patches that
  41   need to be merged in 20.08 onwards. This change will not introduce any
  42   performance degradation.
  43
  44 * rte_smp_*mb: These APIs provide full barrier functionality. However, many
  45   use cases do not require full barriers. To support such use cases, DPDK will
  46   adopt C11 barrier semantics and provide wrappers using C11 atomic built-ins.
  47   These wrappers must be used for patches that need to be merged in 20.08
  48   onwards. This change will not introduce any performance degradation.
  49
  50 * rte_cio_*mb: Since the IO barriers for ARMv8 platforms are relaxed from DSB
  51   to DMB, rte_cio_*mb APIs provide the same functionality as rte_io_*mb
  52   APIs (taking all platforms into consideration). rte_io_*mb APIs should be
  53   used in the place of rte_cio_*mb APIs. The rte_cio_*mb APIs will be
  54   deprecated in 20.11 release.
  55
  56 * igb_uio: In the view of reducing the kernel dependency from the main tree,
  57   as a first step, the Technical Board decided to move ``igb_uio``
  58   kernel module to the dpdk-kmods repository in the /linux/igb_uio/ directory
  59   in 20.11.
  60   Minutes of Technical Board Meeting of `2019-11-06
  61   <https://mails.dpdk.org/archives/dev/2019-November/151763.html>`_.
  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_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 * pci: The PCI resources map API (``pci_map_resource`` and
  78   ``pci_unmap_resource``) was not abstracting the Unix mmap flags (see the
  79   workaround for Windows support implemented in the commit
  80   9d2b24593724 ("pci: keep API compatibility with mmap values")).
  81   This API will be removed from the public API in 20.11 and moved to the PCI
  82   bus driver along with the PCI resources lists and associated structures
  83   (``pci_map``, ``pci_msix_table``, ``mapped_pci_resource`` and
  84   ``mapped_pci_res_list``).
  85   With this removal, there won't be a need for the mentioned workaround which
  86   will be reverted.
  87
  88 * pci: The ``rte_kernel_driver`` enum defined in rte_dev.h will be made private
  89   to the PCI subsystem as it is used only by the PCI bus driver and PCI
  90   drivers.
  91   The associated field ``kdrv`` in the ethdev ``rte_eth_dev_data`` structure
  92   will be removed as it gave no useful abstracted information to the
  93   applications and had no user (neither internal nor external).
  94
  95 * ethdev: Split the ``struct eth_dev_ops`` struct to hide it as much as possible
  96   will be done in 20.11.
  97   Currently the ``struct eth_dev_ops`` struct is accessible by the application
  98   because some inline functions, like ``rte_eth_tx_descriptor_status()``,
  99   access the struct directly.
 100   The struct will be separate in two, the ops used by inline functions will be
 101   moved next to Rx/Tx burst functions, rest of the ``struct eth_dev_ops`` struct
 102   will be moved to header file for drivers to hide it from applications.
 103
 104 * ethdev: the legacy filter API, including
 105   ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
 106   as filter types MACVLAN, ETHERTYPE, FLEXIBLE, SYN, NTUPLE, TUNNEL, FDIR,
 107   HASH and L2_TUNNEL, is superseded by the generic flow API (rte_flow) in
 108   PMDs that implement the latter.
 109   Target release for removal of the legacy API will be defined once most
 110   PMDs have switched to rte_flow.
 111
 112 * ethdev: Update API functions returning ``void`` to return ``int`` with
 113   negative errno values to indicate various error conditions (e.g.
 114   invalid port ID, unsupported operation, failed operation):
 115
 116   - ``rte_eth_dev_stop``
 117   - ``rte_eth_dev_close``
 118
 119 * ethdev: New offload flags ``DEV_RX_OFFLOAD_FLOW_MARK`` will be added in 19.11.
 120   This will allow application to enable or disable PMDs from updating
 121   ``rte_mbuf::hash::fdir``.
 122   This scheme will allow PMDs to avoid writes to ``rte_mbuf`` fields on Rx and
 123   thereby improve Rx performance if application wishes do so.
 124   In 19.11 PMDs will still update the field even when the offload is not
 125   enabled.
 126
 127 * ethdev: ``rx_descriptor_done`` dev_ops and ``rte_eth_rx_descriptor_done``
 128   will be deprecated in 20.11 and will be removed in 21.11.
 129   Existing ``rte_eth_rx_descriptor_status`` and ``rte_eth_tx_descriptor_status``
 130   APIs can be used as replacement.
 131
 132 * ethdev: Some internal APIs for driver usage are exported in the .map file.
 133   Now DPDK has ``__rte_internal`` marker so we can mark internal APIs and move
 134   them to the INTERNAL block in .map. Although these APIs are internal it will
 135   break the ABI checks, that is why change is planned for 20.11.
 136   The list of internal APIs are mainly ones listed in ``rte_ethdev_driver.h``.
 137
 138 * traffic manager: All traffic manager API's in ``rte_tm.h`` were mistakenly made
 139   ABI stable in the v19.11 release. The TM maintainer and other contributors have
 140   agreed to keep the TM APIs as experimental in expectation of additional spec
 141   improvements. Therefore, all APIs in ``rte_tm.h`` will be marked back as
 142   experimental in v20.11 DPDK release. For more details, please see `the thread
 143   <https://mails.dpdk.org/archives/dev/2020-April/164970.html>`_.
 144
 145 * pmd_dpaa: The API ``rte_pmd_dpaa_set_tx_loopback`` will have extended
 146   ``port_id`` definition from ``uint8_t`` to ``uint16_t``.
 147
 148 * cryptodev: support for using IV with all sizes is added, J0 still can
 149   be used but only when IV length in following structs ``rte_crypto_auth_xform``,
 150   ``rte_crypto_aead_xform`` is set to zero. When IV length is greater or equal
 151   to one it means it represents IV, when is set to zero it means J0 is used
 152   directly, in this case 16 bytes of J0 need to be passed.
 153
 154 * rawdev: The rawdev APIs which take a device-specific structure as
 155   parameter directly, or indirectly via a "private" pointer inside another
 156   structure, will be modified to take an additional parameter of the
 157   structure size. The affected APIs will include ``rte_rawdev_info_get``,
 158   ``rte_rawdev_configure``, ``rte_rawdev_queue_conf_get`` and
 159   ``rte_rawdev_queue_setup``.
 160
 161 * sched: To allow more traffic classes, flexible mapping of pipe queues to
 162   traffic classes, and subport level configuration of pipes and queues
 163   changes will be made to macros, data structures and API functions defined
 164   in "rte_sched.h". These changes are aligned to improvements suggested in the
 165   RFC https://mails.dpdk.org/archives/dev/2018-November/120035.html.
 166
 167 * mbuf: ``refcnt_atomic`` member in structures ``rte_mbuf`` and
 168   ``rte_mbuf_ext_shared_info`` is of type ``rte_atomic16_t``. Due to adoption
 169   of C11 atomic builtins it will be of type ``uint16_t``. ``refcnt_atomic``
 170   will be removed in 20.11. It will be replaced with ``refcnt`` of type
 171   ``uint16_t``.
 172
 173 * metrics: The function ``rte_metrics_init`` will have a non-void return
 174   in order to notify errors instead of calling ``rte_exit``.
 175
 176 * power: ``rte_power_set_env`` function will no longer return 0 on attempt
 177   to set new power environment if power environment was already initialized.
 178   In this case the function will return -1 unless the environment is unset first
 179   (using ``rte_power_unset_env``). Other function usage scenarios will not change.
 180
 181 * python: Since the beginning of 2020, Python 2 has officially reached
 182   end-of-support: https://www.python.org/doc/sunset-python-2/.
 183   Python 2 support will be completely removed in 20.11.
 184   In 20.08, explicit deprecation warnings will be displayed when running
 185   scripts with Python 2.