doc/guides/rel_notes/deprecation.rst

   1 ABI and API Deprecation
   2 =======================
   3
   4 See the :doc:`guidelines document for details of the ABI policy </contributing/versioning>`.
   5 API and ABI deprecation notices are to be posted here.
   6
   7
   8 Deprecation Notices
   9 -------------------
  10
  11 * eal: DPDK runtime configuration file (located at
  12   ``/var/run/.<prefix>_config``) will be moved. The new path will be as follows:
  13
  14   - if DPDK is running as root, path will be set to
  15     ``/var/run/dpdk/<prefix>/config``
  16   - if DPDK is not running as root and $XDG_RUNTIME_DIR is set, path will be set
  17     to ``$XDG_RUNTIME_DIR/dpdk/<prefix>/config``
  18   - if DPDK is not running as root and $XDG_RUNTIME_DIR is not set, path will be
  19     set to ``/tmp/dpdk/<prefix>/config``
  20
  21 * eal: both declaring and identifying devices will be streamlined in v18.08.
  22   New functions will appear to query a specific port from buses, classes of
  23   device and device drivers. Device declaration will be made coherent with the
  24   new scheme of device identification.
  25   As such, ``rte_devargs`` device representation will change.
  26
  27   - The enum ``rte_devtype`` was used to identify a bus and will disappear.
  28   - Functions previously deprecated will change or disappear:
  29
  30     + ``rte_eal_devargs_type_count``
  31     + ``rte_eal_devargs_parse`` will change its format and use.
  32
  33 * pci: Several exposed functions are misnamed.
  34   The following functions are deprecated starting from v17.11 and are replaced:
  35
  36   - ``eal_parse_pci_BDF`` replaced by ``rte_pci_addr_parse``
  37   - ``eal_parse_pci_DomBDF`` replaced by ``rte_pci_addr_parse``
  38   - ``rte_eal_compare_pci_addr`` replaced by ``rte_pci_addr_cmp``
  39
  40 * eal: a new set of mbuf mempool ops name APIs for user, platform and best
  41   mempool names have been defined in ``rte_mbuf`` in v18.02. The uses of
  42   ``rte_eal_mbuf_default_mempool_ops`` shall be replaced by
  43   ``rte_mbuf_best_mempool_ops``.
  44   The following function is deprecated since 18.05, and will be removed
  45   in 18.08:
  46
  47   - ``rte_eal_mbuf_default_mempool_ops``
  48
  49 * mbuf: The opaque ``mbuf->hash.sched`` field will be updated to support generic
  50   definition in line with the ethdev TM and MTR APIs. Currently, this field
  51   is defined in librte_sched in a non-generic way. The new generic format
  52   will contain: queue ID, traffic class, color. Field size will not change.
  53
  54 * mbuf: the macro ``RTE_MBUF_INDIRECT()`` will be removed in v18.08 or later and
  55   replaced with ``RTE_MBUF_CLONED()`` which is already added in v18.05. As
  56   ``EXT_ATTACHED_MBUF`` is newly introduced in v18.05, ``RTE_MBUF_INDIRECT()``
  57   can no longer be mutually exclusive with ``RTE_MBUF_DIRECT()`` if the new
  58   experimental API ``rte_pktmbuf_attach_extbuf()`` is used. Removal of the macro
  59   is to fix this semantic inconsistency.
  60
  61 * ethdev: a new Tx and Rx offload API was introduced on 17.11.
  62   In the new API, offloads are divided into per-port and per-queue offloads.
  63   Offloads are disabled by default and enabled per application request.
  64
  65   In later releases the old offloading API will be deprecated, which will include:
  66   - removal of ``ETH_TXQ_FLAGS_NO*`` flags.
  67   - removal of ``txq_flags`` field from ``rte_eth_txconf`` struct.
  68   - removal of the offloads bit-field from ``rte_eth_rxmode`` struct.
  69
  70 * ethdev: In v18.11 ``DEV_RX_OFFLOAD_CRC_STRIP`` offload flag will be removed, default
  71   behavior without any flag will be changed to CRC strip.
  72   To keep CRC ``DEV_RX_OFFLOAD_KEEP_CRC`` flag is required.
  73   ``KEEP_CRC``: Keep CRC in packet
  74   No flag: Strip CRC from packet
  75
  76 * ethdev: the legacy filter API, including
  77   ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
  78   as filter types MACVLAN, ETHERTYPE, FLEXIBLE, SYN, NTUPLE, TUNNEL, FDIR,
  79   HASH and L2_TUNNEL, is superseded by the generic flow API (rte_flow) in
  80   PMDs that implement the latter.
  81   Target release for removal of the legacy API will be defined once most
  82   PMDs have switched to rte_flow.
  83
  84 * pdump: As we changed to use generic IPC, some changes in APIs and structure
  85   are expected in subsequent release.
  86
  87   - ``rte_pdump_set_socket_dir`` will be removed;
  88   - The parameter, ``path``, of ``rte_pdump_init`` will be removed;
  89   - The enum ``rte_pdump_socktype`` will be removed.
  90
  91 * cryptodev: The following changes will be made in the library
  92   for 18.08:
  93
  94   - Removal of ``sym`` structure in ``rte_cryptodev_info`` structure,
  95     containing fields not relevant anymore since the session mempool
  96     is not internal in the crypto device anymore.
  97   - Replacement of ``pci_dev`` field with the more generic ``rte_device``
  98     structure.
  99   - Functions ``rte_cryptodev_queue_pair_attach_sym_session()`` and
 100     ``rte_cryptodev_queue_pair_dettach_sym_session()`` will be deprecated from
 101     18.05 and removed in 18.08, as there are no drivers doing anything useful
 102     with them.
 103   - Functions ``rte_cryptodev_queue_pair_start()`` and
 104     ``rte_cryptodev_queue_pair_stop()`` will be deprecated from 18.05
 105     and removed in 18.08, as there are no drivers doing anything useful
 106     with them.
 107   - Some feature flags such as ``RTE_CRYPTODEV_FF_MBUF_SCATTER_GATHER`` are ambiguous,
 108     so some will be replaced by more explicit flags.
 109   - Function ``rte_cryptodev_get_header_session_size()`` will be deprecated
 110     in 18.05, and it gets replaced with ``rte_cryptodev_sym_get_header_session_size()``.
 111     It will be removed in 18.08.
 112   - Function ``rte_cryptodev_get_private_session_size()`` will be deprecated
 113     in 18.05, and it gets replaced with ``rte_cryptodev_sym_get_private_session_size()``.
 114     It will be removed in 18.08.