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 check for ensuring allocated memory addressable by devices.**
  64
  65   Some devices can have addressing limitations so a new function,
  66   ``rte_mem_check_dma_mask``, has been added for checking allocated memory is
  67   not out of the device range. Because now memory can be dynamically allocated
  68   after initialization, a dma mask is kept and any new allocated memory will be
  69   checked out against that dma mask and rejected if out of range. If more than
  70   one device has addressing limitations, the dma mask is the more restricted one.
  71
  72 * **Updated the C11 memory model version of ring library.**
  73
  74   The latency is decreased for architectures using the C11 memory model
  75   version of the ring library.
  76
  77   On Cavium ThunderX2 platform, the changes decreased latency by 27~29%
  78   and 3~15% for MPMC and SPSC cases respectively (with 2 lcores). The
  79   real improvements may vary with the number of contending lcores and
  80   the size of ring.
  81
  82 * **Added hot-unplug handle mechanism.**
  83
  84   ``rte_dev_hotplug_handle_enable`` and ``rte_dev_hotplug_handle_disable`` are
  85   for enabling or disabling hotplug handle mechanism.
  86
  87 * **Support device multi-process hotplug.**
  88
  89   Hotplug and hot-unplug for devices will now be supported in multiprocessing
  90   scenario. Any ethdev devices created in the primary process will be regarded
  91   as shared and will be available for all DPDK processes. Synchronization
  92   between processes will be done using DPDK IPC.
  93
  94 * **Added new Flow API actions to rewrite fields in packet headers.**
  95
  96   Added new Flow API actions to:
  97
  98   * Modify source and destination IP addresses in the outermost IPv4/IPv6
  99     headers.
 100   * Modify source and destination port numbers in the outermost TCP/UDP
 101     headers.
 102
 103 * **Added new Flow API action to swap MAC addresses in Ethernet header.**
 104
 105   Added new Flow API action to swap the source and destination MAC
 106   addresses in the outermost Ethernet header.
 107
 108 * **Add support to offload more flow match and actions for CXGBE PMD**
 109
 110   Flow API support has been enhanced for CXGBE Poll Mode Driver to offload:
 111
 112   * Match items: destination MAC address.
 113   * Action items: push/pop/rewrite vlan header,
 114     rewrite IP addresses in outermost IPv4/IPv6 header,
 115     rewrite port numbers in outermost TCP/UDP header,
 116     swap MAC addresses in outermost Ethernet header.
 117
 118 * **Added a devarg to use the latest supported vector path in i40e.**
 119   A new devarg ``use-latest-supported-vec`` was introduced to allow users to
 120   choose the latest vector path that the platform supported. For example, users
 121   can use AVX2 vector path on BDW/HSW to get better performance.
 122
 123 * **Added support for SR-IOV in netvsc PMD.**
 124
 125   The ``netvsc`` poll mode driver now supports the Accelerated Networking
 126   SR-IOV option in Hyper-V and Azure. This is an alternative to the previous
 127   vdev_netvsc, tap, and failsafe drivers combination.
 128
 129 * **Added a new net driver for Marvell Armada 3k device.**
 130
 131   Added the new ``mvneta`` net driver for Marvell Armada 3k device. See the
 132   :doc:`../nics/mvneta` NIC guide for more details on this new driver.
 133
 134 * **Added NXP ENETC PMD.**
 135
 136   Added the new enetc driver for NXP enetc platform. See the
 137   "ENETC Poll Mode Driver" document for more details on this new driver.
 138
 139 * **Added Ethernet poll mode driver for Aquantia aQtion family of 10G devices.**
 140
 141   Added the new ``atlantic`` ethernet poll mode driver for Aquantia XGBE devices.
 142   See the :doc:`../nics/atlantic` nic driver guide for more details on this
 143   driver.
 144
 145 * **Updated Solarflare network PMD.**
 146
 147   Updated the sfc_efx driver including the following changes:
 148
 149   * Added support for Rx scatter in EF10 datapath implementation.
 150   * Added support for Rx descriptor status API in EF10 datapath implementation.
 151   * Added support for TSO in EF10 datapath implementation.
 152   * Added support for Tx descriptor status API in EF10 (ef10 and ef10_simple)
 153     datapaths implementation.
 154
 155 * **Updated the enic driver.**
 156
 157   * Added AVX2-based vectorized Rx handler.
 158   * Added VLAN and checksum offloads to the simple Tx handler.
 159   * Added the count flow action.
 160   * Enabled the virtual address IOVA mode.
 161
 162 * **Updated failsafe driver.**
 163
 164   Updated the failsafe driver including the following changes:
 165
 166   * Support for Rx and Tx queues start and stop.
 167   * Support for Rx and Tx queues deferred start.
 168   * Support for runtime Rx and Tx queues setup.
 169   * Support multicast MAC address set.
 170
 171 * **Added a devarg to use PCAP interface physical MAC address.**
 172   A new devarg ``phy_mac`` was introduced to allow users to use physical
 173   MAC address of the selected PCAP interface.
 174
 175 * **Added TAP Rx/Tx queues sharing with a secondary process.**
 176
 177   A secondary process can attach a TAP device created in the primary process,
 178   probe the queues, and process Rx/Tx in a secondary process.
 179
 180 * **Added classification and metering support to SoftNIC PMD.**
 181
 182   Added support for flow classification (rte_flow API), and metering and
 183   policing (rte_mtr API) to the SoftNIC PMD.
 184
 185 * **Added Crypto support to Softnic PMD.**
 186
 187   The Softnic is now capable of processing symmetric crypto workloads such
 188   as cipher, cipher-authentication chaining, and aead encryption and
 189   decryption. This is achieved by calling DPDK Cryptodev APIs.
 190
 191 * **Added cryptodev port to port library.**
 192
 193   Cryptodev port is a shim layer in the port library that interacts with DPDK
 194   Cryptodev PMDs including burst enqueuing and dequeuing crypto operations.
 195
 196 * **Added symmetric cryptographic actions to the pipeline library.**
 197
 198   In the pipeline library an added symmetric crypto action parsing and action
 199   handler are implemented. The action allows automatically preparing the crypto
 200   operation with the rules specified such as algorithm, key, and IV, etc for
 201   the cryptodev port to process.
 202
 203 * **Added support for GEN3 devices to Intel QAT driver .**
 204
 205   Added support for the third generation of Intel QuickAssist devices.
 206
 207 * **Updated the QAT PMD.**
 208
 209   The QAT PMD was updated with additional support for:
 210
 211   * AES-CMAC algorithm.
 212
 213 * **Updated the AESNI MB PMD.**
 214
 215   The AESNI MB PMD has been updated with additional support for AES-GCM
 216   algorithm support.
 217
 218 * **Added NXP CAAM JR PMD.**
 219
 220   Added the new caam job ring driver for NXP platforms. See the
 221   "NXP CAAM JOB RING (caam_jr)" document for more details on this new driver.
 222
 223 * **Added support for Dynamic Huffman Encoding to Intel QAT comp PMD.**
 224
 225   The Intel QuickAssist (QAT) compression PMD has been updated with support
 226   for Dynamic Huffman Encoding for the Deflate algorithm.
 227
 228 * **Added Event Ethernet Tx Adapter.**
 229
 230   Added event ethernet Tx adapter library that  provides configuration and
 231   data path APIs for the ethernet transmit stage of an event driven packet
 232   processing application. These APIs abstract the implementation of the
 233   transmit stage and allow the application to use eventdev PMD support or
 234   a common implementation.
 235
 236 * **Added Distributed Software Eventdev PMD.**
 237
 238   Added the new Distributed Software Event Device (DSW), which is a
 239   pure-software eventdev driver distributing the work of scheduling
 240   among all eventdev ports and the lcores using them. DSW, compared to
 241   the SW eventdev PMD, sacrifices load balancing performance to
 242   gain better event scheduling throughput and scalability.
 243
 244 * **Added extendable bucket feature to hash library (rte_hash).**
 245
 246   This new “extendable bucket” feature provides 100% insertion guarantee to
 247   the capacity specified by the user by extending hash table with extra
 248   buckets when needed to accommodate the unlikely event of intensive hash
 249   collisions.  In addition, the internal hashing algorithm was changed to use
 250   partial-key hashing to improve memory efficiency and lookup performance.
 251
 252 * **Added lock free reader/writer concurrency to hash library (rte_hash).**
 253
 254   Lock free reader/writer concurrency prevents the readers from getting
 255   blocked due to a pre-empted writer thread. This allows the hash library
 256   to be used in scenarios where the writer thread runs on control plane.
 257
 258 * **Added Traffic Pattern Aware Power Control Library**
 259
 260   Added an experimental library. This extend Power Library and provide
 261   empty_poll APIs. This feature measure how many times empty_poll are
 262   executed per core, use the number of empty polls as a hint for system
 263   power management.
 264
 265   See the :doc:`../prog_guide/power_man` section of the DPDK Programmers
 266   Guide document for more information.
 267
 268 * **Added JSON power policy interface for containers.**
 269
 270   Extended the Power Library and vm_power_manager sample app to allow power
 271   policies to be submitted via a FIFO using JSON formatted strings. Previously
 272   limited to Virtual Machines, this feature extends power policy functionality
 273   to containers and host applications that need to have their cores frequency
 274   controlled based on the rules contained in the policy.
 275
 276 * **Added Telemetry API.**
 277
 278   Added the telemetry API which allows applications to transparently expose
 279   their telemetry via a UNIX socket in JSON. The JSON can be consumed by any
 280   Service Assurance agent, such as CollectD.
 281
 282 * **Added ability to switch queue deferred start flag on testpmd app.**
 283
 284   Added a console command to testpmd app, giving ability to switch
 285   ``rx_deferred_start`` or ``tx_deferred_start`` flag of the specified queue of
 286   the specified port. The port must be stopped before the command call in order
 287   to reconfigure queues.
 288
 289 * **Add a new sample for vDPA**
 290
 291   The vdpa sample application creates vhost-user sockets by using the
 292   vDPA backend. vDPA stands for vhost Data Path Acceleration which utilizes
 293   virtio ring compatible devices to serve virtio driver directly to enable
 294   datapath acceleration. As vDPA driver can help to set up vhost datapath,
 295   this application doesn't need to launch dedicated worker threads for vhost
 296   enqueue/dequeue operations.
 297
 298 * **Added cryptodev FIPS validation example application.**
 299
 300   Added an example application to parse and perform symmetric cryptography
 301   computation to the NIST Cryptographic Algorithm Validation Program (CAVP)
 302   test vectors.
 303
 304 * **Allow unit test binary to take parameters from the environment**
 305
 306   The unit test "test", or "dpdk-test", binary is often called from scripts,
 307   which can make passing additional parameters, such as a coremask, to it more
 308   awkward. Support has been added to the application to allow it to take
 309   additional command-line parameter values from the "DPDK_TEST_PARAMS"
 310   environment variable to make this application easier to use.
 311
 312
 313 API Changes
 314 -----------
 315
 316 .. This section should contain API changes. Sample format:
 317
 318    * Add a short 1-2 sentence description of the API change.
 319      Use fixed width quotes for ``function_names`` or ``struct_names``.
 320      Use the past tense.
 321
 322    This section is a comment. Do not overwrite or remove it.
 323    Also, make sure to start the actual text at the margin.
 324    =========================================================
 325
 326 * eal: ``rte_memseg_list`` structure now has an additional flag indicating
 327   whether the memseg list is externally allocated. This will have implications
 328   for any users of memseg-walk-related functions, as they will now have to skip
 329   externally allocated segments in most cases if the intent is to only iterate
 330   over internal DPDK memory.
 331   ``socket_id`` parameter across the entire DPDK has gained additional meaning,
 332   as some socket ID's will now be representing externally allocated memory. No
 333   changes will be required for existing code as backwards compatibility will be
 334   kept, and those who do not use this feature will not see these extra socket
 335   ID's. Any new API's must not check socket ID parameters themselves, and must
 336   instead leave it to the memory subsystem to decide whether socket ID is a
 337   valid one.
 338
 339 * eal: The following devargs functions, which were deprecated in 18.05,
 340   were removed in 18.11:
 341   ``rte_eal_parse_devargs_str()``, ``rte_eal_devargs_add()``,
 342   ``rte_eal_devargs_type_count()``, and ``rte_eal_devargs_dump()``.
 343
 344 * eal: The parameters of the function ``rte_devargs_remove()`` have changed
 345   from bus and device names to ``struct rte_devargs``.
 346
 347 * eal: The deprecated functions attach/detach were removed in 18.11.
 348   ``rte_eal_dev_attach`` can be replaced by
 349   ``rte_dev_probe`` or ``rte_eal_hotplug_add``.
 350   ``rte_eal_dev_detach`` can be replaced by
 351   ``rte_dev_remove`` or ``rte_eal_hotplug_remove``.
 352
 353 * eal: The scope of ``rte_eal_hotplug_add()``/``rte_dev_probe()``
 354   and ``rte_eal_hotplug_remove()``/``rte_dev_remove()`` is extended.
 355   In multi-process model, they will guarantee that the device is
 356   attached or detached on all processes.
 357
 358 * mbuf: The ``__rte_mbuf_raw_free()`` and ``__rte_pktmbuf_prefree_seg()``
 359   functions were deprecated since 17.05 and are replaced by
 360   ``rte_mbuf_raw_free()`` and ``rte_pktmbuf_prefree_seg()``.
 361
 362 * ethdev: The deprecated functions attach/detach were removed in 18.11.
 363   ``rte_eth_dev_attach`` can be replaced by ``RTE_ETH_FOREACH_MATCHING_DEV``
 364   and ``rte_dev_probe`` or ``rte_eal_hotplug_add``.
 365   ``rte_eth_dev_detach`` can be replaced by
 366   ``rte_dev_remove`` or ``rte_eal_hotplug_remove``.
 367
 368 * ethdev: A call to ``rte_eth_dev_release_port()`` has been added in
 369   ``rte_eth_dev_close()``. As a consequence, a closed port is freed
 370   and seen as invalid because of its state ``RTE_ETH_DEV_UNUSED``.
 371   This new behaviour is enabled per driver for a migration period.
 372
 373 * A new device flag, RTE_ETH_DEV_NOLIVE_MAC_ADDR, changes the order of
 374   actions inside rte_eth_dev_start regarding MAC set. Some NICs do not
 375   support MAC changes once the port has started and with this new device
 376   flag the MAC can be properly configured in any case. This is particularly
 377   important for bonding.
 378
 379 * The default behaviour of CRC strip offload changed. Without any specific Rx
 380   offload flag, default behavior by PMD is now to strip CRC.
 381   DEV_RX_OFFLOAD_CRC_STRIP offload flag has been removed.
 382   To request keeping CRC, application should set ``DEV_RX_OFFLOAD_KEEP_CRC`` Rx
 383   offload.
 384
 385 * eventdev: Type of 2nd parameter to ``rte_event_eth_rx_adapter_caps_get()``
 386   has been changed from uint8_t to uint16_t.
 387
 388
 389 ABI Changes
 390 -----------
 391
 392 .. This section should contain ABI changes. Sample format:
 393
 394    * Add a short 1-2 sentence description of the ABI change
 395      that was announced in the previous releases and made in this release.
 396      Use fixed width quotes for ``function_names`` or ``struct_names``.
 397      Use the past tense.
 398
 399    This section is a comment. Do not overwrite or remove it.
 400    Also, make sure to start the actual text at the margin.
 401    =========================================================
 402
 403 * eal: added ``legacy_mem`` and ``single_file_segments`` values to
 404        ``rte_config`` structure on account of improving DPDK usability when
 405        using either ``--legacy-mem`` or ``--single-file-segments`` flags.
 406
 407 * eal: EAL library ABI version was changed due to previously announced work on
 408        supporting external memory in DPDK:
 409          - structure ``rte_memseg_list`` now has a new field indicating length
 410            of memory addressed by the segment list
 411          - structure ``rte_memseg_list`` now has a new flag indicating whether
 412            the memseg list refers to external memory
 413          - structure ``rte_malloc_heap`` now has a new field indicating socket
 414            ID the malloc heap belongs to
 415          - structure ``rte_mem_config`` has had its ``malloc_heaps`` array
 416            resized from ``RTE_MAX_NUMA_NODES`` to ``RTE_MAX_HEAPS`` value
 417          - structure ``rte_malloc_heap`` now has a ``heap_name`` member
 418          - structure ``rte_eal_memconfig`` has been extended to contain next
 419            socket ID for externally allocated segments
 420
 421 * eal: Added ``dma_maskbits`` to ``rte_mem_config`` for keeping more restricted
 422        dma mask based on devices addressing limitations.
 423
 424 * eal: The structure ``rte_device`` got a new field to reference a ``rte_bus``.
 425   It is changing the size of the ``struct rte_device`` and the inherited
 426   device structures of all buses.
 427
 428
 429 Removed Items
 430 -------------
 431
 432 .. This section should contain removed items in this release. Sample format:
 433
 434    * Add a short 1-2 sentence description of the removed item
 435      in the past tense.
 436
 437    This section is a comment. Do not overwrite or remove it.
 438    Also, make sure to start the actual text at the margin.
 439    =========================================================
 440
 441
 442 Shared Library Versions
 443 -----------------------
 444
 445 .. Update any library version updated in this release
 446    and prepend with a ``+`` sign, like this:
 447
 448      librte_acl.so.2
 449    + librte_cfgfile.so.2
 450      librte_cmdline.so.2
 451
 452    This section is a comment. Do not overwrite or remove it.
 453    =========================================================
 454
 455 The libraries prepended with a plus sign were incremented in this version.
 456
 457 .. code-block:: diff
 458
 459      librte_acl.so.2
 460      librte_bbdev.so.1
 461      librte_bitratestats.so.2
 462      librte_bpf.so.1
 463    + librte_bus_dpaa.so.2
 464    + librte_bus_fslmc.so.2
 465    + librte_bus_ifpga.so.2
 466    + librte_bus_pci.so.2
 467    + librte_bus_vdev.so.2
 468    + librte_bus_vmbus.so.2
 469      librte_cfgfile.so.2
 470      librte_cmdline.so.2
 471      librte_compressdev.so.1
 472      librte_cryptodev.so.5
 473      librte_distributor.so.1
 474    + librte_eal.so.9
 475      librte_efd.so.1
 476    + librte_ethdev.so.11
 477    + librte_eventdev.so.6
 478      librte_flow_classify.so.1
 479      librte_gro.so.1
 480      librte_gso.so.1
 481      librte_hash.so.2
 482      librte_ip_frag.so.1
 483      librte_jobstats.so.1
 484      librte_kni.so.2
 485      librte_kvargs.so.1
 486      librte_latencystats.so.1
 487      librte_lpm.so.2
 488      librte_mbuf.so.4
 489      librte_member.so.1
 490      librte_mempool.so.5
 491      librte_meter.so.2
 492      librte_metrics.so.1
 493      librte_net.so.1
 494      librte_pci.so.1
 495      librte_pdump.so.2
 496      librte_pipeline.so.3
 497      librte_pmd_bnxt.so.2
 498      librte_pmd_bond.so.2
 499      librte_pmd_i40e.so.2
 500      librte_pmd_ixgbe.so.2
 501      librte_pmd_dpaa2_qdma.so.1
 502      librte_pmd_ring.so.2
 503      librte_pmd_softnic.so.1
 504      librte_pmd_vhost.so.2
 505      librte_port.so.3
 506      librte_power.so.1
 507      librte_rawdev.so.1
 508      librte_reorder.so.1
 509      librte_ring.so.2
 510      librte_sched.so.1
 511      librte_security.so.1
 512      librte_table.so.3
 513      librte_timer.so.1
 514      librte_vhost.so.4
 515
 516
 517 Known Issues
 518 ------------
 519
 520 .. This section should contain new known issues in this release. Sample format:
 521
 522    * **Add title in present tense with full stop.**
 523
 524      Add a short 1-2 sentence description of the known issue
 525      in the present tense. Add information on any known workarounds.
 526
 527    This section is a comment. Do not overwrite or remove it.
 528    Also, make sure to start the actual text at the margin.
 529    =========================================================
 530
 531 * When using SR-IOV (VF) support with netvsc PMD and the Mellanox mlx5 bifurcated
 532   driver; the Linux netvsc device must be brought up before the netvsc device is
 533   unbound and passed to the DPDK.
 534
 535
 536 Tested Platforms
 537 ----------------
 538
 539 .. This section should contain a list of platforms that were tested
 540    with this release.
 541
 542    The format is:
 543
 544    * <vendor> platform with <vendor> <type of devices> combinations
 545
 546      * List of CPU
 547      * List of OS
 548      * List of devices
 549      * Other relevant details...
 550
 551    This section is a comment. Do not overwrite or remove it.
 552    Also, make sure to start the actual text at the margin.
 553    =========================================================