X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Frel_notes%2Fdeprecation.rst;h=7f78ee940f5c9df9e8571a70a7482c2cbb8a8901;hb=6399c4bc965c10fe463ec167ea5b6e202ad4274e;hp=9a5f6b84fb729bfc7d08dc1750c33a5239d8af3a;hpb=2a2d0d181c80279c1bcbd6892445dcaffef11783;p=dpdk.git diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index 9a5f6b84fb..7f78ee940f 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -8,57 +8,34 @@ API and ABI deprecation notices are to be posted here. Deprecation Notices ------------------- -* eal: the following functions are deprecated starting from 17.05 and will - be removed in 17.11: - - - ``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`` - -* eal: several API and ABI changes are planned for ``rte_devargs`` in v17.11. +* eal: several API and ABI changes are planned for ``rte_devargs`` in v18.02. The format of device command line parameters will change. The bus will need to be explicitly stated in the device declaration. The enum ``rte_devtype`` was used to identify a bus and will disappear. The structure ``rte_devargs`` will change. The ``rte_devargs_list`` will be made private. The following functions are deprecated starting from 17.08 and will either be - modified or removed in 17.11: + modified or removed in 18.02: - ``rte_eal_devargs_add`` - ``rte_eal_devargs_type_count`` - ``rte_eal_parse_devargs_str``, replaced by ``rte_eal_devargs_parse`` -* eal: the support of Xen dom0 will be removed from EAL in 17.11; and with - that, drivers/net/xenvirt and examples/vhost_xen will also be removed. - -* eal: An ABI change is planned for 17.11 to make DPDK aware of IOVA address - translation scheme. - Reference to phys address in EAL data-structure or functions may change to - IOVA address or more appropriate name. - The change will be only for the name. - Functional aspects of the API or data-structure will remain same. - -* 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.08 and will be removed in 17.11. +* pci: Several exposed functions are misnamed. + The following functions are deprecated starting from v17.11 and are replaced: -* mempool: The following will be modified in 17.11: + - ``eal_parse_pci_BDF`` replaced by ``rte_pci_addr_parse`` + - ``eal_parse_pci_DomBDF`` replaced by ``rte_pci_addr_parse`` + - ``rte_eal_compare_pci_addr`` replaced by ``rte_pci_addr_cmp`` - - ``rte_mempool_xmem_size`` and ``rte_mempool_xmem_usage`` need to know - the mempool flag status so adding new param rte_mempool in those API. - - Removing __rte_unused int flag param from ``rte_mempool_generic_put`` - and ``rte_mempool_generic_get`` API. - - ``rte_mempool`` flags data type will changed from int to - unsigned int. +* ethdev: a new Tx and Rx offload API was introduced on 17.11. + In the new API, offloads are divided into per-port and per-queue offloads. + Offloads are disabled by default and enabled per application request. + The old offloads API is target to be deprecated on 18.05. This includes: -* ethdev: Tx offloads will no longer be enabled by default in 17.11. - Instead, the ``rte_eth_txmode`` structure will be extended with - bit field to enable each Tx offload. - Besides of making the Rx/Tx configuration API more consistent for the - application, PMDs will be able to provide a better out of the box performance. - As part of the work, ``ETH_TXQ_FLAGS_NO*`` will be superseded as well. + - removal of ``ETH_TXQ_FLAGS_NO*`` flags. + - removal of ``txq_flags`` field from ``rte_eth_txconf`` struct. + - removal of the offloads bit-field from ``rte_eth_rxmode`` struct. * ethdev: the legacy filter API, including ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well @@ -68,27 +45,28 @@ Deprecation Notices Target release for removal of the legacy API will be defined once most PMDs have switched to rte_flow. -* ethdev: The device flag advertizing hotplug capability - ``RTE_ETH_DEV_DETACHABLE`` is not needed anymore and will be removed in - v17.11. - This capability is verified upon calling the relevant hotplug functions in EAL - by checking that the ``unplug`` ops is set in the bus. This verification is - done by the EAL and not by the ``ethdev`` layer anymore. Users relying on this - flag being present only have to remove their checks to follow the change. - -* ABI/API changes are planned for 17.11 in all structures which include port_id - definition such as "rte_eth_dev_data", "rte_port_ethdev_reader_params", - "rte_port_ethdev_writer_params", and so on. The definition of port_id will be - changed from 8 bits to 16 bits in order to support more than 256 ports in - DPDK. All APIs which have port_id parameter will be changed at the same time. - -* librte_table: The ``key_mask`` parameter will be added to all the hash tables - that currently do not have it, as well as to the hash compute function prototype. - The non-"do-sig" versions of the hash tables will be removed - (including the ``signature_offset`` parameter) - and the "do-sig" versions renamed accordingly. - -* cryptodev: the following function is deprecated starting from 17.08 and will - be removed in 17.11: - - - ``rte_cryptodev_create_vdev`` +* i40e: The default flexible payload configuration which extracts the first 16 + bytes of the payload for RSS will be deprecated starting from 18.02. If + required the previous behavior can be configured using existing flow + director APIs. There is no ABI/API break. This change will just remove a + global configuration setting and require explicit configuration. + +* librte_meter: The API will change to accommodate configuration profiles. + Most of the API functions will have an additional opaque parameter. + +* ring: The alignment constraints on the ring structure will be relaxed + to one cache line instead of two, and an empty cache line padding will + be added between the producer and consumer structures. The size of the + structure and the offset of the fields will remain the same on + platforms with 64B cache line, but will change on other platforms. + +* mbuf: The control mbuf API (``rte_ctrlmbuf_init()`` function, + ``rte_ctrlmbuf_alloc()`` macro, ``rte_ctrlmbuf_free()`` macro, + ``rte_ctrlmbuf_data()`` macro, ``rte_ctrlmbuf_len()`` macro, + ``rte_is_ctrlmbuf()`` macro and ``CTRL_MBUF_FLAG`` macro) will be + removed in v18.05. The packet mbuf API should be used as a + replacement. + +* mbuf: The mbuf flags ``PKT_TX_VLAN_PKT`` and ``PKT_TX_QINQ_PKT`` are + respectively renamed as ``PKT_TX_VLAN`` and ``PKT_TX_QINQ``. The old + names will be removed in v18.08.