X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Frel_notes%2Fdeprecation.rst;h=a708ad76912178767a8de917ef2f2a0da49c3308;hb=25be39cc1760fac2b65de65f0ec9e4f8f0fbbf7e;hp=9584d6bfd723135bfbb3afdef9581b44a7592065;hpb=e9c5672ac15febcc93d5d30ff1a12050e5d7d571;p=dpdk.git diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index 9584d6bfd7..a708ad7691 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -17,18 +17,39 @@ 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: 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 @@ -39,7 +60,7 @@ 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. @@ -48,7 +69,7 @@ Deprecation Notices and the related structures (``rte_fdir_*`` and ``rte_eth_fdir_*``), 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 @@ -56,45 +77,8 @@ Deprecation Notices In 19.11 PMDs will still update the field even when the offload is not enabled. -* ethdev: ``uint32_t max_rx_pkt_len`` field of ``struct rte_eth_rxmode``, will be - replaced by a new ``uint32_t mtu`` field of ``struct rte_eth_conf`` in v21.11. - The new ``mtu`` field will be used to configure the initial device MTU via - ``rte_eth_dev_configure()`` API. - Later MTU can be changed by ``rte_eth_dev_set_mtu()`` API as done now. - The existing ``(struct rte_eth_dev)->data->mtu`` variable will be used to store - the configured ``mtu`` value, - and this new ``(struct rte_eth_dev)->data->dev_conf.mtu`` variable will - be used to store the user configuration request. - Unlike ``max_rx_pkt_len``, which was valid only when ``JUMBO_FRAME`` enabled, - ``mtu`` field will be always valid. - When ``mtu`` config is not provided by the application, default ``RTE_ETHER_MTU`` - value will be used. - ``(struct rte_eth_dev)->data->mtu`` should be updated after MTU set successfully, - either by ``rte_eth_dev_configure()`` or ``rte_eth_dev_set_mtu()``. - - An application may need to configure device for a specific Rx packet size, like for - cases ``DEV_RX_OFFLOAD_SCATTER`` is not supported and device received packet size - can't be bigger than Rx buffer size. - To cover these cases an application needs to know the device packet overhead to be - able to calculate the ``mtu`` corresponding to a Rx buffer size, for this - ``(struct rte_eth_dev_info).max_rx_pktlen`` will be kept, - the device packet overhead can be calculated as: - ``(struct rte_eth_dev_info).max_rx_pktlen - (struct rte_eth_dev_info).max_mtu`` - -* 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: 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: Attribute ``shared`` of the ``struct rte_flow_action_count`` - is deprecated and will be removed in DPDK 21.11. Shared counters should - be managed using shared actions API (``rte_flow_shared_action_create`` etc). +* ethdev: Announce moving from dedicated modify function for each field, + to using the general ``rte_flow_modify_field`` action. * ethdev: The flow API matching pattern structures, ``struct rte_flow_item_*``, should start with relevant protocol header. @@ -113,18 +97,47 @@ Deprecation Notices will be limited to maximum 256 queues. Also compile time flag ``RTE_ETHDEV_QUEUE_STAT_CNTRS`` will be removed. -* ethdev: The offload flag ``PKT_RX_EIP_CKSUM_BAD`` will be removed and - replaced by the new flag ``PKT_RX_OUTER_IP_CKSUM_BAD``. The new name is more - consistent with existing outer header checksum status flag naming, which - should help in reducing confusion about its usage. - -* i40e: As there are both i40evf and iavf pmd, the functions of them are - duplicated. And now more and more advanced features are developed on iavf. - To keep consistent with kernel driver's name - (https://patchwork.ozlabs.org/patch/970154/), i40evf is no need to maintain. - Starting from 21.05, the default VF driver of i40e will be iavf, but i40evf - can still be used if users specify the devarg "driver=i40evf". I40evf will - be deleted in DPDK 21.11. +* 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 @@ -135,15 +148,18 @@ Deprecation Notices values to the function ``rte_event_eth_rx_adapter_queue_add`` using the structure ``rte_event_eth_rx_adapter_queue_add``. -* 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. +* 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``. -* 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. +* 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