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