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: To be more inclusive in choice of naming, the DPDK project
  31   will replace uses of master/slave in the API's and command line arguments.
  32
  33   References to master/slave in relation to lcore will be renamed
  34   to initial/worker.  The function ``rte_get_master_lcore()``
  35   will be renamed to ``rte_get_initial_lcore()``.
  36   For the 20.11 release, both names will be present and the
  37   old function will be marked with the deprecated tag.
  38   The old function will be removed in a future version.
  39
  40   The iterator for worker lcores will also change:
  41   ``RTE_LCORE_FOREACH_SLAVE`` will be replaced with
  42   ``RTE_LCORE_FOREACH_WORKER``.
  43
  44   The ``master-lcore`` argument to testpmd will be replaced
  45   with ``initial-lcore``. The old ``master-lcore`` argument
  46   will produce a runtime notification in 20.11 release, and
  47   be removed completely in a future release.
  48
  49 * eal: The terms blacklist and whitelist to describe devices used
  50   by DPDK will be replaced in the 20.11 relase.
  51   This will apply to command line arguments as well as macros.
  52
  53   The macro ``RTE_DEV_BLACKLISTED`` will be replaced with ``RTE_DEV_EXCLUDED``
  54   and ``RTE_DEV_WHITELISTED`` will be replaced with ``RTE_DEV_INCLUDED``
  55   ``RTE_BUS_SCAN_BLACKLIST`` and ``RTE_BUS_SCAN_WHITELIST`` will be
  56   replaced with ``RTE_BUS_SCAN_EXCLUDED`` and ``RTE_BUS_SCAN_INCLUDED``
  57   respectively. Likewise ``RTE_DEVTYPE_BLACKLISTED_PCI`` and
  58   ``RTE_DEVTYPE_WHITELISTED_PCI`` will be replaced with
  59   ``RTE_DEVTYPE_EXCLUDED`` and ``RTE_DEVTYPE_INCLUDED``.
  60
  61   The old macros will be marked as deprecated in 20.11 and any
  62   usage will cause a compile warning. They will be removed in
  63   a future release.
  64
  65   The command line arguments to ``rte_eal_init`` will change from
  66   ``-b, --pci-blacklist`` to ``-x, --exclude`` and
  67   ``-w, --pci-whitelist`` to ``-i, --include``.
  68   The old command line arguments will continue to be accepted in 20.11
  69   but will cause a runtime warning message. The old arguments will
  70   be removed in a future release.
  71
  72 * eal: The function ``rte_eal_remote_launch`` will return new error codes
  73   after read or write error on the pipe, instead of calling ``rte_panic``.
  74
  75 * eal: The ``rte_logs`` struct and global symbol will be made private to
  76   remove it from the externally visible ABI and allow it to be updated in the
  77   future.
  78
  79 * eal: The ``rte_dev_event`` structure will be made private to the EAL as no
  80   public API makes use of it.
  81
  82 * rte_atomicNN_xxx: These APIs do not take memory order parameter. This does
  83   not allow for writing optimized code for all the CPU architectures supported
  84   in DPDK. DPDK will adopt C11 atomic operations semantics and provide wrappers
  85   using C11 atomic built-ins. These wrappers must be used for patches that
  86   need to be merged in 20.08 onwards. This change will not introduce any
  87   performance degradation.
  88
  89 * rte_smp_*mb: These APIs provide full barrier functionality. However, many
  90   use cases do not require full barriers. To support such use cases, DPDK will
  91   adopt C11 barrier semantics and provide wrappers using C11 atomic built-ins.
  92   These wrappers must be used for patches that need to be merged in 20.08
  93   onwards. This change will not introduce any performance degradation.
  94
  95 * rte_cio_*mb: Since the IO barriers for ARMv8 platforms are relaxed from DSB
  96   to DMB, rte_cio_*mb APIs provide the same functionality as rte_io_*mb
  97   APIs (taking all platforms into consideration). rte_io_*mb APIs should be
  98   used in the place of rte_cio_*mb APIs. The rte_cio_*mb APIs will be
  99   deprecated in 20.11 release.
 100
 101 * igb_uio: In the view of reducing the kernel dependency from the main tree,
 102   as a first step, the Technical Board decided to move ``igb_uio``
 103   kernel module to the dpdk-kmods repository in the /linux/igb_uio/ directory
 104   in 20.11.
 105   Minutes of Technical Board Meeting of `2019-11-06
 106   <https://mails.dpdk.org/archives/dev/2019-November/151763.html>`_.
 107
 108 * lib: will fix extending some enum/define breaking the ABI. There are multiple
 109   samples in DPDK that enum/define terminated with a ``.*MAX.*`` value which is
 110   used by iterators, and arrays holding these values are sized with this
 111   ``.*MAX.*`` value. So extending this enum/define increases the ``.*MAX.*``
 112   value which increases the size of the array and depending on how/where the
 113   array is used this may break the ABI.
 114   ``RTE_ETH_FLOW_MAX`` is one sample of the mentioned case, adding a new flow
 115   type will break the ABI because of ``flex_mask[RTE_ETH_FLOW_MAX]`` array
 116   usage in following public struct hierarchy:
 117   ``rte_eth_fdir_flex_conf -> rte_fdir_conf -> rte_eth_conf (in the middle)``.
 118   Need to identify this kind of usages and fix in 20.11, otherwise this blocks
 119   us extending existing enum/define.
 120   One solution can be using a fixed size array instead of ``.*MAX.*`` value.
 121
 122 * pci: The PCI resources map API (``pci_map_resource`` and
 123   ``pci_unmap_resource``) was not abstracting the Unix mmap flags (see the
 124   workaround for Windows support implemented in the commit
 125   9d2b24593724 ("pci: keep API compatibility with mmap values")).
 126   This API will be removed from the public API in 20.11 and moved to the PCI
 127   bus driver along with the PCI resources lists and associated structures
 128   (``pci_map``, ``pci_msix_table``, ``mapped_pci_resource`` and
 129   ``mapped_pci_res_list``).
 130   With this removal, there won't be a need for the mentioned workaround which
 131   will be reverted.
 132
 133 * pci: The ``rte_kernel_driver`` enum defined in rte_dev.h will be made private
 134   to the PCI subsystem as it is used only by the PCI bus driver and PCI
 135   drivers.
 136   The associated field ``kdrv`` in the ethdev ``rte_eth_dev_data`` structure
 137   will be removed as it gave no useful abstracted information to the
 138   applications and had no user (neither internal nor external).
 139
 140 * mbuf: Some fields will be converted to dynamic API in DPDK 20.11
 141   in order to reserve more space for the dynamic fields, as explained in
 142   `this presentation <https://www.youtube.com/watch?v=Ttl6MlhmzWY>`_.
 143   The following static fields will be moved as dynamic:
 144
 145   - ``timestamp``
 146   - ``userdata`` / ``udata64``
 147   - ``seqn``
 148
 149   As a consequence, the layout of the ``struct rte_mbuf`` will be re-arranged,
 150   avoiding impact on vectorized implementation of the driver datapaths,
 151   while evaluating performance gains of a better use of the first cache line.
 152
 153   The deprecated unioned fields ``buf_physaddr`` and ``refcnt_atomic``
 154   (as explained below) will be removed in DPDK 20.11.
 155
 156 * mbuf: ``refcnt_atomic`` member in structures ``rte_mbuf`` and
 157   ``rte_mbuf_ext_shared_info`` is of type ``rte_atomic16_t``.
 158   Due to adoption of C11 atomic builtins, the field ``refcnt_atomic``
 159   will be replaced with ``refcnt`` of type ``uint16_t`` in DPDK 20.11.
 160
 161 * ethdev: Split the ``struct eth_dev_ops`` struct to hide it as much as possible
 162   will be done in 20.11.
 163   Currently the ``struct eth_dev_ops`` struct is accessible by the application
 164   because some inline functions, like ``rte_eth_tx_descriptor_status()``,
 165   access the struct directly.
 166   The struct will be separate in two, the ops used by inline functions will be
 167   moved next to Rx/Tx burst functions, rest of the ``struct eth_dev_ops`` struct
 168   will be moved to header file for drivers to hide it from applications.
 169
 170 * ethdev: the legacy filter API, including
 171   ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
 172   as filter types MACVLAN, ETHERTYPE, FLEXIBLE, SYN, NTUPLE, TUNNEL, FDIR,
 173   HASH and L2_TUNNEL, is superseded by the generic flow API (rte_flow) in
 174   PMDs that implement the latter.
 175   The legacy API will be removed in DPDK 20.11.
 176
 177 * ethdev: The flow director API, including ``rte_eth_conf.fdir_conf`` field,
 178   and the related structures (``rte_fdir_*`` and ``rte_eth_fdir_*``),
 179   will be removed in DPDK 20.11.
 180
 181 * ethdev: The legacy L2 tunnel filtering API is deprecated as the rest of
 182   the legacy filtering API.
 183   The functions ``rte_eth_dev_l2_tunnel_eth_type_conf`` and
 184   ``rte_eth_dev_l2_tunnel_offload_set`` which were not marked as deprecated,
 185   will be removed in DPDK 20.11.
 186
 187 * ethdev: Update API functions returning ``void`` to return ``int`` with
 188   negative errno values to indicate various error conditions (e.g.
 189   invalid port ID, unsupported operation, failed operation):
 190
 191   - ``rte_eth_dev_stop``
 192   - ``rte_eth_dev_close``
 193
 194 * ethdev: The temporary flag RTE_ETH_DEV_CLOSE_REMOVE will be removed in 20.11.
 195   As a consequence, the new behaviour introduced in 18.11 will be effective
 196   for all drivers: generic port resources are freed on close operation.
 197   Private resources are expected to be released in the ``dev_close`` callback.
 198   More details in http://inbox.dpdk.org/dev/5248162.j6AOsuQRmx@thomas/
 199
 200 * ethdev: New offload flags ``DEV_RX_OFFLOAD_FLOW_MARK`` will be added in 19.11.
 201   This will allow application to enable or disable PMDs from updating
 202   ``rte_mbuf::hash::fdir``.
 203   This scheme will allow PMDs to avoid writes to ``rte_mbuf`` fields on Rx and
 204   thereby improve Rx performance if application wishes do so.
 205   In 19.11 PMDs will still update the field even when the offload is not
 206   enabled.
 207
 208 * ethdev: Add new fields to ``rte_eth_rxconf`` to configure the receiving
 209   queues to split ingress packets into multiple segments according to the
 210   specified lengths into the buffers allocated from the specified
 211   memory pools. The backward compatibility to existing API is preserved.
 212
 213 * ethdev: ``rx_descriptor_done`` dev_ops and ``rte_eth_rx_descriptor_done``
 214   will be deprecated in 20.11 and will be removed in 21.11.
 215   Existing ``rte_eth_rx_descriptor_status`` and ``rte_eth_tx_descriptor_status``
 216   APIs can be used as replacement.
 217
 218 * ethdev: The port mirroring API can be replaced with a more fine grain flow API.
 219   The structs ``rte_eth_mirror_conf``, ``rte_eth_vlan_mirror`` and the functions
 220   ``rte_eth_mirror_rule_set``, ``rte_eth_mirror_rule_reset`` will be marked
 221   as deprecated in DPDK 20.11, along with the associated macros ``ETH_MIRROR_*``.
 222   This API will be fully removed in DPDK 21.11.
 223
 224 * ethdev: The ``struct rte_flow_item_eth`` and ``struct rte_flow_item_vlan``
 225   structs will be modified, to include an additional value, indicating existence
 226   or absence of a VLAN header following the current header, as proposed in RFC
 227   https://mails.dpdk.org/archives/dev/2020-August/177536.html.
 228
 229 * ethdev: The ``struct rte_flow_item_ipv6`` struct will be modified to include
 230   additional values, indicating existence or absence of IPv6 extension headers
 231   following the IPv6 header, as proposed in RFC
 232   https://mails.dpdk.org/archives/dev/2020-August/177257.html.
 233
 234 * ethdev: Some internal APIs for driver usage are exported in the .map file.
 235   Now DPDK has ``__rte_internal`` marker so we can mark internal APIs and move
 236   them to the INTERNAL block in .map. Although these APIs are internal it will
 237   break the ABI checks, that is why change is planned for 20.11.
 238   The list of internal APIs are mainly ones listed in ``rte_ethdev_driver.h``.
 239
 240 * traffic manager: All traffic manager API's in ``rte_tm.h`` were mistakenly made
 241   ABI stable in the v19.11 release. The TM maintainer and other contributors have
 242   agreed to keep the TM APIs as experimental in expectation of additional spec
 243   improvements. Therefore, all APIs in ``rte_tm.h`` will be marked back as
 244   experimental in v20.11 DPDK release. For more details, please see `the thread
 245   <https://mails.dpdk.org/archives/dev/2020-April/164970.html>`_.
 246
 247 * pmd_dpaa: The API ``rte_pmd_dpaa_set_tx_loopback`` will have extended
 248   ``port_id`` definition from ``uint8_t`` to ``uint16_t``.
 249
 250 * security: The API ``rte_security_session_create`` takes only single mempool
 251   for session and session private data. So the application need to create
 252   mempool for twice the number of sessions needed and will also lead to
 253   wastage of memory as session private data need more memory compared to session.
 254   Hence the API will be modified to take two mempool pointers - one for session
 255   and one for private data.
 256
 257 * cryptodev: ``RTE_CRYPTO_AEAD_LIST_END`` from ``enum rte_crypto_aead_algorithm``,
 258   ``RTE_CRYPTO_CIPHER_LIST_END`` from ``enum rte_crypto_cipher_algorithm`` and
 259   ``RTE_CRYPTO_AUTH_LIST_END`` from ``enum rte_crypto_auth_algorithm``
 260   will be removed.
 261
 262 * cryptodev: support for using IV with all sizes is added, J0 still can
 263   be used but only when IV length in following structs ``rte_crypto_auth_xform``,
 264   ``rte_crypto_aead_xform`` is set to zero. When IV length is greater or equal
 265   to one it means it represents IV, when is set to zero it means J0 is used
 266   directly, in this case 16 bytes of J0 need to be passed.
 267
 268 * eventdev: Following structures will be modified to support DLB PMD
 269   and future extensions:
 270
 271   - ``rte_event_dev_info``
 272   - ``rte_event_dev_config``
 273   - ``rte_event_port_conf``
 274
 275   Patches containing justification, documentation, and proposed modifications
 276   can be found at:
 277
 278   - https://patches.dpdk.org/patch/71457/
 279   - https://patches.dpdk.org/patch/71456/
 280
 281 * rawdev: The rawdev APIs which take a device-specific structure as
 282   parameter directly, or indirectly via a "private" pointer inside another
 283   structure, will be modified to take an additional parameter of the
 284   structure size. The affected APIs will include ``rte_rawdev_info_get``,
 285   ``rte_rawdev_configure``, ``rte_rawdev_queue_conf_get`` and
 286   ``rte_rawdev_queue_setup``.
 287
 288 * acl: ``RTE_ACL_CLASSIFY_NUM`` enum value will be removed.
 289   This enum value is not used inside DPDK, while it prevents to add new
 290   classify algorithms without causing an ABI breakage.
 291
 292 * sched: To allow more traffic classes, flexible mapping of pipe queues to
 293   traffic classes, and subport level configuration of pipes and queues
 294   changes will be made to macros, data structures and API functions defined
 295   in "rte_sched.h". These changes are aligned to improvements suggested in the
 296   RFC https://mails.dpdk.org/archives/dev/2018-November/120035.html.
 297
 298 * metrics: The function ``rte_metrics_init`` will have a non-void return
 299   in order to notify errors instead of calling ``rte_exit``.
 300
 301 * power: ``rte_power_set_env`` function will no longer return 0 on attempt
 302   to set new power environment if power environment was already initialized.
 303   In this case the function will return -1 unless the environment is unset first
 304   (using ``rte_power_unset_env``). Other function usage scenarios will not change.
 305
 306 * python: Since the beginning of 2020, Python 2 has officially reached
 307   end-of-support: https://www.python.org/doc/sunset-python-2/.
 308   Python 2 support will be completely removed in 20.11.
 309   In 20.08, explicit deprecation warnings will be displayed when running
 310   scripts with Python 2.
 311
 312 * dpdk-setup.sh: This old script relies on deprecated stuff, and especially
 313   ``make``. Given environments are too much variables for such a simple script,
 314   it will be removed in DPDK 20.11.
 315   Some useful parts may be converted into specific scripts.