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 * eal: both declaring and identifying devices will be streamlined in v18.11.
  15   New functions will appear to query a specific port from buses, classes of
  16   device and device drivers. Device declaration will be made coherent with the
  17   new scheme of device identification.
  18   As such, ``rte_devargs`` device representation will change.
  19
  20   - The enum ``rte_devtype`` was used to identify a bus and will disappear.
  21   - Functions previously deprecated will change or disappear:
  22
  23     + ``rte_eal_devargs_type_count``
  24
  25 * pci: Several exposed functions are misnamed.
  26   The following functions are deprecated starting from v17.11 and are replaced:
  27
  28   - ``eal_parse_pci_BDF`` replaced by ``rte_pci_addr_parse``
  29   - ``eal_parse_pci_DomBDF`` replaced by ``rte_pci_addr_parse``
  30   - ``rte_eal_compare_pci_addr`` replaced by ``rte_pci_addr_cmp``
  31
  32 * mbuf: The opaque ``mbuf->hash.sched`` field will be updated to support generic
  33   definition in line with the ethdev TM and MTR APIs. Currently, this field
  34   is defined in librte_sched in a non-generic way. The new generic format
  35   will contain: queue ID, traffic class, color. Field size will not change.
  36
  37 * mbuf: the macro ``RTE_MBUF_INDIRECT()`` will be removed in v18.08 or later and
  38   replaced with ``RTE_MBUF_CLONED()`` which is already added in v18.05. As
  39   ``EXT_ATTACHED_MBUF`` is newly introduced in v18.05, ``RTE_MBUF_INDIRECT()``
  40   can no longer be mutually exclusive with ``RTE_MBUF_DIRECT()`` if the new
  41   experimental API ``rte_pktmbuf_attach_extbuf()`` is used. Removal of the macro
  42   is to fix this semantic inconsistency.
  43
  44 * ethdev: the legacy filter API, including
  45   ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
  46   as filter types MACVLAN, ETHERTYPE, FLEXIBLE, SYN, NTUPLE, TUNNEL, FDIR,
  47   HASH and L2_TUNNEL, is superseded by the generic flow API (rte_flow) in
  48   PMDs that implement the latter.
  49   Target release for removal of the legacy API will be defined once most
  50   PMDs have switched to rte_flow.
  51
  52 * pdump: As we changed to use generic IPC, some changes in APIs and structure
  53   are expected in subsequent release.
  54
  55   - ``rte_pdump_set_socket_dir`` will be removed;
  56   - The parameter, ``path``, of ``rte_pdump_init`` will be removed;
  57   - The enum ``rte_pdump_socktype`` will be removed.