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 * **Added support for using externally allocated memory in DPDK.**
  58
  59   DPDK has gained support for creating new ``rte_malloc`` heaps referencing
  60   memory that was created outside of DPDK's own page allocator, and using that
  61   memory natively with any other DPDK library or data structure.
  62
  63 * **Add support to offload more flow match and actions for CXGBE PMD**
  64
  65   Flow API support has been enhanced for CXGBE Poll Mode Driver to offload:
  66
  67   * Match items: destination MAC address.
  68   * Action items: push/pop/rewrite vlan header.
  69
  70 * **Added a devarg to use the latest supported vector path in i40e.**
  71   A new devarg ``use-latest-supported-vec`` was introduced to allow users to
  72   choose the latest vector path that the platform supported. For example, users
  73   can use AVX2 vector path on BDW/HSW to get better performance.
  74
  75 * **Added support for SR-IOV in netvsc PMD.**
  76
  77   The ``netvsc`` poll mode driver now supports the Accelerated Networking
  78   SR-IOV option in Hyper-V and Azure. This is an alternative to the previous
  79   vdev_netvsc, tap, and failsafe drivers combination.
  80
  81 * **Updated failsafe driver.**
  82
  83   Updated the failsafe driver including the following changes:
  84
  85   * Support for Rx and Tx queues start and stop.
  86   * Support for Rx and Tx queues deferred start.
  87   * Support for runtime Rx and Tx queues setup.
  88   * Support multicast MAC address set.
  89
  90 * **Added Event Ethernet Tx Adapter.**
  91
  92   Added event ethernet Tx adapter library that  provides configuration and
  93   data path APIs for the ethernet transmit stage of an event driven packet
  94   processing application. These APIs abstract the implementation of the
  95   transmit stage and allow the application to use eventdev PMD support or
  96   a common implementation.
  97
  98 * **Added Distributed Software Eventdev PMD.**
  99
 100   Added the new Distributed Software Event Device (DSW), which is a
 101   pure-software eventdev driver distributing the work of scheduling
 102   among all eventdev ports and the lcores using them. DSW, compared to
 103   the SW eventdev PMD, sacrifices load balancing performance to
 104   gain better event scheduling throughput and scalability.
 105
 106 * **Added ability to switch queue deferred start flag on testpmd app.**
 107
 108   Added a console command to testpmd app, giving ability to switch
 109   ``rx_deferred_start`` or ``tx_deferred_start`` flag of the specified queue of
 110   the specified port. The port must be stopped before the command call in order
 111   to reconfigure queues.
 112
 113
 114 API Changes
 115 -----------
 116
 117 .. This section should contain API changes. Sample format:
 118
 119    * Add a short 1-2 sentence description of the API change.
 120      Use fixed width quotes for ``function_names`` or ``struct_names``.
 121      Use the past tense.
 122
 123    This section is a comment. Do not overwrite or remove it.
 124    Also, make sure to start the actual text at the margin.
 125    =========================================================
 126
 127 * eal: ``rte_memseg_list`` structure now has an additional flag indicating
 128   whether the memseg list is externally allocated. This will have implications
 129   for any users of memseg-walk-related functions, as they will now have to skip
 130   externally allocated segments in most cases if the intent is to only iterate
 131   over internal DPDK memory.
 132   ``socket_id`` parameter across the entire DPDK has gained additional meaning,
 133   as some socket ID's will now be representing externally allocated memory. No
 134   changes will be required for existing code as backwards compatibility will be
 135   kept, and those who do not use this feature will not see these extra socket
 136   ID's. Any new API's must not check socket ID parameters themselves, and must
 137   instead leave it to the memory subsystem to decide whether socket ID is a
 138   valid one.
 139
 140 * mbuf: The ``__rte_mbuf_raw_free()`` and ``__rte_pktmbuf_prefree_seg()``
 141   functions were deprecated since 17.05 and are replaced by
 142   ``rte_mbuf_raw_free()`` and ``rte_pktmbuf_prefree_seg()``.
 143
 144 * A new device flag, RTE_ETH_DEV_NOLIVE_MAC_ADDR, changes the order of
 145   actions inside rte_eth_dev_start regarding MAC set. Some NICs do not
 146   support MAC changes once the port has started and with this new device
 147   flag the MAC can be properly configured in any case. This is particularly
 148   important for bonding.
 149
 150 * The default behaviour of CRC strip offload changed. Without any specific Rx
 151   offload flag, default behavior by PMD is now to strip CRC.
 152   DEV_RX_OFFLOAD_CRC_STRIP offload flag has been removed.
 153   To request keeping CRC, application should set ``DEV_RX_OFFLOAD_KEEP_CRC`` Rx
 154   offload.
 155
 156 * eventdev: Type of 2nd parameter to ``rte_event_eth_rx_adapter_caps_get()``
 157   has been changed from uint8_t to uint16_t.
 158
 159
 160 ABI Changes
 161 -----------
 162
 163 .. This section should contain ABI changes. Sample format:
 164
 165    * Add a short 1-2 sentence description of the ABI change
 166      that was announced in the previous releases and made in this release.
 167      Use fixed width quotes for ``function_names`` or ``struct_names``.
 168      Use the past tense.
 169
 170    This section is a comment. Do not overwrite or remove it.
 171    Also, make sure to start the actual text at the margin.
 172    =========================================================
 173
 174 * eal: added ``legacy_mem`` and ``single_file_segments`` values to
 175        ``rte_config`` structure on account of improving DPDK usability when
 176        using either ``--legacy-mem`` or ``--single-file-segments`` flags.
 177
 178 * eal: EAL library ABI version was changed due to previously announced work on
 179        supporting external memory in DPDK:
 180          - structure ``rte_memseg_list`` now has a new field indicating length
 181            of memory addressed by the segment list
 182          - structure ``rte_memseg_list`` now has a new flag indicating whether
 183            the memseg list refers to external memory
 184          - structure ``rte_malloc_heap`` now has a new field indicating socket
 185            ID the malloc heap belongs to
 186          - structure ``rte_mem_config`` has had its ``malloc_heaps`` array
 187            resized from ``RTE_MAX_NUMA_NODES`` to ``RTE_MAX_HEAPS`` value
 188          - structure ``rte_malloc_heap`` now has a ``heap_name`` member
 189          - structure ``rte_eal_memconfig`` has been extended to contain next
 190            socket ID for externally allocated segments
 191
 192
 193 Removed Items
 194 -------------
 195
 196 .. This section should contain removed items in this release. Sample format:
 197
 198    * Add a short 1-2 sentence description of the removed item
 199      in the past tense.
 200
 201    This section is a comment. Do not overwrite or remove it.
 202    Also, make sure to start the actual text at the margin.
 203    =========================================================
 204
 205
 206 Shared Library Versions
 207 -----------------------
 208
 209 .. Update any library version updated in this release
 210    and prepend with a ``+`` sign, like this:
 211
 212      librte_acl.so.2
 213    + librte_cfgfile.so.2
 214      librte_cmdline.so.2
 215
 216    This section is a comment. Do not overwrite or remove it.
 217    =========================================================
 218
 219 The libraries prepended with a plus sign were incremented in this version.
 220
 221 .. code-block:: diff
 222
 223      librte_acl.so.2
 224      librte_bbdev.so.1
 225      librte_bitratestats.so.2
 226      librte_bpf.so.1
 227      librte_bus_dpaa.so.1
 228      librte_bus_fslmc.so.1
 229      librte_bus_pci.so.1
 230      librte_bus_vdev.so.1
 231    + librte_bus_vmbus.so.1
 232      librte_cfgfile.so.2
 233      librte_cmdline.so.2
 234      librte_common_octeontx.so.1
 235      librte_compressdev.so.1
 236      librte_cryptodev.so.5
 237      librte_distributor.so.1
 238    + librte_eal.so.9
 239      librte_ethdev.so.10
 240    + librte_eventdev.so.6
 241      librte_flow_classify.so.1
 242      librte_gro.so.1
 243      librte_gso.so.1
 244      librte_hash.so.2
 245      librte_ip_frag.so.1
 246      librte_jobstats.so.1
 247      librte_kni.so.2
 248      librte_kvargs.so.1
 249      librte_latencystats.so.1
 250      librte_lpm.so.2
 251      librte_mbuf.so.4
 252      librte_mempool.so.5
 253      librte_meter.so.2
 254      librte_metrics.so.1
 255      librte_net.so.1
 256      librte_pci.so.1
 257      librte_pdump.so.2
 258      librte_pipeline.so.3
 259      librte_pmd_bnxt.so.2
 260      librte_pmd_bond.so.2
 261      librte_pmd_i40e.so.2
 262      librte_pmd_ixgbe.so.2
 263      librte_pmd_dpaa2_cmdif.so.1
 264      librte_pmd_dpaa2_qdma.so.1
 265      librte_pmd_ring.so.2
 266      librte_pmd_softnic.so.1
 267      librte_pmd_vhost.so.2
 268    + librte_pmd_netvsc.so.1
 269      librte_port.so.3
 270      librte_power.so.1
 271      librte_rawdev.so.1
 272      librte_reorder.so.1
 273      librte_ring.so.2
 274      librte_sched.so.1
 275      librte_security.so.1
 276      librte_table.so.3
 277      librte_timer.so.1
 278      librte_vhost.so.3
 279
 280
 281 Known Issues
 282 ------------
 283
 284 .. This section should contain new known issues in this release. Sample format:
 285
 286    * **Add title in present tense with full stop.**
 287
 288      Add a short 1-2 sentence description of the known issue
 289      in the present tense. Add information on any known workarounds.
 290
 291    This section is a comment. Do not overwrite or remove it.
 292    Also, make sure to start the actual text at the margin.
 293    =========================================================
 294
 295 * When using SR-IOV (VF) support with netvsc PMD and the Mellanox mlx5 bifurcated
 296   driver; the Linux netvsc device must be brought up before the netvsc device is
 297   unbound and passed to the DPDK.
 298
 299
 300 Tested Platforms
 301 ----------------
 302
 303 .. This section should contain a list of platforms that were tested
 304    with this release.
 305
 306    The format is:
 307
 308    * <vendor> platform with <vendor> <type of devices> combinations
 309
 310      * List of CPU
 311      * List of OS
 312      * List of devices
 313      * Other relevant details...
 314
 315    This section is a comment. Do not overwrite or remove it.
 316    Also, make sure to start the actual text at the margin.
 317    =========================================================