Deprecation Notices
-------------------
-* ring: Changes are planned to rte_ring APIs in release 17.05. Proposed
- changes include:
-
- - Removing build time options for the ring:
- CONFIG_RTE_RING_SPLIT_PROD_CONS
- CONFIG_RTE_RING_PAUSE_REP_COUNT
- - Adding an additional parameter to enqueue functions to return the
- amount of free space in the ring
- - Adding an additional parameter to dequeue functions to return the
- number of remaining elements in the ring
- - Removing direct support for watermarks in the rings, since the
- additional return value from the enqueue function makes it
- unneeded
- - Adjusting the return values of the bulk() enq/deq functions to
- make them consistent with the burst() equivalents. [Note, parameter
- to these functions are changing too, per points above, so compiler
- will flag them as needing update in legacy code]
- - Updates to some library functions e.g. rte_ring_get_memsize() to
- allow for variably-sized ring elements.
-
-* 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.
-
-* vfio: Some functions are planned to be exported outside librte_eal in 17.05.
- VFIO APIs like ``vfio_setup_device``, ``vfio_get_group_fd`` can be used by
- subsystem other than EAL/PCI. For that, these need to be exported symbols.
- Such APIs are planned to be renamed according to ``rte_*`` naming convention
- and exported from librte_eal.
-
-* The PCI and VDEV subsystems will be converted as drivers of the new bus model.
- It will imply some EAL API changes in 17.05.
-
-* ``eth_driver`` is planned to be removed in 17.05. This currently serves as
- a placeholder for PMDs to register themselves. Changes for ``rte_bus`` will
- provide a way to handle device initialization currently being done in
- ``eth_driver``. Similarly, ``rte_pci_driver`` is planned to be removed from
- ``rte_cryptodev_driver`` in 17.05.
-
-* ethdev: An API change is planned for 17.05 for the function
- ``_rte_eth_dev_callback_process``. In 17.05 the function will return an ``int``
- instead of ``void`` and a fourth parameter ``void *ret_param`` will be added.
-
-* ethdev: for 17.05 it is planned to deprecate the following nine rte_eth_dev_*
- functions and move them into the ixgbe PMD:
-
- ``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 following fields will be removed from ``struct eth_dev_ops``:
-
- ``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``.
-
- The functions will be renamed to the following, and moved to the ``ixgbe`` PMD:
-
- ``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``.
-
-* ABI changes are planned for 17.05 in the ``rte_mbuf`` structure: some fields
- may be reordered to facilitate the writing of ``data_off``, ``refcnt``, and
- ``nb_segs`` in one operation, because some platforms have an overhead if the
- store address is not naturally aligned. Other mbuf fields, such as the
- ``port`` field, may be moved or removed as part of this mbuf work. A
- ``timestamp`` will also be added.
+* eal: the following functions are deprecated starting from 17.05 and will
+ be removed in 17.11:
+
+ - ``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``
+
+* eal: several API and ABI changes are planned for ``rte_devargs`` in v17.11.
+ The format of device command line parameters will change. The bus will need
+ to be explicitly stated in the device declaration. The enum ``rte_devtype``
+ was used to identify a bus and will disappear.
+ The structure ``rte_devargs`` will change.
+ The ``rte_devargs_list`` will be made private.
+ The following functions are deprecated starting from 17.08 and will either be
+ modified or removed in 17.11:
+
+ - ``rte_eal_devargs_add``
+ - ``rte_eal_devargs_type_count``
+ - ``rte_eal_parse_devargs_str``, replaced by ``rte_eal_devargs_parse``
+
+* eal: the support of Xen dom0 will be removed from EAL in 17.11; and with
+ that, drivers/net/xenvirt and examples/vhost_xen will also be removed.
+
+* eal: An ABI change is planned for 17.11 to make DPDK aware of IOVA address
+ translation scheme.
+ Reference to phys address in EAL data-structure or functions may change to
+ IOVA address or more appropriate name.
+ The change will be only for the name.
+ Functional aspects of the API or data-structure will remain same.
* 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.02 and will be removed in 17.05.
+ their behavior will be kept until 17.08 and will be removed in 17.11.
-* mempool: The functions ``rte_mempool_count`` and ``rte_mempool_free_count``
- will be removed in 17.05.
- They are replaced by ``rte_mempool_avail_count`` and
- ``rte_mempool_in_use_count`` respectively.
+* mempool: The following will be modified in 17.11:
-* mempool: The functions for single/multi producer/consumer are deprecated
- and will be removed in 17.05.
- It is replaced by ``rte_mempool_generic_get/put`` functions.
+ - ``rte_mempool_xmem_size`` and ``rte_mempool_xmem_usage`` need to know
+ the mempool flag status so adding new param rte_mempool in those API.
+ - Removing __rte_unused int flag param from ``rte_mempool_generic_put``
+ and ``rte_mempool_generic_get`` API.
+ - ``rte_mempool`` flags data type will changed from int to
+ unsigned int.
+
+* ethdev: Tx offloads will no longer be enabled by default in 17.11.
+ 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.
* 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.
-* distributor: library API will be changed to incorporate a burst-oriented
- API. This will include a change to ``rte_distributor_create``
- to specify which type of instance to create (single or burst), and
- additional calls for ``rte_distributor_poll_pkt_burst`` and
- ``rte_distributor_return_pkt_burst``, among others.
-
-* The architecture TILE-Gx and the associated mpipe driver are not
- maintained and will be removed in 17.05.
+* ethdev: The device flag advertizing hotplug capability
+ ``RTE_ETH_DEV_DETACHABLE`` is not needed anymore and will be removed in
+ v17.11.
+ This capability is verified upon calling the relevant hotplug functions in EAL
+ by checking that the ``unplug`` ops is set in the bus. This verification is
+ done by the EAL and not by the ``ethdev`` layer anymore. Users relying on this
+ flag being present only have to remove their checks to follow the change.
+
+* ABI/API changes are planned for 17.11 in all structures which include port_id
+ definition such as "rte_eth_dev_data", "rte_port_ethdev_reader_params",
+ "rte_port_ethdev_writer_params", and so on. The definition of port_id will be
+ changed from 8 bits to 16 bits in order to support more than 256 ports in
+ DPDK. All APIs which have port_id parameter will be changed at the same time.
+
+* ethdev: An ABI change is planned for 17.11 for the structure rte_eth_dev_data.
+ The size of the unique name will increase RTE_ETH_NAME_MAX_LEN from 32 to
+ 64 characters to allow using a globally unique identifier (GUID) in this field.
+
+* ethdev: new parameters - ``rte_security_capabilities`` and
+ ``rte_security_ops`` will be added to ``rte_eth_dev_info`` and
+ ``rte_eth_dev`` respectively to support security operations like
+ ipsec inline.
+
+* cryptodev: new parameters - ``rte_security_capabilities`` and
+ ``rte_security_ops`` will be added to ``rte_cryptodev_info`` and
+ ``rte_cryptodev`` respectively to support security protocol offloaded
+ operations.
+
+* cryptodev: the following function is deprecated starting from 17.08 and will
+ be removed in 17.11:
+
+ - ``rte_cryptodev_create_vdev``
+
+* cryptodev: the following function will be static in 17.11 and included
+ by all crypto drivers, therefore, will not be public:
+
+ - ``rte_cryptodev_vdev_pmd_init``
+
+* 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.
git.droids-corp.org / dpdk.git / blobdiff