doc/guides/rel_notes/release_18_11.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright 2018 The DPDK contributors
   3
   4 DPDK Release 18.11
   5 ==================
   6
   7 .. **Read this first.**
   8
   9    The text in the sections below explains how to update the release notes.
  10
  11    Use proper spelling, capitalization and punctuation in all sections.
  12
  13    Variable and config names should be quoted as fixed width text:
  14    ``LIKE_THIS``.
  15
  16    Build the docs and view the output file to ensure the changes are correct::
  17
  18       make doc-guides-html
  19
  20       xdg-open build/doc/html/guides/rel_notes/release_18_11.html
  21
  22
  23 New Features
  24 ------------
  25
  26 .. This section should contain new features added in this release.
  27    Sample format:
  28
  29    * **Add a title in the past tense with a full stop.**
  30
  31      Add a short 1-2 sentence description in the past tense.
  32      The description should be enough to allow someone scanning
  33      the release notes to understand the new feature.
  34
  35      If the feature adds a lot of sub-features you can use a bullet list
  36      like this:
  37
  38      * Added feature foo to do something.
  39      * Enhanced feature bar to do something else.
  40
  41      Refer to the previous release notes for examples.
  42
  43      Suggested order in release notes items:
  44      * Core libs (EAL, mempool, ring, mbuf, buses)
  45      * Device abstraction libs and PMDs
  46        - ethdev (lib, PMDs)
  47        - cryptodev (lib, PMDs)
  48        - eventdev (lib, PMDs)
  49        - etc
  50      * Other libs
  51      * Apps, Examples, Tools (if significative)
  52
  53      This section is a comment. Do not overwrite or remove it.
  54      Also, make sure to start the actual text at the margin.
  55      =========================================================
  56
  57 * **Add support to offload more flow match and actions for CXGBE PMD**
  58
  59   Flow API support has been enhanced for CXGBE Poll Mode Driver to offload:
  60
  61   * Match items: destination MAC address.
  62   * Action items: push/pop/rewrite vlan header.
  63
  64 * **Added a devarg to use the latest supported vector path in i40e.**
  65   A new devarg ``use-latest-supported-vec`` was introduced to allow users to
  66   choose the latest vector path that the platform supported. For example, users
  67   can use AVX2 vector path on BDW/HSW to get better performance.
  68
  69 * **Added support for SR-IOV in netvsc PMD.**
  70
  71   The ``netvsc`` poll mode driver now supports the Accelerated Networking
  72   SR-IOV option in Hyper-V and Azure. This is an alternative to the previous
  73   vdev_netvsc, tap, and failsafe drivers combination.
  74
  75 * **Updated failsafe driver.**
  76
  77   Updated the failsafe driver including the following changes:
  78
  79   * Support for Rx and Tx queues start and stop.
  80   * Support for Rx and Tx queues deferred start.
  81   * Support for runtime Rx and Tx queues setup.
  82   * Support multicast MAC address set.
  83
  84 * **Added Distributed Software Eventdev PMD.**
  85
  86   Added the new Distributed Software Event Device (DSW), which is a
  87   pure-software eventdev driver distributing the work of scheduling
  88   among all eventdev ports and the lcores using them. DSW, compared to
  89   the SW eventdev PMD, sacrifices load balancing performance to
  90   gain better event scheduling throughput and scalability.
  91
  92 * **Added ability to switch queue deferred start flag on testpmd app.**
  93
  94   Added a console command to testpmd app, giving ability to switch
  95   ``rx_deferred_start`` or ``tx_deferred_start`` flag of the specified queue of
  96   the specified port. The port must be stopped before the command call in order
  97   to reconfigure queues.
  98
  99
 100 API Changes
 101 -----------
 102
 103 .. This section should contain API changes. Sample format:
 104
 105    * Add a short 1-2 sentence description of the API change.
 106      Use fixed width quotes for ``function_names`` or ``struct_names``.
 107      Use the past tense.
 108
 109    This section is a comment. Do not overwrite or remove it.
 110    Also, make sure to start the actual text at the margin.
 111    =========================================================
 112
 113 * mbuf: The ``__rte_mbuf_raw_free()`` and ``__rte_pktmbuf_prefree_seg()``
 114   functions were deprecated since 17.05 and are replaced by
 115   ``rte_mbuf_raw_free()`` and ``rte_pktmbuf_prefree_seg()``.
 116
 117 * A new device flag, RTE_ETH_DEV_NOLIVE_MAC_ADDR, changes the order of
 118   actions inside rte_eth_dev_start regarding MAC set. Some NICs do not
 119   support MAC changes once the port has started and with this new device
 120   flag the MAC can be properly configured in any case. This is particularly
 121   important for bonding.
 122
 123 * The default behaviour of CRC strip offload changed. Without any specific Rx
 124   offload flag, default behavior by PMD is now to strip CRC.
 125   DEV_RX_OFFLOAD_CRC_STRIP offload flag has been removed.
 126   To request keeping CRC, application should set ``DEV_RX_OFFLOAD_KEEP_CRC`` Rx
 127   offload.
 128
 129
 130 ABI Changes
 131 -----------
 132
 133 .. This section should contain ABI changes. Sample format:
 134
 135    * Add a short 1-2 sentence description of the ABI change
 136      that was announced in the previous releases and made in this release.
 137      Use fixed width quotes for ``function_names`` or ``struct_names``.
 138      Use the past tense.
 139
 140    This section is a comment. Do not overwrite or remove it.
 141    Also, make sure to start the actual text at the margin.
 142    =========================================================
 143
 144
 145 Removed Items
 146 -------------
 147
 148 .. This section should contain removed items in this release. Sample format:
 149
 150    * Add a short 1-2 sentence description of the removed item
 151      in the past tense.
 152
 153    This section is a comment. Do not overwrite or remove it.
 154    Also, make sure to start the actual text at the margin.
 155    =========================================================
 156
 157
 158 Shared Library Versions
 159 -----------------------
 160
 161 .. Update any library version updated in this release
 162    and prepend with a ``+`` sign, like this:
 163
 164      librte_acl.so.2
 165    + librte_cfgfile.so.2
 166      librte_cmdline.so.2
 167
 168    This section is a comment. Do not overwrite or remove it.
 169    =========================================================
 170
 171 The libraries prepended with a plus sign were incremented in this version.
 172
 173 .. code-block:: diff
 174
 175      librte_acl.so.2
 176      librte_bbdev.so.1
 177      librte_bitratestats.so.2
 178      librte_bpf.so.1
 179      librte_bus_dpaa.so.1
 180      librte_bus_fslmc.so.1
 181      librte_bus_pci.so.1
 182      librte_bus_vdev.so.1
 183    + librte_bus_vmbus.so.1
 184      librte_cfgfile.so.2
 185      librte_cmdline.so.2
 186      librte_common_octeontx.so.1
 187      librte_compressdev.so.1
 188      librte_cryptodev.so.5
 189      librte_distributor.so.1
 190      librte_eal.so.8
 191      librte_ethdev.so.10
 192      librte_eventdev.so.5
 193      librte_flow_classify.so.1
 194      librte_gro.so.1
 195      librte_gso.so.1
 196      librte_hash.so.2
 197      librte_ip_frag.so.1
 198      librte_jobstats.so.1
 199      librte_kni.so.2
 200      librte_kvargs.so.1
 201      librte_latencystats.so.1
 202      librte_lpm.so.2
 203      librte_mbuf.so.4
 204      librte_mempool.so.5
 205      librte_meter.so.2
 206      librte_metrics.so.1
 207      librte_net.so.1
 208      librte_pci.so.1
 209      librte_pdump.so.2
 210      librte_pipeline.so.3
 211      librte_pmd_bnxt.so.2
 212      librte_pmd_bond.so.2
 213      librte_pmd_i40e.so.2
 214      librte_pmd_ixgbe.so.2
 215      librte_pmd_dpaa2_cmdif.so.1
 216      librte_pmd_dpaa2_qdma.so.1
 217      librte_pmd_ring.so.2
 218      librte_pmd_softnic.so.1
 219      librte_pmd_vhost.so.2
 220    + librte_pmd_netvsc.so.1
 221      librte_port.so.3
 222      librte_power.so.1
 223      librte_rawdev.so.1
 224      librte_reorder.so.1
 225      librte_ring.so.2
 226      librte_sched.so.1
 227      librte_security.so.1
 228      librte_table.so.3
 229      librte_timer.so.1
 230      librte_vhost.so.3
 231
 232
 233 Known Issues
 234 ------------
 235
 236 .. This section should contain new known issues in this release. Sample format:
 237
 238    * **Add title in present tense with full stop.**
 239
 240      Add a short 1-2 sentence description of the known issue
 241      in the present tense. Add information on any known workarounds.
 242
 243    This section is a comment. Do not overwrite or remove it.
 244    Also, make sure to start the actual text at the margin.
 245    =========================================================
 246
 247 * When using SR-IOV (VF) support with netvsc PMD and the Mellanox mlx5 bifurcated
 248   driver; the Linux netvsc device must be brought up before the netvsc device is
 249   unbound and passed to the DPDK.
 250
 251
 252 Tested Platforms
 253 ----------------
 254
 255 .. This section should contain a list of platforms that were tested
 256    with this release.
 257
 258    The format is:
 259
 260    * <vendor> platform with <vendor> <type of devices> combinations
 261
 262      * List of CPU
 263      * List of OS
 264      * List of devices
 265      * Other relevant details...
 266
 267    This section is a comment. Do not overwrite or remove it.
 268    Also, make sure to start the actual text at the margin.
 269    =========================================================