X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Frel_notes%2Fdeprecation.rst;h=20aa745b7753fbb160a3247ef44a315c35c6bc74;hb=c0280d5d8ac047b9f56d21d17e2fd0961891072a;hp=cbb4c34efd13482640b2c8f0f0acd396847906c4;hpb=4f25d7d2252f57ce6e2358eaf3da36dcc195ebc1;p=dpdk.git diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index cbb4c34efd..20aa745b77 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -4,9 +4,9 @@ ABI and API Deprecation ======================= -See the :doc:`guidelines document for details of the ABI policy `. -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 ------------------- @@ -23,10 +23,6 @@ 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 @@ -38,22 +34,30 @@ Deprecation Notices + ``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: 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. - - ``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`` +* 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 + `_. + +* 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. * 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 @@ -61,21 +65,6 @@ Deprecation Notices 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. - * ethdev: the legacy filter API, including ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well as filter types MACVLAN, ETHERTYPE, FLEXIBLE, SYN, NTUPLE, TUNNEL, FDIR, @@ -88,43 +77,17 @@ Deprecation Notices negative errno values to indicate various error conditions (e.g. invalid port ID, unsupported operation, failed operation): - - ``rte_eth_promiscuous_enable`` and ``rte_eth_promiscuous_disable`` - - ``rte_eth_allmulticast_enable`` and ``rte_eth_allmulticast_disable`` - - ``rte_eth_link_get`` and ``rte_eth_link_get_nowait`` - ``rte_eth_dev_stop`` - ``rte_eth_dev_close`` - - ``rte_eth_xstats_reset`` - - ``rte_eth_macaddr_get`` - - ``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 @@ -144,3 +107,9 @@ Deprecation Notices 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.