X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Frel_notes%2Fdeprecation.rst;h=237813b6472c67d967601ee3a834f7620677d9ae;hb=a6a752402dfce8695c258a27da97d5a6d187c49b;hp=67324a2a9c52f7967a56c26b6e60e1462169ad95;hpb=2ee10c8a56296ad1441b81be5ab35e2de1f65aea;p=dpdk.git diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index 67324a2a9c..237813b647 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -1,3 +1,6 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright 2018 The DPDK contributors + ABI and API Deprecation ======================= @@ -8,72 +11,70 @@ 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`` +* 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. -* 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. +* kvargs: The function ``rte_kvargs_process`` will get a new parameter + for returning key match count. It will ease handling of no-match case. - Accompanying this evolution, device command line parameters will thus support - explicit bus definition in a device declaration. +* 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``. -* 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. +* 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. -* 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. +* 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. -* The VDEV subsystem will be converted as driver of the new bus model. - It will imply some EAL API changes in 17.05. + - The enum ``rte_devtype`` was used to identify a bus and will disappear. + - Functions previously deprecated will change or disappear: -* ``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. + + ``rte_eal_devargs_type_count`` -* 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. +* eal: The ``rte_cpu_check_supported`` function has been deprecated since + v17.08 and will be removed. -* ethdev: for 17.05 it is planned to deprecate the following nine rte_eth_dev_* - functions and move them into the ixgbe PMD: +* eal: The ``rte_malloc_virt2phy`` function has been deprecated and replaced + by ``rte_malloc_virt2iova`` since v17.11 and will be removed. - ``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``. +* 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. - The following fields will be removed from ``struct eth_dev_ops``: +* pci: Several exposed functions are misnamed. + The following functions are deprecated starting from v17.11 and are replaced: - ``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_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`` - 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``. +* 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. -* 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. +* 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. * ethdev: the legacy filter API, including ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well @@ -83,8 +84,57 @@ Deprecation Notices Target release for removal of the legacy API will be defined once most PMDs have switched to rte_flow. -* 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_RSS_HASH`` and + ``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. + 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 + 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 + 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.