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