doc/guides/rel_notes/release_18_08.rst

   1 DPDK Release 18.08
   2 ==================
   3
   4 .. **Read this first.**
   5
   6    The text in the sections below explains how to update the release notes.
   7
   8    Use proper spelling, capitalization and punctuation in all sections.
   9
  10    Variable and config names should be quoted as fixed width text:
  11    ``LIKE_THIS``.
  12
  13    Build the docs and view the output file to ensure the changes are correct::
  14
  15       make doc-guides-html
  16
  17       xdg-open build/doc/html/guides/rel_notes/release_18_08.html
  18
  19
  20 New Features
  21 ------------
  22
  23 .. This section should contain new features added in this release.
  24    Sample format:
  25
  26    * **Add a title in the past tense with a full stop.**
  27
  28      Add a short 1-2 sentence description in the past tense.
  29      The description should be enough to allow someone scanning
  30      the release notes to understand the new feature.
  31
  32      If the feature adds a lot of sub-features you can use a bullet list
  33      like this:
  34
  35      * Added feature foo to do something.
  36      * Enhanced feature bar to do something else.
  37
  38      Refer to the previous release notes for examples.
  39
  40      This section is a comment. Do not overwrite or remove it.
  41      Also, make sure to start the actual text at the margin.
  42      =========================================================
  43
  44 * **Added support for Hyper-V netvsc PMD.**
  45
  46   The new ``netvsc`` poll mode driver provides native support for
  47   networking on Hyper-V. See the :doc:`../nics/netvsc` NIC driver guide
  48   for more details on this new driver.
  49
  50 * **Added Flow API support for CXGBE PMD.**
  51
  52   Flow API support has been added to CXGBE Poll Mode Driver to offload
  53   flows to Chelsio T5/T6 NICs.
  54
  55 * **Added ixgbe preferred Rx/Tx parameters.**
  56
  57   Rather than applications providing explicit Rx and Tx parameters such as
  58   queue and burst sizes, they can request that the EAL instead uses preferred
  59   values provided by the PMD, falling back to defaults within the EAL if the
  60   PMD does not provide any. The provision of such tuned values now includes
  61   the ixgbe PMD.
  62
  63 * **Added descriptor status check support for fm10k.**
  64
  65   ``rte_eth_rx_descritpr_status`` and ``rte_eth_tx_descriptor_status``
  66   are supported by fm10K.
  67
  68 * **Updated the enic driver.**
  69
  70   * Add support for mbuf fast free offload.
  71   * Add low cycle count Tx handler for no-offload Tx (except mbuf fast free).
  72   * Add low cycle count Rx handler for non-scattered Rx.
  73   * Minor performance improvements to scattered Rx handler.
  74   * Add handlers to add/delete VxLAN port number.
  75   * Add devarg to specify ingress VLAN rewrite mode.
  76
  77 * **Updated the AESNI MB PMD.**
  78
  79   The AESNI MB PMD has been updated with additional support for:
  80
  81   * 3DES for 8, 16 and 24 byte keys.
  82
  83 * **Added a new compression PMD using Intel's QuickAssist (QAT) device family.**
  84
  85   Added the new ``QAT`` compression driver, for compression and decompression
  86   operations in software. See the :doc:`../compressdevs/qat_comp` compression
  87   driver guide for details on this new driver.
  88
  89
  90 API Changes
  91 -----------
  92
  93 .. This section should contain API changes. Sample format:
  94
  95    * Add a short 1-2 sentence description of the API change.
  96      Use fixed width quotes for ``function_names`` or ``struct_names``.
  97      Use the past tense.
  98
  99    This section is a comment. Do not overwrite or remove it.
 100    Also, make sure to start the actual text at the margin.
 101    =========================================================
 102
 103 * Path to runtime config file has changed. The new path is determined as
 104   follows:
 105
 106   - If DPDK is running as root, ``/var/run/dpdk/<prefix>/config``
 107   - If DPDK is not running as root:
 108
 109     * If ``$XDG_RUNTIME_DIR`` is set, ``${XDG_RUNTIME_DIR}/dpdk/<prefix>/config``
 110     * Otherwise, ``/tmp/dpdk/<prefix>/config``
 111
 112 * cryptodev: In struct ``struct rte_cryptodev_info``, field ``rte_pci_device *pci_dev``
 113   has been replaced with field ``struct rte_device *device``.
 114   Value 0 is accepted in ``sym.max_nb_sessions``, meaning that a device
 115   supports an unlimited number of sessions.
 116   Two new fields of type ``uint16_t`` have been added:
 117   ``min_mbuf_headroom_req`` and ``min_mbuf_tailroom_req``.
 118   These parameters specify the recommended headroom and tailroom for mbufs
 119   to be processed by the PMD.
 120
 121 * cryptodev: Following functions were deprecated and are removed in 18.08:
 122
 123   - ``rte_cryptodev_queue_pair_start``
 124   - ``rte_cryptodev_queue_pair_stop``
 125   - ``rte_cryptodev_queue_pair_attach_sym_session``
 126   - ``rte_cryptodev_queue_pair_detach_sym_session``
 127
 128 * cryptodev: Following functions were deprecated and are replaced by
 129   other functions in 18.08:
 130
 131   - ``rte_cryptodev_get_header_session_size`` is replaced with
 132     ``rte_cryptodev_sym_get_header_session_size``
 133   - ``rte_cryptodev_get_private_session_size`` is replaced with
 134     ``rte_cryptodev_sym_get_private_session_size``
 135
 136 * cryptodev: Feature flag ``RTE_CRYPTODEV_FF_MBUF_SCATTER_GATHER`` is
 137   replaced with the following more explicit flags:
 138
 139   - ``RTE_CRYPTODEV_FF_IN_PLACE_SGL``
 140   - ``RTE_CRYPTODEV_FF_OOP_SGL_IN_SGL_OUT``
 141   - ``RTE_CRYPTODEV_FF_OOP_SGL_IN_LB_OUT``
 142   - ``RTE_CRYPTODEV_FF_OOP_LB_IN_SGL_OUT``
 143   - ``RTE_CRYPTODEV_FF_OOP_LB_IN_LB_OUT``
 144
 145 * cryptodev: Renamed cryptodev experimental APIs:
 146
 147   Used user_data instead of private_data in following APIs to avoid confusion
 148   with the existing session parameter ``sess_private_data[]`` and related APIs.
 149
 150   - ``rte_cryptodev_sym_session_set_private_data()`` changed to
 151     ``rte_cryptodev_sym_session_set_user_data()``
 152   - ``rte_cryptodev_sym_session_get_private_data()`` changed to
 153     ``rte_cryptodev_sym_session_get_user_data()``
 154
 155 * compressdev: Feature flag ``RTE_COMP_FF_MBUF_SCATTER_GATHER`` is
 156   replaced with the following more explicit flags:
 157
 158   - ``RTE_COMP_FF_OOP_SGL_IN_SGL_OUT``
 159   - ``RTE_COMP_FF_OOP_SGL_IN_LB_OUT``
 160   - ``RTE_COMP_FF_OOP_LB_IN_SGL_OUT``
 161
 162
 163 ABI Changes
 164 -----------
 165
 166 .. This section should contain ABI changes. Sample format:
 167
 168    * Add a short 1-2 sentence description of the ABI change
 169      that was announced in the previous releases and made in this release.
 170      Use fixed width quotes for ``function_names`` or ``struct_names``.
 171      Use the past tense.
 172
 173    This section is a comment. Do not overwrite or remove it.
 174    Also, make sure to start the actual text at the margin.
 175    =========================================================
 176
 177
 178 Removed Items
 179 -------------
 180
 181 .. This section should contain removed items in this release. Sample format:
 182
 183    * Add a short 1-2 sentence description of the removed item
 184      in the past tense.
 185
 186    This section is a comment. Do not overwrite or remove it.
 187    Also, make sure to start the actual text at the margin.
 188    =========================================================
 189
 190
 191 Shared Library Versions
 192 -----------------------
 193
 194 .. Update any library version updated in this release
 195    and prepend with a ``+`` sign, like this:
 196
 197      librte_acl.so.2
 198    + librte_cfgfile.so.2
 199      librte_cmdline.so.2
 200
 201    This section is a comment. Do not overwrite or remove it.
 202    =========================================================
 203
 204 The libraries prepended with a plus sign were incremented in this version.
 205
 206 .. code-block:: diff
 207
 208      librte_acl.so.2
 209      librte_bbdev.so.1
 210      librte_bitratestats.so.2
 211      librte_bpf.so.1
 212      librte_bus_dpaa.so.1
 213      librte_bus_fslmc.so.1
 214      librte_bus_pci.so.1
 215      librte_bus_vdev.so.1
 216    + librte_bus_vmbus.so.1
 217      librte_cfgfile.so.2
 218      librte_cmdline.so.2
 219      librte_common_octeontx.so.1
 220      librte_compressdev.so.1
 221    + librte_cryptodev.so.5
 222      librte_distributor.so.1
 223      librte_eal.so.7
 224      librte_ethdev.so.9
 225      librte_eventdev.so.4
 226      librte_flow_classify.so.1
 227      librte_gro.so.1
 228      librte_gso.so.1
 229      librte_hash.so.2
 230      librte_ip_frag.so.1
 231      librte_jobstats.so.1
 232      librte_kni.so.2
 233      librte_kvargs.so.1
 234      librte_latencystats.so.1
 235      librte_lpm.so.2
 236      librte_mbuf.so.4
 237      librte_mempool.so.4
 238      librte_meter.so.2
 239      librte_metrics.so.1
 240      librte_net.so.1
 241      librte_pci.so.1
 242      librte_pdump.so.2
 243      librte_pipeline.so.3
 244      librte_pmd_bnxt.so.2
 245      librte_pmd_bond.so.2
 246      librte_pmd_i40e.so.2
 247      librte_pmd_ixgbe.so.2
 248      librte_pmd_dpaa2_cmdif.so.1
 249      librte_pmd_dpaa2_qdma.so.1
 250      librte_pmd_ring.so.2
 251      librte_pmd_softnic.so.1
 252      librte_pmd_vhost.so.2
 253      librte_port.so.3
 254      librte_power.so.1
 255      librte_rawdev.so.1
 256      librte_reorder.so.1
 257      librte_ring.so.2
 258      librte_sched.so.1
 259      librte_security.so.1
 260      librte_table.so.3
 261      librte_timer.so.1
 262      librte_vhost.so.3
 263
 264
 265 Known Issues
 266 ------------
 267
 268 .. This section should contain new known issues in this release. Sample format:
 269
 270    * **Add title in present tense with full stop.**
 271
 272      Add a short 1-2 sentence description of the known issue
 273      in the present tense. Add information on any known workarounds.
 274
 275    This section is a comment. Do not overwrite or remove it.
 276    Also, make sure to start the actual text at the margin.
 277    =========================================================
 278
 279
 280 Tested Platforms
 281 ----------------
 282
 283 .. This section should contain a list of platforms that were tested
 284    with this release.
 285
 286    The format is:
 287
 288    * <vendor> platform with <vendor> <type of devices> combinations
 289
 290      * List of CPU
 291      * List of OS
 292      * List of devices
 293      * Other relevant details...
 294
 295    This section is a comment. Do not overwrite or remove it.
 296    Also, make sure to start the actual text at the margin.
 297    =========================================================