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. Support added for:
  54   * Wildcard (LE-TCAM) and Exact (HASH) match filters.
  55   * Match items: physical ingress port, IPv4, IPv6, TCP and UDP.
  56   * Action items: queue, drop, count, and physical egress port redirect.
  57
  58 * **Added ixgbe preferred Rx/Tx parameters.**
  59
  60   Rather than applications providing explicit Rx and Tx parameters such as
  61   queue and burst sizes, they can request that the EAL instead uses preferred
  62   values provided by the PMD, falling back to defaults within the EAL if the
  63   PMD does not provide any. The provision of such tuned values now includes
  64   the ixgbe PMD.
  65
  66 * **Added descriptor status check support for fm10k.**
  67
  68   ``rte_eth_rx_descritpr_status`` and ``rte_eth_tx_descriptor_status``
  69   are supported by fm10K.
  70
  71 * **Updated the enic driver.**
  72
  73   * Add low cycle count Tx handler for no-offload Tx.
  74   * Add low cycle count Rx handler for non-scattered Rx.
  75   * Minor performance improvements to scattered Rx handler.
  76   * Add handlers to add/delete VxLAN port number.
  77   * Add devarg to specify ingress VLAN rewrite mode.
  78
  79 * **SoftNIC PMD rework.**
  80
  81   The SoftNIC PMD infrastructure is restructured to use the Packet Framework,
  82   which makes it more flexible, modular and easier to add new functionality
  83   in future.
  84
  85 * **Updated the AESNI MB PMD.**
  86
  87   The AESNI MB PMD has been updated with additional support for:
  88
  89   * 3DES for 8, 16 and 24 byte keys.
  90
  91 * **Added a new compression PMD using Intel's QuickAssist (QAT) device family.**
  92
  93   Added the new ``QAT`` compression driver, for compression and decompression
  94   operations in software. See the :doc:`../compressdevs/qat_comp` compression
  95   driver guide for details on this new driver.
  96
  97 * **Updated the ISA-L PMD.**
  98
  99   Added support for chained mbufs (input and output).
 100
 101
 102 API Changes
 103 -----------
 104
 105 .. This section should contain API changes. Sample format:
 106
 107    * Add a short 1-2 sentence description of the API change.
 108      Use fixed width quotes for ``function_names`` or ``struct_names``.
 109      Use the past tense.
 110
 111    This section is a comment. Do not overwrite or remove it.
 112    Also, make sure to start the actual text at the margin.
 113    =========================================================
 114
 115 * Path to runtime config file has changed. The new path is determined as
 116   follows:
 117
 118   - If DPDK is running as root, ``/var/run/dpdk/<prefix>/config``
 119   - If DPDK is not running as root:
 120
 121     * If ``$XDG_RUNTIME_DIR`` is set, ``${XDG_RUNTIME_DIR}/dpdk/<prefix>/config``
 122     * Otherwise, ``/tmp/dpdk/<prefix>/config``
 123
 124 * cryptodev: In struct ``struct rte_cryptodev_info``, field ``rte_pci_device *pci_dev``
 125   has been replaced with field ``struct rte_device *device``.
 126   Value 0 is accepted in ``sym.max_nb_sessions``, meaning that a device
 127   supports an unlimited number of sessions.
 128   Two new fields of type ``uint16_t`` have been added:
 129   ``min_mbuf_headroom_req`` and ``min_mbuf_tailroom_req``.
 130   These parameters specify the recommended headroom and tailroom for mbufs
 131   to be processed by the PMD.
 132
 133 * cryptodev: Following functions were deprecated and are removed in 18.08:
 134
 135   - ``rte_cryptodev_queue_pair_start``
 136   - ``rte_cryptodev_queue_pair_stop``
 137   - ``rte_cryptodev_queue_pair_attach_sym_session``
 138   - ``rte_cryptodev_queue_pair_detach_sym_session``
 139
 140 * cryptodev: Following functions were deprecated and are replaced by
 141   other functions in 18.08:
 142
 143   - ``rte_cryptodev_get_header_session_size`` is replaced with
 144     ``rte_cryptodev_sym_get_header_session_size``
 145   - ``rte_cryptodev_get_private_session_size`` is replaced with
 146     ``rte_cryptodev_sym_get_private_session_size``
 147
 148 * cryptodev: Feature flag ``RTE_CRYPTODEV_FF_MBUF_SCATTER_GATHER`` is
 149   replaced with the following more explicit flags:
 150
 151   - ``RTE_CRYPTODEV_FF_IN_PLACE_SGL``
 152   - ``RTE_CRYPTODEV_FF_OOP_SGL_IN_SGL_OUT``
 153   - ``RTE_CRYPTODEV_FF_OOP_SGL_IN_LB_OUT``
 154   - ``RTE_CRYPTODEV_FF_OOP_LB_IN_SGL_OUT``
 155   - ``RTE_CRYPTODEV_FF_OOP_LB_IN_LB_OUT``
 156
 157 * cryptodev: Renamed cryptodev experimental APIs:
 158
 159   Used user_data instead of private_data in following APIs to avoid confusion
 160   with the existing session parameter ``sess_private_data[]`` and related APIs.
 161
 162   - ``rte_cryptodev_sym_session_set_private_data()`` changed to
 163     ``rte_cryptodev_sym_session_set_user_data()``
 164   - ``rte_cryptodev_sym_session_get_private_data()`` changed to
 165     ``rte_cryptodev_sym_session_get_user_data()``
 166
 167 * compressdev: Feature flag ``RTE_COMP_FF_MBUF_SCATTER_GATHER`` is
 168   replaced with the following more explicit flags:
 169
 170   - ``RTE_COMP_FF_OOP_SGL_IN_SGL_OUT``
 171   - ``RTE_COMP_FF_OOP_SGL_IN_LB_OUT``
 172   - ``RTE_COMP_FF_OOP_LB_IN_SGL_OUT``
 173
 174
 175 ABI Changes
 176 -----------
 177
 178 .. This section should contain ABI changes. Sample format:
 179
 180    * Add a short 1-2 sentence description of the ABI change
 181      that was announced in the previous releases and made in this release.
 182      Use fixed width quotes for ``function_names`` or ``struct_names``.
 183      Use the past tense.
 184
 185    This section is a comment. Do not overwrite or remove it.
 186    Also, make sure to start the actual text at the margin.
 187    =========================================================
 188
 189
 190 Removed Items
 191 -------------
 192
 193 .. This section should contain removed items in this release. Sample format:
 194
 195    * Add a short 1-2 sentence description of the removed item
 196      in the past tense.
 197
 198    This section is a comment. Do not overwrite or remove it.
 199    Also, make sure to start the actual text at the margin.
 200    =========================================================
 201
 202
 203 Shared Library Versions
 204 -----------------------
 205
 206 .. Update any library version updated in this release
 207    and prepend with a ``+`` sign, like this:
 208
 209      librte_acl.so.2
 210    + librte_cfgfile.so.2
 211      librte_cmdline.so.2
 212
 213    This section is a comment. Do not overwrite or remove it.
 214    =========================================================
 215
 216 The libraries prepended with a plus sign were incremented in this version.
 217
 218 .. code-block:: diff
 219
 220      librte_acl.so.2
 221      librte_bbdev.so.1
 222      librte_bitratestats.so.2
 223      librte_bpf.so.1
 224      librte_bus_dpaa.so.1
 225      librte_bus_fslmc.so.1
 226      librte_bus_pci.so.1
 227      librte_bus_vdev.so.1
 228    + librte_bus_vmbus.so.1
 229      librte_cfgfile.so.2
 230      librte_cmdline.so.2
 231      librte_common_octeontx.so.1
 232      librte_compressdev.so.1
 233    + librte_cryptodev.so.5
 234      librte_distributor.so.1
 235      librte_eal.so.7
 236      librte_ethdev.so.9
 237      librte_eventdev.so.4
 238      librte_flow_classify.so.1
 239      librte_gro.so.1
 240      librte_gso.so.1
 241      librte_hash.so.2
 242      librte_ip_frag.so.1
 243      librte_jobstats.so.1
 244      librte_kni.so.2
 245      librte_kvargs.so.1
 246      librte_latencystats.so.1
 247      librte_lpm.so.2
 248      librte_mbuf.so.4
 249      librte_mempool.so.4
 250      librte_meter.so.2
 251      librte_metrics.so.1
 252      librte_net.so.1
 253      librte_pci.so.1
 254      librte_pdump.so.2
 255      librte_pipeline.so.3
 256      librte_pmd_bnxt.so.2
 257      librte_pmd_bond.so.2
 258      librte_pmd_i40e.so.2
 259      librte_pmd_ixgbe.so.2
 260      librte_pmd_dpaa2_cmdif.so.1
 261      librte_pmd_dpaa2_qdma.so.1
 262      librte_pmd_ring.so.2
 263      librte_pmd_softnic.so.1
 264      librte_pmd_vhost.so.2
 265      librte_port.so.3
 266      librte_power.so.1
 267      librte_rawdev.so.1
 268      librte_reorder.so.1
 269      librte_ring.so.2
 270      librte_sched.so.1
 271      librte_security.so.1
 272      librte_table.so.3
 273      librte_timer.so.1
 274      librte_vhost.so.3
 275
 276
 277 Known Issues
 278 ------------
 279
 280 .. This section should contain new known issues in this release. Sample format:
 281
 282    * **Add title in present tense with full stop.**
 283
 284      Add a short 1-2 sentence description of the known issue
 285      in the present tense. Add information on any known workarounds.
 286
 287    This section is a comment. Do not overwrite or remove it.
 288    Also, make sure to start the actual text at the margin.
 289    =========================================================
 290
 291
 292 Tested Platforms
 293 ----------------
 294
 295 .. This section should contain a list of platforms that were tested
 296    with this release.
 297
 298    The format is:
 299
 300    * <vendor> platform with <vendor> <type of devices> combinations
 301
 302      * List of CPU
 303      * List of OS
 304      * List of devices
 305      * Other relevant details...
 306
 307    This section is a comment. Do not overwrite or remove it.
 308    Also, make sure to start the actual text at the margin.
 309    =========================================================