X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Frel_notes%2Fdeprecation.rst;h=ad05ebabaffa7138f09131a4db3a41487dbc1e34;hb=587d684d70f9d7f74e77a886c58103b40409caea;hp=f033bbc869c8b88d307bfffa3c695e54feb10257;hpb=88ac2fd99fa06419c5b95ad662dc1e618bd8ac49;p=dpdk.git diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index f033bbc869..ad05ebabaf 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -8,36 +8,52 @@ API and ABI deprecation notices are to be posted here. 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. - -* 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 ethdev structures rte_eth_link, rte_eth_dev_info and rte_eth_conf - must be updated to support 100G link and to have a cleaner link speed API. - -* ABI changes are planned for struct rte_eth_fdir_flow in order to support - extend flow director's input set. The release 2.2 does not contain these ABI - changes, but release 2.3 will, and no backwards compatibility is planned. - -* ABI changes are planned for rte_eth_ipv4_flow and rte_eth_ipv6_flow to - include more fields to be matched against. The release 2.2 does not - contain these ABI changes, but release 2.3 will. +* 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 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 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. - -* ABI changes are planned for rte_eth_tunnel_filter_conf. Change the fields - of outer_mac and inner_mac from pointer to struct in order to keep the - code's readability. The release 2.2 does not contain these ABI changes, but - release 2.3 will, and no backwards compatibility is planned. - -* The scheduler statistics structure will change to allow keeping track of - RED actions. + 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. + +* 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. + +* A librte_vhost public structures refactor is planned for DPDK 16.07 + that requires both ABI and API change. + The proposed refactor would expose DPDK vhost dev to applications as + a handle, like the way kernel exposes an fd to user for locating a + specific file, and to keep all major structures internally, so that + we are likely to be free from ABI violations in future.