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