1 ABI and API Deprecation
2 =======================
4 See the :doc:`guidelines document for details of the ABI policy </contributing/versioning>`.
5 API and ABI deprecation notices are to be posted here.
11 * eal: DPDK runtime configuration file (located at
12 ``/var/run/.<prefix>_config``) will be moved. The new path will be as follows:
14 - if DPDK is running as root, path will be set to
15 ``/var/run/dpdk/<prefix>/config``
16 - if DPDK is not running as root and $XDG_RUNTIME_DIR is set, path will be set
17 to ``$XDG_RUNTIME_DIR/dpdk/<prefix>/config``
18 - if DPDK is not running as root and $XDG_RUNTIME_DIR is not set, path will be
19 set to ``/tmp/dpdk/<prefix>/config``
21 * eal: both declaring and identifying devices will be streamlined in v18.05.
22 New functions will appear to query a specific port from buses, classes of
23 device and device drivers. Device declaration will be made coherent with the
24 new scheme of device identification.
25 As such, ``rte_devargs`` device representation will change.
27 - removal of ``name`` and ``args`` fields.
28 - The enum ``rte_devtype`` was used to identify a bus and will disappear.
29 - Functions previously deprecated will change or disappear:
31 + ``rte_eal_devargs_type_count``
32 + ``rte_eal_devargs_parse`` will change its format and use.
34 * pci: Several exposed functions are misnamed.
35 The following functions are deprecated starting from v17.11 and are replaced:
37 - ``eal_parse_pci_BDF`` replaced by ``rte_pci_addr_parse``
38 - ``eal_parse_pci_DomBDF`` replaced by ``rte_pci_addr_parse``
39 - ``rte_eal_compare_pci_addr`` replaced by ``rte_pci_addr_cmp``
41 * eal: a new set of mbuf mempool ops name APIs for user, platform and best
42 mempool names have been defined in ``rte_mbuf`` in v18.02. The uses of
43 ``rte_eal_mbuf_default_mempool_ops`` shall be replaced by
44 ``rte_mbuf_best_mempool_ops``.
45 The following function is deprecated since 18.05, and will be removed
48 - ``rte_eal_mbuf_default_mempool_ops``
50 * mbuf: The opaque ``mbuf->hash.sched`` field will be updated to support generic
51 definition in line with the ethdev TM and MTR APIs. Currently, this field
52 is defined in librte_sched in a non-generic way. The new generic format
53 will contain: queue ID, traffic class, color. Field size will not change.
55 * mbuf: the macro ``RTE_MBUF_INDIRECT()`` will be removed in v18.08 or later and
56 replaced with ``RTE_MBUF_CLONED()`` which is already added in v18.05. As
57 ``EXT_ATTACHED_MBUF`` is newly introduced in v18.05, ``RTE_MBUF_INDIRECT()``
58 can no longer be mutually exclusive with ``RTE_MBUF_DIRECT()`` if the new
59 experimental API ``rte_pktmbuf_attach_extbuf()`` is used. Removal of the macro
60 is to fix this semantic inconsistency.
62 * ethdev: a new Tx and Rx offload API was introduced on 17.11.
63 In the new API, offloads are divided into per-port and per-queue offloads.
64 Offloads are disabled by default and enabled per application request.
66 In later releases the old offloading API will be deprecated, which will include:
67 - removal of ``ETH_TXQ_FLAGS_NO*`` flags.
68 - removal of ``txq_flags`` field from ``rte_eth_txconf`` struct.
69 - removal of the offloads bit-field from ``rte_eth_rxmode`` struct.
71 * ethdev: A new offloading flag ``DEV_RX_OFFLOAD_KEEP_CRC`` will be added in v18.08,
72 This will replace the usage of not setting ``DEV_RX_OFFLOAD_CRC_STRIP`` flag
73 and will be implemented in PMDs accordingly.
74 In v18.08 both ``DEV_RX_OFFLOAD_KEEP_CRC`` and ``DEV_RX_OFFLOAD_CRC_STRIP`` flags
75 will be available, usage will be:
76 ``CRC_STRIP``: Strip CRC from packet
77 ``KEEP_CRC``: Keep CRC in packet
78 Both ``CRC_STRIP`` & ``KEEP_CRC``: Invalid
79 No flag: Keep CRC in packet
81 * ethdev: In v18.11 ``DEV_RX_OFFLOAD_CRC_STRIP`` offload flag will be removed, default
82 behavior without any flag will be changed to CRC strip.
83 To keep CRC ``DEV_RX_OFFLOAD_KEEP_CRC`` flag is required.
84 ``KEEP_CRC``: Keep CRC in packet
85 No flag: Strip CRC from packet
87 * ethdev: the legacy filter API, including
88 ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
89 as filter types MACVLAN, ETHERTYPE, FLEXIBLE, SYN, NTUPLE, TUNNEL, FDIR,
90 HASH and L2_TUNNEL, is superseded by the generic flow API (rte_flow) in
91 PMDs that implement the latter.
92 Target release for removal of the legacy API will be defined once most
93 PMDs have switched to rte_flow.
95 * pdump: As we changed to use generic IPC, some changes in APIs and structure
96 are expected in subsequent release.
98 - ``rte_pdump_set_socket_dir`` will be removed;
99 - The parameter, ``path``, of ``rte_pdump_init`` will be removed;
100 - The enum ``rte_pdump_socktype`` will be removed.
102 * cryptodev: The following changes will be made in the library
105 - Removal of ``sym`` structure in ``rte_cryptodev_info`` structure,
106 containing fields not relevant anymore since the session mempool
107 is not internal in the crypto device anymore.
108 - Replacement of ``pci_dev`` field with the more generic ``rte_device``
110 - Functions ``rte_cryptodev_queue_pair_attach_sym_session()`` and
111 ``rte_cryptodev_queue_pair_dettach_sym_session()`` will be deprecated from
112 18.05 and removed in 18.08, as there are no drivers doing anything useful
114 - Functions ``rte_cryptodev_queue_pair_start()`` and
115 ``rte_cryptodev_queue_pair_stop()`` will be deprecated from 18.05
116 and removed in 18.08, as there are no drivers doing anything useful
118 - Some feature flags such as ``RTE_CRYPTODEV_FF_MBUF_SCATTER_GATHER`` are ambiguous,
119 so some will be replaced by more explicit flags.
120 - Function ``rte_cryptodev_get_header_session_size()`` will be deprecated
121 in 18.05, and it gets replaced with ``rte_cryptodev_sym_get_header_session_size()``.
122 It will be removed in 18.08.
123 - Function ``rte_cryptodev_get_private_session_size()`` will be deprecated
124 in 18.05, and it gets replaced with ``rte_cryptodev_sym_get_private_session_size()``.
125 It will be removed in 18.08.