X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Frel_notes%2Fdeprecation.rst;h=1ce692eaca343d6a905be93742952783cdcef4d3;hb=ee61f5113b170b3b7742c7060c7e9cef6f5bc6ca;hp=56f766663bfbb42994231f1d49898199e38e41f9;hpb=4c2128edeeac151ed01c5a674f1bae8423ed79e2;p=dpdk.git diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index 56f766663b..1ce692eaca 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -8,40 +8,80 @@ API and ABI deprecation notices are to be posted here. Deprecation Notices ------------------- -* 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. - -* ``eth_driver`` is planned to be removed in 17.02. 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``. - -* ethdev: an API change is planned for 17.02 for the function - ``_rte_eth_dev_callback_process``. In 17.02 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. +* eal: DPDK runtime configuration file (located at + ``/var/run/._config``) will be moved. The new path will be as follows: + + - if DPDK is running as root, path will be set to + ``/var/run/dpdk//config`` + - if DPDK is not running as root and $XDG_RUNTIME_DIR is set, path will be set + to ``$XDG_RUNTIME_DIR/dpdk//config`` + - if DPDK is not running as root and $XDG_RUNTIME_DIR is not set, path will be + set to ``/tmp/dpdk//config`` + +* eal: both declaring and identifying devices will be streamlined in v18.08. + New functions will appear to query a specific port from buses, classes of + device and device drivers. Device declaration will be made coherent with the + new scheme of device identification. + As such, ``rte_devargs`` device representation will change. + + - The enum ``rte_devtype`` was used to identify a bus and will disappear. + - Functions previously deprecated will change or disappear: + + + ``rte_eal_devargs_type_count`` + + ``rte_eal_devargs_parse`` will change its format and use. + +* pci: Several exposed functions are misnamed. + The following functions are deprecated starting from v17.11 and are replaced: + + - ``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`` + +* eal: a new set of mbuf mempool ops name APIs for user, platform and best + mempool names have been defined in ``rte_mbuf`` in v18.02. The uses of + ``rte_eal_mbuf_default_mempool_ops`` shall be replaced by + ``rte_mbuf_best_mempool_ops``. + The following function is deprecated since 18.05, and will be removed + in 18.08: + + - ``rte_eal_mbuf_default_mempool_ops`` + +* mbuf: The opaque ``mbuf->hash.sched`` field will be updated to support generic + definition in line with the ethdev TM and MTR APIs. Currently, this field + is defined in librte_sched in a non-generic way. The new generic format + will contain: queue ID, traffic class, color. Field size will not change. + +* mbuf: the macro ``RTE_MBUF_INDIRECT()`` will be removed in v18.08 or later and + replaced with ``RTE_MBUF_CLONED()`` which is already added in v18.05. As + ``EXT_ATTACHED_MBUF`` is newly introduced in v18.05, ``RTE_MBUF_INDIRECT()`` + can no longer be mutually exclusive with ``RTE_MBUF_DIRECT()`` if the new + experimental API ``rte_pktmbuf_attach_extbuf()`` is used. Removal of the macro + is to fix this semantic inconsistency. + +* 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. + + In later releases the old offloading API will be deprecated, which will include: + - 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: A new offloading flag ``DEV_RX_OFFLOAD_KEEP_CRC`` will be added in v18.08, + This will replace the usage of not setting ``DEV_RX_OFFLOAD_CRC_STRIP`` flag + and will be implemented in PMDs accordingly. + In v18.08 both ``DEV_RX_OFFLOAD_KEEP_CRC`` and ``DEV_RX_OFFLOAD_CRC_STRIP`` flags + will be available, usage will be: + ``CRC_STRIP``: Strip CRC from packet + ``KEEP_CRC``: Keep CRC in packet + Both ``CRC_STRIP`` & ``KEEP_CRC``: Invalid + No flag: Keep CRC in packet + +* ethdev: In v18.11 ``DEV_RX_OFFLOAD_CRC_STRIP`` offload flag will be removed, default + behavior without any flag will be changed to CRC strip. + To keep CRC ``DEV_RX_OFFLOAD_KEEP_CRC`` flag is required. + ``KEEP_CRC``: Keep CRC in packet + No flag: Strip CRC from packet * ethdev: the legacy filter API, including ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well @@ -51,11 +91,34 @@ Deprecation Notices 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. +* pdump: As we changed to use generic IPC, some changes in APIs and structure + are expected in subsequent release. + + - ``rte_pdump_set_socket_dir`` will be removed; + - The parameter, ``path``, of ``rte_pdump_init`` will be removed; + - The enum ``rte_pdump_socktype`` will be removed. + +* cryptodev: The following changes will be made in the library + for 18.08: -* The architecture TILE-Gx and the associated mpipe driver are not - maintained and will be removed in 17.05. + - Removal of ``sym`` structure in ``rte_cryptodev_info`` structure, + containing fields not relevant anymore since the session mempool + is not internal in the crypto device anymore. + - Replacement of ``pci_dev`` field with the more generic ``rte_device`` + structure. + - Functions ``rte_cryptodev_queue_pair_attach_sym_session()`` and + ``rte_cryptodev_queue_pair_dettach_sym_session()`` will be deprecated from + 18.05 and removed in 18.08, as there are no drivers doing anything useful + with them. + - Functions ``rte_cryptodev_queue_pair_start()`` and + ``rte_cryptodev_queue_pair_stop()`` will be deprecated from 18.05 + and removed in 18.08, as there are no drivers doing anything useful + with them. + - Some feature flags such as ``RTE_CRYPTODEV_FF_MBUF_SCATTER_GATHER`` are ambiguous, + so some will be replaced by more explicit flags. + - Function ``rte_cryptodev_get_header_session_size()`` will be deprecated + in 18.05, and it gets replaced with ``rte_cryptodev_sym_get_header_session_size()``. + It will be removed in 18.08. + - Function ``rte_cryptodev_get_private_session_size()`` will be deprecated + in 18.05, and it gets replaced with ``rte_cryptodev_sym_get_private_session_size()``. + It will be removed in 18.08.