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.
+
+* 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 function ``rte_eal_remote_launch`` will return new error codes
+ after read or write error on the pipe, instead of calling ``rte_panic``.
+
* 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
+ ``rte_eal_devargs_type_count``
+* vfio: removal of ``rte_vfio_dma_map`` and ``rte_vfio_dma_unmap`` APIs which
+ have been replaced with ``rte_dev_dma_map`` and ``rte_dev_dma_unmap``
+ functions. The due date for the removal targets DPDK 20.02.
+
* pci: Several exposed functions are misnamed.
The following functions are deprecated starting from v17.11 and are replaced:
- ``eal_parse_pci_DomBDF`` replaced by ``rte_pci_addr_parse``
- ``rte_eal_compare_pci_addr`` replaced by ``rte_pci_addr_cmp``
-* 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.
-
-* 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.
+* 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.
* ethdev: the legacy filter API, including
``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
Target release for removal of the legacy API will be defined once most
PMDs have switched to rte_flow.
-* ethdev: In v18.11 ``rte_eth_dev_attach()`` and ``rte_eth_dev_detach()``
- will be removed.
- Hotplug functions ``rte_eal_hotplug_add()`` and ``rte_eal_hotplug_remove()``
- should be used instread.
- Function ``rte_eth_dev_get_port_by_name()`` may be used to find
- identifier of the added port.
+* kni: remove KNI ethtool support. To clarify, this is not to remove the KNI,
+ but only to remove ethtool support of it that is disabled by default and
+ can be enabled via ``CONFIG_RTE_KNI_KMOD_ETHTOOL`` config option.
+ Existing KNI ethtool implementation is only supported by ``igb`` & ``ixgbe``
+ drivers, by using a copy of kernel drivers in DPDK. This model cannot be
+ extended to all drivers in DPDK and it is too much effort to maintain
+ kernel modules in DPDK. As a result users won't be able to use ``ethtool``
+ via ``igb`` & ``ixgbe`` anymore.
+
+* cryptodev: New member in ``rte_cryptodev_config`` to allow applications to
+ disable features supported by the crypto device. Only the following features
+ would be allowed to be disabled this way,
+
+ - ``RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO``
+ - ``RTE_CRYPTODEV_FF_ASYMMETRIC_CRYPTO``
+ - ``RTE_CRYPTODEV_FF_SECURITY``
-* eal: In v18.11 ``rte_eal_dev_attach()`` and ``rte_eal_dev_detach()``
- will be removed.
- Hotplug functions ``rte_eal_hotplug_add()`` and ``rte_eal_hotplug_remove()``
- should be used directly.
+ Disabling unused features would facilitate efficient usage of HW/SW offload.
-* pdump: As we changed to use generic IPC, some changes in APIs and structure
- are expected in subsequent release.
+ - Member ``uint64_t ff_disable`` in ``rte_cryptodev_config``
- - ``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.
+ The field would be added in v19.08.
-* ethdev: flow API function ``rte_flow_copy()`` will be deprecated in v18.11
- in favor of ``rte_flow_conv()`` (which will appear in that version) and
- subsequently removed for v19.02.
+* cryptodev: the ``uint8_t *data`` member of ``key`` structure in the xforms
+ structure (``rte_crypto_cipher_xform``, ``rte_crypto_auth_xform``, and
+ ``rte_crypto_aead_xform``) will be changed to ``const uint8_t *data``.
- This is due to a lack of flexibility and reliance on a type unusable with
- C++ programs (struct rte_flow_desc).
+* metrics: The function ``rte_metrics_init`` will have a non-void return
+ in order to notify errors instead of calling ``rte_exit``.