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 function ``rte_eal_remote_launch`` will return new error codes
after read or write error on the pipe, instead of calling ``rte_panic``.
-* eal: The ``lcore_config`` 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.
-
* 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
+ ``rte_eal_devargs_type_count``
-* eal: The ``rte_cpu_check_supported`` function has been deprecated since
- v17.08 and will be removed.
-
-* eal: The ``rte_malloc_virt2phy`` function has been deprecated and replaced
- by ``rte_malloc_virt2iova`` since v17.11 and will be removed.
-
-* vfio: removal of ``rte_vfio_dma_map`` and ``rte_vfio_dma_unmap`` APIs which
- have been replaced with ``rte_dev_dma_map`` and ``rte_dev_dma_unmap``
- functions. The due date for the removal targets DPDK 20.02.
-
-* pci: Several exposed functions are misnamed.
- The following functions are deprecated starting from v17.11 and are replaced:
-
- - ``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``
+* 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.
* 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
structure would be made internal (or removed if all dependencies are cleared)
in future releases.
-* net: The Ethernet address and header definitions will change
- attributes. The Ethernet address struct will no longer be marked as
- packed since the packed attribute is meaningless on a byte
- array. The Ethernet header will be marked as aligned on a 2-byte
- boundary and will no longer have the packed attribute. This allows
- for efficient access on CPU architectures where unaligned access is
- expensive. These changes should not impact normal usage because drivers
- naturally align the Ethernet header on receive and all known
- encapsulations preserve the alignment of the header.
-
-* ethdev: The function ``rte_eth_dev_count`` will be removed in DPDK 20.02.
- It is replaced by the function ``rte_eth_dev_count_avail``.
- If the intent is to iterate over ports, ``RTE_ETH_FOREACH_*`` macros
- are better port iterators.
+* 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
negative errno values to indicate various error conditions (e.g.
invalid port ID, unsupported operation, failed operation):
- - ``rte_eth_allmulticast_enable`` and ``rte_eth_allmulticast_disable``
- ``rte_eth_dev_stop``
- ``rte_eth_dev_close``
- - ``rte_eth_dev_owner_delete``
-* ethdev: New offload flags ``DEV_RX_OFFLOAD_RSS_HASH`` and
- ``DEV_RX_OFFLOAD_FLOW_MARK`` will be added in 19.11.
+* 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::rss`` and ``rte_mbuf::hash::fdir`` respectively.
+ ``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 fields even when the offloads are not
+ In 19.11 PMDs will still update the field even when the offload is not
enabled.
-* ethdev: New function ``rte_eth_dev_set_supported_ptypes`` will be added in
- 19.11.
- This will allow application to request PMD to set specific ptypes defined
- through ``rte_eth_dev_set_supported_ptypes`` in ``rte_mbuf::packet_type``.
- If application doesn't want any ptype information it can call
- ``rte_eth_dev_set_supported_ptypes(ethdev_id, RTE_PTYPE_UNKNOWN)`` and PMD
- will set ``rte_mbuf::packet_type`` to ``0``.
- If application doesn't call ``rte_eth_dev_set_supported_ptypes`` PMD can
- return ``rte_mbuf::packet_type`` with ``rte_eth_dev_get_supported_ptypes``.
- If application is interested only in L2/L3 layer, it can inform the PMD
- to update ``rte_mbuf::packet_type`` with L2/L3 ptype by calling
- ``rte_eth_dev_set_supported_ptypes(ethdev_id, RTE_PTYPE_L2_MASK | RTE_PTYPE_L3_MASK)``.
- This scheme will allow PMDs to avoid lookup to internal ptype table on Rx and
- thereby improve Rx performance if application wishes do so.
-
-* ethdev: New 32-bit fields may be added for maximum LRO session size, in
- struct ``rte_eth_dev_info`` for the port capability and in struct
- ``rte_eth_rxmode`` for the port configuration.
-
* 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
git.droids-corp.org / dpdk.git / blobdiff