X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Frel_notes%2Fdeprecation.rst;h=d1034f60fdb8f5d629e4d7bd67ea3db68bdecfc7;hb=9311beeea4963d8b97330c20ff1736b006486c5d;hp=b48486d36d2a82f4be1b83830648c6c72ee29309;hpb=865cd191162ae1e4281ce5ebbf2992becd6ff42b;p=dpdk.git diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index b48486d36d..d1034f60fd 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -4,67 +4,71 @@ 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 ------------------- -* linux: Linux kernel version 3.2 (which is the current minimum required - version for the DPDK) is not maintained anymore. Therefore the planned - minimum required kernel version for DPDK 19.02 will be the next oldest - Long Term Stable (LTS) version which is 3.16, but compatibility for - recent distribution kernels will be kept. +* 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: function ``rte_bsf64`` in ``rte_bitmap.h`` has been renamed to - ``rte_bsf64_safe`` and moved to ``rte_common.h``. A new ``rte_bsf64`` function - will be added in the next release in ``rte_common.h`` that follows convention - set by existing ``rte_bsf32`` function. - -* 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 enum ``rte_devtype`` was used to identify a bus and will disappear. - - Functions previously deprecated will change or disappear: - - + ``rte_eal_devargs_type_count`` - -* 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`` - -* 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. - -* 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. - -* sched: Some API functions will change prototype due to the above - deprecation note for mbuf->hash.sched, e.g. ``rte_sched_port_pkt_write()`` - and ``rte_sched_port_pkt_read()`` will likely have an additional parameter - of type ``struct rte_sched_port``. - -* mbuf: the macro ``RTE_MBUF_INDIRECT()`` will be removed in v18.08 or later and - replaced with ``RTE_MBUF_CLONED()`` which is already added in v18.05. As - ``EXT_ATTACHED_MBUF`` is newly introduced in v18.05, ``RTE_MBUF_INDIRECT()`` - can no longer be mutually exclusive with ``RTE_MBUF_DIRECT()`` if the new - experimental API ``rte_pktmbuf_attach_extbuf()`` is used. Removal of the macro - is to fix this semantic inconsistency. +* 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. + +* 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. + +* 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 @@ -74,34 +78,55 @@ Deprecation Notices Target release for removal of the legacy API will be defined once most PMDs have switched to rte_flow. -* ethdev: Maximum and minimum MTU values vary between hardware devices. In - hardware agnostic DPDK applications access to such information would allow - a more accurate way of validating and setting supported MTU values on a per - device basis rather than using a defined default for all devices. To - resolve this, the following members will be added to ``rte_eth_dev_info``. - Note: these can be added to fit a hole in the existing structure for amd64 - but not for 32-bit, as such ABI change will occur as size of the structure - will increase. - - - Member ``uint16_t min_mtu`` the minimum MTU allowed. - - Member ``uint16_t max_mtu`` the maximum MTU allowed. - -* security: New field ``uint64_t opaque_data`` is planned to be added into - ``rte_security_session`` structure. That would allow upper layer to easily - associate/de-associate some user defined data with the security session. - -* cryptodev: several API and ABI changes are planned for rte_cryptodev - in v19.02: - - - The size and layout of ``rte_cryptodev_sym_session`` will change - to fix existing issues. - - The size and layout of ``rte_cryptodev_qp_conf`` and syntax of - ``rte_cryptodev_queue_pair_setup`` will change to to allow to use - two different mempools for crypto and device private sessions. - -* pdump: As we changed to use generic IPC, some changes in APIs and structure - are expected in subsequent release. - - - ``rte_pdump_set_socket_dir`` will be removed; - - The parameter, ``path``, of ``rte_pdump_init`` will be removed; - - The enum ``rte_pdump_socktype`` will be removed. +* 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. + +* 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 + `_. + +* 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. + +* 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.