doc/guides/rel_notes/deprecation.rst

   1 ABI and API Deprecation
   2 =======================
   3
   4 See the :doc:`guidelines document for details of the ABI policy </contributing/versioning>`.
   5 API and ABI deprecation notices are to be posted here.
   6
   7
   8 Deprecation Notices
   9 -------------------
  10
  11 * eal: the following functions are deprecated starting from 17.05 and will
  12   be removed in 17.11:
  13
  14   - ``rte_set_log_level``, replaced by ``rte_log_set_global_level``
  15   - ``rte_get_log_level``, replaced by ``rte_log_get_global_level``
  16   - ``rte_set_log_type``, replaced by ``rte_log_set_level``
  17   - ``rte_get_log_type``, replaced by ``rte_log_get_level``
  18
  19 * eal: several API and ABI changes are planned for ``rte_devargs`` in v17.11.
  20   The format of device command line parameters will change. The bus will need
  21   to be explicitly stated in the device declaration. The enum ``rte_devtype``
  22   was used to identify a bus and will disappear.
  23   The structure ``rte_devargs`` will change.
  24   The ``rte_devargs_list`` will be made private.
  25   The following functions are deprecated starting from 17.08 and will either be
  26   modified or removed in 17.11:
  27
  28   - ``rte_eal_devargs_add``
  29   - ``rte_eal_devargs_type_count``
  30   - ``rte_eal_parse_devargs_str``, replaced by ``rte_eal_devargs_parse``
  31
  32 * eal: the support of Xen dom0 will be removed from EAL in 17.11; and with
  33   that, drivers/net/xenvirt and examples/vhost_xen will also be removed.
  34
  35 * eal: An ABI change is planned for 17.11 to make DPDK aware of IOVA address
  36   translation scheme.
  37   Reference to phys address in EAL data-structure or functions may change to
  38   IOVA address or more appropriate name.
  39   The change will be only for the name.
  40   Functional aspects of the API or data-structure will remain same.
  41
  42 * The mbuf flags PKT_RX_VLAN_PKT and PKT_RX_QINQ_PKT are deprecated and
  43   are respectively replaced by PKT_RX_VLAN_STRIPPED and
  44   PKT_RX_QINQ_STRIPPED, that are better described. The old flags and
  45   their behavior will be kept until 17.08 and will be removed in 17.11.
  46
  47 * ethdev: Tx offloads will no longer be enabled by default in 17.11.
  48   Instead, the ``rte_eth_txmode`` structure will be extended with
  49   bit field to enable each Tx offload.
  50   Besides of making the Rx/Tx configuration API more consistent for the
  51   application, PMDs will be able to provide a better out of the box performance.
  52   As part of the work, ``ETH_TXQ_FLAGS_NO*`` will be superseded as well.
  53
  54 * ethdev: the legacy filter API, including
  55   ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
  56   as filter types MACVLAN, ETHERTYPE, FLEXIBLE, SYN, NTUPLE, TUNNEL, FDIR,
  57   HASH and L2_TUNNEL, is superseded by the generic flow API (rte_flow) in
  58   PMDs that implement the latter.
  59   Target release for removal of the legacy API will be defined once most
  60   PMDs have switched to rte_flow.
  61
  62 * librte_table: The ``key_mask`` parameter will be added to all the hash tables
  63   that currently do not have it, as well as to the hash compute function prototype.
  64   The non-"do-sig" versions of the hash tables will be removed
  65   (including the ``signature_offset`` parameter)
  66   and the "do-sig" versions renamed accordingly.
  67
  68 * cryptodev: the following function is deprecated starting from 17.08 and will
  69   be removed in 17.11:
  70
  71   - ``rte_cryptodev_create_vdev``