Deprecation Notices
-------------------
-* eal: the following functions are deprecated starting from 17.05 and will
- be removed in 17.08:
+* eal: both declaring and identifying devices will be streamlined in v18.05.
+ New functions will appear to query a specific port from buses, classes of
+ device and device drivers. Device declaration will be made coherent with the
+ new scheme of device identification.
+ As such, ``rte_devargs`` device representation will change.
- - ``rte_set_log_level``, replaced by ``rte_log_set_global_level``
- - ``rte_get_log_level``, replaced by ``rte_log_get_global_level``
- - ``rte_set_log_type``, replaced by ``rte_log_set_level``
- - ``rte_get_log_type``, replaced by ``rte_log_get_level``
+ - removal of ``name`` and ``args`` fields.
+ - The enum ``rte_devtype`` was used to identify a bus and will disappear.
+ - Functions previously deprecated will change or disappear:
-* devargs: An ABI change is planned for 17.08 for the structure ``rte_devargs``.
- The current version is dependent on bus-specific device identifier, which will
- be made generic and abstracted, in order to make the EAL bus-agnostic.
+ + ``rte_eal_devargs_type_count``
+ + ``rte_eal_devargs_parse`` will change its format and use.
- Accompanying this evolution, device command line parameters will thus support
- explicit bus definition in a device declaration.
+* pci: Several exposed functions are misnamed.
+ The following functions are deprecated starting from v17.11 and are replaced:
-* igb_uio: iomem mapping and sysfs files created for iomem and ioport in
- igb_uio will be removed, because we are able to detect these from what Linux
- has exposed, like the way we have done with uio-pci-generic. This change
- targets release 17.05.
+ - ``eal_parse_pci_BDF`` replaced by ``rte_pci_addr_parse``
+ - ``eal_parse_pci_DomBDF`` replaced by ``rte_pci_addr_parse``
+ - ``rte_eal_compare_pci_addr`` replaced by ``rte_pci_addr_cmp``
-* The VDEV subsystem will be converted as driver of the new bus model.
- It may imply some EAL API changes in 17.08.
+* eal: a new set of mbuf mempool ops name APIs for user, platform and best
+ mempool names have been defined in ``rte_mbuf`` in v18.02. The uses of
+ ``rte_eal_mbuf_default_mempool_ops`` shall be replaced by
+ ``rte_mbuf_best_mempool_ops``.
+ The following function is now redundant and it is target to be deprecated
+ in 18.05:
-* The struct ``rte_pci_driver`` is planned to be removed from
- ``rte_cryptodev_driver`` and ``rte_eventdev_driver`` in 17.08.
+ - ``rte_eal_mbuf_default_mempool_ops``
-* The mbuf flags PKT_RX_VLAN_PKT and PKT_RX_QINQ_PKT are deprecated and
- are respectively replaced by PKT_RX_VLAN_STRIPPED and
- PKT_RX_QINQ_STRIPPED, that are better described. The old flags and
- their behavior will be kept until 17.05 and will be removed in 17.08.
+* mempool: several API and ABI changes are planned in v18.05.
-* ethdev: Tx offloads will no longer be enabled by default in 17.08.
- Instead, the ``rte_eth_txmode`` structure will be extended with
- bit field to enable each Tx offload.
- Besides of making the Rx/Tx configuration API more consistent for the
- application, PMDs will be able to provide a better out of the box performance.
- As part of the work, ``ETH_TXQ_FLAGS_NO*`` will be superseded as well.
+ The following changes are planned:
+
+ - addition of new op to allocate contiguous
+ block of objects if underlying driver supports it.
+
+* mbuf: The opaque ``mbuf->hash.sched`` field will be updated to support generic
+ definition in line with the ethdev TM and MTR APIs. Currently, this field
+ is defined in librte_sched in a non-generic way. The new generic format
+ will contain: queue ID, traffic class, color. Field size will not change.
+
+* ethdev: a new Tx and Rx offload API was introduced on 17.11.
+ In the new API, offloads are divided into per-port and per-queue offloads.
+ Offloads are disabled by default and enabled per application request.
+
+ The old ethdev - drivers offload interface will be deprecated on 18.05.
+ This includes:
+ - removal of the conversion in ethdev from new offloading API to old API for drivers.
+
+ In later releases the old offloading API will be deprecated, which will include:
+ - removal of ``ETH_TXQ_FLAGS_NO*`` flags.
+ - removal of ``txq_flags`` field from ``rte_eth_txconf`` struct.
+ - removal of the offloads bit-field from ``rte_eth_rxmode`` struct.
* ethdev: the legacy filter API, including
``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
Target release for removal of the legacy API will be defined once most
PMDs have switched to rte_flow.
-* cryptodev: API changes are planned for 17.08 for the sessions management
- to make it agnostic to the underlying devices, removing coupling with
- crypto PMDs, so a single session can be used on multiple devices.
-
- An API of followed functions will be changed to allow operate on multiple
- devices with one session:
+* ethdev: A new rss level field planned in 18.05.
+ The new API add rss_level field to ``rte_eth_rss_conf`` to enable a choice
+ of RSS hash calculation on outer or inner header of tunneled packet.
- - ``rte_cryptodev_sym_session_create``
- - ``rte_cryptodev_sym_session_free``
- - ``rte_cryptodev_sym_session_pool_create``
+* ethdev: A work is being planned for 18.05 to expose VF port representors
+ as a mean to perform control and data path operation on the different VFs.
+ As VF representor is an ethdev port, new fields are needed in order to map
+ between the VF representor and the VF or the parent PF. Those new fields
+ are to be included in ``rte_eth_dev_info`` struct.
- While dev_id will not be stored in the ``struct rte_cryptodev_sym_session``,
- directly, the change of followed API is required:
+* i40e: The default flexible payload configuration which extracts the first 16
+ bytes of the payload for RSS will be deprecated starting from 18.02. If
+ required the previous behavior can be configured using existing flow
+ director APIs. There is no ABI/API break. This change will just remove a
+ global configuration setting and require explicit configuration.
- - ``rte_cryptodev_queue_pair_attach_sym_session``
- - ``rte_cryptodev_queue_pair_detach_sym_session``
+* pdump: As we changed to use generic IPC, some changes in APIs and structure
+ are expected in subsequent release.
-* librte_table: The ``key_mask`` parameter will be added to all the hash tables
- that currently do not have it, as well as to the hash compute function prototype.
- The non-"do-sig" versions of the hash tables will be removed
- (including the ``signature_offset`` parameter)
- and the "do-sig" versions renamed accordingly.
+ - ``rte_pdump_set_socket_dir`` will be removed;
+ - The parameter, ``path``, of ``rte_pdump_init`` will be removed;
+ - The enum ``rte_pdump_socktype`` will be removed.