a106fcce2c
rte_cryptodev_get_header_session_size() and rte_cryptodev_get_private_session_size() functions are targeting symmetric sessions. With the future addition of asymmetric operations, these functions need to be renamed from *cryptodev_*_session_* to *cryptodev_sym_*_session_* to be symmetric specific. The two original functions are marked as deprecated and will be removed in 18.08, so applications can still use the functions in 18.05. Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com> Acked-by: Shally Verma <shally.verma@caviumnetworks.com> Acked-by: Fiona Trahe <fiona.trahe@intel.com> Acked-by: Deepak Kumar Jain <deepak.k.jain@intel.com>
99 lines
4.6 KiB
ReStructuredText
99 lines
4.6 KiB
ReStructuredText
ABI and API Deprecation
|
|
=======================
|
|
|
|
See the :doc:`guidelines document for details of the ABI policy </contributing/versioning>`.
|
|
API and ABI deprecation notices are to be posted here.
|
|
|
|
|
|
Deprecation Notices
|
|
-------------------
|
|
|
|
* 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 now redundant and it is target to be deprecated
|
|
in 18.05:
|
|
|
|
- ``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.
|
|
|
|
* 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.
|
|
|
|
* 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.
|