X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Frel_notes%2Fdeprecation.rst;h=287ffb2fe5a0f29cd4c0a2e80280beb20851fec8;hb=725d2a7fbf717d9a6189ac9b49bad2b4f5391a60;hp=9b55761522206d5d4d6e465be42d6320240a6fef;hpb=1d81d4f2a6a7fd02a4f1f2d89b1de048a7f74ea6;p=dpdk.git diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index 9b55761522..287ffb2fe5 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -1,3 +1,6 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright 2018 The DPDK contributors + ABI and API Deprecation ======================= @@ -8,23 +11,25 @@ API and ABI deprecation notices are to be posted here. Deprecation Notices ------------------- -* eal: both declaring and identifying devices will be streamlined in v18.05. +* 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. + +* 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: 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. - - removal of ``name`` and ``args`` fields. - The enum ``rte_devtype`` was used to identify a bus and will disappear. - - The ``rte_devargs_list`` will be made private. - Functions previously deprecated will change or disappear: - + ``rte_eal_devargs_add`` + ``rte_eal_devargs_type_count`` - + ``rte_eal_parse_devargs_str``, replaced by ``rte_eal_devargs_parse`` - + ``rte_eal_devargs_parse`` will change its format and use. - + all ``rte_devargs`` related functions will be renamed, changing the - ``rte_eal_devargs_`` prefix to ``rte_devargs_``. * pci: Several exposed functions are misnamed. The following functions are deprecated starting from v17.11 and are replaced: @@ -33,75 +38,18 @@ Deprecation Notices - ``eal_parse_pci_DomBDF`` replaced by ``rte_pci_addr_parse`` - ``rte_eal_compare_pci_addr`` replaced by ``rte_pci_addr_cmp`` -* eal: The semantics of the return value for the ``rte_lcore_has_role`` function - are planned to change in v18.05. The function currently returns 0 and <0 for - success and failure, respectively. This will change to 1 and 0 for true and - false, respectively, to make use of the function more intuitive. - -* eal: new ``numa_node_count`` member will be added to ``rte_config`` structure - in v18.05. - -* eal: due to internal data layout reorganization, there will be changes to - several structures and functions as a result of coming changes to support - memory hotplug in v18.05. - ``rte_eal_get_physmem_layout`` will be deprecated and removed in subsequent - releases. - ``rte_mem_config`` contents will change due to switch to memseg lists. - ``rte_memzone`` member ``memseg_id`` will no longer serve any useful purpose - and will be removed. - -* eal: a new set of mbuf mempool ops name APIs for user, platform and best - mempool names have been defined in ``rte_mbuf`` in v18.02. The uses of - ``rte_eal_mbuf_default_mempool_ops`` shall be replaced by - ``rte_mbuf_best_mempool_ops``. - The following function is now redundant and it is target to be deprecated - in 18.05: - - - ``rte_eal_mbuf_default_mempool_ops`` - -* mempool: several API and ABI changes are planned in v18.05. - The following functions, introduced for Xen, which is not supported - anymore since v17.11, are hard to use, not used anywhere else in DPDK. - Therefore they will be deprecated in v18.05 and removed in v18.08: - - - ``rte_mempool_xmem_create`` - - ``rte_mempool_xmem_size`` - - ``rte_mempool_xmem_usage`` - - The following changes are planned: - - - removal of ``get_capabilities`` mempool ops and related flags. - - substitute ``register_memory_area`` with ``populate`` ops. - - addition of new ops to customize required memory chunk calculation, - customize objects population and allocate contiguous - block of objects if underlying driver supports it. - -* mbuf: The control mbuf API will be removed in v18.05. The impacted - functions and macros are: - - - ``rte_ctrlmbuf_init()`` - - ``rte_ctrlmbuf_alloc()`` - - ``rte_ctrlmbuf_free()`` - - ``rte_ctrlmbuf_data()`` - - ``rte_ctrlmbuf_len()`` - - ``rte_is_ctrlmbuf()`` - - ``CTRL_MBUF_FLAG`` - - The packet mbuf API should be used as a replacement. - -* 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. - -* ethdev: a new Tx and Rx offload API was introduced on 17.11. - In the new API, offloads are divided into per-port and per-queue offloads. - Offloads are disabled by default and enabled per application request. - The old offloads API is target to be deprecated on 18.05. This includes: - - - removal of ``ETH_TXQ_FLAGS_NO*`` flags. - - removal of ``txq_flags`` field from ``rte_eth_txconf`` struct. - - removal of the offloads bit-field from ``rte_eth_rxmode`` struct. +* 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 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. * ethdev: the legacy filter API, including ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well @@ -111,65 +59,27 @@ Deprecation Notices Target release for removal of the legacy API will be defined once most PMDs have switched to rte_flow. -* ethdev: A new rss level field planned in 18.05. - The new API add rss_level field to ``rte_eth_rss_conf`` to enable a choice - of RSS hash calculation on outer or inner header of tunneled packet. - -* ethdev: Currently, if the rte_eth_rx_burst() function returns a value less - than *nb_pkts*, the application will assume that no more packets are present. - Some of the hw queue based hardware can only support smaller burst for RX - and TX and thus break the expectation of the rx_burst API. Similar is the - case for TX burst as well as ring sizes. ``rte_eth_dev_info`` will be added - with following new parameters so as to support semantics for drivers to - define a preferred size for Rx/Tx burst and rings. - - - Member ``struct preferred_size`` would be added to enclose all preferred - size to be fetched from driver/implementation. - - Members ``uint16_t rx_burst``, ``uint16_t tx_burst``, ``uint16_t rx_ring``, - and ``uint16_t tx_ring`` would be added to ``struct preferred_size``. - -* ethdev: A work is being planned for 18.05 to expose VF port representors - as a mean to perform control and data path operation on the different VFs. - As VF representor is an ethdev port, new fields are needed in order to map - between the VF representor and the VF or the parent PF. Those new fields - are to be included in ``rte_eth_dev_info`` struct. - -* ethdev: The prototype and the behavior of - ``dev_ops->eth_mac_addr_set()`` will change in v18.05. A return code - will be added to notify the caller if an error occurred in the PMD. In - ``rte_eth_dev_default_mac_addr_set()``, the new default MAC address - will be copied in ``dev->data->mac_addrs[0]`` only if the operation is - successful. This modification will only impact the PMDs, not the - applications. - -* ethdev: functions add rx/tx callback will return named opaque type - ``rte_eth_add_rx_callback()``, ``rte_eth_add_first_rx_callback()`` and - ``rte_eth_add_tx_callback()`` functions currently return callback object as - ``void \*`` but APIs to delete callbacks get ``struct rte_eth_rxtx_callback \*`` - as parameter. For consistency functions adding callback will return - ``struct rte_eth_rxtx_callback \*`` instead of ``void \*``. - -* ethdev: The size of variables ``flow_types_mask`` in - ``rte_eth_fdir_info structure``, ``sym_hash_enable_mask`` and - ``valid_bit_mask`` in ``rte_eth_hash_global_conf`` structure - will be increased from 32 to 64 bits to fulfill hardware requirements. - This change will break existing ABI as size of the structures will increase. - -* ethdev: ``rte_eth_dev_get_sec_ctx()`` fix port id storage - ``rte_eth_dev_get_sec_ctx()`` is using ``uint8_t`` for ``port_id``, - which should be ``uint16_t``. - -* i40e: The default flexible payload configuration which extracts the first 16 - bytes of the payload for RSS will be deprecated starting from 18.02. If - required the previous behavior can be configured using existing flow - director APIs. There is no ABI/API break. This change will just remove a - global configuration setting and require explicit configuration. - -* librte_meter: The API will change to accommodate configuration profiles. - Most of the API functions will have an additional opaque parameter. - -* ring: The alignment constraints on the ring structure will be relaxed - to one cache line instead of two, and an empty cache line padding will - be added between the producer and consumer structures. The size of the - structure and the offset of the fields will remain the same on - platforms with 64B cache line, but will change on other platforms. +* 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. + +* crypto/aesni_mb: the minimum supported intel-ipsec-mb library version will be + changed from 0.49.0 to 0.52.0.