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 :doc:`guidelines document for details of the ABI policy </contributing/versioning>`.
   8 API and ABI deprecation notices are to be posted here.
   9
  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 * vfio: removal of ``rte_vfio_dma_map`` and ``rte_vfio_dma_unmap`` APIs which
  42   have been replaced with ``rte_dev_dma_map`` and ``rte_dev_dma_unmap``
  43   functions.  The due date for the removal targets DPDK 20.02.
  44
  45 * dpaa2: removal of ``rte_dpaa2_memsegs`` structure which has been replaced
  46   by a pa-va search library. This structure was earlier being used for holding
  47   memory segments used by dpaa2 driver for faster pa->va translation. This
  48   structure would be made internal (or removed if all dependencies are cleared)
  49   in future releases.
  50
  51 * ethdev: The function ``rte_eth_dev_count`` will be removed in DPDK 20.02.
  52   It is replaced by the function ``rte_eth_dev_count_avail``.
  53   If the intent is to iterate over ports, ``RTE_ETH_FOREACH_*`` macros
  54   are better port iterators.
  55
  56 * ethdev: the legacy filter API, including
  57   ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
  58   as filter types MACVLAN, ETHERTYPE, FLEXIBLE, SYN, NTUPLE, TUNNEL, FDIR,
  59   HASH and L2_TUNNEL, is superseded by the generic flow API (rte_flow) in
  60   PMDs that implement the latter.
  61   Target release for removal of the legacy API will be defined once most
  62   PMDs have switched to rte_flow.
  63
  64 * ethdev: Update API functions returning ``void`` to return ``int`` with
  65   negative errno values to indicate various error conditions (e.g.
  66   invalid port ID, unsupported operation, failed operation):
  67
  68   - ``rte_eth_dev_stop``
  69   - ``rte_eth_dev_close``
  70
  71 * ethdev: New offload flags ``DEV_RX_OFFLOAD_RSS_HASH`` and
  72   ``DEV_RX_OFFLOAD_FLOW_MARK`` will be added in 19.11.
  73   This will allow application to enable or disable PMDs from updating
  74   ``rte_mbuf::hash::rss`` and ``rte_mbuf::hash::fdir`` respectively.
  75   This scheme will allow PMDs to avoid writes to ``rte_mbuf`` fields on Rx and
  76   thereby improve Rx performance if application wishes do so.
  77   In 19.11 PMDs will still update the fields even when the offloads are not
  78   enabled.
  79
  80 * ethdev: New function ``rte_eth_dev_set_supported_ptypes`` will be added in
  81   19.11.
  82   This will allow application to request PMD to set specific ptypes defined
  83   through ``rte_eth_dev_set_supported_ptypes`` in ``rte_mbuf::packet_type``.
  84   If application doesn't want any ptype information it can call
  85   ``rte_eth_dev_set_supported_ptypes(ethdev_id, RTE_PTYPE_UNKNOWN)`` and PMD
  86   will set ``rte_mbuf::packet_type`` to ``0``.
  87   If application doesn't call ``rte_eth_dev_set_supported_ptypes`` PMD can
  88   return ``rte_mbuf::packet_type`` with ``rte_eth_dev_get_supported_ptypes``.
  89   If application is interested only in L2/L3 layer, it can inform the PMD
  90   to update ``rte_mbuf::packet_type`` with L2/L3 ptype by calling
  91   ``rte_eth_dev_set_supported_ptypes(ethdev_id, RTE_PTYPE_L2_MASK | RTE_PTYPE_L3_MASK)``.
  92   This scheme will allow PMDs to avoid lookup to internal ptype table on Rx and
  93   thereby improve Rx performance if application wishes do so.
  94
  95 * ethdev: New 32-bit fields may be added for maximum LRO session size, in
  96   struct ``rte_eth_dev_info`` for the port capability and in struct
  97   ``rte_eth_rxmode`` for the port configuration.
  98
  99 * cryptodev: support for using IV with all sizes is added, J0 still can
 100   be used but only when IV length in following structs ``rte_crypto_auth_xform``,
 101   ``rte_crypto_aead_xform`` is set to zero. When IV length is greater or equal
 102   to one it means it represents IV, when is set to zero it means J0 is used
 103   directly, in this case 16 bytes of J0 need to be passed.
 104
 105 * sched: To allow more traffic classes, flexible mapping of pipe queues to
 106   traffic classes, and subport level configuration of pipes and queues
 107   changes will be made to macros, data structures and API functions defined
 108   in "rte_sched.h". These changes are aligned to improvements suggested in the
 109   RFC https://mails.dpdk.org/archives/dev/2018-November/120035.html.
 110
 111 * metrics: The function ``rte_metrics_init`` will have a non-void return
 112   in order to notify errors instead of calling ``rte_exit``.
 113
 114 * power: ``rte_power_set_env`` function will no longer return 0 on attempt
 115   to set new power environment if power environment was already initialized.
 116   In this case the function will return -1 unless the environment is unset first
 117   (using ``rte_power_unset_env``). Other function usage scenarios will not change.