+.. 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: 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.
-
- - removal of ``name`` and ``args`` fields.
- - The enum ``rte_devtype`` was used to identify a bus and will disappear.
- - The ``rte_devargs_list`` will be made private.
- - Functions previously deprecated will change or disappear:
-
- + ``rte_eal_devargs_add``
- + ``rte_eal_devargs_type_count``
- + ``rte_eal_parse_devargs_str``, replaced by ``rte_eal_devargs_parse``
- + ``rte_eal_devargs_parse`` will change its format and use.
- + all ``rte_devargs`` related functions will be renamed, changing the
- ``rte_eal_devargs_`` prefix to ``rte_devargs_``.
-
-* 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 semantics of the return value for the ``rte_lcore_has_role`` function
- are planned to change in v18.05. The function currently returns 0 and <0 for
- success and failure, respectively. This will change to 1 and 0 for true and
- false, respectively, to make use of the function more intuitive.
-
-* eal: new ``numa_node_count`` member will be added to ``rte_config`` structure
- in v18.05.
-
-* eal: due to internal data layout reorganization, there will be changes to
- several structures and functions as a result of coming changes to support
- memory hotplug in v18.05.
- ``rte_eal_get_physmem_layout`` will be deprecated and removed in subsequent
- releases.
- ``rte_mem_config`` contents will change due to switch to memseg lists.
- ``rte_memzone`` member ``memseg_id`` will no longer serve any useful purpose
- and will be removed.
-
-* 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:
-
- - ``rte_eal_mbuf_default_mempool_ops``
-
-* mempool: several API and ABI changes are planned in v18.05.
- The following functions, introduced for Xen, which is not supported
- anymore since v17.11, are hard to use, not used anywhere else in DPDK.
- Therefore they will be deprecated in v18.05 and removed in v18.08:
-
- - ``rte_mempool_xmem_create``
- - ``rte_mempool_xmem_size``
- - ``rte_mempool_xmem_usage``
-
- The following changes are planned:
-
- - removal of ``get_capabilities`` mempool ops and related flags.
- - substitute ``register_memory_area`` with ``populate`` ops.
- - addition of new ops to customize required memory chunk calculation,
- customize objects population and allocate contiguous
- block of objects if underlying driver supports it.
-
-* mbuf: The control mbuf API will be removed in v18.05. The impacted
- functions and macros are:
-
- - ``rte_ctrlmbuf_init()``
- - ``rte_ctrlmbuf_alloc()``
- - ``rte_ctrlmbuf_free()``
- - ``rte_ctrlmbuf_data()``
- - ``rte_ctrlmbuf_len()``
- - ``rte_is_ctrlmbuf()``
- - ``CTRL_MBUF_FLAG``
-
- The packet mbuf API should be used as a replacement.
-
-* 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 offloads API is target to be deprecated on 18.05. This includes:
-
- - 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.
+* 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.
+
+* kvargs: The function ``rte_kvargs_process`` will get a new parameter
+ for returning key match count. It will ease handling of no-match case.
+
+* 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 ``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.
+
+* rte_atomicNN_xxx: These APIs do not take memory order parameter. This does
+ not allow for writing optimized code for all the CPU architectures supported
+ in DPDK. DPDK will adopt C11 atomic operations semantics and provide wrappers
+ using C11 atomic built-ins. These wrappers must be used for patches that
+ need to be merged in 20.08 onwards. This change will not introduce any
+ performance degradation.
+
+* rte_smp_*mb: These APIs provide full barrier functionality. However, many
+ use cases do not require full barriers. To support such use cases, DPDK will
+ adopt C11 barrier semantics and provide wrappers using C11 atomic built-ins.
+ These wrappers must be used for patches that need to be merged in 20.08
+ onwards. This change will not introduce any performance degradation.
+
+* rte_cio_*mb: Since the IO barriers for ARMv8 platforms are relaxed from DSB
+ to DMB, rte_cio_*mb APIs provide the same functionality as rte_io_*mb
+ APIs (taking all platforms into consideration). rte_io_*mb APIs should be
+ used in the place of rte_cio_*mb APIs. The rte_cio_*mb APIs will be
+ deprecated in 20.11 release.
+
+* igb_uio: In the view of reducing the kernel dependency from the main tree,
+ as a first step, the Technical Board decided to move ``igb_uio``
+ kernel module to the dpdk-kmods repository in the /linux/igb_uio/ directory
+ in 20.11.
+ Minutes of Technical Board Meeting of `2019-11-06
+ <https://mails.dpdk.org/archives/dev/2019-November/151763.html>`_.
+
+* lib: will fix extending some enum/define breaking the ABI. There are multiple
+ samples in DPDK that enum/define terminated with a ``.*MAX.*`` value which is
+ used by iterators, and arrays holding these values are sized with this
+ ``.*MAX.*`` value. So extending this enum/define increases the ``.*MAX.*``
+ value which increases the size of the array and depending on how/where the
+ array is used this may break the ABI.
+ ``RTE_ETH_FLOW_MAX`` is one sample of the mentioned case, adding a new flow
+ type will break the ABI because of ``flex_mask[RTE_ETH_FLOW_MAX]`` array
+ usage in following public struct hierarchy:
+ ``rte_eth_fdir_flex_conf -> rte_fdir_conf -> rte_eth_conf (in the middle)``.
+ Need to identify this kind of usages and fix in 20.11, otherwise this blocks
+ us extending existing enum/define.
+ One solution can be using a fixed size array instead of ``.*MAX.*`` value.
+
+* ethdev: Split the ``struct eth_dev_ops`` struct to hide it as much as possible
+ will be done in 20.11.
+ Currently the ``struct eth_dev_ops`` struct is accessible by the application
+ because some inline functions, like ``rte_eth_tx_descriptor_status()``,
+ access the struct directly.
+ The struct will be separate in two, the ops used by inline functions will be
+ moved next to Rx/Tx burst functions, rest of the ``struct eth_dev_ops`` struct
+ will be moved to header file for drivers to hide it from applications.
* 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.
-* 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.
-
-* ethdev: Currently, if the rte_eth_rx_burst() function returns a value less
- than *nb_pkts*, the application will assume that no more packets are present.
- Some of the hw queue based hardware can only support smaller burst for RX
- and TX and thus break the expectation of the rx_burst API. Similar is the
- case for TX burst as well as ring sizes. ``rte_eth_dev_info`` will be added
- with following new parameters so as to support semantics for drivers to
- define a preferred size for Rx/Tx burst and rings.
-
- - Member ``struct preferred_size`` would be added to enclose all preferred
- size to be fetched from driver/implementation.
- - Members ``uint16_t rx_burst``, ``uint16_t tx_burst``, ``uint16_t rx_ring``,
- and ``uint16_t tx_ring`` would be added to ``struct preferred_size``.
-
-* 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.
-
-* ethdev: The prototype and the behavior of
- ``dev_ops->eth_mac_addr_set()`` will change in v18.05. A return code
- will be added to notify the caller if an error occurred in the PMD. In
- ``rte_eth_dev_default_mac_addr_set()``, the new default MAC address
- will be copied in ``dev->data->mac_addrs[0]`` only if the operation is
- successful. This modification will only impact the PMDs, not the
- applications.
-
-* ethdev: functions add rx/tx callback will return named opaque type
- ``rte_eth_add_rx_callback()``, ``rte_eth_add_first_rx_callback()`` and
- ``rte_eth_add_tx_callback()`` functions currently return callback object as
- ``void \*`` but APIs to delete callbacks get ``struct rte_eth_rxtx_callback \*``
- as parameter. For consistency functions adding callback will return
- ``struct rte_eth_rxtx_callback \*`` instead of ``void \*``.
-
-* ethdev: The size of variables ``flow_types_mask`` in
- ``rte_eth_fdir_info structure``, ``sym_hash_enable_mask`` and
- ``valid_bit_mask`` in ``rte_eth_hash_global_conf`` structure
- will be increased from 32 to 64 bits to fulfill hardware requirements.
- This change will break existing ABI as size of the structures will increase.
-
-* ethdev: ``rte_eth_dev_get_sec_ctx()`` fix port id storage
- ``rte_eth_dev_get_sec_ctx()`` is using ``uint8_t`` for ``port_id``,
- which should be ``uint16_t``.
-
-* 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.
-
-* ring: The alignment constraints on the ring structure will be relaxed
- to one cache line instead of two, and an empty cache line padding will
- be added between the producer and consumer structures. The size of the
- structure and the offset of the fields will remain the same on
- platforms with 64B cache line, but will change on other platforms.
+* 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.
+
+* ethdev: ``rx_descriptor_done`` dev_ops and ``rte_eth_rx_descriptor_done``
+ will be deprecated in 20.11 and will be removed in 21.11.
+ Existing ``rte_eth_rx_descriptor_status`` and ``rte_eth_tx_descriptor_status``
+ APIs can be used as replacement.
+
+* ethdev: Some internal APIs for driver usage are exported in the .map file.
+ Now DPDK has ``__rte_internal`` marker so we can mark internal APIs and move
+ them to the INTERNAL block in .map. Although these APIs are internal it will
+ break the ABI checks, that is why change is planned for 20.11.
+ The list of internal APIs are mainly ones listed in ``rte_ethdev_driver.h``.
+
+* traffic manager: All traffic manager API's in ``rte_tm.h`` were mistakenly made
+ ABI stable in the v19.11 release. The TM maintainer and other contributors have
+ agreed to keep the TM APIs as experimental in expectation of additional spec
+ improvements. Therefore, all APIs in ``rte_tm.h`` will be marked back as
+ experimental in v20.11 DPDK release. For more details, please see `the thread
+ <https://mails.dpdk.org/archives/dev/2020-April/164970.html>`_.
+
+* pmd_dpaa: The API ``rte_pmd_dpaa_set_tx_loopback`` will have extended
+ ``port_id`` definition from ``uint8_t`` to ``uint16_t``.
+
+* 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.
+
+* mbuf: ``refcnt_atomic`` member in structures ``rte_mbuf`` and
+ ``rte_mbuf_ext_shared_info`` is of type ``rte_atomic16_t``. Due to adoption
+ of C11 atomic builtins it will be of type ``uint16_t``. ``refcnt_atomic``
+ will be removed in 20.11. It will be replaced with ``refcnt`` of type
+ ``uint16_t``.
+
+* 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.
+
+* python: Since the beginning of 2020, Python 2 has officially reached
+ end-of-support: https://www.python.org/doc/sunset-python-2/.
+ Python 2 support will be completely removed in 20.11.
+ In 20.08, explicit deprecation warnings will be displayed when running
+ scripts with Python 2.
git.droids-corp.org / dpdk.git / blobdiff