1.. SPDX-License-Identifier: BSD-3-Clause 2 Copyright 2018 The DPDK contributors 3 4ABI and API Deprecation 5======================= 6 7See the guidelines document for details of the :doc:`ABI policy 8<../contributing/abi_policy>`. API and ABI deprecation notices are to be posted 9here. 10 11Deprecation Notices 12------------------- 13 14* meson: The minimum supported version of meson for configuring and building 15 DPDK will be increased to v0.47.1 (from 0.41) from DPDK 19.05 onwards. For 16 those users with a version earlier than 0.47.1, an updated copy of meson 17 can be got using the ``pip``, or ``pip3``, tool for downloading python 18 packages. 19 20* kvargs: The function ``rte_kvargs_process`` will get a new parameter 21 for returning key match count. It will ease handling of no-match case. 22 23* eal: The function ``rte_eal_remote_launch`` will return new error codes 24 after read or write error on the pipe, instead of calling ``rte_panic``. 25 26* eal: both declaring and identifying devices will be streamlined in v18.11. 27 New functions will appear to query a specific port from buses, classes of 28 device and device drivers. Device declaration will be made coherent with the 29 new scheme of device identification. 30 As such, ``rte_devargs`` device representation will change. 31 32 - The enum ``rte_devtype`` was used to identify a bus and will disappear. 33 - Functions previously deprecated will change or disappear: 34 35 + ``rte_eal_devargs_type_count`` 36 37* eal: The ``rte_logs`` struct and global symbol will be made private to 38 remove it from the externally visible ABI and allow it to be updated in the 39 future. 40 41* dpaa2: removal of ``rte_dpaa2_memsegs`` structure which has been replaced 42 by a pa-va search library. This structure was earlier being used for holding 43 memory segments used by dpaa2 driver for faster pa->va translation. This 44 structure would be made internal (or removed if all dependencies are cleared) 45 in future releases. 46 47* ethdev: the legacy filter API, including 48 ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well 49 as filter types MACVLAN, ETHERTYPE, FLEXIBLE, SYN, NTUPLE, TUNNEL, FDIR, 50 HASH and L2_TUNNEL, is superseded by the generic flow API (rte_flow) in 51 PMDs that implement the latter. 52 Target release for removal of the legacy API will be defined once most 53 PMDs have switched to rte_flow. 54 55* ethdev: Update API functions returning ``void`` to return ``int`` with 56 negative errno values to indicate various error conditions (e.g. 57 invalid port ID, unsupported operation, failed operation): 58 59 - ``rte_eth_dev_stop`` 60 - ``rte_eth_dev_close`` 61 62* ethdev: New offload flags ``DEV_RX_OFFLOAD_RSS_HASH`` and 63 ``DEV_RX_OFFLOAD_FLOW_MARK`` will be added in 19.11. 64 This will allow application to enable or disable PMDs from updating 65 ``rte_mbuf::hash::rss`` and ``rte_mbuf::hash::fdir`` respectively. 66 This scheme will allow PMDs to avoid writes to ``rte_mbuf`` fields on Rx and 67 thereby improve Rx performance if application wishes do so. 68 In 19.11 PMDs will still update the fields even when the offloads are not 69 enabled. 70 71* ethdev: New function ``rte_eth_dev_set_supported_ptypes`` will be added in 72 19.11. 73 This will allow application to request PMD to set specific ptypes defined 74 through ``rte_eth_dev_set_supported_ptypes`` in ``rte_mbuf::packet_type``. 75 If application doesn't want any ptype information it can call 76 ``rte_eth_dev_set_supported_ptypes(ethdev_id, RTE_PTYPE_UNKNOWN)`` and PMD 77 will set ``rte_mbuf::packet_type`` to ``0``. 78 If application doesn't call ``rte_eth_dev_set_supported_ptypes`` PMD can 79 return ``rte_mbuf::packet_type`` with ``rte_eth_dev_get_supported_ptypes``. 80 If application is interested only in L2/L3 layer, it can inform the PMD 81 to update ``rte_mbuf::packet_type`` with L2/L3 ptype by calling 82 ``rte_eth_dev_set_supported_ptypes(ethdev_id, RTE_PTYPE_L2_MASK | RTE_PTYPE_L3_MASK)``. 83 This scheme will allow PMDs to avoid lookup to internal ptype table on Rx and 84 thereby improve Rx performance if application wishes do so. 85 86* cryptodev: support for using IV with all sizes is added, J0 still can 87 be used but only when IV length in following structs ``rte_crypto_auth_xform``, 88 ``rte_crypto_aead_xform`` is set to zero. When IV length is greater or equal 89 to one it means it represents IV, when is set to zero it means J0 is used 90 directly, in this case 16 bytes of J0 need to be passed. 91 92* sched: To allow more traffic classes, flexible mapping of pipe queues to 93 traffic classes, and subport level configuration of pipes and queues 94 changes will be made to macros, data structures and API functions defined 95 in "rte_sched.h". These changes are aligned to improvements suggested in the 96 RFC https://mails.dpdk.org/archives/dev/2018-November/120035.html. 97 98* metrics: The function ``rte_metrics_init`` will have a non-void return 99 in order to notify errors instead of calling ``rte_exit``. 100 101* power: ``rte_power_set_env`` function will no longer return 0 on attempt 102 to set new power environment if power environment was already initialized. 103 In this case the function will return -1 unless the environment is unset first 104 (using ``rte_power_unset_env``). Other function usage scenarios will not change. 105