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