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 * kvargs: The function ``rte_kvargs_process`` will get a new parameter
  15   for returning key match count. It will ease handling of no-match case.
  16
  17 * eal: function ``rte_bsf64`` in ``rte_bitmap.h`` has been renamed to
  18   ``rte_bsf64_safe`` and moved to ``rte_common.h``. A new ``rte_bsf64`` function
  19   will be added in the next release in ``rte_common.h`` that follows convention
  20   set by existing ``rte_bsf32`` function.
  21
  22 * eal: both declaring and identifying devices will be streamlined in v18.11.
  23   New functions will appear to query a specific port from buses, classes of
  24   device and device drivers. Device declaration will be made coherent with the
  25   new scheme of device identification.
  26   As such, ``rte_devargs`` device representation will change.
  27
  28   - The enum ``rte_devtype`` was used to identify a bus and will disappear.
  29   - Functions previously deprecated will change or disappear:
  30
  31     + ``rte_eal_devargs_type_count``
  32
  33 * pci: Several exposed functions are misnamed.
  34   The following functions are deprecated starting from v17.11 and are replaced:
  35
  36   - ``eal_parse_pci_BDF`` replaced by ``rte_pci_addr_parse``
  37   - ``eal_parse_pci_DomBDF`` replaced by ``rte_pci_addr_parse``
  38   - ``rte_eal_compare_pci_addr`` replaced by ``rte_pci_addr_cmp``
  39
  40 * mbuf: The opaque ``mbuf->hash.sched`` field will be updated to support generic
  41   definition in line with the ethdev TM and MTR APIs. Currently, this field
  42   is defined in librte_sched in a non-generic way. The new generic format
  43   will contain: queue ID, traffic class, color. Field size will not change.
  44
  45 * mbuf: the macro ``RTE_MBUF_INDIRECT()`` will be removed in v18.08 or later and
  46   replaced with ``RTE_MBUF_CLONED()`` which is already added in v18.05. As
  47   ``EXT_ATTACHED_MBUF`` is newly introduced in v18.05, ``RTE_MBUF_INDIRECT()``
  48   can no longer be mutually exclusive with ``RTE_MBUF_DIRECT()`` if the new
  49   experimental API ``rte_pktmbuf_attach_extbuf()`` is used. Removal of the macro
  50   is to fix this semantic inconsistency.
  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 * pdump: As we changed to use generic IPC, some changes in APIs and structure
  61   are expected in subsequent release.
  62
  63   - ``rte_pdump_set_socket_dir`` will be removed;
  64   - The parameter, ``path``, of ``rte_pdump_init`` will be removed;
  65   - The enum ``rte_pdump_socktype`` will be removed.