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 * linux: Linux kernel version 3.2 (which is the current minimum required
  15   version for the DPDK) is not maintained anymore. Therefore the planned
  16   minimum required kernel version for DPDK 19.02 will be the next oldest
  17   Long Term Stable (LTS) version which is 3.16, but compatibility for
  18   recent distribution kernels will be kept.
  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: function ``rte_bsf64`` in ``rte_bitmap.h`` has been renamed to
  24   ``rte_bsf64_safe`` and moved to ``rte_common.h``. A new ``rte_bsf64`` function
  25   will be added in the next release in ``rte_common.h`` that follows convention
  26   set by existing ``rte_bsf32`` function.
  27
  28 * eal: both declaring and identifying devices will be streamlined in v18.11.
  29   New functions will appear to query a specific port from buses, classes of
  30   device and device drivers. Device declaration will be made coherent with the
  31   new scheme of device identification.
  32   As such, ``rte_devargs`` device representation will change.
  33
  34   - The enum ``rte_devtype`` was used to identify a bus and will disappear.
  35   - Functions previously deprecated will change or disappear:
  36
  37     + ``rte_eal_devargs_type_count``
  38
  39 * pci: Several exposed functions are misnamed.
  40   The following functions are deprecated starting from v17.11 and are replaced:
  41
  42   - ``eal_parse_pci_BDF`` replaced by ``rte_pci_addr_parse``
  43   - ``eal_parse_pci_DomBDF`` replaced by ``rte_pci_addr_parse``
  44   - ``rte_eal_compare_pci_addr`` replaced by ``rte_pci_addr_cmp``
  45
  46 * dpaa2: removal of ``rte_dpaa2_memsegs`` structure which has been replaced
  47   by a pa-va search library. This structure was earlier being used for holding
  48   memory segments used by dpaa2 driver for faster pa->va translation. This
  49   structure would be made internal (or removed if all dependencies are cleared)
  50   in future releases.
  51
  52 * mbuf: The opaque ``mbuf->hash.sched`` field will be updated to support generic
  53   definition in line with the ethdev TM and MTR APIs. Currently, this field
  54   is defined in librte_sched in a non-generic way. The new generic format
  55   will contain: queue ID, traffic class, color. Field size will not change.
  56
  57 * sched: Some API functions will change prototype due to the above
  58   deprecation note for mbuf->hash.sched, e.g. ``rte_sched_port_pkt_write()``
  59   and ``rte_sched_port_pkt_read()`` will likely have an additional parameter
  60   of type ``struct rte_sched_port``.
  61
  62 * mbuf: the macro ``RTE_MBUF_INDIRECT()`` will be removed in v18.08 or later and
  63   replaced with ``RTE_MBUF_CLONED()`` which is already added in v18.05. As
  64   ``EXT_ATTACHED_MBUF`` is newly introduced in v18.05, ``RTE_MBUF_INDIRECT()``
  65   can no longer be mutually exclusive with ``RTE_MBUF_DIRECT()`` if the new
  66   experimental API ``rte_pktmbuf_attach_extbuf()`` is used. Removal of the macro
  67   is to fix this semantic inconsistency.
  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: Maximum and minimum MTU values vary between hardware devices. In
  78   hardware agnostic DPDK applications access to such information would allow
  79   a more accurate way of validating and setting supported MTU values on a per
  80   device basis rather than using a defined default for all devices. To
  81   resolve this, the following members will be added to ``rte_eth_dev_info``.
  82   Note: these can be added to fit a hole in the existing structure for amd64
  83   but not for 32-bit, as such ABI change will occur as size of the structure
  84   will increase.
  85
  86   - Member ``uint16_t min_mtu`` the minimum MTU allowed.
  87   - Member ``uint16_t max_mtu`` the maximum MTU allowed.
  88
  89 * security: New field ``uint64_t opaque_data`` is planned to be added into
  90   ``rte_security_session`` structure. That would allow upper layer to easily
  91   associate/de-associate some user defined data with the security session.
  92
  93 * cryptodev: several API and ABI changes are planned for rte_cryptodev
  94   in v19.02:
  95
  96   - The size and layout of ``rte_cryptodev_sym_session`` will change
  97     to fix existing issues.
  98   - The size and layout of ``rte_cryptodev_qp_conf`` and syntax of
  99     ``rte_cryptodev_queue_pair_setup`` will change to to allow to use
 100     two different mempools for crypto and device private sessions.
 101
 102 * pdump: As we changed to use generic IPC, some changes in APIs and structure
 103   are expected in subsequent release.
 104
 105   - ``rte_pdump_set_socket_dir`` will be removed;
 106   - The parameter, ``path``, of ``rte_pdump_init`` will be removed;
 107   - The enum ``rte_pdump_socktype`` will be removed.