X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Frel_notes%2Fdeprecation.rst;h=845d2aa188ccb24a69ebd8b5ad41b57f2af41695;hb=c711ccb30987037691f2564a053926a89d87985f;hp=80f873de6676fed929abc96ae048fdfb0f4f3e58;hpb=449c49b93a6b87506c7bb07468e82b539efddca3;p=dpdk.git diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index 80f873de66..845d2aa188 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -8,8 +8,15 @@ API and ABI deprecation notices are to be posted here. 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 @@ -23,18 +30,35 @@ Deprecation Notices 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 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 will change for rte_mempool struct to move the cache-related fields - to the more appropriate rte_mempool_cache struct. The mempool API is - also changed to enable external cache management that is not tied to EAL - threads. Some mempool get and put calls are removed in favor of a more - compact API. The ones that remain are backwards compatible and use the - per-lcore default cache if available. This change targets release 16.07. +* 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. + +* mempool: The functions ``rte_mempool_count`` and ``rte_mempool_free_count`` + will be removed in 17.02. + They are replaced by ``rte_mempool_avail_count`` and + ``rte_mempool_in_use_count`` respectively. + +* mempool: The functions for single/multi producer/consumer are deprecated + and will be removed in 17.02. + It is replaced by ``rte_mempool_generic_get/put`` functions. + +* 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.