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 * meson: The minimum supported version of meson for configuring and building
  15   DPDK will be increased to v0.47.1 (from 0.41) from DPDK 19.05 onwards. For
  16   those users with a version earlier than 0.47.1, an updated copy of meson
  17   can be got using the ``pip``, or ``pip3``, tool for downloading python
  18   packages.
  19
  20 * build macros: The macros defining RTE_MACHINE_CPUFLAG_* will be removed
  21   from the build. The information provided by these macros is available
  22   through standard compiler macros. For example, RTE_MACHINE_CPUFLAG_SSE3
  23   duplicates the compiler-provided macro __SSE3__.
  24
  25 * kvargs: The function ``rte_kvargs_process`` will get a new parameter
  26   for returning key match count. It will ease handling of no-match case.
  27
  28 * eal: To be more inclusive in choice of naming, the DPDK project
  29   will replace uses of master/slave in the API's and command line arguments.
  30
  31   References to master/slave in relation to lcore will be renamed
  32   to initial/worker.  The function ``rte_get_master_lcore()``
  33   will be renamed to ``rte_get_initial_lcore()``.
  34   For the 20.11 release, both names will be present and the
  35   old function will be marked with the deprecated tag.
  36   The old function will be removed in a future version.
  37
  38   The iterator for worker lcores will also change:
  39   ``RTE_LCORE_FOREACH_SLAVE`` will be replaced with
  40   ``RTE_LCORE_FOREACH_WORKER``.
  41
  42   The ``master-lcore`` argument to testpmd will be replaced
  43   with ``initial-lcore``. The old ``master-lcore`` argument
  44   will produce a runtime notification in 20.11 release, and
  45   be removed completely in a future release.
  46
  47 * eal: The terms blacklist and whitelist to describe devices used
  48   by DPDK will be replaced in the 20.11 relase.
  49   This will apply to command line arguments as well as macros.
  50
  51   The macro ``RTE_DEV_BLACKLISTED`` will be replaced with ``RTE_DEV_EXCLUDED``
  52   and ``RTE_DEV_WHITELISTED`` will be replaced with ``RTE_DEV_INCLUDED``
  53   ``RTE_BUS_SCAN_BLACKLIST`` and ``RTE_BUS_SCAN_WHITELIST`` will be
  54   replaced with ``RTE_BUS_SCAN_EXCLUDED`` and ``RTE_BUS_SCAN_INCLUDED``
  55   respectively. Likewise ``RTE_DEVTYPE_BLACKLISTED_PCI`` and
  56   ``RTE_DEVTYPE_WHITELISTED_PCI`` will be replaced with
  57   ``RTE_DEVTYPE_EXCLUDED`` and ``RTE_DEVTYPE_INCLUDED``.
  58
  59   The old macros will be marked as deprecated in 20.11 and any
  60   usage will cause a compile warning. They will be removed in
  61   a future release.
  62
  63   The command line arguments to ``rte_eal_init`` will change from
  64   ``-b, --pci-blacklist`` to ``-x, --exclude`` and
  65   ``-w, --pci-whitelist`` to ``-i, --include``.
  66   The old command line arguments will continue to be accepted in 20.11
  67   but will cause a runtime warning message. The old arguments will
  68   be removed in a future release.
  69
  70 * eal: The function ``rte_eal_remote_launch`` will return new error codes
  71   after read or write error on the pipe, instead of calling ``rte_panic``.
  72
  73 * rte_atomicNN_xxx: These APIs do not take memory order parameter. This does
  74   not allow for writing optimized code for all the CPU architectures supported
  75   in DPDK. DPDK will adopt C11 atomic operations semantics and provide wrappers
  76   using C11 atomic built-ins. These wrappers must be used for patches that
  77   need to be merged in 20.08 onwards. This change will not introduce any
  78   performance degradation.
  79
  80 * rte_smp_*mb: These APIs provide full barrier functionality. However, many
  81   use cases do not require full barriers. To support such use cases, DPDK will
  82   adopt C11 barrier semantics and provide wrappers using C11 atomic built-ins.
  83   These wrappers must be used for patches that need to be merged in 20.08
  84   onwards. This change will not introduce any performance degradation.
  85
  86 * igb_uio: In the view of reducing the kernel dependency from the main tree,
  87   as a first step, the Technical Board decided to move ``igb_uio``
  88   kernel module to the dpdk-kmods repository in the /linux/igb_uio/ directory
  89   in 20.11.
  90   Minutes of Technical Board Meeting of `2019-11-06
  91   <https://mails.dpdk.org/archives/dev/2019-November/151763.html>`_.
  92
  93 * lib: will fix extending some enum/define breaking the ABI. There are multiple
  94   samples in DPDK that enum/define terminated with a ``.*MAX.*`` value which is
  95   used by iterators, and arrays holding these values are sized with this
  96   ``.*MAX.*`` value. So extending this enum/define increases the ``.*MAX.*``
  97   value which increases the size of the array and depending on how/where the
  98   array is used this may break the ABI.
  99   ``RTE_ETH_FLOW_MAX`` is one sample of the mentioned case, adding a new flow
 100   type will break the ABI because of ``flex_mask[RTE_ETH_FLOW_MAX]`` array
 101   usage in following public struct hierarchy:
 102   ``rte_eth_fdir_flex_conf -> rte_fdir_conf -> rte_eth_conf (in the middle)``.
 103   Need to identify this kind of usages and fix in 20.11, otherwise this blocks
 104   us extending existing enum/define.
 105   One solution can be using a fixed size array instead of ``.*MAX.*`` value.
 106
 107 * mbuf: Some fields will be converted to dynamic API in DPDK 20.11
 108   in order to reserve more space for the dynamic fields, as explained in
 109   `this presentation <https://www.youtube.com/watch?v=Ttl6MlhmzWY>`_.
 110   The following static fields will be moved as dynamic:
 111
 112   - ``timestamp``
 113   - ``userdata`` / ``udata64``
 114   - ``seqn``
 115
 116   As a consequence, the layout of the ``struct rte_mbuf`` will be re-arranged,
 117   avoiding impact on vectorized implementation of the driver datapaths,
 118   while evaluating performance gains of a better use of the first cache line.
 119
 120
 121 * ethdev: the legacy filter API, including
 122   ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
 123   as filter types MACVLAN, ETHERTYPE, FLEXIBLE, SYN, NTUPLE, TUNNEL, FDIR,
 124   HASH and L2_TUNNEL, is superseded by the generic flow API (rte_flow) in
 125   PMDs that implement the latter.
 126   The legacy API will be removed in DPDK 20.11.
 127
 128 * ethdev: The flow director API, including ``rte_eth_conf.fdir_conf`` field,
 129   and the related structures (``rte_fdir_*`` and ``rte_eth_fdir_*``),
 130   will be removed in DPDK 20.11.
 131
 132 * ethdev: The legacy L2 tunnel filtering API is deprecated as the rest of
 133   the legacy filtering API.
 134   The functions ``rte_eth_dev_l2_tunnel_eth_type_conf`` and
 135   ``rte_eth_dev_l2_tunnel_offload_set`` which were not marked as deprecated,
 136   will be removed in DPDK 20.11.
 137
 138 * ethdev: Update API functions returning ``void`` to return ``int`` with
 139   negative errno values to indicate various error conditions (e.g.
 140   invalid port ID, unsupported operation, failed operation):
 141
 142   - ``rte_eth_dev_stop``
 143   - ``rte_eth_dev_close``
 144
 145 * ethdev: The temporary flag RTE_ETH_DEV_CLOSE_REMOVE will be removed in 20.11.
 146   As a consequence, the new behaviour introduced in 18.11 will be effective
 147   for all drivers: generic port resources are freed on close operation.
 148   Private resources are expected to be released in the ``dev_close`` callback.
 149   More details in http://inbox.dpdk.org/dev/5248162.j6AOsuQRmx@thomas/
 150
 151 * ethdev: New offload flags ``DEV_RX_OFFLOAD_FLOW_MARK`` will be added in 19.11.
 152   This will allow application to enable or disable PMDs from updating
 153   ``rte_mbuf::hash::fdir``.
 154   This scheme will allow PMDs to avoid writes to ``rte_mbuf`` fields on Rx and
 155   thereby improve Rx performance if application wishes do so.
 156   In 19.11 PMDs will still update the field even when the offload is not
 157   enabled.
 158
 159 * ethdev: Add new fields to ``rte_eth_rxconf`` to configure the receiving
 160   queues to split ingress packets into multiple segments according to the
 161   specified lengths into the buffers allocated from the specified
 162   memory pools. The backward compatibility to existing API is preserved.
 163
 164 * ethdev: ``rx_descriptor_done`` dev_ops and ``rte_eth_rx_descriptor_done``
 165   will be removed in 21.11.
 166   Existing ``rte_eth_rx_descriptor_status`` and ``rte_eth_tx_descriptor_status``
 167   APIs can be used as replacement.
 168
 169 * ethdev: The port mirroring API can be replaced with a more fine grain flow API.
 170   The structs ``rte_eth_mirror_conf``, ``rte_eth_vlan_mirror`` and the functions
 171   ``rte_eth_mirror_rule_set``, ``rte_eth_mirror_rule_reset`` will be marked
 172   as deprecated in DPDK 20.11, along with the associated macros ``ETH_MIRROR_*``.
 173   This API will be fully removed in DPDK 21.11.
 174
 175 * ethdev: The ``struct rte_flow_item_eth`` and ``struct rte_flow_item_vlan``
 176   structs will be modified, to include an additional value, indicating existence
 177   or absence of a VLAN header following the current header, as proposed in RFC
 178   https://mails.dpdk.org/archives/dev/2020-August/177536.html.
 179
 180 * ethdev: The ``struct rte_flow_item_ipv6`` struct will be modified to include
 181   additional values, indicating existence or absence of IPv6 extension headers
 182   following the IPv6 header, as proposed in RFC
 183   https://mails.dpdk.org/archives/dev/2020-August/177257.html.
 184
 185 * vhost: Vhost-user dequeue zero-copy support will be removed in 20.11.
 186   The only known user is OVS where the feature is still experimental,
 187   and has not received any update for 2.5 years.
 188   This feature faces reliability issues and is often conflicting with
 189   new features being implemented.
 190
 191 * security: The API ``rte_security_session_create`` takes only single mempool
 192   for session and session private data. So the application need to create
 193   mempool for twice the number of sessions needed and will also lead to
 194   wastage of memory as session private data need more memory compared to session.
 195   Hence the API will be modified to take two mempool pointers - one for session
 196   and one for private data.
 197
 198 * cryptodev: ``RTE_CRYPTO_AEAD_LIST_END`` from ``enum rte_crypto_aead_algorithm``,
 199   ``RTE_CRYPTO_CIPHER_LIST_END`` from ``enum rte_crypto_cipher_algorithm`` and
 200   ``RTE_CRYPTO_AUTH_LIST_END`` from ``enum rte_crypto_auth_algorithm``
 201   will be removed.
 202
 203 * cryptodev: support for using IV with all sizes is added, J0 still can
 204   be used but only when IV length in following structs ``rte_crypto_auth_xform``,
 205   ``rte_crypto_aead_xform`` is set to zero. When IV length is greater or equal
 206   to one it means it represents IV, when is set to zero it means J0 is used
 207   directly, in this case 16 bytes of J0 need to be passed.
 208
 209 * scheduler: The functions ``rte_cryptodev_scheduler_slave_attach``,
 210   ``rte_cryptodev_scheduler_slave_detach`` and
 211   ``rte_cryptodev_scheduler_slaves_get`` will be replaced in 20.11 by
 212   ``rte_cryptodev_scheduler_worker_attach``,
 213   ``rte_cryptodev_scheduler_worker_detach`` and
 214   ``rte_cryptodev_scheduler_workers_get`` accordingly.
 215
 216 * eventdev: Following structures will be modified to support DLB PMD
 217   and future extensions:
 218
 219   - ``rte_event_dev_info``
 220   - ``rte_event_dev_config``
 221   - ``rte_event_port_conf``
 222
 223   Patches containing justification, documentation, and proposed modifications
 224   can be found at:
 225
 226   - https://patches.dpdk.org/patch/71457/
 227   - https://patches.dpdk.org/patch/71456/
 228
 229 * acl: ``RTE_ACL_CLASSIFY_NUM`` enum value will be removed.
 230   This enum value is not used inside DPDK, while it prevents to add new
 231   classify algorithms without causing an ABI breakage.
 232
 233 * sched: To allow more traffic classes, flexible mapping of pipe queues to
 234   traffic classes, and subport level configuration of pipes and queues
 235   changes will be made to macros, data structures and API functions defined
 236   in "rte_sched.h". These changes are aligned to improvements suggested in the
 237   RFC https://mails.dpdk.org/archives/dev/2018-November/120035.html.
 238
 239 * sched: To allow dynamic configuration of the subport bandwidth profile,
 240   changes will be made to data structures ``rte_sched_subport_params``,
 241   ``rte_sched_port_params`` and new data structure, API functions will be
 242   defined in ``rte_sched.h``. These changes are aligned as suggested in the
 243   RFC https://mails.dpdk.org/archives/dev/2020-July/175161.html
 244
 245 * metrics: The function ``rte_metrics_init`` will have a non-void return
 246   in order to notify errors instead of calling ``rte_exit``.
 247
 248 * power: ``rte_power_set_env`` function will no longer return 0 on attempt
 249   to set new power environment if power environment was already initialized.
 250   In this case the function will return -1 unless the environment is unset first
 251   (using ``rte_power_unset_env``). Other function usage scenarios will not change.
 252
 253 * python: Since the beginning of 2020, Python 2 has officially reached
 254   end-of-support: https://www.python.org/doc/sunset-python-2/.
 255   Python 2 support will be completely removed in 20.11.
 256   In 20.08, explicit deprecation warnings will be displayed when running
 257   scripts with Python 2.
 258
 259 * dpdk-setup.sh: This old script relies on deprecated stuff, and especially
 260   ``make``. Given environments are too much variables for such a simple script,
 261   it will be removed in DPDK 20.11.
 262   Some useful parts may be converted into specific scripts.