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