-Deprecation
-===========
+ABI and API Deprecation
+=======================
See the :doc:`guidelines document for details of the ABI policy </contributing/versioning>`.
API and ABI deprecation notices are to be posted here.
-Help to update from a previous release is provided in
-:doc:`another section </rel_notes/updating_apps>`.
-
Deprecation Notices
-------------------
-* Significant ABI changes are planned for struct rte_eth_dev to support up to
- 1024 queues per port. This change will be in release 2.2.
- There is no backward compatibility planned from release 2.2.
- All binaries will need to be rebuilt from release 2.2.
+* 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 EAL function rte_eal_pci_close_one is deprecated because renamed to
- rte_eal_pci_detach.
+* 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.
-* The Macros RTE_HASH_BUCKET_ENTRIES_MAX and RTE_HASH_KEY_LENGTH_MAX are
- deprecated and will be removed with version 2.2.
+* ABI changes is planned for the reta field in struct rte_eth_rss_reta_entry64
+ which handles at most 256 entries (8 bits) while newer NICs support larger
+ tables (512 entries).
+ It should be integrated in release 2.3.
-* Significant ABI changes are planned for struct rte_mbuf, struct rte_kni_mbuf,
- and several ``PKT_RX_`` flags will be removed, to support unified packet type
- from release 2.1. Those changes may be enabled in the upcoming release 2.1
- with CONFIG_RTE_NEXT_ABI.
+* 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.
-* librte_malloc library has been integrated into librte_eal. The 2.1 release
- creates a dummy/empty malloc library to fulfill binaries with dynamic linking
- dependencies on librte_malloc.so. Such dummy library will not be created from
- release 2.2 so binaries will need to be rebuilt.
+* 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 following fields have been deprecated in rte_eth_stats:
- imissed, ibadcrc, ibadlen, imcasts, fdirmatch, fdirmiss,
- tx_pause_xon, rx_pause_xon, tx_pause_xoff, rx_pause_xoff
+* The scheduler statistics structure will change to allow keeping track of
+ RED actions.
+
+* librte_pipeline: The prototype for the pipeline input port, output port
+ and table action handlers will be updated:
+ the pipeline parameter will be added, the packets mask parameter will be
+ either removed (for input port action handler) or made input-only.
+
+* ABI changes are planned in cmdline buffer size to allow the use of long
+ commands (such as RETA update in testpmd). This should impact
+ CMDLINE_PARSE_RESULT_BUFSIZE, STR_TOKEN_SIZE and RDLINE_BUF_SIZE.
+ It should be integrated in release 2.3.