ring: support freeing
[dpdk.git] / doc / guides / rel_notes / deprecation.rst
1 ABI and API Deprecation
2 =======================
3
4 See the :doc:`guidelines document for details of the ABI policy </contributing/versioning>`.
5 API and ABI deprecation notices are to be posted here.
6
7
8 Deprecation Notices
9 -------------------
10
11 * The following fields have been deprecated in rte_eth_stats:
12   ibadcrc, ibadlen, imcasts, fdirmatch, fdirmiss,
13   tx_pause_xon, rx_pause_xon, tx_pause_xoff, rx_pause_xoff
14
15 * ABI changes are planned for struct rte_eth_fdir_flow_ext in order to support
16   flow director filtering in VF. The release 2.1 does not contain these ABI
17   changes, but release 2.2 will, and no backwards compatibility is planned.
18
19 * ABI changes are planned for struct rte_eth_fdir_filter and
20   rte_eth_fdir_masks in order to support new flow director modes,
21   MAC VLAN and Cloud, on x550. The MAC VLAN mode means the MAC and
22   VLAN are monitored. The Cloud mode is for VxLAN and NVGRE, and
23   the tunnel type, TNI/VNI, inner MAC and inner VLAN are monitored.
24   The release 2.2 will contain these changes without backwards compatibility.
25
26 * ABI changes are planned for struct virtio_net in order to support vhost-user
27   multiple queues feature.
28   It should be integrated in release 2.2 without backward compatibility.
29
30 * The scheduler hierarchy structure (rte_sched_port_hierarchy) will change to
31   allow for a larger number of subport entries.
32   The number of available traffic_classes and queues may also change.
33   The mbuf structure element for sched hierarchy will also change from a single
34   32 bit to a 64 bit structure.
35
36 * The scheduler statistics structure will change to allow keeping track of
37   RED actions.
38
39 * librte_table: New functions for table entry bulk add/delete will be added
40   to the table operations structure.
41
42 * librte_table hash: Key mask parameter will be added to the hash table
43   parameter structure for 8-byte key and 16-byte key extendible bucket and
44   LRU tables.
45
46 * librte_pipeline: The prototype for the pipeline input port, output port
47   and table action handlers will be updated:
48   the pipeline parameter will be added, the packets mask parameter will be
49   either removed (for input port action handler) or made input-only.