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: both declaring and identifying devices will be streamlined in v18.08.
12 New functions will appear to query a specific port from buses, classes of
13 device and device drivers. Device declaration will be made coherent with the
14 new scheme of device identification.
15 As such, ``rte_devargs`` device representation will change.
17 - The enum ``rte_devtype`` was used to identify a bus and will disappear.
18 - Functions previously deprecated will change or disappear:
20 + ``rte_eal_devargs_type_count``
21 + ``rte_eal_devargs_parse`` will change its format and use.
23 * pci: Several exposed functions are misnamed.
24 The following functions are deprecated starting from v17.11 and are replaced:
26 - ``eal_parse_pci_BDF`` replaced by ``rte_pci_addr_parse``
27 - ``eal_parse_pci_DomBDF`` replaced by ``rte_pci_addr_parse``
28 - ``rte_eal_compare_pci_addr`` replaced by ``rte_pci_addr_cmp``
30 * eal: a new set of mbuf mempool ops name APIs for user, platform and best
31 mempool names have been defined in ``rte_mbuf`` in v18.02. The uses of
32 ``rte_eal_mbuf_default_mempool_ops`` shall be replaced by
33 ``rte_mbuf_best_mempool_ops``.
34 The following function is deprecated since 18.05, and will be removed
37 - ``rte_eal_mbuf_default_mempool_ops``
39 * mbuf: The opaque ``mbuf->hash.sched`` field will be updated to support generic
40 definition in line with the ethdev TM and MTR APIs. Currently, this field
41 is defined in librte_sched in a non-generic way. The new generic format
42 will contain: queue ID, traffic class, color. Field size will not change.
44 * mbuf: the macro ``RTE_MBUF_INDIRECT()`` will be removed in v18.08 or later and
45 replaced with ``RTE_MBUF_CLONED()`` which is already added in v18.05. As
46 ``EXT_ATTACHED_MBUF`` is newly introduced in v18.05, ``RTE_MBUF_INDIRECT()``
47 can no longer be mutually exclusive with ``RTE_MBUF_DIRECT()`` if the new
48 experimental API ``rte_pktmbuf_attach_extbuf()`` is used. Removal of the macro
49 is to fix this semantic inconsistency.
51 * ethdev: In v18.11 ``DEV_RX_OFFLOAD_CRC_STRIP`` offload flag will be removed, default
52 behavior without any flag will be changed to CRC strip.
53 To keep CRC ``DEV_RX_OFFLOAD_KEEP_CRC`` flag is required.
54 ``KEEP_CRC``: Keep CRC in packet
55 No flag: Strip CRC from packet
57 * ethdev: the legacy filter API, including
58 ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
59 as filter types MACVLAN, ETHERTYPE, FLEXIBLE, SYN, NTUPLE, TUNNEL, FDIR,
60 HASH and L2_TUNNEL, is superseded by the generic flow API (rte_flow) in
61 PMDs that implement the latter.
62 Target release for removal of the legacy API will be defined once most
63 PMDs have switched to rte_flow.
65 * ethdev: In v18.11 ``rte_eth_dev_attach()`` and ``rte_eth_dev_detach()``
67 Hotplug functions ``rte_eal_hotplug_add()`` and ``rte_eal_hotplug_remove()``
68 should be used instread.
69 Function ``rte_eth_dev_get_port_by_name()`` may be used to find
70 identifier of the added port.
72 * pdump: As we changed to use generic IPC, some changes in APIs and structure
73 are expected in subsequent release.
75 - ``rte_pdump_set_socket_dir`` will be removed;
76 - The parameter, ``path``, of ``rte_pdump_init`` will be removed;
77 - The enum ``rte_pdump_socktype`` will be removed.