Deprecation Notices
-------------------
-* The log history is deprecated.
- It is voided in 16.07 and will be removed in release 16.11.
-
-* The ethdev library file will be renamed from libethdev.* to librte_ethdev.*
- in release 16.11 in order to have a more consistent namespace.
-
-* The ethdev hotplug API is going to be moved to EAL with a notification
- mechanism added to crypto and ethdev libraries so that hotplug is now
- available to both of them. This API will be stripped of the device arguments
- so that it only cares about hotplugging.
-
-* Structures embodying pci and vdev devices are going to be reworked to
- integrate new common rte_device / rte_driver objects (see
- http://dpdk.org/ml/archives/dev/2016-January/031390.html).
- ethdev and crypto libraries will then only handle those objects so that they
- do not need to care about the kind of devices that are being used, making it
- easier to add new buses later.
-
-* The mbuf flags PKT_RX_VLAN_PKT and PKT_RX_QINQ_PKT are deprecated and
- are respectively replaced by PKT_RX_VLAN_STRIPPED and
- PKT_RX_QINQ_STRIPPED, that are better described. The old flags and
- their behavior will be kept in 16.07 and will be removed in 16.11.
-
-* The APIs rte_mempool_count and rte_mempool_free_count are being deprecated
- on the basis that they are confusing to use - free_count actually returns
- the number of allocated entries, not the number of free entries as expected.
- They are being replaced by rte_mempool_avail_count and
- rte_mempool_in_use_count respectively.
-
-* The mempool functions for single/multi producer/consumer are deprecated and
- will be removed in 16.11.
- It is replaced by rte_mempool_generic_get/put functions.
-
-* Driver names are quite inconsistent among each others and they will be
- renamed to something more consistent (net and crypto prefixes) in 16.11.
- Some of these driver names are used publicly, to create virtual devices,
- so a deprecation notice is necessary.
+* eal: DPDK runtime configuration file (located at
+ ``/var/run/.<prefix>_config``) will be moved. The new path will be as follows:
+
+ - if DPDK is running as root, path will be set to
+ ``/var/run/dpdk/<prefix>/config``
+ - if DPDK is not running as root and $XDG_RUNTIME_DIR is set, path will be set
+ to ``$XDG_RUNTIME_DIR/dpdk/<prefix>/config``
+ - if DPDK is not running as root and $XDG_RUNTIME_DIR is not set, path will be
+ set to ``/tmp/dpdk/<prefix>/config``
+
+* eal: both declaring and identifying devices will be streamlined in v18.05.
+ 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.
+ - Functions previously deprecated will change or disappear:
+
+ + ``rte_eal_devargs_type_count``
+ + ``rte_eal_devargs_parse`` will change its format and use.
+
+* pci: Several exposed functions are misnamed.
+ The following functions are deprecated starting from v17.11 and are replaced:
+
+ - ``eal_parse_pci_BDF`` replaced by ``rte_pci_addr_parse``
+ - ``eal_parse_pci_DomBDF`` replaced by ``rte_pci_addr_parse``
+ - ``rte_eal_compare_pci_addr`` replaced by ``rte_pci_addr_cmp``
+
+* 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 deprecated since 18.05, and will be removed
+ in 18.08:
+
+ - ``rte_eal_mbuf_default_mempool_ops``
+
+* 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.
+
+ In later releases the old offloading API will be deprecated, which will include:
+ - 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.
+
+* 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.
+ Target release for removal of the legacy API will be defined once most
+ PMDs have switched to rte_flow.
+
+* pdump: As we changed to use generic IPC, some changes in APIs and structure
+ are expected in subsequent release.
+
+ - ``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.
+
+* cryptodev: The following changes will be made in the library
+ for 18.08:
+
+ - Removal of ``sym`` structure in ``rte_cryptodev_info`` structure,
+ containing fields not relevant anymore since the session mempool
+ is not internal in the crypto device anymore.
+ - Replacement of ``pci_dev`` field with the more generic ``rte_device``
+ structure.
+ - Functions ``rte_cryptodev_queue_pair_attach_sym_session()`` and
+ ``rte_cryptodev_queue_pair_dettach_sym_session()`` will be deprecated from
+ 18.05 and removed in 18.08, as there are no drivers doing anything useful
+ with them.
+ - Functions ``rte_cryptodev_queue_pair_start()`` and
+ ``rte_cryptodev_queue_pair_stop()`` will be deprecated from 18.05
+ and removed in 18.08, as there are no drivers doing anything useful
+ with them.
+ - Some feature flags such as ``RTE_CRYPTODEV_FF_MBUF_SCATTER_GATHER`` are ambiguous,
+ so some will be replaced by more explicit flags.
+ - Function ``rte_cryptodev_get_header_session_size()`` will be deprecated
+ in 18.05, and it gets replaced with ``rte_cryptodev_sym_get_header_session_size()``.
+ It will be removed in 18.08.
+ - Function ``rte_cryptodev_get_private_session_size()`` will be deprecated
+ in 18.05, and it gets replaced with ``rte_cryptodev_sym_get_private_session_size()``.
+ It will be removed in 18.08.
git.droids-corp.org / dpdk.git / blobdiff