X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fguides%2Frel_notes%2Fdeprecation.rst;h=138335dfb5c7017952a18bac5e904d507aa6646c;hb=b65eb10c4db7c976f989e6d21e98dc4001becfc6;hp=fd4728520204f91104839bf531ac020c03117c09;hpb=5eba8e38bed16f0106532a957f67a53314370135;p=dpdk.git diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index fd47285202..138335dfb5 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -1,3 +1,6 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright 2018 The DPDK contributors + ABI and API Deprecation ======================= @@ -8,32 +11,50 @@ API and ABI deprecation notices are to be posted here. Deprecation Notices ------------------- -* eal: the following functions are deprecated starting from 17.05 and will - be removed in 17.11: +* eal: certain structures will change in EAL on account of upcoming external + memory support. Aside from internal changes leading to an ABI break, the + following externally visible changes will also be implemented: + + - ``rte_memseg_list`` will change to include a boolean flag indicating + whether a particular memseg list is externally allocated. This will have + implications for any users of memseg-walk-related functions, as they will + now have to skip externally allocated segments in most cases if the intent + is to only iterate over internal DPDK memory. + - ``socket_id`` parameter across the entire DPDK will gain additional meaning, + as some socket ID's will now be representing externally allocated memory. No + changes will be required for existing code as backwards compatibility will + be kept, and those who do not use this feature will not see these extra + socket ID's. + +* eal: both declaring and identifying devices will be streamlined in v18.11. + 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. - - ``rte_set_log_level``, replaced by ``rte_log_set_global_level`` - - ``rte_get_log_level``, replaced by ``rte_log_get_global_level`` - - ``rte_set_log_type``, replaced by ``rte_log_set_level`` - - ``rte_get_log_type``, replaced by ``rte_log_get_level`` + - The enum ``rte_devtype`` was used to identify a bus and will disappear. + - Functions previously deprecated will change or disappear: -* devargs: An ABI change is planned for 17.08 for the structure ``rte_devargs``. - The current version is dependent on bus-specific device identifier, which will - be made generic and abstracted, in order to make the EAL bus-agnostic. + + ``rte_eal_devargs_type_count`` - Accompanying this evolution, device command line parameters will thus support - explicit bus definition in a device declaration. +* pci: Several exposed functions are misnamed. + The following functions are deprecated starting from v17.11 and are replaced: -* 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 until 17.08 and will be removed in 17.11. + - ``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`` -* 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. +* 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. + +* mbuf: the macro ``RTE_MBUF_INDIRECT()`` will be removed in v18.08 or later and + replaced with ``RTE_MBUF_CLONED()`` which is already added in v18.05. As + ``EXT_ATTACHED_MBUF`` is newly introduced in v18.05, ``RTE_MBUF_INDIRECT()`` + can no longer be mutually exclusive with ``RTE_MBUF_DIRECT()`` if the new + experimental API ``rte_pktmbuf_attach_extbuf()`` is used. Removal of the macro + is to fix this semantic inconsistency. * ethdev: the legacy filter API, including ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well @@ -43,18 +64,28 @@ Deprecation Notices Target release for removal of the legacy API will be defined once most PMDs have switched to rte_flow. -* librte_table: The ``key_mask`` parameter will be added to all the hash tables - that currently do not have it, as well as to the hash compute function prototype. - The non-"do-sig" versions of the hash tables will be removed - (including the ``signature_offset`` parameter) - and the "do-sig" versions renamed accordingly. +* ethdev: In v18.11 ``rte_eth_dev_attach()`` and ``rte_eth_dev_detach()`` + will be removed. + Hotplug functions ``rte_eal_hotplug_add()`` and ``rte_eal_hotplug_remove()`` + should be used instread. + Function ``rte_eth_dev_get_port_by_name()`` may be used to find + identifier of the added port. + +* eal: In v18.11 ``rte_eal_dev_attach()`` and ``rte_eal_dev_detach()`` + will be removed. + Hotplug functions ``rte_eal_hotplug_add()`` and ``rte_eal_hotplug_remove()`` + should be used directly. -* eal: the following function is deprecated starting from 17.08 and will - be removed in 17.11: +* pdump: As we changed to use generic IPC, some changes in APIs and structure + are expected in subsequent release. - - ``rte_eal_parse_devargs_str``, replaced by ``rte_eal_devargs_parse`` + - ``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 function is deprecated starting from 17.08 and will - be removed in 17.11: +* ethdev: flow API function ``rte_flow_copy()`` will be deprecated in v18.11 + in favor of ``rte_flow_conv()`` (which will appear in that version) and + subsequently removed for v19.02. - - ``rte_cryptodev_create_vdev`` + This is due to a lack of flexibility and reliance on a type unusable with + C++ programs (struct rte_flow_desc).