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