Deprecation Notices
-------------------
-* eal: several API and ABI changes are planned for ``rte_devargs`` in v17.11.
- The format of device command line parameters will change. The bus will need
- to be explicitly stated in the device declaration. The enum ``rte_devtype``
- was used to identify a bus and will disappear.
- The structure ``rte_devargs`` will change.
- The ``rte_devargs_list`` will be made private.
- The following functions are deprecated starting from 17.08 and will either be
- modified or removed in 17.11:
-
- - ``rte_eal_devargs_add``
- - ``rte_eal_devargs_type_count``
- - ``rte_eal_parse_devargs_str``, replaced by ``rte_eal_devargs_parse``
+* 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_DomBDF`` replaced by ``rte_pci_addr_parse``
- ``rte_eal_compare_pci_addr`` replaced by ``rte_pci_addr_cmp``
-* ethdev: Tx offloads will no longer be enabled by default in 17.11.
- Instead, the ``rte_eth_txmode`` structure will be extended with
- bit field to enable each Tx offload.
- Besides of making the Rx/Tx configuration API more consistent for the
- application, PMDs will be able to provide a better out of the box performance.
- As part of the work, ``ETH_TXQ_FLAGS_NO*`` will be superseded as well.
+* 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
Target release for removal of the legacy API will be defined once most
PMDs have switched to rte_flow.
-* ethdev: new parameters - ``rte_security_capabilities`` and
- ``rte_security_ops`` will be added to ``rte_eth_dev_info`` and
- ``rte_eth_dev`` respectively to support security operations like
- ipsec inline.
+* 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: new parameters - ``rte_security_capabilities`` and
- ``rte_security_ops`` will be added to ``rte_cryptodev_info`` and
- ``rte_cryptodev`` respectively to support security protocol offloaded
- operations.
+* cryptodev: The following changes will be made in the library
+ for 18.08:
-* librte_meter: The API will change to accommodate configuration profiles.
- Most of the API functions will have an additional opaque parameter.
+ - 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