X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Frel_notes%2Fdeprecation.rst;h=4366015b015f20cdb39e7e8e101420f830ee5f49;hb=f6c6c686f134dac6a0b4540b1a6b85719991b6dc;hp=d2350c1434663ac0e9ea4d655926254bf3145bc2;hpb=9f3b3a96dec2f4c01cc92a132d763b8887d29e6a;p=dpdk.git diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index d2350c1434..4366015b01 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -11,61 +11,45 @@ here. Deprecation Notices ------------------- -* build: The macros defined to indicate which DPDK libraries and drivers - are included in the meson build are changing to a standardized format of - ``RTE_LIB_`` and ``RTE__``, where ``NAME`` is the - upper-case component name, e.g. EAL, ETHDEV, IXGBE, and ``CLASS`` is the - upper-case name of the device class to which a driver belongs e.g. - ``NET``, ``CRYPTO``, ``VDPA``. The old macros are deprecated and will be - removed in a future release. - -* 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 ``pip3`` tool (or ``python3 -m pip``) 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 terms blacklist and whitelist to describe devices used - by DPDK will be replaced in the 20.11 relase. - This will apply to command line arguments as well as macros. - - The macro ``RTE_DEV_BLACKLISTED`` will be replaced with ``RTE_DEV_EXCLUDED`` - and ``RTE_DEV_WHITELISTED`` will be replaced with ``RTE_DEV_INCLUDED`` - ``RTE_BUS_SCAN_BLACKLIST`` and ``RTE_BUS_SCAN_WHITELIST`` will be - replaced with ``RTE_BUS_SCAN_EXCLUDED`` and ``RTE_BUS_SCAN_INCLUDED`` - respectively. Likewise ``RTE_DEVTYPE_BLACKLISTED_PCI`` and - ``RTE_DEVTYPE_WHITELISTED_PCI`` will be replaced with - ``RTE_DEVTYPE_EXCLUDED`` and ``RTE_DEVTYPE_INCLUDED``. - - The old macros will be marked as deprecated in 20.11 and any - usage will cause a compile warning. They will be removed in - a future release. - - The command line arguments to ``rte_eal_init`` will change from - ``-b, --pci-blacklist`` to ``-x, --exclude`` and - ``-w, --pci-whitelist`` to ``-i, --include``. - The old command line arguments will continue to be accepted in 20.11 - but will cause a runtime warning message. The old arguments will - be removed in a future release. - * 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: Making ``struct rte_intr_handle`` internal to avoid any ABI breakages + in 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. + in DPDK. DPDK has adopted the atomic operations from + https://gcc.gnu.org/onlinedocs/gcc/_005f_005fatomic-Builtins.html. These + operations 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. + use cases do not require full barriers. To support such use cases, DPDK has + adopted atomic operations from + https://gcc.gnu.org/onlinedocs/gcc/_005f_005fatomic-Builtins.html. These + operations and a new wrapper ``rte_atomic_thread_fence`` instead of + ``__atomic_thread_fence`` must be used for patches that need to be merged in + 20.08 onwards. This change will not introduce any performance degradation. + +* mempool: Helper macro ``MEMPOOL_HEADER_SIZE()`` is deprecated and will + be removed in DPDK 22.11. The replacement macro + ``RTE_MEMPOOL_HEADER_SIZE()`` is internal only. + +* mempool: Macro to register mempool driver ``MEMPOOL_REGISTER_OPS()`` is + deprecated and will be removed in DPDK 22.11. Use replacement macro + ``RTE_MEMPOOL_REGISTER_OPS()``. + +* mempool: The mempool API macros ``MEMPOOL_PG_*`` are deprecated and + will be removed in DPDK 22.11. + +* pci: To reduce unnecessary ABIs exposed by DPDK bus driver, "rte_bus_pci.h" + will be made internal in 21.11 and macros/data structures/functions defined + in the header will not be considered as ABI anymore. This change is inspired + by the RFC https://patchwork.dpdk.org/project/dpdk/list/?series=17176. * 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 @@ -76,37 +60,16 @@ Deprecation Notices ``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)``. + ``rte_eth_fdir_flex_conf -> rte_eth_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. -* mbuf: Some fields will be converted to dynamic API in DPDK 20.11 - in order to reserve more space for the dynamic fields, as explained in - `this presentation `_. - As a consequence, the layout of the ``struct rte_mbuf`` will be re-arranged, - avoiding impact on vectorized implementation of the driver datapaths, - while evaluating performance gains of a better use of the first cache line. - - -* ethdev: the legacy filter API, including - ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well - as filter types ETHERTYPE, FLEXIBLE, SYN, NTUPLE, TUNNEL, FDIR, - HASH and L2_TUNNEL, is superseded by the generic flow API (rte_flow) in - PMDs that implement the latter. - The legacy API will be removed in DPDK 20.11. - * ethdev: The flow director API, including ``rte_eth_conf.fdir_conf`` field, and the related structures (``rte_fdir_*`` and ``rte_eth_fdir_*``), will be removed in DPDK 20.11. -* ethdev: The legacy L2 tunnel filtering API is deprecated as the rest of - the legacy filtering API. - The functions ``rte_eth_dev_l2_tunnel_eth_type_conf`` and - ``rte_eth_dev_l2_tunnel_offload_set`` which were not marked as deprecated, - will be removed in DPDK 20.11. - -* ethdev: New offload flags ``DEV_RX_OFFLOAD_FLOW_MARK`` will be added in 19.11. +* ethdev: New offload flags ``RTE_ETH_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 @@ -114,16 +77,21 @@ Deprecation Notices 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 removed in 21.11. - Existing ``rte_eth_rx_descriptor_status`` and ``rte_eth_tx_descriptor_status`` - APIs can be used as replacement. +* ethdev: Announce moving from dedicated modify function for each field, + to using the general ``rte_flow_modify_field`` action. -* ethdev: The port mirroring API can be replaced with a more fine grain flow API. - The structs ``rte_eth_mirror_conf``, ``rte_eth_vlan_mirror`` and the functions - ``rte_eth_mirror_rule_set``, ``rte_eth_mirror_rule_reset`` will be marked - as deprecated in DPDK 20.11, along with the associated macros ``ETH_MIRROR_*``. - This API will be fully removed in DPDK 21.11. +* ethdev: The flow API matching pattern structures, ``struct rte_flow_item_*``, + should start with relevant protocol header. + Some matching pattern structures implements this by duplicating protocol header + fields in the struct. To clarify the intention and to be sure protocol header + is intact, will replace those fields with relevant protocol header struct. + In v21.02 both individual protocol header fields and the protocol header struct + will be added as union, target is switch usage to the protocol header by time. + In v21.11 LTS, protocol header fields will be cleaned and only protocol header + struct will remain. + +* ethdev: Add new Rx queue offload flag ``RTE_ETH_RX_OFFLOAD_SHARED_RXQ`` and + ``shared_group`` field to ``struct rte_eth_rxconf``. * ethdev: Queue specific stats fields will be removed from ``struct rte_eth_stats``. Mentioned fields are: ``q_ipackets``, ``q_opackets``, ``q_ibytes``, ``q_obytes``, @@ -132,25 +100,69 @@ Deprecation Notices will be limited to maximum 256 queues. Also compile time flag ``RTE_ETHDEV_QUEUE_STAT_CNTRS`` will be removed. -* 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. +* ethdev: Items and actions ``PF``, ``VF``, ``PHY_PORT``, ``PORT_ID`` are + deprecated as hard-to-use / ambiguous and will be removed in DPDK 22.11. + +* ethdev: The use of attributes ``ingress`` / ``egress`` in "transfer" flows + is deprecated as ambiguous with respect to the embedded switch. The use of + these attributes will become invalid starting from DPDK 22.11. + +* vhost: ``rte_vdpa_register_device``, ``rte_vdpa_unregister_device``, + ``rte_vhost_host_notifier_ctrl`` and ``rte_vdpa_relay_vring_used`` vDPA + driver interface will be marked as internal in DPDK v21.11. + +* vhost: rename ``struct vhost_device_ops`` to ``struct rte_vhost_device_ops`` + in DPDK v21.11. + +* vhost: The experimental tags of ``rte_vhost_driver_get_protocol_features``, + ``rte_vhost_driver_get_queue_num``, ``rte_vhost_crypto_create``, + ``rte_vhost_crypto_free``, ``rte_vhost_crypto_fetch_requests``, + ``rte_vhost_crypto_finalize_requests``, ``rte_vhost_crypto_set_zero_copy``, + ``rte_vhost_va_from_guest_pa``, ``rte_vhost_extern_callback_register``, + and ``rte_vhost_driver_set_protocol_features`` functions will be removed + and the API functions will be made stable in DPDK 21.11. + +* cryptodev: Hide structures ``rte_cryptodev_sym_session`` and + ``rte_cryptodev_asym_session`` to remove unnecessary indirection between + session and the private data of session. An opaque pointer can be exposed + directly to application which can be attached to the ``rte_crypto_op``. + +* security: Hide structure ``rte_security_session`` and expose an opaque + pointer for the private data to the application which can be attached + to the packet while enqueuing. + +* eventdev: The file ``rte_eventdev_pmd.h`` will be renamed to ``eventdev_driver.h`` + to make the driver interface as internal and the structures ``rte_eventdev_data``, + ``rte_eventdev`` and ``rte_eventdevs`` will be moved to a new file named + ``rte_eventdev_core.h`` in DPDK 21.11. + The ``rte_`` prefix for internal structures and functions will be removed across the + library. + The experimental eventdev trace APIs and ``rte_event_vector_pool_create``, + ``rte_event_eth_rx_adapter_vector_limits_get`` will be promoted to stable. + An 8-byte reserved field will be added to the structure ``rte_event_timer`` to + support future extensions. + +* eventdev: The structure ``rte_event_eth_rx_adapter_queue_conf`` will be + extended to include ``rte_event_eth_rx_adapter_event_vector_config`` elements + and the function ``rte_event_eth_rx_adapter_queue_event_vector_config`` will + be removed in DPDK 21.11. + + An application can enable event vectorization by passing the desired vector + values to the function ``rte_event_eth_rx_adapter_queue_add`` using + the structure ``rte_event_eth_rx_adapter_queue_add``. + +* eventdev: Reserved bytes of ``rte_event_crypto_request`` is a space holder + for ``response_info``. Both should be decoupled for better clarity in + DPDK 21.11. + New space for ``response_info`` can be made by changing + ``rte_event_crypto_metadata`` type to structure from union. * 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. - -* cmdline: ``cmdline`` structure will be made opaque to hide platform-specific - content. On Linux and FreeBSD, supported prior to DPDK 20.11, - original structure will be kept until DPDK 21.11. - -* dpdk-setup.sh: This old script relies on deprecated stuff, and especially - ``make``. Given environments are too much variables for such a simple script, - it will be removed in DPDK 20.11. - Some useful parts may be converted into specific scripts. +* raw/ioat: The ``ioat`` rawdev driver has been deprecated, since it's + functionality is provided through the new ``dmadev`` infrastructure. + To continue to use hardware previously supported by the ``ioat`` rawdev driver, + applications should be updated to use the ``dmadev`` library instead, + with the underlying HW-functionality being provided by the ``ioat`` or + ``idxd`` dma drivers