+.. SPDX-License-Identifier: BSD-3-Clause
+ Copyright 2018 The DPDK contributors
+
ABI and API Deprecation
=======================
-See the :doc:`guidelines document for details of the ABI policy </contributing/versioning>`.
-API and ABI deprecation notices are to be posted here.
-
+See the guidelines document for details of the :doc:`ABI policy
+<../contributing/abi_policy>`. API and ABI deprecation notices are to be posted
+here.
Deprecation Notices
-------------------
-* eal: the following functions are deprecated starting from 17.05 and will
- be removed in 17.08:
-
- - ``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``
-
-* 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.
-
- Accompanying this evolution, device command line parameters will thus support
- explicit bus definition in a device declaration.
-
-* 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.
-
-* The VDEV subsystem will be converted as driver of the new bus model.
- It may imply some EAL API changes in 17.08.
+* meson: The minimum supported version of meson for configuring and building
+ DPDK will be increased to v0.47.1 (from 0.41) from DPDK 19.05 onwards. For
+ those users with a version earlier than 0.47.1, an updated copy of meson
+ can be got using the ``pip``, or ``pip3``, tool for downloading python
+ packages.
-* The struct ``rte_pci_driver`` is planned to be removed from
- ``rte_cryptodev_driver`` and ``rte_eventdev_driver`` in 17.08.
+* kvargs: The function ``rte_kvargs_process`` will get a new parameter
+ for returning key match count. It will ease handling of no-match case.
-* ethdev: An API change is planned for 17.08 for the function
- ``_rte_eth_dev_callback_process``. In 17.08 the function will return an ``int``
- instead of ``void`` and a fourth parameter ``void *ret_param`` will be added.
+* eal: The function ``rte_eal_remote_launch`` will return new error codes
+ after read or write error on the pipe, instead of calling ``rte_panic``.
-* ethdev: for 17.08 it is planned to deprecate the following nine rte_eth_dev_*
- functions and move them into the ixgbe PMD:
+* eal: both declaring and identifying devices will be streamlined in v18.11.
+ 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_eth_dev_bypass_init``, ``rte_eth_dev_bypass_state_set``,
- ``rte_eth_dev_bypass_state_show``, ``rte_eth_dev_bypass_event_store``,
- ``rte_eth_dev_bypass_event_show``, ``rte_eth_dev_wd_timeout_store``,
- ``rte_eth_dev_bypass_wd_timeout_show``, ``rte_eth_dev_bypass_ver_show``,
- ``rte_eth_dev_bypass_wd_reset``.
+ - The enum ``rte_devtype`` was used to identify a bus and will disappear.
+ - Functions previously deprecated will change or disappear:
- The following fields will be removed from ``struct eth_dev_ops``:
+ + ``rte_eal_devargs_type_count``
- ``bypass_init_t``, ``bypass_state_set_t``, ``bypass_state_show_t``,
- ``bypass_event_set_t``, ``bypass_event_show_t``, ``bypass_wd_timeout_set_t``,
- ``bypass_wd_timeout_show_t``, ``bypass_ver_show_t``, ``bypass_wd_reset_t``.
+* eal: The ``rte_logs`` struct and global symbol will be made private to
+ remove it from the externally visible ABI and allow it to be updated in the
+ future.
- The functions will be renamed to the following, and moved to the ``ixgbe`` PMD:
+* dpaa2: removal of ``rte_dpaa2_memsegs`` structure which has been replaced
+ by a pa-va search library. This structure was earlier being used for holding
+ memory segments used by dpaa2 driver for faster pa->va translation. This
+ structure would be made internal (or removed if all dependencies are cleared)
+ in future releases.
- ``rte_pmd_ixgbe_bypass_init``, ``rte_pmd_ixgbe_bypass_state_set``,
- ``rte_pmd_ixgbe_bypass_state_show``, ``rte_pmd_ixgbe_bypass_event_set``,
- ``rte_pmd_ixgbe_bypass_event_show``, ``rte_pmd_ixgbe_bypass_wd_timeout_set``,
- ``rte_pmd_ixgbe_bypass_wd_timeout_show``, ``rte_pmd_ixgbe_bypass_ver_show``,
- ``rte_pmd_ixgbe_bypass_wd_reset``.
-
-* 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.
-
-* 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.
+* mempool: starting from v20.05, the API of rte_mempool_populate_iova()
+ and rte_mempool_populate_virt() will change to return 0 instead
+ of -EINVAL when there is not enough room to store one object. The ABI
+ will be preserved until 20.11.
* 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: All PMD names definitions will be moved to the individual PMDs
- in 17.08.
-
-* cryptodev: The following changes will be done in in 17.08:
-
- - the device type enumeration ``rte_cryptodev_type`` will be removed
- - the following structures will be changed: ``rte_cryptodev_session``,
- ``rte_cryptodev_sym_session``, ``rte_cryptodev_info``, ``rte_cryptodev``
- - the function ``rte_cryptodev_count_devtype`` will be replaced by
- ``rte_cryptodev_device_count_by_driver``
-
-* crypto/scheduler: the following two functions are deprecated starting
- from 17.05 and will be removed in 17.08:
-
- - ``rte_crpytodev_scheduler_mode_get``, replaced by ``rte_cryptodev_scheduler_mode_get``
- - ``rte_crpytodev_scheduler_mode_set``, replaced by ``rte_cryptodev_scheduler_mode_set``
+* ethdev: Update API functions returning ``void`` to return ``int`` with
+ negative errno values to indicate various error conditions (e.g.
+ invalid port ID, unsupported operation, failed operation):
+
+ - ``rte_eth_dev_stop``
+ - ``rte_eth_dev_close``
+
+* ethdev: New offload flags ``DEV_RX_OFFLOAD_FLOW_MARK`` will be added in 19.11.
+ This will allow application to enable or disable PMDs from updating
+ ``rte_mbuf::hash::fdir``.
+ This scheme will allow PMDs to avoid writes to ``rte_mbuf`` fields on Rx and
+ thereby improve Rx performance if application wishes do so.
+ In 19.11 PMDs will still update the field even when the offload is not
+ enabled.
+
+* cryptodev: support for using IV with all sizes is added, J0 still can
+ be used but only when IV length in following structs ``rte_crypto_auth_xform``,
+ ``rte_crypto_aead_xform`` is set to zero. When IV length is greater or equal
+ to one it means it represents IV, when is set to zero it means J0 is used
+ directly, in this case 16 bytes of J0 need to be passed.
+
+* sched: To allow more traffic classes, flexible mapping of pipe queues to
+ traffic classes, and subport level configuration of pipes and queues
+ changes will be made to macros, data structures and API functions defined
+ in "rte_sched.h". These changes are aligned to improvements suggested in the
+ RFC https://mails.dpdk.org/archives/dev/2018-November/120035.html.
+
+* metrics: The function ``rte_metrics_init`` will have a non-void return
+ in order to notify errors instead of calling ``rte_exit``.
+
+* power: ``rte_power_set_env`` function will no longer return 0 on attempt
+ to set new power environment if power environment was already initialized.
+ In this case the function will return -1 unless the environment is unset first
+ (using ``rte_power_unset_env``). Other function usage scenarios will not change.
git.droids-corp.org / dpdk.git / blobdiff