Deprecation Notices
-------------------
-* The log history is deprecated.
- It is voided in 16.07 and will be removed in release 16.11.
-
-* The ethdev library file will be renamed from libethdev.* to librte_ethdev.*
- in release 16.11 in order to have a more consistent namespace.
-
-* In 16.11 ABI changes are planned: the ``rte_eth_dev`` structure will be
- extended with new function pointer ``tx_pkt_prep`` allowing verification
- and processing of packet burst to meet HW specific requirements before
- transmit. Also new fields will be added to the ``rte_eth_desc_lim`` structure:
- ``nb_seg_max`` and ``nb_mtu_seg_max`` providing information about number of
- segments limit to be transmitted by device for TSO/non-TSO packets.
-
-* The ethdev hotplug API is going to be moved to EAL with a notification
- mechanism added to crypto and ethdev libraries so that hotplug is now
- available to both of them. This API will be stripped of the device arguments
- so that it only cares about hotplugging.
-
-* Structures embodying pci and vdev devices are going to be reworked to
- integrate new common rte_device / rte_driver objects (see
- http://dpdk.org/ml/archives/dev/2016-January/031390.html).
- ethdev and crypto libraries will then only handle those objects so that they
- do not need to care about the kind of devices that are being used, making it
- easier to add new buses later.
-
-* ABI changes are planned for 16.11 in the ``rte_mbuf`` structure: some fields
- may be reordered to facilitate the writing of ``data_off``, ``refcnt``, and
- ``nb_segs`` in one operation, because some platforms have an overhead if the
- store address is not naturally aligned. Other mbuf fields, such as the
- ``port`` field, may be moved or removed as part of this mbuf work.
-
-* 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 in 16.07 and will be removed in 16.11.
-
-* The APIs rte_mempool_count and rte_mempool_free_count are being deprecated
- on the basis that they are confusing to use - free_count actually returns
- the number of allocated entries, not the number of free entries as expected.
- They are being replaced by rte_mempool_avail_count and
- rte_mempool_in_use_count respectively.
-
-* The mempool functions for single/multi producer/consumer are deprecated and
- will be removed in 16.11.
- It is replaced by rte_mempool_generic_get/put functions.
-
-* The ``rte_ivshmem`` feature (including library and EAL code) will be removed
- in 16.11 because it has some design issues which are not planned to be fixed.
-
-* The vhost-cuse will be removed in 16.11. Since v2.1, a large majority of
- development effort has gone to vhost-user, such as multiple-queue, live
- migration, reconnect etc. Therefore, vhost-user should be used instead.
-
-* Driver names are quite inconsistent among each others and they will be
- renamed to something more consistent (net and crypto prefixes) in 16.11.
- Some of these driver names are used publicly, to create virtual devices,
- so a deprecation notice is necessary.
-
-* API will change for ``rte_port_source_params`` and ``rte_port_sink_params``
- structures. The member ``file_name`` data type will be changed from
- ``char *`` to ``const char *``. This change targets release 16.11.
+* 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.
+ - The ``rte_devargs_list`` will be made private.
+ - Functions previously deprecated will change or disappear:
+
+ + ``rte_eal_devargs_add``
+ + ``rte_eal_devargs_type_count``
+ + ``rte_eal_parse_devargs_str``, replaced by ``rte_eal_devargs_parse``
+ + ``rte_eal_devargs_parse`` will change its format and use.
+ + all ``rte_devargs`` related functions will be renamed, changing the
+ ``rte_eal_devargs_`` prefix to ``rte_devargs_``.
+
+* 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: The semantics of the return value for the ``rte_lcore_has_role`` function
+ are planned to change in v18.05. The function currently returns 0 and <0 for
+ success and failure, respectively. This will change to 1 and 0 for true and
+ false, respectively, to make use of the function more intuitive.
+
+* eal: new ``numa_node_count`` member will be added to ``rte_config`` structure
+ in v18.05.
+
+* eal: due to internal data layout reorganization, there will be changes to
+ several structures and functions as a result of coming changes to support
+ memory hotplug in v18.05.
+ ``rte_eal_get_physmem_layout`` will be deprecated and removed in subsequent
+ releases.
+ ``rte_mem_config`` contents will change due to switch to memseg lists.
+ ``rte_memzone`` member ``memseg_id`` will no longer serve any useful purpose
+ and will be removed.
+
+* 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``
+
+* mempool: several API and ABI changes are planned in v18.05.
+ The following functions, introduced for Xen, which is not supported
+ anymore since v17.11, are hard to use, not used anywhere else in DPDK.
+ Therefore they will be deprecated in v18.05 and removed in v18.08:
+
+ - ``rte_mempool_xmem_create``
+ - ``rte_mempool_xmem_size``
+ - ``rte_mempool_xmem_usage``
+
+ The following changes are planned:
+
+ - removal of ``get_capabilities`` mempool ops and related flags.
+ - substitute ``register_memory_area`` with ``populate`` ops.
+ - addition of new ops to customize required memory chunk calculation,
+ customize objects population and allocate contiguous
+ block of objects if underlying driver supports it.
+
+* mbuf: The control mbuf API will be removed in v18.05. The impacted
+ functions and macros are:
+
+ - ``rte_ctrlmbuf_init()``
+ - ``rte_ctrlmbuf_alloc()``
+ - ``rte_ctrlmbuf_free()``
+ - ``rte_ctrlmbuf_data()``
+ - ``rte_ctrlmbuf_len()``
+ - ``rte_is_ctrlmbuf()``
+ - ``CTRL_MBUF_FLAG``
+
+ The packet mbuf API should be used as a replacement.
+
+* 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.
+ The old offloads API is target to be deprecated on 18.05. This includes:
+
+ - 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.
+
+* ethdev: A new rss level field planned in 18.05.
+ The new API add rss_level field to ``rte_eth_rss_conf`` to enable a choice
+ of RSS hash calculation on outer or inner header of tunneled packet.
+
+* ethdev: Currently, if the rte_eth_rx_burst() function returns a value less
+ than *nb_pkts*, the application will assume that no more packets are present.
+ Some of the hw queue based hardware can only support smaller burst for RX
+ and TX and thus break the expectation of the rx_burst API. Similar is the
+ case for TX burst as well as ring sizes. ``rte_eth_dev_info`` will be added
+ with following new parameters so as to support semantics for drivers to
+ define a preferred size for Rx/Tx burst and rings.
+
+ - Member ``struct preferred_size`` would be added to enclose all preferred
+ size to be fetched from driver/implementation.
+ - Members ``uint16_t rx_burst``, ``uint16_t tx_burst``, ``uint16_t rx_ring``,
+ and ``uint16_t tx_ring`` would be added to ``struct preferred_size``.
+
+* ethdev: A work is being planned for 18.05 to expose VF port representors
+ as a mean to perform control and data path operation on the different VFs.
+ As VF representor is an ethdev port, new fields are needed in order to map
+ between the VF representor and the VF or the parent PF. Those new fields
+ are to be included in ``rte_eth_dev_info`` struct.
+
+* ethdev: The prototype and the behavior of
+ ``dev_ops->eth_mac_addr_set()`` will change in v18.05. A return code
+ will be added to notify the caller if an error occurred in the PMD. In
+ ``rte_eth_dev_default_mac_addr_set()``, the new default MAC address
+ will be copied in ``dev->data->mac_addrs[0]`` only if the operation is
+ successful. This modification will only impact the PMDs, not the
+ applications.
+
+* ethdev: functions add rx/tx callback will return named opaque type
+ ``rte_eth_add_rx_callback()``, ``rte_eth_add_first_rx_callback()`` and
+ ``rte_eth_add_tx_callback()`` functions currently return callback object as
+ ``void \*`` but APIs to delete callbacks get ``struct rte_eth_rxtx_callback \*``
+ as parameter. For consistency functions adding callback will return
+ ``struct rte_eth_rxtx_callback \*`` instead of ``void \*``.
+
+* ethdev: The size of variables ``flow_types_mask`` in
+ ``rte_eth_fdir_info structure``, ``sym_hash_enable_mask`` and
+ ``valid_bit_mask`` in ``rte_eth_hash_global_conf`` structure
+ will be increased from 32 to 64 bits to fulfill hardware requirements.
+ This change will break existing ABI as size of the structures will increase.
+
+* ethdev: ``rte_eth_dev_get_sec_ctx()`` fix port id storage
+ ``rte_eth_dev_get_sec_ctx()`` is using ``uint8_t`` for ``port_id``,
+ which should be ``uint16_t``.
+
+* 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.
+
+* librte_meter: The API will change to accommodate configuration profiles.
+ Most of the API functions will have an additional opaque parameter.
+
+* ring: The alignment constraints on the ring structure will be relaxed
+ to one cache line instead of two, and an empty cache line padding will
+ be added between the producer and consumer structures. The size of the
+ structure and the offset of the fields will remain the same on
+ platforms with 64B cache line, but will change on other platforms.
Code Review / deb_dpdk.git / blobdiff