X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fguides%2Frel_notes%2Fdeprecation.rst;h=2a103584586c1f6b63a02ae8dd133a976edc4662;hb=d0a3685b5351362cac9484d59e2d6684c0704889;hp=c632c47ef8f800ab6612f84839f8c42cdaf157c2;hpb=5dfcb689845876b8eb8c7bbe3a6527f7b21f273a;p=dpdk.git diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index c632c47ef8..2a10358458 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -11,90 +11,43 @@ here. Deprecation Notices ------------------- -* 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. - -* build macros: The macros defining RTE_MACHINE_CPUFLAG_* will be removed - from the build. The information provided by these macros is available - through standard compiler macros. For example, RTE_MACHINE_CPUFLAG_SSE3 - duplicates the compiler-provided macro __SSE3__. - * 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: To be more inclusive in choice of naming, the DPDK project - will replace uses of master/slave in the API's and command line arguments. - - References to master/slave in relation to lcore will be renamed - to initial/worker. The function ``rte_get_master_lcore()`` - will be renamed to ``rte_get_initial_lcore()``. - For the 20.11 release, both names will be present and the - old function will be marked with the deprecated tag. - The old function will be removed in a future version. - - The iterator for worker lcores will also change: - ``RTE_LCORE_FOREACH_SLAVE`` will be replaced with - ``RTE_LCORE_FOREACH_WORKER``. - - The ``master-lcore`` argument to testpmd will be replaced - with ``initial-lcore``. The old ``master-lcore`` argument - will produce a runtime notification in 20.11 release, and - be removed completely in a future release. - -* 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: The lcore state ``FINISHED`` will be removed from + the ``enum rte_lcore_state_t``. + The lcore state ``WAIT`` is enough to represent the same state. + +* 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. - -* rte_cio_*mb: Since the IO barriers for ARMv8 platforms are relaxed from DSB - to DMB, rte_cio_*mb APIs provide the same functionality as rte_io_*mb - APIs (taking all platforms into consideration). rte_io_*mb APIs should be - used in the place of rte_cio_*mb APIs. The rte_cio_*mb APIs will be - deprecated in 20.11 release. - -* 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 - `_. + 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. + +* mbuf: The mbuf offload flags ``PKT_*`` will be renamed as ``RTE_MBUF_F_*``. + A compatibility layer will be kept until DPDK 22.11, except for the flags + that are already deprecated (``PKT_RX_L4_CKSUM_BAD``, ``PKT_RX_IP_CKSUM_BAD``, + ``PKT_RX_EIP_CKSUM_BAD``, ``PKT_TX_QINQ_PKT``) which will be removed. + +* 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 @@ -110,58 +63,16 @@ Deprecation Notices 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 `_. - The following static fields will be moved as dynamic: - - - ``timestamp`` - - ``userdata`` / ``udata64`` - - ``seqn`` - - 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: 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 - as filter types MACVLAN, 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: Will add ``RTE_ETH_`` prefix to all ethdev macros/enums in v21.11. + Macros will be added for backward compatibility. + Backward compatibility macros will be removed on v22.11. + A few old backward compatibility macros from 2013 that does not have + proper prefix will be removed on v21.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: 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: The temporary flag RTE_ETH_DEV_CLOSE_REMOVE will be removed in 20.11. - As a consequence, the new behaviour introduced in 18.11 will be effective - for all drivers: generic port resources are freed on close operation. - Private resources are expected to be released in the ``dev_close`` callback. - More details in http://inbox.dpdk.org/dev/5248162.j6AOsuQRmx@thomas/ - * 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``. @@ -170,18 +81,33 @@ Deprecation Notices In 19.11 PMDs will still update the field even when the offload is not enabled. -* ethdev: Add new fields to ``rte_eth_rxconf`` to configure the receiving - queues to split ingress packets into multiple segments according to the - specified lengths into the buffers allocated from the specified - memory pools. The backward compatibility to existing API is preserved. - -* ethdev: The ``struct rte_eth_rxq_info`` will be modified to include - a new optional field, indicating the buffer size used in receiving packets - for HW. This change is planned for 20.11. For more details: - https://mails.dpdk.org/archives/dev/2020-July/176135.html. +* 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 deprecated in 20.11 and will be removed in 21.11. + will be removed in 21.11. Existing ``rte_eth_rx_descriptor_status`` and ``rte_eth_tx_descriptor_status`` APIs can be used as replacement. @@ -191,100 +117,137 @@ Deprecation Notices 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 ``struct rte_flow_item_eth`` and ``struct rte_flow_item_vlan`` - structs will be modified, to include an additional value, indicating existence - or absence of a VLAN header following the current header, as proposed in RFC - https://mails.dpdk.org/archives/dev/2020-August/177536.html. - -* ethdev: The ``struct rte_flow_item_ipv6`` struct will be modified to include - additional values, indicating existence or absence of IPv6 extension headers - following the IPv6 header, as proposed in RFC - https://mails.dpdk.org/archives/dev/2020-August/177257.html. - -* ethdev: Some internal APIs for driver usage are exported in the .map file. - Now DPDK has ``__rte_internal`` marker so we can mark internal APIs and move - them to the INTERNAL block in .map. Although these APIs are internal it will - break the ABI checks, that is why change is planned for 20.11. - The list of internal APIs are mainly ones listed in ``rte_ethdev_driver.h``. - -* pmd_dpaa: The API ``rte_pmd_dpaa_set_tx_loopback`` will have extended - ``port_id`` definition from ``uint8_t`` to ``uint16_t``. - -* vhost: Vhost-user dequeue zero-copy support will be removed in 20.11. - The only known user is OVS where the feature is still experimental, - and has not received any update for 2.5 years. - This feature faces reliability issues and is often conflicting with - new features being implemented. - -* security: The API ``rte_security_session_create`` takes only single mempool - for session and session private data. So the application need to create - mempool for twice the number of sessions needed and will also lead to - wastage of memory as session private data need more memory compared to session. - Hence the API will be modified to take two mempool pointers - one for session - and one for private data. - -* cryptodev: ``RTE_CRYPTO_AEAD_LIST_END`` from ``enum rte_crypto_aead_algorithm``, - ``RTE_CRYPTO_CIPHER_LIST_END`` from ``enum rte_crypto_cipher_algorithm`` and - ``RTE_CRYPTO_AUTH_LIST_END`` from ``enum rte_crypto_auth_algorithm`` - will be removed. - -* 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. - -* scheduler: The functions ``rte_cryptodev_scheduler_slave_attach``, - ``rte_cryptodev_scheduler_slave_detach`` and - ``rte_cryptodev_scheduler_slaves_get`` will be replaced in 20.11 by - ``rte_cryptodev_scheduler_worker_attach``, - ``rte_cryptodev_scheduler_worker_detach`` and - ``rte_cryptodev_scheduler_workers_get`` accordingly. - -* eventdev: Following structures will be modified to support DLB PMD - and future extensions: - - - ``rte_event_dev_info`` - - ``rte_event_dev_config`` - - ``rte_event_port_conf`` - - Patches containing justification, documentation, and proposed modifications - can be found at: - - - https://patches.dpdk.org/patch/71457/ - - https://patches.dpdk.org/patch/71456/ - -* acl: ``RTE_ACL_CLASSIFY_NUM`` enum value will be removed. - This enum value is not used inside DPDK, while it prevents to add new - classify algorithms without causing an ABI breakage. - -* 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. - -* sched: To allow dynamic configuration of the subport bandwidth profile, - changes will be made to data structures ``rte_sched_subport_params``, - ``rte_sched_port_params`` and new data structure, API functions will be - defined in ``rte_sched.h``. These changes are aligned as suggested in the - RFC https://mails.dpdk.org/archives/dev/2020-July/175161.html +* 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: 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: Queue specific stats fields will be removed from ``struct rte_eth_stats``. + Mentioned fields are: ``q_ipackets``, ``q_opackets``, ``q_ibytes``, ``q_obytes``, + ``q_errors``. + Instead queue stats will be received via xstats API. Current method support + 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. + +* net: ``s_addr`` and ``d_addr`` fields of ``rte_ether_hdr`` structure + will be renamed in DPDK 21.11 to avoid conflict with Windows Sockets headers. + +* net: The structure ``rte_ipv4_hdr`` will have two unions. + The first union is for existing ``version_ihl`` byte + and new bitfield for version and IHL. + The second union is for existing ``fragment_offset`` + and new bitfield for fragment flags and offset. + +* 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: 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. + +* compressdev: ``min`` and ``max`` fields of ``rte_param_log2_range`` structure + will be renamed in DPDK 21.11 to avoid conflict with Windows Sockets headers. + +* cryptodev: ``min`` and ``max`` fields of ``rte_crypto_param_range`` structure + will be renamed in DPDK 21.11 to avoid conflict with Windows Sockets headers. + +* cryptodev: The field ``dataunit_len`` of the ``struct rte_crypto_cipher_xform`` + has a limited size ``uint16_t``. + It will be moved and extended as ``uint32_t`` in DPDK 21.11. + +* cryptodev: The structure ``rte_crypto_sym_vec`` would be updated to add + ``dest_sgl`` to support out of place processing. + This field will be null for inplace processing. + This change is targeted for DPDK 21.11. + +* cryptodev: The structure ``rte_crypto_vec`` would be updated to add + ``tot_len`` to support total buffer length. + This is required for security cases like IPsec and PDCP encryption offload + to know how much additional memory space is available in buffer other than + data length so that driver/HW can write expanded size data after encryption. + This change is targeted for DPDK 21.11. + +* cryptodev: The interface between library and drivers will be marked + as internal in DPDK 21.11. + +* 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. + +* security: The IPsec configuration structure + ``struct rte_security_ipsec_xform`` will be updated with new members to allow + SA lifetime configuration. A new structure would be introduced to replace the + current member, ``esn_soft_limit``. + +* security: The IPsec SA config options ``struct rte_security_ipsec_sa_options`` + will be updated with new fields to support new features like IPsec inner + checksum, tunnel header verification, TSO in case of protocol offload. + +* 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. + New space for ``response_info`` can be made by changing + ``rte_event_crypto_metadata`` type to structure from union. + This change is targeted for DPDK 21.11. * 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. - -* 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. +* 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. + +* security: The functions ``rte_security_set_pkt_metadata`` and + ``rte_security_get_userdata`` will be made inline functions and additional + flags will be added in structure ``rte_security_ctx`` in DPDK 21.11. + +* cryptodev: The structure ``rte_crypto_op`` would be updated to reduce + reserved bytes to 2 (from 3), and use 1 byte to indicate warnings and other + information from the crypto/security operation. This field will be used to + communicate events such as soft expiry with IPsec in lookaside mode.