Deprecation Notices
-------------------
-* eal: the following functions are deprecated starting from 17.05 and will
- be removed in 17.11:
-
- - ``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``
-
-* 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: the support of Xen dom0 will be removed from EAL in 17.11; and with
- that, drivers/net/xenvirt and examples/vhost_xen will also be removed.
-
-* eal: An ABI change is planned for 17.11 to make DPDK aware of IOVA address
- translation scheme.
- Reference to phys address in EAL data-structure or functions may change to
- IOVA address or more appropriate name.
- The change will be only for the name.
- Functional aspects of the API or data-structure will remain same.
-
-* 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.
-
-* 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: 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.08.
+ 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.
+
+ - 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``
+
+* 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: In v18.11 ``DEV_RX_OFFLOAD_CRC_STRIP`` offload flag will be removed, default
+ behavior without any flag will be changed to CRC strip.
+ To keep CRC ``DEV_RX_OFFLOAD_KEEP_CRC`` flag is required.
+ ``KEEP_CRC``: Keep CRC in packet
+ No flag: Strip CRC from packet
* 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: The device flag advertizing hotplug capability
- ``RTE_ETH_DEV_DETACHABLE`` is not needed anymore and will be removed in
- v17.11.
- This capability is verified upon calling the relevant hotplug functions in EAL
- by checking that the ``unplug`` ops is set in the bus. This verification is
- done by the EAL and not by the ``ethdev`` layer anymore. Users relying on this
- flag being present only have to remove their checks to follow the change.
+* 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.
-* ethdev: An ABI change is planned for 17.11 for the structure rte_eth_dev_data.
- The size of the unique name will increase RTE_ETH_NAME_MAX_LEN from 32 to
- 64 characters to allow using a globally unique identifier (GUID) in this field.
+* 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.
-* 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.
-* 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 function is deprecated starting from 17.08 and will
- be removed in 17.11:
-
- - ``rte_cryptodev_create_vdev``
-
-* cryptodev: the following function will be static in 17.11 and included
- by all crypto drivers, therefore, will not be public:
-
- - ``rte_cryptodev_vdev_pmd_init``
-
-* cryptodev: the following function will have an extra parameter, passing a
- statically allocated crypto driver structure, instead of calling malloc,
- in 17.11:
-
- - ``rte_cryptodev_allocate_driver``
-
-* librte_meter: The API will change to accommodate configuration profiles.
- Most of the API functions will have an additional opaque parameter.
-
-* 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.
+ - ``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.
git.droids-corp.org / dpdk.git / blobdiff