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 * kvargs: The function ``rte_kvargs_process`` will get a new parameter
  21   for returning key match count. It will ease handling of no-match case.
  22
  23 * eal: The function ``rte_eal_remote_launch`` will return new error codes
  24   after read or write error on the pipe, instead of calling ``rte_panic``.
  25
  26 * eal: both declaring and identifying devices will be streamlined in v18.11.
  27   New functions will appear to query a specific port from buses, classes of
  28   device and device drivers. Device declaration will be made coherent with the
  29   new scheme of device identification.
  30   As such, ``rte_devargs`` device representation will change.
  31
  32   - The enum ``rte_devtype`` was used to identify a bus and will disappear.
  33   - Functions previously deprecated will change or disappear:
  34
  35     + ``rte_eal_devargs_type_count``
  36
  37 * eal: The ``rte_logs`` struct and global symbol will be made private to
  38   remove it from the externally visible ABI and allow it to be updated in the
  39   future.
  40
  41 * dpaa2: removal of ``rte_dpaa2_memsegs`` structure which has been replaced
  42   by a pa-va search library. This structure was earlier being used for holding
  43   memory segments used by dpaa2 driver for faster pa->va translation. This
  44   structure would be made internal (or removed if all dependencies are cleared)
  45   in future releases.
  46
  47 * mempool: starting from v20.05, the API of rte_mempool_populate_iova()
  48   and rte_mempool_populate_virt() will change to return 0 instead
  49   of -EINVAL when there is not enough room to store one object. The ABI
  50   will be preserved until 20.11.
  51
  52 * ethdev: the legacy filter API, including
  53   ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
  54   as filter types MACVLAN, ETHERTYPE, FLEXIBLE, SYN, NTUPLE, TUNNEL, FDIR,
  55   HASH and L2_TUNNEL, is superseded by the generic flow API (rte_flow) in
  56   PMDs that implement the latter.
  57   Target release for removal of the legacy API will be defined once most
  58   PMDs have switched to rte_flow.
  59
  60 * ethdev: Update API functions returning ``void`` to return ``int`` with
  61   negative errno values to indicate various error conditions (e.g.
  62   invalid port ID, unsupported operation, failed operation):
  63
  64   - ``rte_eth_dev_stop``
  65   - ``rte_eth_dev_close``
  66
  67 * ethdev: New offload flags ``DEV_RX_OFFLOAD_FLOW_MARK`` will be added in 19.11.
  68   This will allow application to enable or disable PMDs from updating
  69   ``rte_mbuf::hash::fdir``.
  70   This scheme will allow PMDs to avoid writes to ``rte_mbuf`` fields on Rx and
  71   thereby improve Rx performance if application wishes do so.
  72   In 19.11 PMDs will still update the field even when the offload is not
  73   enabled.
  74
  75 * cryptodev: support for using IV with all sizes is added, J0 still can
  76   be used but only when IV length in following structs ``rte_crypto_auth_xform``,
  77   ``rte_crypto_aead_xform`` is set to zero. When IV length is greater or equal
  78   to one it means it represents IV, when is set to zero it means J0 is used
  79   directly, in this case 16 bytes of J0 need to be passed.
  80
  81 * sched: To allow more traffic classes, flexible mapping of pipe queues to
  82   traffic classes, and subport level configuration of pipes and queues
  83   changes will be made to macros, data structures and API functions defined
  84   in "rte_sched.h". These changes are aligned to improvements suggested in the
  85   RFC https://mails.dpdk.org/archives/dev/2018-November/120035.html.
  86
  87 * metrics: The function ``rte_metrics_init`` will have a non-void return
  88   in order to notify errors instead of calling ``rte_exit``.
  89
  90 * power: ``rte_power_set_env`` function will no longer return 0 on attempt
  91   to set new power environment if power environment was already initialized.
  92   In this case the function will return -1 unless the environment is unset first
  93   (using ``rte_power_unset_env``). Other function usage scenarios will not change.