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 * eal: ``rte_memseg_list`` structure now has an additional flag indicating
 122   whether the memseg list is externally allocated. This will have implications
 123   for any users of memseg-walk-related functions, as they will now have to skip
 124   externally allocated segments in most cases if the intent is to only iterate
 125   over internal DPDK memory.
 126
 127 * mbuf: The ``__rte_mbuf_raw_free()`` and ``__rte_pktmbuf_prefree_seg()``
 128   functions were deprecated since 17.05 and are replaced by
 129   ``rte_mbuf_raw_free()`` and ``rte_pktmbuf_prefree_seg()``.
 130
 131 * A new device flag, RTE_ETH_DEV_NOLIVE_MAC_ADDR, changes the order of
 132   actions inside rte_eth_dev_start regarding MAC set. Some NICs do not
 133   support MAC changes once the port has started and with this new device
 134   flag the MAC can be properly configured in any case. This is particularly
 135   important for bonding.
 136
 137 * The default behaviour of CRC strip offload changed. Without any specific Rx
 138   offload flag, default behavior by PMD is now to strip CRC.
 139   DEV_RX_OFFLOAD_CRC_STRIP offload flag has been removed.
 140   To request keeping CRC, application should set ``DEV_RX_OFFLOAD_KEEP_CRC`` Rx
 141   offload.
 142
 143 * eventdev: Type of 2nd parameter to ``rte_event_eth_rx_adapter_caps_get()``
 144   has been changed from uint8_t to uint16_t.
 145
 146
 147 ABI Changes
 148 -----------
 149
 150 .. This section should contain ABI changes. Sample format:
 151
 152    * Add a short 1-2 sentence description of the ABI change
 153      that was announced in the previous releases and made in this release.
 154      Use fixed width quotes for ``function_names`` or ``struct_names``.
 155      Use the past tense.
 156
 157    This section is a comment. Do not overwrite or remove it.
 158    Also, make sure to start the actual text at the margin.
 159    =========================================================
 160
 161 * eal: added ``legacy_mem`` and ``single_file_segments`` values to
 162        ``rte_config`` structure on account of improving DPDK usability when
 163        using either ``--legacy-mem`` or ``--single-file-segments`` flags.
 164
 165 * eal: EAL library ABI version was changed due to previously announced work on
 166        supporting external memory in DPDK:
 167          - structure ``rte_memseg_list`` now has a new field indicating length
 168            of memory addressed by the segment list
 169          - structure ``rte_memseg_list`` now has a new flag indicating whether
 170            the memseg list refers to external memory
 171
 172
 173 Removed Items
 174 -------------
 175
 176 .. This section should contain removed items in this release. Sample format:
 177
 178    * Add a short 1-2 sentence description of the removed item
 179      in the past tense.
 180
 181    This section is a comment. Do not overwrite or remove it.
 182    Also, make sure to start the actual text at the margin.
 183    =========================================================
 184
 185
 186 Shared Library Versions
 187 -----------------------
 188
 189 .. Update any library version updated in this release
 190    and prepend with a ``+`` sign, like this:
 191
 192      librte_acl.so.2
 193    + librte_cfgfile.so.2
 194      librte_cmdline.so.2
 195
 196    This section is a comment. Do not overwrite or remove it.
 197    =========================================================
 198
 199 The libraries prepended with a plus sign were incremented in this version.
 200
 201 .. code-block:: diff
 202
 203      librte_acl.so.2
 204      librte_bbdev.so.1
 205      librte_bitratestats.so.2
 206      librte_bpf.so.1
 207      librte_bus_dpaa.so.1
 208      librte_bus_fslmc.so.1
 209      librte_bus_pci.so.1
 210      librte_bus_vdev.so.1
 211    + librte_bus_vmbus.so.1
 212      librte_cfgfile.so.2
 213      librte_cmdline.so.2
 214      librte_common_octeontx.so.1
 215      librte_compressdev.so.1
 216      librte_cryptodev.so.5
 217      librte_distributor.so.1
 218    + librte_eal.so.9
 219      librte_ethdev.so.10
 220    + librte_eventdev.so.6
 221      librte_flow_classify.so.1
 222      librte_gro.so.1
 223      librte_gso.so.1
 224      librte_hash.so.2
 225      librte_ip_frag.so.1
 226      librte_jobstats.so.1
 227      librte_kni.so.2
 228      librte_kvargs.so.1
 229      librte_latencystats.so.1
 230      librte_lpm.so.2
 231      librte_mbuf.so.4
 232      librte_mempool.so.5
 233      librte_meter.so.2
 234      librte_metrics.so.1
 235      librte_net.so.1
 236      librte_pci.so.1
 237      librte_pdump.so.2
 238      librte_pipeline.so.3
 239      librte_pmd_bnxt.so.2
 240      librte_pmd_bond.so.2
 241      librte_pmd_i40e.so.2
 242      librte_pmd_ixgbe.so.2
 243      librte_pmd_dpaa2_cmdif.so.1
 244      librte_pmd_dpaa2_qdma.so.1
 245      librte_pmd_ring.so.2
 246      librte_pmd_softnic.so.1
 247      librte_pmd_vhost.so.2
 248    + librte_pmd_netvsc.so.1
 249      librte_port.so.3
 250      librte_power.so.1
 251      librte_rawdev.so.1
 252      librte_reorder.so.1
 253      librte_ring.so.2
 254      librte_sched.so.1
 255      librte_security.so.1
 256      librte_table.so.3
 257      librte_timer.so.1
 258      librte_vhost.so.3
 259
 260
 261 Known Issues
 262 ------------
 263
 264 .. This section should contain new known issues in this release. Sample format:
 265
 266    * **Add title in present tense with full stop.**
 267
 268      Add a short 1-2 sentence description of the known issue
 269      in the present tense. Add information on any known workarounds.
 270
 271    This section is a comment. Do not overwrite or remove it.
 272    Also, make sure to start the actual text at the margin.
 273    =========================================================
 274
 275 * When using SR-IOV (VF) support with netvsc PMD and the Mellanox mlx5 bifurcated
 276   driver; the Linux netvsc device must be brought up before the netvsc device is
 277   unbound and passed to the DPDK.
 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    =========================================================