X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Frel_notes%2Fdeprecation.rst;h=a3e7c720cedb66bff1e9dc24047d2bca000b4aa2;hb=9e5c3faecc152a53b1474312ad29f097d7044e87;hp=3fa4c90bb84bfc7cbaf865c8edb3235259a30be1;hpb=5eaef15c1925b25237f5ef32b20b5701f95419e6;p=dpdk.git diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index 3fa4c90bb8..a3e7c720ce 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -8,84 +8,76 @@ API and ABI deprecation notices are to be posted here. 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 Macros RTE_HASH_BUCKET_ENTRIES_MAX and RTE_HASH_KEY_LENGTH_MAX are - deprecated and will be removed with version 2.2. - -* The function rte_jhash2 is deprecated and should be removed. - -* The field mem_location of the rte_lpm structure is deprecated and should be - removed as well as the macros RTE_LPM_HEAP and RTE_LPM_MEMZONE. - -* 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 - -* API for flow director filters has been replaced by rte_eth_dev_filter_ctrl. - Following old API is deprecated and will be removed with version 2.2 without - backward compatibility. - Functions: rte_eth_dev_fdir_*. - Structures: rte_fdir_*, rte_eth_fdir. - Enums: rte_l4type, rte_iptype. - -* ABI changes are planned for struct rte_eth_fdir_flow_ext in order to support - flow director filtering in VF. The release 2.1 does not contain these ABI - changes, but release 2.2 will, and no backwards compatibility is planned. - -* ABI changes are planned for struct rte_eth_fdir_filter and - rte_eth_fdir_masks in order to support new flow director modes, - MAC VLAN and Cloud, on x550. The MAC VLAN mode means the MAC and - VLAN are monitored. The Cloud mode is for VxLAN and NVGRE, and - the tunnel type, TNI/VNI, inner MAC and inner VLAN are monitored. - The release 2.2 will contain these changes without backwards compatibility. - -* librte_kni: Functions based on port id are deprecated for a long time and - should be removed (rte_kni_create, rte_kni_get_port_id and rte_kni_info_get). - -* librte_pmd_ring: The deprecated functions rte_eth_ring_pair_create and - rte_eth_ring_pair_attach should be removed. - -* ABI changes are planned for struct virtio_net in order to support vhost-user - multiple queues feature. - It should be integrated in release 2.2 without backward compatibility. - -* The scheduler hierarchy structure (rte_sched_port_hierarchy) will change to - allow for a larger number of subport entries. - The number of available traffic_classes and queues may also change. - The mbuf structure element for sched hierarchy will also change from a single - 32 bit to a 64 bit structure. - -* The scheduler statistics structure will change to allow keeping track of - RED actions. - -* librte_acl: The structure rte_acl_ipv4vlan_rule is deprecated and should - be removed as well as the associated functions rte_acl_ipv4vlan_add_rules - and rte_acl_ipv4vlan_build. - -* librte_cfgfile: In order to allow for longer names and values, - the value of macros CFG_NAME_LEN and CFG_NAME_VAL will be increased. - Most likely, the new values will be 64 and 256, respectively. - -* librte_port: Macros to access the packet meta-data stored within the - packet buffer will be adjusted to cover the packet mbuf structure as well, - as currently they are able to access any packet buffer location except the - packet mbuf structure. - -* librte_table LPM: A new parameter to hold the table name will be added to - the LPM table parameter structure. - -* librte_table: New functions for table entry bulk add/delete will be added - to the table operations structure. - -* librte_table hash: Key mask parameter will be added to the hash table - parameter structure for 8-byte key and 16-byte key extendible bucket and - LRU tables. - -* 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. +* eal: the following functions are deprecated starting from 17.05 and will + be removed in 17.08: + + - ``rte_set_log_level``, replaced by ``rte_log_set_global_level`` + - ``rte_get_log_level``, replaced by ``rte_log_get_global_level`` + - ``rte_set_log_type``, replaced by ``rte_log_set_level`` + - ``rte_get_log_type``, replaced by ``rte_log_get_level`` + +* 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 VDEV subsystem will be converted as driver 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. + +* ethdev: for 17.05 it is planned to deprecate the following nine rte_eth_dev_* + functions and move them into the ixgbe PMD: + + ``rte_eth_dev_bypass_init``, ``rte_eth_dev_bypass_state_set``, + ``rte_eth_dev_bypass_state_show``, ``rte_eth_dev_bypass_event_store``, + ``rte_eth_dev_bypass_event_show``, ``rte_eth_dev_wd_timeout_store``, + ``rte_eth_dev_bypass_wd_timeout_show``, ``rte_eth_dev_bypass_ver_show``, + ``rte_eth_dev_bypass_wd_reset``. + + The following fields will be removed from ``struct eth_dev_ops``: + + ``bypass_init_t``, ``bypass_state_set_t``, ``bypass_state_show_t``, + ``bypass_event_set_t``, ``bypass_event_show_t``, ``bypass_wd_timeout_set_t``, + ``bypass_wd_timeout_show_t``, ``bypass_ver_show_t``, ``bypass_wd_reset_t``. + + The functions will be renamed to the following, and moved to the ``ixgbe`` PMD: + + ``rte_pmd_ixgbe_bypass_init``, ``rte_pmd_ixgbe_bypass_state_set``, + ``rte_pmd_ixgbe_bypass_state_show``, ``rte_pmd_ixgbe_bypass_event_set``, + ``rte_pmd_ixgbe_bypass_event_show``, ``rte_pmd_ixgbe_bypass_wd_timeout_set``, + ``rte_pmd_ixgbe_bypass_wd_timeout_show``, ``rte_pmd_ixgbe_bypass_ver_show``, + ``rte_pmd_ixgbe_bypass_wd_reset``. + +* 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. + +* 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. + +* crypto/scheduler: the following two functions are deprecated starting + from 17.05 and will be removed in 17.08: + + - ``rte_crpytodev_scheduler_mode_get``, replaced by ``rte_cryptodev_scheduler_mode_get`` + - ``rte_crpytodev_scheduler_mode_set``, replaced by ``rte_cryptodev_scheduler_mode_set``