X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Frel_notes%2Fdeprecation.rst;h=d2dd302db630cbb8add60f4512bfbd138413d184;hb=d8cda718e13ce3b238489217832dc5ed28557206;hp=0e840228cdb64aadbf2d63b9868f1fc72059f059;hpb=fd943c764a63e5ed4ec4df6ca78e5d7fa8835d4d;p=dpdk.git diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index 0e840228cd..d2dd302db6 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -8,6 +8,16 @@ API and ABI deprecation notices are to be posted here. Deprecation Notices ------------------- +* 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.05. 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 @@ -16,15 +26,10 @@ Deprecation Notices - removal of ``name`` and ``args`` fields. - The enum ``rte_devtype`` was used to identify a bus and will disappear. - - The ``rte_devargs_list`` will be made private. - Functions previously deprecated will change or disappear: - + ``rte_eal_devargs_add`` + ``rte_eal_devargs_type_count`` - + ``rte_eal_parse_devargs_str``, replaced by ``rte_eal_devargs_parse`` + ``rte_eal_devargs_parse`` will change its format and use. - + all ``rte_devargs`` related functions will be renamed, changing the - ``rte_eal_devargs_`` prefix to ``rte_devargs_``. * pci: Several exposed functions are misnamed. The following functions are deprecated starting from v17.11 and are replaced: @@ -33,28 +38,15 @@ Deprecation Notices - ``eal_parse_pci_DomBDF`` replaced by ``rte_pci_addr_parse`` - ``rte_eal_compare_pci_addr`` replaced by ``rte_pci_addr_cmp`` -* eal: The semantics of the return value for the ``rte_lcore_has_role`` function - are planned to change in v18.05. The function currently returns 0 and <0 for - success and failure, respectively. This will change to 1 and 0 for true and - false, respectively, to make use of the function more intuitive. - * 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 now redundant and it is target to be deprecated - in 18.05: + The following function is deprecated since 18.05, and will be removed + in 18.08: - ``rte_eal_mbuf_default_mempool_ops`` -* mempool: several API and ABI changes are planned in v18.05. - - The following changes are planned: - - - substitute ``register_memory_area`` with ``populate`` ops. - - addition of new op to allocate contiguous - block of objects if underlying driver supports it. - * 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 @@ -64,10 +56,6 @@ Deprecation Notices 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 ethdev - drivers offload interface will be deprecated on 18.05. - This includes: - - removal of the conversion in ethdev from new offloading API to old API for drivers. - 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. @@ -81,25 +69,34 @@ Deprecation Notices Target release for removal of the legacy API will be defined once most PMDs have switched to rte_flow. -* ethdev: A new rss level field planned in 18.05. - The new API add rss_level field to ``rte_eth_rss_conf`` to enable a choice - of RSS hash calculation on outer or inner header of tunneled packet. - -* ethdev: A work is being planned for 18.05 to expose VF port representors - as a mean to perform control and data path operation on the different VFs. - As VF representor is an ethdev port, new fields are needed in order to map - between the VF representor and the VF or the parent PF. Those new fields - are to be included in ``rte_eth_dev_info`` struct. - -* 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. - * 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: + + - 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.