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.08:
  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 * devargs: An ABI change is planned for 17.08 for the structure ``rte_devargs``.
  20   The current version is dependent on bus-specific device identifier, which will
  21   be made generic and abstracted, in order to make the EAL bus-agnostic.
  22
  23   Accompanying this evolution, device command line parameters will thus support
  24   explicit bus definition in a device declaration.
  25
  26 * igb_uio: iomem mapping and sysfs files created for iomem and ioport in
  27   igb_uio will be removed, because we are able to detect these from what Linux
  28   has exposed, like the way we have done with uio-pci-generic. This change
  29   targets release 17.05.
  30
  31 * vfio: Some functions are planned to be exported outside librte_eal in 17.05.
  32   VFIO APIs like ``vfio_setup_device``, ``vfio_get_group_fd`` can be used by
  33   subsystem other than EAL/PCI. For that, these need to be exported symbols.
  34   Such APIs are planned to be renamed according to ``rte_*`` naming convention
  35   and exported from librte_eal.
  36
  37 * The VDEV subsystem will be converted as driver of the new bus model.
  38   It will imply some EAL API changes in 17.05.
  39
  40 * ``eth_driver`` is planned to be removed in 17.05. This currently serves as
  41   a placeholder for PMDs to register themselves. Changes for ``rte_bus`` will
  42   provide a way to handle device initialization currently being done in
  43   ``eth_driver``. Similarly, ``rte_pci_driver`` is planned to be removed from
  44   ``rte_cryptodev_driver`` in 17.05.
  45
  46 * ethdev: An API change is planned for 17.05 for the function
  47   ``_rte_eth_dev_callback_process``. In 17.05 the function will return an ``int``
  48   instead of ``void`` and a fourth parameter ``void *ret_param`` will be added.
  49
  50 * ethdev: for 17.05 it is planned to deprecate the following nine rte_eth_dev_*
  51   functions and move them into the ixgbe PMD:
  52
  53   ``rte_eth_dev_bypass_init``, ``rte_eth_dev_bypass_state_set``,
  54   ``rte_eth_dev_bypass_state_show``, ``rte_eth_dev_bypass_event_store``,
  55   ``rte_eth_dev_bypass_event_show``, ``rte_eth_dev_wd_timeout_store``,
  56   ``rte_eth_dev_bypass_wd_timeout_show``, ``rte_eth_dev_bypass_ver_show``,
  57   ``rte_eth_dev_bypass_wd_reset``.
  58
  59   The following fields will be removed from ``struct eth_dev_ops``:
  60
  61   ``bypass_init_t``, ``bypass_state_set_t``, ``bypass_state_show_t``,
  62   ``bypass_event_set_t``, ``bypass_event_show_t``, ``bypass_wd_timeout_set_t``,
  63   ``bypass_wd_timeout_show_t``, ``bypass_ver_show_t``, ``bypass_wd_reset_t``.
  64
  65   The functions will be renamed to the following, and moved to the ``ixgbe`` PMD:
  66
  67   ``rte_pmd_ixgbe_bypass_init``, ``rte_pmd_ixgbe_bypass_state_set``,
  68   ``rte_pmd_ixgbe_bypass_state_show``, ``rte_pmd_ixgbe_bypass_event_set``,
  69   ``rte_pmd_ixgbe_bypass_event_show``, ``rte_pmd_ixgbe_bypass_wd_timeout_set``,
  70   ``rte_pmd_ixgbe_bypass_wd_timeout_show``, ``rte_pmd_ixgbe_bypass_ver_show``,
  71   ``rte_pmd_ixgbe_bypass_wd_reset``.
  72
  73 * The mbuf flags PKT_RX_VLAN_PKT and PKT_RX_QINQ_PKT are deprecated and
  74   are respectively replaced by PKT_RX_VLAN_STRIPPED and
  75   PKT_RX_QINQ_STRIPPED, that are better described. The old flags and
  76   their behavior will be kept until 17.02 and will be removed in 17.05.
  77
  78 * ethdev: Tx offloads will no longer be enabled by default in 17.08.
  79   Instead, the ``rte_eth_txmode`` structure will be extended with
  80   bit field to enable each Tx offload.
  81   Besides of making the Rx/Tx configuration API more consistent for the
  82   application, PMDs will be able to provide a better out of the box performance.
  83   As part of the work, ``ETH_TXQ_FLAGS_NO*`` will be superseded as well.
  84
  85 * ethdev: the legacy filter API, including
  86   ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
  87   as filter types MACVLAN, ETHERTYPE, FLEXIBLE, SYN, NTUPLE, TUNNEL, FDIR,
  88   HASH and L2_TUNNEL, is superseded by the generic flow API (rte_flow) in
  89   PMDs that implement the latter.
  90   Target release for removal of the legacy API will be defined once most
  91   PMDs have switched to rte_flow.
  92
  93 * crypto/scheduler: the following two functions are deprecated starting
  94   from 17.05 and will be removed in 17.08:
  95
  96   - ``rte_crpytodev_scheduler_mode_get``, replaced by ``rte_cryptodev_scheduler_mode_get``
  97   - ``rte_crpytodev_scheduler_mode_set``, replaced by ``rte_cryptodev_scheduler_mode_set``