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 * **Added hot-unplug handle mechanism.**
  64
  65   ``rte_dev_hotplug_handle_enable`` and ``rte_dev_hotplug_handle_disable`` are
  66   for enabling or disabling hotplug handle mechanism.
  67
  68 * **Support device multi-process hotplug.**
  69
  70   Hotplug and hot-unplug for devices will now be supported in multiprocessing
  71   scenario. Any ethdev devices created in the primary process will be regarded
  72   as shared and will be available for all DPDK processes. Synchronization
  73   between processes will be done using DPDK IPC.
  74
  75 * **Added new Flow API actions to rewrite fields in packet headers.**
  76
  77   Added new Flow API actions to:
  78
  79   * Modify source and destination IP addresses in the outermost IPv4/IPv6
  80     headers.
  81   * Modify source and destination port numbers in the outermost TCP/UDP
  82     headers.
  83
  84 * **Added new Flow API action to swap MAC addresses in Ethernet header.**
  85
  86   Added new Flow API action to swap the source and destination MAC
  87   addresses in the outermost Ethernet header.
  88
  89 * **Add support to offload more flow match and actions for CXGBE PMD**
  90
  91   Flow API support has been enhanced for CXGBE Poll Mode Driver to offload:
  92
  93   * Match items: destination MAC address.
  94   * Action items: push/pop/rewrite vlan header,
  95     rewrite IP addresses in outermost IPv4/IPv6 header,
  96     rewrite port numbers in outermost TCP/UDP header.
  97
  98 * **Added a devarg to use the latest supported vector path in i40e.**
  99   A new devarg ``use-latest-supported-vec`` was introduced to allow users to
 100   choose the latest vector path that the platform supported. For example, users
 101   can use AVX2 vector path on BDW/HSW to get better performance.
 102
 103 * **Added support for SR-IOV in netvsc PMD.**
 104
 105   The ``netvsc`` poll mode driver now supports the Accelerated Networking
 106   SR-IOV option in Hyper-V and Azure. This is an alternative to the previous
 107   vdev_netvsc, tap, and failsafe drivers combination.
 108
 109 * **Added a new net driver for Marvell Armada 3k device.**
 110
 111   Added the new ``mvneta`` net driver for Marvell Armada 3k device. See the
 112   :doc:`../nics/mvneta` NIC guide for more details on this new driver.
 113
 114 * **Added NXP ENETC PMD.**
 115
 116   Added the new enetc driver for NXP enetc platform. See the
 117   "ENETC Poll Mode Driver" document for more details on this new driver.
 118
 119 * **Updated Solarflare network PMD.**
 120
 121   Updated the sfc_efx driver including the following changes:
 122
 123   * Added support for Rx scatter in EF10 datapath implementation.
 124   * Added support for Rx descriptor status API in EF10 datapath implementation.
 125   * Added support for TSO in EF10 datapath implementation.
 126   * Added support for Tx descriptor status API in EF10 (ef10 and ef10_simple)
 127     datapaths implementation.
 128
 129 * **Updated failsafe driver.**
 130
 131   Updated the failsafe driver including the following changes:
 132
 133   * Support for Rx and Tx queues start and stop.
 134   * Support for Rx and Tx queues deferred start.
 135   * Support for runtime Rx and Tx queues setup.
 136   * Support multicast MAC address set.
 137
 138 * **Added a devarg to use PCAP interface physical MAC address.**
 139   A new devarg ``phy_mac`` was introduced to allow users to use physical
 140   MAC address of the selected PCAP interface.
 141
 142 * **Added support for GEN3 devices to Intel QAT driver .**
 143
 144   Added support for the third generation of Intel QuickAssist devices.
 145
 146 * **Updated the QAT PMD.**
 147
 148   The QAT PMD was updated with additional support for:
 149
 150   * AES-CMAC algorithm.
 151
 152 * **Updated the AESNI MB PMD.**
 153
 154   The AESNI MB PMD has been updated with additional support for AES-GCM
 155   algorithm support.
 156
 157 * **Added Event Ethernet Tx Adapter.**
 158
 159   Added event ethernet Tx adapter library that  provides configuration and
 160   data path APIs for the ethernet transmit stage of an event driven packet
 161   processing application. These APIs abstract the implementation of the
 162   transmit stage and allow the application to use eventdev PMD support or
 163   a common implementation.
 164
 165 * **Added Distributed Software Eventdev PMD.**
 166
 167   Added the new Distributed Software Event Device (DSW), which is a
 168   pure-software eventdev driver distributing the work of scheduling
 169   among all eventdev ports and the lcores using them. DSW, compared to
 170   the SW eventdev PMD, sacrifices load balancing performance to
 171   gain better event scheduling throughput and scalability.
 172
 173 * **Added ability to switch queue deferred start flag on testpmd app.**
 174
 175   Added a console command to testpmd app, giving ability to switch
 176   ``rx_deferred_start`` or ``tx_deferred_start`` flag of the specified queue of
 177   the specified port. The port must be stopped before the command call in order
 178   to reconfigure queues.
 179
 180 * **Add a new sample for vDPA**
 181
 182   The vdpa sample application creates vhost-user sockets by using the
 183   vDPA backend. vDPA stands for vhost Data Path Acceleration which utilizes
 184   virtio ring compatible devices to serve virtio driver directly to enable
 185   datapath acceleration. As vDPA driver can help to set up vhost datapath,
 186   this application doesn't need to launch dedicated worker threads for vhost
 187   enqueue/dequeue operations.
 188
 189
 190 API Changes
 191 -----------
 192
 193 .. This section should contain API changes. Sample format:
 194
 195    * Add a short 1-2 sentence description of the API change.
 196      Use fixed width quotes for ``function_names`` or ``struct_names``.
 197      Use the past tense.
 198
 199    This section is a comment. Do not overwrite or remove it.
 200    Also, make sure to start the actual text at the margin.
 201    =========================================================
 202
 203 * eal: ``rte_memseg_list`` structure now has an additional flag indicating
 204   whether the memseg list is externally allocated. This will have implications
 205   for any users of memseg-walk-related functions, as they will now have to skip
 206   externally allocated segments in most cases if the intent is to only iterate
 207   over internal DPDK memory.
 208   ``socket_id`` parameter across the entire DPDK has gained additional meaning,
 209   as some socket ID's will now be representing externally allocated memory. No
 210   changes will be required for existing code as backwards compatibility will be
 211   kept, and those who do not use this feature will not see these extra socket
 212   ID's. Any new API's must not check socket ID parameters themselves, and must
 213   instead leave it to the memory subsystem to decide whether socket ID is a
 214   valid one.
 215
 216 * eal: The following devargs functions, which were deprecated in 18.05,
 217   were removed in 18.11:
 218   ``rte_eal_parse_devargs_str()``, ``rte_eal_devargs_add()``,
 219   ``rte_eal_devargs_type_count()``, and ``rte_eal_devargs_dump()``.
 220
 221 * eal: The parameters of the function ``rte_devargs_remove()`` have changed
 222   from bus and device names to ``struct rte_devargs``.
 223
 224 * eal: The scope of ``rte_eal_hotplug_add()``/``rte_dev_probe()``
 225   and ``rte_eal_hotplug_remove()``/``rte_dev_remove()`` is extended.
 226   In multi-process model, they will guarantee that the device is
 227   attached or detached on all processes.
 228
 229 * mbuf: The ``__rte_mbuf_raw_free()`` and ``__rte_pktmbuf_prefree_seg()``
 230   functions were deprecated since 17.05 and are replaced by
 231   ``rte_mbuf_raw_free()`` and ``rte_pktmbuf_prefree_seg()``.
 232
 233 * A new device flag, RTE_ETH_DEV_NOLIVE_MAC_ADDR, changes the order of
 234   actions inside rte_eth_dev_start regarding MAC set. Some NICs do not
 235   support MAC changes once the port has started and with this new device
 236   flag the MAC can be properly configured in any case. This is particularly
 237   important for bonding.
 238
 239 * The default behaviour of CRC strip offload changed. Without any specific Rx
 240   offload flag, default behavior by PMD is now to strip CRC.
 241   DEV_RX_OFFLOAD_CRC_STRIP offload flag has been removed.
 242   To request keeping CRC, application should set ``DEV_RX_OFFLOAD_KEEP_CRC`` Rx
 243   offload.
 244
 245 * eventdev: Type of 2nd parameter to ``rte_event_eth_rx_adapter_caps_get()``
 246   has been changed from uint8_t to uint16_t.
 247
 248
 249 ABI Changes
 250 -----------
 251
 252 .. This section should contain ABI changes. Sample format:
 253
 254    * Add a short 1-2 sentence description of the ABI change
 255      that was announced in the previous releases and made in this release.
 256      Use fixed width quotes for ``function_names`` or ``struct_names``.
 257      Use the past tense.
 258
 259    This section is a comment. Do not overwrite or remove it.
 260    Also, make sure to start the actual text at the margin.
 261    =========================================================
 262
 263 * eal: added ``legacy_mem`` and ``single_file_segments`` values to
 264        ``rte_config`` structure on account of improving DPDK usability when
 265        using either ``--legacy-mem`` or ``--single-file-segments`` flags.
 266
 267 * eal: EAL library ABI version was changed due to previously announced work on
 268        supporting external memory in DPDK:
 269          - structure ``rte_memseg_list`` now has a new field indicating length
 270            of memory addressed by the segment list
 271          - structure ``rte_memseg_list`` now has a new flag indicating whether
 272            the memseg list refers to external memory
 273          - structure ``rte_malloc_heap`` now has a new field indicating socket
 274            ID the malloc heap belongs to
 275          - structure ``rte_mem_config`` has had its ``malloc_heaps`` array
 276            resized from ``RTE_MAX_NUMA_NODES`` to ``RTE_MAX_HEAPS`` value
 277          - structure ``rte_malloc_heap`` now has a ``heap_name`` member
 278          - structure ``rte_eal_memconfig`` has been extended to contain next
 279            socket ID for externally allocated segments
 280
 281 * eal: The structure ``rte_device`` got a new field to reference a ``rte_bus``.
 282   It is changing the size of the ``struct rte_device`` and the inherited
 283   device structures of all buses.
 284
 285
 286 Removed Items
 287 -------------
 288
 289 .. This section should contain removed items in this release. Sample format:
 290
 291    * Add a short 1-2 sentence description of the removed item
 292      in the past tense.
 293
 294    This section is a comment. Do not overwrite or remove it.
 295    Also, make sure to start the actual text at the margin.
 296    =========================================================
 297
 298
 299 Shared Library Versions
 300 -----------------------
 301
 302 .. Update any library version updated in this release
 303    and prepend with a ``+`` sign, like this:
 304
 305      librte_acl.so.2
 306    + librte_cfgfile.so.2
 307      librte_cmdline.so.2
 308
 309    This section is a comment. Do not overwrite or remove it.
 310    =========================================================
 311
 312 The libraries prepended with a plus sign were incremented in this version.
 313
 314 .. code-block:: diff
 315
 316      librte_acl.so.2
 317      librte_bbdev.so.1
 318      librte_bitratestats.so.2
 319      librte_bpf.so.1
 320    + librte_bus_dpaa.so.2
 321    + librte_bus_fslmc.so.2
 322    + librte_bus_ifpga.so.2
 323    + librte_bus_pci.so.2
 324    + librte_bus_vdev.so.2
 325    + librte_bus_vmbus.so.2
 326      librte_cfgfile.so.2
 327      librte_cmdline.so.2
 328      librte_common_octeontx.so.1
 329      librte_compressdev.so.1
 330      librte_cryptodev.so.5
 331      librte_distributor.so.1
 332    + librte_eal.so.9
 333      librte_ethdev.so.10
 334    + librte_eventdev.so.6
 335      librte_flow_classify.so.1
 336      librte_gro.so.1
 337      librte_gso.so.1
 338      librte_hash.so.2
 339      librte_ip_frag.so.1
 340      librte_jobstats.so.1
 341      librte_kni.so.2
 342      librte_kvargs.so.1
 343      librte_latencystats.so.1
 344      librte_lpm.so.2
 345      librte_mbuf.so.4
 346      librte_mempool.so.5
 347      librte_meter.so.2
 348      librte_metrics.so.1
 349      librte_net.so.1
 350      librte_pci.so.1
 351      librte_pdump.so.2
 352      librte_pipeline.so.3
 353      librte_pmd_bnxt.so.2
 354      librte_pmd_bond.so.2
 355      librte_pmd_i40e.so.2
 356      librte_pmd_ixgbe.so.2
 357      librte_pmd_dpaa2_cmdif.so.1
 358      librte_pmd_dpaa2_qdma.so.1
 359      librte_pmd_ring.so.2
 360      librte_pmd_softnic.so.1
 361      librte_pmd_vhost.so.2
 362    + librte_pmd_netvsc.so.1
 363      librte_port.so.3
 364      librte_power.so.1
 365      librte_rawdev.so.1
 366      librte_reorder.so.1
 367      librte_ring.so.2
 368      librte_sched.so.1
 369      librte_security.so.1
 370      librte_table.so.3
 371      librte_timer.so.1
 372      librte_vhost.so.3
 373
 374
 375 Known Issues
 376 ------------
 377
 378 .. This section should contain new known issues in this release. Sample format:
 379
 380    * **Add title in present tense with full stop.**
 381
 382      Add a short 1-2 sentence description of the known issue
 383      in the present tense. Add information on any known workarounds.
 384
 385    This section is a comment. Do not overwrite or remove it.
 386    Also, make sure to start the actual text at the margin.
 387    =========================================================
 388
 389 * When using SR-IOV (VF) support with netvsc PMD and the Mellanox mlx5 bifurcated
 390   driver; the Linux netvsc device must be brought up before the netvsc device is
 391   unbound and passed to the DPDK.
 392
 393
 394 Tested Platforms
 395 ----------------
 396
 397 .. This section should contain a list of platforms that were tested
 398    with this release.
 399
 400    The format is:
 401
 402    * <vendor> platform with <vendor> <type of devices> combinations
 403
 404      * List of CPU
 405      * List of OS
 406      * List of devices
 407      * Other relevant details...
 408
 409    This section is a comment. Do not overwrite or remove it.
 410    Also, make sure to start the actual text at the margin.
 411    =========================================================