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