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: The ``lcore_config`` struct and global symbol will be made private to
  27   remove it from the externally visible ABI and allow it to be updated in the
  28   future.
  29
  30 * eal: both declaring and identifying devices will be streamlined in v18.11.
  31   New functions will appear to query a specific port from buses, classes of
  32   device and device drivers. Device declaration will be made coherent with the
  33   new scheme of device identification.
  34   As such, ``rte_devargs`` device representation will change.
  35
  36   - The enum ``rte_devtype`` was used to identify a bus and will disappear.
  37   - Functions previously deprecated will change or disappear:
  38
  39     + ``rte_eal_devargs_type_count``
  40
  41 * eal: The ``rte_cpu_check_supported`` function has been deprecated since
  42   v17.08 and will be removed.
  43
  44 * eal: The ``rte_malloc_virt2phy`` function has been deprecated and replaced
  45   by ``rte_malloc_virt2iova`` since v17.11 and will be removed.
  46
  47 * vfio: removal of ``rte_vfio_dma_map`` and ``rte_vfio_dma_unmap`` APIs which
  48   have been replaced with ``rte_dev_dma_map`` and ``rte_dev_dma_unmap``
  49   functions.  The due date for the removal targets DPDK 20.02.
  50
  51 * pci: Several exposed functions are misnamed.
  52   The following functions are deprecated starting from v17.11 and are replaced:
  53
  54   - ``eal_parse_pci_BDF`` replaced by ``rte_pci_addr_parse``
  55   - ``eal_parse_pci_DomBDF`` replaced by ``rte_pci_addr_parse``
  56   - ``rte_eal_compare_pci_addr`` replaced by ``rte_pci_addr_cmp``
  57
  58 * dpaa2: removal of ``rte_dpaa2_memsegs`` structure which has been replaced
  59   by a pa-va search library. This structure was earlier being used for holding
  60   memory segments used by dpaa2 driver for faster pa->va translation. This
  61   structure would be made internal (or removed if all dependencies are cleared)
  62   in future releases.
  63
  64 * net: The Ethernet address and header definitions will change
  65   attributes. The Ethernet address struct will no longer be marked as
  66   packed since the packed attribute is meaningless on a byte
  67   array. The Ethernet header will be marked as aligned on a 2-byte
  68   boundary and will no longer have the packed attribute. This allows
  69   for efficient access on CPU architectures where unaligned access is
  70   expensive. These changes should not impact normal usage because drivers
  71   naturally align the Ethernet header on receive and all known
  72   encapsulations preserve the alignment of the header.
  73
  74 * ethdev: The function ``rte_eth_dev_count`` will be removed in DPDK 20.02.
  75   It is replaced by the function ``rte_eth_dev_count_avail``.
  76   If the intent is to iterate over ports, ``RTE_ETH_FOREACH_*`` macros
  77   are better port iterators.
  78
  79 * ethdev: the legacy filter API, including
  80   ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
  81   as filter types MACVLAN, ETHERTYPE, FLEXIBLE, SYN, NTUPLE, TUNNEL, FDIR,
  82   HASH and L2_TUNNEL, is superseded by the generic flow API (rte_flow) in
  83   PMDs that implement the latter.
  84   Target release for removal of the legacy API will be defined once most
  85   PMDs have switched to rte_flow.
  86
  87 * ethdev: Update API functions returning ``void`` to return ``int`` with
  88   negative errno values to indicate various error conditions (e.g.
  89   invalid port ID, unsupported operation, failed operation):
  90
  91   - ``rte_eth_allmulticast_enable`` and ``rte_eth_allmulticast_disable``
  92   - ``rte_eth_link_get`` and ``rte_eth_link_get_nowait``
  93   - ``rte_eth_dev_stop``
  94   - ``rte_eth_dev_close``
  95   - ``rte_eth_macaddr_get``
  96   - ``rte_eth_dev_owner_delete``
  97
  98 * ethdev: New offload flags ``DEV_RX_OFFLOAD_RSS_HASH`` and
  99   ``DEV_RX_OFFLOAD_FLOW_MARK`` will be added in 19.11.
 100   This will allow application to enable or disable PMDs from updating
 101   ``rte_mbuf::hash::rss`` and ``rte_mbuf::hash::fdir`` respectively.
 102   This scheme will allow PMDs to avoid writes to ``rte_mbuf`` fields on Rx and
 103   thereby improve Rx performance if application wishes do so.
 104   In 19.11 PMDs will still update the fields even when the offloads are not
 105   enabled.
 106
 107 * ethdev: New function ``rte_eth_dev_set_supported_ptypes`` will be added in
 108   19.11.
 109   This will allow application to request PMD to set specific ptypes defined
 110   through ``rte_eth_dev_set_supported_ptypes`` in ``rte_mbuf::packet_type``.
 111   If application doesn't want any ptype information it can call
 112   ``rte_eth_dev_set_supported_ptypes(ethdev_id, RTE_PTYPE_UNKNOWN)`` and PMD
 113   will set ``rte_mbuf::packet_type`` to ``0``.
 114   If application doesn't call ``rte_eth_dev_set_supported_ptypes`` PMD can
 115   return ``rte_mbuf::packet_type`` with ``rte_eth_dev_get_supported_ptypes``.
 116   If application is interested only in L2/L3 layer, it can inform the PMD
 117   to update ``rte_mbuf::packet_type`` with L2/L3 ptype by calling
 118   ``rte_eth_dev_set_supported_ptypes(ethdev_id, RTE_PTYPE_L2_MASK | RTE_PTYPE_L3_MASK)``.
 119   This scheme will allow PMDs to avoid lookup to internal ptype table on Rx and
 120   thereby improve Rx performance if application wishes do so.
 121
 122 * ethdev: New 32-bit fields may be added for maximum LRO session size, in
 123   struct ``rte_eth_dev_info`` for the port capability and in struct
 124   ``rte_eth_rxmode`` for the port configuration.
 125
 126 * cryptodev: support for using IV with all sizes is added, J0 still can
 127   be used but only when IV length in following structs ``rte_crypto_auth_xform``,
 128   ``rte_crypto_aead_xform`` is set to zero. When IV length is greater or equal
 129   to one it means it represents IV, when is set to zero it means J0 is used
 130   directly, in this case 16 bytes of J0 need to be passed.
 131
 132 * sched: To allow more traffic classes, flexible mapping of pipe queues to
 133   traffic classes, and subport level configuration of pipes and queues
 134   changes will be made to macros, data structures and API functions defined
 135   in "rte_sched.h". These changes are aligned to improvements suggested in the
 136   RFC https://mails.dpdk.org/archives/dev/2018-November/120035.html.
 137
 138 * metrics: The function ``rte_metrics_init`` will have a non-void return
 139   in order to notify errors instead of calling ``rte_exit``.
 140
 141 * power: ``rte_power_set_env`` function will no longer return 0 on attempt
 142   to set new power environment if power environment was already initialized.
 143   In this case the function will return -1 unless the environment is unset first
 144   (using ``rte_power_unset_env``). Other function usage scenarios will not change.