Deprecation Notices
-------------------
-* 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
-
-* 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.
-
-* 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.
+* ring: Changes are planned to rte_ring APIs in release 17.05. Proposed
+ changes include:
+
+ - Removing build time options for the ring:
+ CONFIG_RTE_RING_SPLIT_PROD_CONS
+ CONFIG_RTE_RING_PAUSE_REP_COUNT
+ - Adding an additional parameter to enqueue functions to return the
+ amount of free space in the ring
+ - Adding an additional parameter to dequeue functions to return the
+ number of remaining elements in the ring
+ - Removing direct support for watermarks in the rings, since the
+ additional return value from the enqueue function makes it
+ unneeded
+ - Adjusting the return values of the bulk() enq/deq functions to
+ make them consistent with the burst() equivalents. [Note, parameter
+ to these functions are changing too, per points above, so compiler
+ will flag them as needing update in legacy code]
+ - Updates to some library functions e.g. rte_ring_get_memsize() to
+ allow for variably-sized ring elements.
+
+* igb_uio: iomem mapping and sysfs files created for iomem and ioport in
+ igb_uio will be removed, because we are able to detect these from what Linux
+ has exposed, like the way we have done with uio-pci-generic. This change
+ targets release 17.05.
+
+* vfio: Some functions are planned to be exported outside librte_eal in 17.05.
+ VFIO APIs like ``vfio_setup_device``, ``vfio_get_group_fd`` can be used by
+ subsystem other than EAL/PCI. For that, these need to be exported symbols.
+ Such APIs are planned to be renamed according to ``rte_*`` naming convention
+ and exported from librte_eal.
+
+* The PCI and VDEV subsystems will be converted as drivers of the new bus model.
+ It will imply some EAL API changes in 17.05.
+
+* ``eth_driver`` is planned to be removed in 17.05. This currently serves as
+ a placeholder for PMDs to register themselves. Changes for ``rte_bus`` will
+ provide a way to handle device initialization currently being done in
+ ``eth_driver``. Similarly, ``rte_pci_driver`` is planned to be removed from
+ ``rte_cryptodev_driver`` in 17.05.
+
+* ethdev: An API change is planned for 17.05 for the function
+ ``_rte_eth_dev_callback_process``. In 17.05 the function will return an ``int``
+ instead of ``void`` and a fourth parameter ``void *ret_param`` will be added.
+
+* ABI changes are planned for 17.05 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. A
+ ``timestamp`` will also be added.
+
+* 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 until 17.02 and will be removed in 17.05.
+
+* mempool: The functions ``rte_mempool_count`` and ``rte_mempool_free_count``
+ will be removed in 17.05.
+ 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.05.
+ It is replaced by ``rte_mempool_generic_get/put`` functions.
+
+* ethdev: the legacy filter API, including
+ ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
+ as filter types MACVLAN, ETHERTYPE, FLEXIBLE, SYN, NTUPLE, TUNNEL, FDIR,
+ HASH and L2_TUNNEL, is superseded by the generic flow API (rte_flow) in
+ PMDs that implement the latter.
+ Target release for removal of the legacy API will be defined once most
+ PMDs have switched to rte_flow.
+
+* distributor: library API will be changed to incorporate a burst-oriented
+ API. This will include a change to ``rte_distributor_create``
+ to specify which type of instance to create (single or burst), and
+ additional calls for ``rte_distributor_poll_pkt_burst`` and
+ ``rte_distributor_return_pkt_burst``, among others.
+
+* The architecture TILE-Gx and the associated mpipe driver are not
+ maintained and will be removed in 17.05.
git.droids-corp.org / dpdk.git / blobdiff