Deprecation Notices
-------------------
-* The EAL function pci_config_space_set is deprecated in release 16.04
- and will be removed from 16.07.
- Macros CONFIG_RTE_PCI_CONFIG, CONFIG_RTE_PCI_EXTENDED_TAG and
- CONFIG_RTE_PCI_MAX_READ_REQUEST_SIZE will be removed.
- The /sys entries extended_tag and max_read_request_size created by igb_uio
- will be removed.
-
-* ABI changes are planned for struct rte_pci_id, i.e., add new field ``class``.
- This new added ``class`` field can be used to probe pci device by class
- related info. This change should impact size of struct rte_pci_id and struct
- rte_pci_device. The release 16.04 does not contain these ABI changes, but
- release 16.07 will.
-
-* The following fields have been deprecated in rte_eth_stats:
- ibadcrc, ibadlen, imcasts, fdirmatch, fdirmiss,
- tx_pause_xon, rx_pause_xon, tx_pause_xoff, rx_pause_xoff
-
-* The xstats API and rte_eth_xstats struct will be changed to allow retrieval
- of values without any string copies or parsing.
- No backwards compatibility is planned, as it would require code duplication
- in every PMD that supports xstats.
-
-* ABI changes are planned for adding four new flow types. This impacts
- RTE_ETH_FLOW_MAX. The release 2.2 does not contain these ABI changes,
- but release 2.3 will. [postponed]
-
-* ABI change is planned for the rte_mempool structure to allow mempool
- cache support to be dynamic depending on the mempool being created
- needing cache support. Saves about 1.5M of memory per rte_mempool structure
- by removing the per lcore cache memory. Change will occur in DPDK 16.07
- release and will skip the define RTE_NEXT_ABI in DPDK 16.04 release. The
- code affected is app/test/test_mempool.c and librte_mempool/rte_mempool.[ch].
- The rte_mempool.local_cache will be converted from an array to a pointer to
- allow for dynamic allocation of the per lcore cache memory.
-
-* The rte_mempool struct will be changed in 16.07 to facilitate the new
- external mempool manager functionality.
- The ring element will be replaced with a more generic 'pool' opaque pointer
- to allow new mempool handlers to use their own user-defined mempool
- layout. Also newly added to rte_mempool is a handler index.
- The existing API will be backward compatible, but there will be new API
- functions added to facilitate the creation of mempools using an external
- handler. The 16.07 release will contain these changes.
-
-* The rte_mempool allocation will be changed in 16.07:
- allocation of large mempool in several virtual memory chunks, new API
- to populate a mempool, new API to free a mempool, allocation in
- anonymous mapping, drop of specific dom0 code. These changes will
- induce a modification of the rte_mempool structure, plus a
- modification of the API of rte_mempool_obj_iter(), implying a breakage
- of the ABI.
-
-* ABI changes are planned for struct rte_port_source_params in order to
- support PCAP file reading feature. The release 16.04 contains this ABI
- change wrapped by RTE_NEXT_ABI macro. Release 16.07 will contain this
- change, and no backwards compatibility is planned.
+* 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.
git.droids-corp.org / dpdk.git / blobdiff