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
  83 * **Added ability to switch queue deferred start flag on testpmd app.**
  84
  85   Added a console command to testpmd app, giving ability to switch
  86   ``rx_deferred_start`` or ``tx_deferred_start`` flag of the specified queue of
  87   the specified port. The port must be stopped before the command call in order
  88   to reconfigure queues.
  89
  90
  91 API Changes
  92 -----------
  93
  94 .. This section should contain API changes. Sample format:
  95
  96    * Add a short 1-2 sentence description of the API change.
  97      Use fixed width quotes for ``function_names`` or ``struct_names``.
  98      Use the past tense.
  99
 100    This section is a comment. Do not overwrite or remove it.
 101    Also, make sure to start the actual text at the margin.
 102    =========================================================
 103
 104 * mbuf: The ``__rte_mbuf_raw_free()`` and ``__rte_pktmbuf_prefree_seg()``
 105   functions were deprecated since 17.05 and are replaced by
 106   ``rte_mbuf_raw_free()`` and ``rte_pktmbuf_prefree_seg()``.
 107
 108 * A new device flag, RTE_ETH_DEV_NOLIVE_MAC_ADDR, changes the order of
 109   actions inside rte_eth_dev_start regarding MAC set. Some NICs do not
 110   support MAC changes once the port has started and with this new device
 111   flag the MAC can be properly configured in any case. This is particularly
 112   important for bonding.
 113
 114
 115 ABI Changes
 116 -----------
 117
 118 .. This section should contain ABI changes. Sample format:
 119
 120    * Add a short 1-2 sentence description of the ABI change
 121      that was announced in the previous releases and made in this release.
 122      Use fixed width quotes for ``function_names`` or ``struct_names``.
 123      Use the past tense.
 124
 125    This section is a comment. Do not overwrite or remove it.
 126    Also, make sure to start the actual text at the margin.
 127    =========================================================
 128
 129
 130 Removed Items
 131 -------------
 132
 133 .. This section should contain removed items in this release. Sample format:
 134
 135    * Add a short 1-2 sentence description of the removed item
 136      in the past tense.
 137
 138    This section is a comment. Do not overwrite or remove it.
 139    Also, make sure to start the actual text at the margin.
 140    =========================================================
 141
 142
 143 Shared Library Versions
 144 -----------------------
 145
 146 .. Update any library version updated in this release
 147    and prepend with a ``+`` sign, like this:
 148
 149      librte_acl.so.2
 150    + librte_cfgfile.so.2
 151      librte_cmdline.so.2
 152
 153    This section is a comment. Do not overwrite or remove it.
 154    =========================================================
 155
 156 The libraries prepended with a plus sign were incremented in this version.
 157
 158 .. code-block:: diff
 159
 160      librte_acl.so.2
 161      librte_bbdev.so.1
 162      librte_bitratestats.so.2
 163      librte_bpf.so.1
 164      librte_bus_dpaa.so.1
 165      librte_bus_fslmc.so.1
 166      librte_bus_pci.so.1
 167      librte_bus_vdev.so.1
 168    + librte_bus_vmbus.so.1
 169      librte_cfgfile.so.2
 170      librte_cmdline.so.2
 171      librte_common_octeontx.so.1
 172      librte_compressdev.so.1
 173      librte_cryptodev.so.5
 174      librte_distributor.so.1
 175      librte_eal.so.8
 176      librte_ethdev.so.10
 177      librte_eventdev.so.4
 178      librte_flow_classify.so.1
 179      librte_gro.so.1
 180      librte_gso.so.1
 181      librte_hash.so.2
 182      librte_ip_frag.so.1
 183      librte_jobstats.so.1
 184      librte_kni.so.2
 185      librte_kvargs.so.1
 186      librte_latencystats.so.1
 187      librte_lpm.so.2
 188      librte_mbuf.so.4
 189      librte_mempool.so.5
 190      librte_meter.so.2
 191      librte_metrics.so.1
 192      librte_net.so.1
 193      librte_pci.so.1
 194      librte_pdump.so.2
 195      librte_pipeline.so.3
 196      librte_pmd_bnxt.so.2
 197      librte_pmd_bond.so.2
 198      librte_pmd_i40e.so.2
 199      librte_pmd_ixgbe.so.2
 200      librte_pmd_dpaa2_cmdif.so.1
 201      librte_pmd_dpaa2_qdma.so.1
 202      librte_pmd_ring.so.2
 203      librte_pmd_softnic.so.1
 204      librte_pmd_vhost.so.2
 205    + librte_pmd_netvsc.so.1
 206      librte_port.so.3
 207      librte_power.so.1
 208      librte_rawdev.so.1
 209      librte_reorder.so.1
 210      librte_ring.so.2
 211      librte_sched.so.1
 212      librte_security.so.1
 213      librte_table.so.3
 214      librte_timer.so.1
 215      librte_vhost.so.3
 216
 217
 218 Known Issues
 219 ------------
 220
 221 .. This section should contain new known issues in this release. Sample format:
 222
 223    * **Add title in present tense with full stop.**
 224
 225      Add a short 1-2 sentence description of the known issue
 226      in the present tense. Add information on any known workarounds.
 227
 228    This section is a comment. Do not overwrite or remove it.
 229    Also, make sure to start the actual text at the margin.
 230    =========================================================
 231
 232 * When using SR-IOV (VF) support with netvsc PMD and the Mellanox mlx5 bifurcated
 233   driver; the Linux netvsc device must be brought up before the netvsc device is
 234   unbound and passed to the DPDK.
 235
 236
 237 Tested Platforms
 238 ----------------
 239
 240 .. This section should contain a list of platforms that were tested
 241    with this release.
 242
 243    The format is:
 244
 245    * <vendor> platform with <vendor> <type of devices> combinations
 246
 247      * List of CPU
 248      * List of OS
 249      * List of devices
 250      * Other relevant details...
 251
 252    This section is a comment. Do not overwrite or remove it.
 253    Also, make sure to start the actual text at the margin.
 254    =========================================================