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