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 * mempool: The following will be modified in 17.11:
  48
  49   - ``rte_mempool_xmem_size`` and ``rte_mempool_xmem_usage`` need to know
  50     the mempool flag status so adding new param rte_mempool in those API.
  51   - Removing __rte_unused int flag param from ``rte_mempool_generic_put``
  52     and ``rte_mempool_generic_get`` API.
  53   - ``rte_mempool`` flags data type will changed from int to
  54     unsigned int.
  55
  56 * ethdev: Tx offloads will no longer be enabled by default in 17.11.
  57   Instead, the ``rte_eth_txmode`` structure will be extended with
  58   bit field to enable each Tx offload.
  59   Besides of making the Rx/Tx configuration API more consistent for the
  60   application, PMDs will be able to provide a better out of the box performance.
  61   As part of the work, ``ETH_TXQ_FLAGS_NO*`` will be superseded as well.
  62
  63 * ethdev: the legacy filter API, including
  64   ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
  65   as filter types MACVLAN, ETHERTYPE, FLEXIBLE, SYN, NTUPLE, TUNNEL, FDIR,
  66   HASH and L2_TUNNEL, is superseded by the generic flow API (rte_flow) in
  67   PMDs that implement the latter.
  68   Target release for removal of the legacy API will be defined once most
  69   PMDs have switched to rte_flow.
  70
  71 * ethdev: The device flag advertizing hotplug capability
  72   ``RTE_ETH_DEV_DETACHABLE`` is not needed anymore and will be removed in
  73   v17.11.
  74   This capability is verified upon calling the relevant hotplug functions in EAL
  75   by checking that the ``unplug`` ops is set in the bus. This verification is
  76   done by the EAL and not by the ``ethdev`` layer anymore. Users relying on this
  77   flag being present only have to remove their checks to follow the change.
  78
  79 * ABI/API changes are planned for 17.11 in all structures which include port_id
  80   definition such as "rte_eth_dev_data", "rte_port_ethdev_reader_params",
  81   "rte_port_ethdev_writer_params", and so on. The definition of port_id will be
  82   changed from 8 bits to 16 bits in order to support more than 256 ports in
  83   DPDK. All APIs which have port_id parameter will be changed at the same time.
  84
  85 * ethdev: An ABI change is planned for 17.11 for the structure rte_eth_dev_data.
  86   The size of the unique name will increase RTE_ETH_NAME_MAX_LEN from 32 to
  87   64 characters to allow using a globally unique identifier (GUID) in this field.
  88
  89 * ethdev: new parameters - ``rte_security_capabilities`` and
  90   ``rte_security_ops`` will be added to ``rte_eth_dev_info`` and
  91   ``rte_eth_dev`` respectively  to support security operations like
  92   ipsec inline.
  93
  94 * cryptodev: new parameters - ``rte_security_capabilities`` and
  95   ``rte_security_ops`` will be added to ``rte_cryptodev_info`` and
  96   ``rte_cryptodev`` respectively to support security protocol offloaded
  97   operations.
  98
  99 * cryptodev: the following function is deprecated starting from 17.08 and will
 100   be removed in 17.11:
 101
 102   - ``rte_cryptodev_create_vdev``
 103
 104 * cryptodev: the following function will be static in 17.11 and included
 105   by all crypto drivers, therefore, will not be public:
 106
 107   - ``rte_cryptodev_vdev_pmd_init``
 108
 109 * cryptodev: the following function will have an extra parameter, passing a
 110   statically allocated crypto driver structure, instead of calling malloc,
 111   in 17.11:
 112
 113   - ``rte_cryptodev_allocate_driver``
 114
 115 * librte_meter: The API will change to accommodate configuration profiles.
 116   Most of the API functions will have an additional opaque parameter.
 117
 118 * librte_table: The ``key_mask`` parameter will be added to all the hash tables
 119   that currently do not have it, as well as to the hash compute function prototype.
 120   The non-"do-sig" versions of the hash tables will be removed
 121   (including the ``signature_offset`` parameter)
 122   and the "do-sig" versions renamed accordingly.