doc/guides/rel_notes/release_19_11.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright 2019 The DPDK contributors
   3
   4 .. include:: <isonum.txt>
   5
   6 DPDK Release 19.11
   7 ==================
   8
   9 .. **Read this first.**
  10
  11    The text in the sections below explains how to update the release notes.
  12
  13    Use proper spelling, capitalization and punctuation in all sections.
  14
  15    Variable and config names should be quoted as fixed width text:
  16    ``LIKE_THIS``.
  17
  18    Build the docs and view the output file to ensure the changes are correct::
  19
  20       make doc-guides-html
  21
  22       xdg-open build/doc/html/guides/rel_notes/release_19_11.html
  23
  24
  25 New Features
  26 ------------
  27
  28 .. This section should contain new features added in this release.
  29    Sample format:
  30
  31    * **Add a title in the past tense with a full stop.**
  32
  33      Add a short 1-2 sentence description in the past tense.
  34      The description should be enough to allow someone scanning
  35      the release notes to understand the new feature.
  36
  37      If the feature adds a lot of sub-features you can use a bullet list
  38      like this:
  39
  40      * Added feature foo to do something.
  41      * Enhanced feature bar to do something else.
  42
  43      Refer to the previous release notes for examples.
  44
  45      Suggested order in release notes items:
  46      * Core libs (EAL, mempool, ring, mbuf, buses)
  47      * Device abstraction libs and PMDs
  48        - ethdev (lib, PMDs)
  49        - cryptodev (lib, PMDs)
  50        - eventdev (lib, PMDs)
  51        - etc
  52      * Other libs
  53      * Apps, Examples, Tools (if significant)
  54
  55      This section is a comment. Do not overwrite or remove it.
  56      Also, make sure to start the actual text at the margin.
  57      =========================================================
  58
  59 * **FreeBSD now supports `--base-virtaddr` EAL option.**
  60
  61   FreeBSD version now also supports setting base virtual address for mapping
  62   pages and resources into its address space.
  63
  64 * **Added Lock-free Stack for aarch64.**
  65
  66   The lock-free stack implementation is enabled for aarch64 platforms.
  67
  68 * **Changed mempool allocation behaviour.**
  69
  70   Objects are no longer across pages by default.
  71   It may consume more memory when using small memory pages.
  72
  73 * **Added support of dynamic fields and flags in mbuf.**
  74
  75   This new feature adds the ability to dynamically register some room
  76   for a field or a flag in the mbuf structure. This is typically used
  77   for specific offload features, where adding a static field or flag
  78   in the mbuf is not justified.
  79
  80 * **Added hairpin queue.**
  81
  82   On supported NICs, we can now setup haipin queue which will offload packets
  83   from the wire, backto the wire.
  84
  85 * **Added flow tag in rte_flow.**
  86
  87   SET_TAG action and TAG item have been added to support transient flow tag.
  88
  89 * **Extended metadata support in rte_flow.**
  90
  91   Flow metadata is extended to both Rx and Tx.
  92
  93   * Tx metadata can also be set by SET_META action of rte_flow.
  94   * Rx metadata is delivered to host via a dynamic field of ``rte_mbuf`` with
  95     PKT_RX_DYNF_METADATA.
  96
  97 * **Added ethdev API to set supported packet types**
  98
  99   * Added new API ``rte_eth_dev_set_ptypes`` that allows an application to
 100     inform PMD about reduced range of packet types to handle.
 101   * This scheme will allow PMDs to avoid lookup to internal ptype table on Rx
 102     and thereby improve Rx performance if application wishes do so.
 103
 104 * **Added Rx offload flag to enable or disable RSS update**
 105
 106   * Added new Rx offload flag `DEV_RX_OFFLOAD_RSS_HASH` which can be used to
 107     enable/disable PMDs write to `rte_mbuf::hash::rss`.
 108   * PMDs notify the validity of `rte_mbuf::hash:rss` to the application
 109     by enabling `PKT_RX_RSS_HASH ` flag in `rte_mbuf::ol_flags`.
 110
 111 * **Updated the enic driver.**
 112
 113   * Added support for Geneve with options offload.
 114   * Added flow API implementation based on VIC Flow Manager API.
 115
 116 * **Added Hisilicon hns3 PMD.**
 117
 118   Added the new ``hns3`` net driver for the inbuilt Hisilicon Network
 119   Subsystem 3(HNS3) network engine found in the Hisilicon Kunpeng 920 SoC.
 120   See the :doc:`../nics/hns3` guide for more details on this new driver.
 121
 122 * **Added NXP PFE PMD.**
 123
 124   Added the new PFE driver for the NXP LS1012A platform. See the
 125   :doc:`../nics/pfe` NIC driver guide for more details on this new driver.
 126
 127 * **Updated iavf PMD.**
 128
 129   Enable AVX2 data path for iavf PMD.
 130
 131 * **Updated the Intel e1000 driver.**
 132
 133   Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
 134
 135 * **Updated the Intel ixgbe driver.**
 136
 137   Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
 138
 139 * **Updated the Intel i40e driver.**
 140
 141   Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
 142
 143 * **Updated the Intel fm10k driver.**
 144
 145   Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
 146
 147 * **Added RX/TX packet burst mode get API.**
 148
 149   Added two new functions ``rte_eth_rx_burst_mode_get`` and
 150   ``rte_eth_tx_burst_mode_get`` that allow an application
 151   to retrieve the mode information about RX/TX packet burst
 152   such as Scalar or Vector, and Vector technology like AVX2.
 153
 154 * **Updated the Intel ice driver.**
 155
 156   Updated the Intel ice driver with new features and improvements, including:
 157
 158   * Added support for device-specific DDP package loading.
 159   * Added support for handling Receive Flex Descriptor.
 160   * Added support for protocol extraction on per Rx queue.
 161   * Added support for Flow Director filter based on generic filter framework.
 162   * Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
 163   * Generic filter enhancement
 164     - Supported pipeline mode.
 165     - Supported new packet type like PPPoE for switch filter.
 166   * Supported input set change and symmetric hash by rte_flow RSS action.
 167   * Added support for GTP Tx checksum offload.
 168   * Added new device IDs to support E810_XXV devices.
 169
 170 * **Added cryptodev asymmetric session-less operation.**
 171
 172   Added session-less option to cryptodev asymmetric structure. It works the same
 173   way as symmetric crypto, corresponding xform is used directly by the crypto op.
 174
 175 * **Updated the Huawei hinic driver.**
 176
 177   Updated the Huawei hinic driver with new features and improvements, including:
 178
 179   * Enabled SR-IOV - Partially supported at this point, VFIO only.
 180   * Supported VLAN filter and VLAN offload.
 181   * Supported Unicast MAC filter and Multicast MAC filter.
 182   * Supported Flow API for LACP, VRRP, BGP and so on.
 183   * Supported FW version get.
 184
 185 * **Updated Mellanox mlx5 driver.**
 186
 187   Updated Mellanox mlx5 driver with new features and improvements, including:
 188
 189   * Added support for VLAN pop flow offload command.
 190   * Added support for VLAN push flow offload command.
 191   * Added support for VLAN set PCP offload command.
 192   * Added support for VLAN set VID offload command.
 193   * Added support for matching on packets withe Geneve tunnel header.
 194   * Added hairpin support.
 195   * Added ConnectX6-DX support.
 196
 197 * **Updated the AF_XDP PMD.**
 198
 199   Updated the AF_XDP PMD. The new features include:
 200
 201   * Enabled zero copy between application mempools and UMEM by enabling the
 202     XDP_UMEM_UNALIGNED_CHUNKS UMEM flag.
 203
 204 * **Added Marvell NITROX symmetric crypto PMD.**
 205
 206   Added a symmetric crypto PMD for Marvell NITROX V security processor.
 207   See the :doc:`../cryptodevs/nitrox` guide for more details on this new
 208
 209 * **Added asymmetric support to Marvell OCTEON TX crypto PMD.**
 210
 211   Added support for asymmetric operations in Marvell OCTEON TX cypto PMD.
 212   Supports RSA and modexp operations.
 213
 214 * **Added Marvell OCTEON TX2 crypto PMD**
 215
 216   Added a new PMD driver for h/w crypto offload block on ``OCTEON TX2`` SoC.
 217
 218   See :doc:`../cryptodevs/octeontx2` for more details
 219
 220 * **Updated NXP crypto PMDs for PDCP support.**
 221
 222   PDCP support is added to DPAA_SEC and DPAA2_SEC PMDs using rte_security APIs.
 223   Support is added for all sequence number sizes for control and user plane.
 224   Test application is updated for unit testing.
 225
 226 * **Enabled Single Pass GCM acceleration on QAT GEN3.**
 227
 228   Added support for Single Pass GCM, available on QAT GEN3 only (Intel
 229   QuickAssist Technology C4xxx). It is automatically chosen instead of the
 230   classic 2-pass mode when running on QAT GEN3, significantly improving
 231   the performance of AES GCM operations.
 232
 233 * **Updated the Intel QuickAssist Technology (QAT) asymmetric crypto PMD.**
 234
 235   * Added support for asymmetric session-less operations.
 236   * Added support for RSA algorithm with pair (n, d) private key representation.
 237   * Added support for RSA algorithm with quintuple private key representation.
 238
 239 * **Updated the Intel QuickAssist Technology (QAT) compression PMD.**
 240
 241   Added stateful decompression support in the Intel QuickAssist Technology PMD.
 242   Please note that stateful compression is not supported.
 243
 244 * **Added external buffers support for dpdk-test-compress-perf tool.**
 245
 246   Added a command line option to dpdk-test-compress-perf tool to allocate
 247   and use memory zones as external buffers instead of keeping the data directly
 248   in mbuf areas.
 249
 250 * **Updated the IPSec library.**
 251
 252   * Added SA Database API to ``librte_ipsec``. A new test-sad application is also
 253     introduced to evaluate and perform custom functional and performance tests
 254     for IPsec SAD implementation.
 255
 256   * Support fragmented packets in inline crypto processing mode with fallback
 257     ``lookaside-none`` session. Corresponding changes are also added in IPsec
 258     Security Gateway application.
 259
 260 * **Introduced FIFO for NTB PMD.**
 261
 262   Introduced FIFO for NTB (Non-transparent Bridge) PMD to support
 263   packet based processing.
 264
 265 * **Added eBPF JIT support for arm64.**
 266
 267   Added eBPF JIT support for arm64 architecture to improve the eBPF program
 268   performance.
 269
 270 * **Added RIB and FIB (Routing/Forwarding Information Base) libraries.**
 271
 272   RIB and FIB can replace the LPM (Longest Prefix Match) library
 273   with better control plane (RIB) performance.
 274   The data plane (FIB) can be extended with new algorithms.
 275
 276 * **Updated testpmd.**
 277
 278   * Added a console command to testpmd app, ``show port (port_id) ptypes`` which
 279     gives ability to print port supported ptypes in different protocol layers.
 280   * Packet type detection disabled by default for the supported PMDs.
 281
 282 * **Added new example l2fwd-event application.**
 283
 284   Added an example application `l2fwd-event` that adds event device support to
 285   traditional l2fwd example. It demonstrates usage of poll and event mode IO
 286   mechanism under a single application.
 287
 288 * **Added build support for Link Time Optimization.**
 289
 290   LTO is an optimization technique used by the compiler to perform whole
 291   program analysis and optimization at link time.  In order to do that
 292   compilers store their internal representation of the source code that
 293   the linker uses at the final stage of compilation process.
 294
 295   See :doc:`../prog_guide/lto` for more information:
 296
 297 * **Added IOVA as VA support for KNI.**
 298
 299   * Added IOVA = VA support for KNI, KNI can operate in IOVA = VA mode when
 300     `iova-mode=va` EAL option is passed to the application or when bus IOVA
 301     scheme is selected as RTE_IOVA_VA. This mode only works on Linux Kernel
 302     versions 4.6.0 and above.
 303
 304   * Due to IOVA to KVA address translations, based on the KNI use case there
 305     can be a performance impact. For mitigation, forcing IOVA to PA via EAL
 306     "--iova-mode=pa" option can be used, IOVA_DC bus iommu scheme can also
 307     result in IOVA as PA.
 308
 309
 310 Removed Items
 311 -------------
 312
 313 .. This section should contain removed items in this release. Sample format:
 314
 315    * Add a short 1-2 sentence description of the removed item
 316      in the past tense.
 317
 318    This section is a comment. Do not overwrite or remove it.
 319    Also, make sure to start the actual text at the margin.
 320    =========================================================
 321
 322 * Removed duplicated set of commands for Rx offload configuration from testpmd::
 323
 324     port config all crc-strip|scatter|rx-cksum|rx-timestamp|
 325                     hw-vlan|hw-vlan-filter|hw-vlan-strip|hw-vlan-extend on|off
 326
 327   The testpmd commands set that can be used instead
 328   in order to enable or disable Rx offloading on all Rx queues of a port is::
 329
 330     port config <port_id> rx_offload crc_strip|scatter|
 331                                      ipv4_cksum|udp_cksum|tcp_cksum|timestamp|
 332                                      vlan_strip|vlan_filter|vlan_extend on|off
 333
 334 * Removed AF_XDP pmd_zero copy vdev argument. Support is now auto-detected.
 335
 336 * The following sample applications have been removed in this release:
 337
 338   * Exception Path
 339   * L3 Forwarding in a Virtualization Environment
 340   * Load Balancer
 341   * Netmap Compatibility
 342   * Quota and Watermark
 343   * vhost-scsi
 344
 345 * Removed arm64-dpaa2-* build config. arm64-dpaa-* can now build for both
 346   dpaa and dpaa2 platforms.
 347
 348
 349 API Changes
 350 -----------
 351
 352 .. This section should contain API changes. Sample format:
 353
 354    * sample: Add a short 1-2 sentence description of the API change
 355      which was announced in the previous releases and made in this release.
 356      Start with a scope label like "ethdev:".
 357      Use fixed width quotes for ``function_names`` or ``struct_names``.
 358      Use the past tense.
 359
 360    This section is a comment. Do not overwrite or remove it.
 361    Also, make sure to start the actual text at the margin.
 362    =========================================================
 363
 364 * eal: made the ``lcore_config`` struct and global symbol private.
 365
 366 * eal: removed the ``rte_cpu_check_supported`` function, replaced by
 367   ``rte_cpu_is_supported`` since dpdk v17.08.
 368
 369 * eal: removed the ``rte_malloc_virt2phy`` function, replaced by
 370   ``rte_malloc_virt2iova`` since v17.11.
 371
 372 * eal: made the ``rte_config`` struct and ``rte_eal_get_configuration``
 373   function private.
 374
 375 * mem: hid the internal ``malloc_heap`` structure and the
 376   ``rte_malloc_heap.h`` header.
 377
 378 * vfio: removed ``rte_vfio_dma_map`` and ``rte_vfio_dma_unmap`` that have
 379   been marked as deprecated in release 19.05.
 380   ``rte_vfio_container_dma_map`` and ``rte_vfio_container_dma_unmap`` can
 381   be used as substitutes.
 382
 383 * pci: removed the following functions deprecated since dpdk v17.11:
 384
 385   - ``eal_parse_pci_BDF`` replaced by ``rte_pci_addr_parse``
 386   - ``eal_parse_pci_DomBDF`` replaced by ``rte_pci_addr_parse``
 387   - ``rte_eal_compare_pci_addr`` replaced by ``rte_pci_addr_cmp``
 388
 389 * The network structure ``esp_tail`` has been prefixed by ``rte_``.
 390
 391 * The network definitions of PPPoE ethertypes have been prefixed by ``RTE_``.
 392
 393 * The network structure for MPLS has been prefixed by ``rte_``.
 394
 395 * ethdev: changed ``rte_eth_dev_infos_get`` return value from ``void`` to
 396   ``int`` to provide a way to report various error conditions.
 397
 398 * ethdev: changed ``rte_eth_promiscuous_enable`` and
 399   ``rte_eth_promiscuous_disable`` return value from ``void`` to ``int`` to
 400   provide a way to report various error conditions.
 401
 402 * ethdev: changed ``rte_eth_allmulticast_enable`` and
 403   ``rte_eth_allmulticast_disable`` return value from ``void`` to ``int`` to
 404   provide a way to report various error conditions.
 405
 406 * ethdev: changed ``rte_eth_dev_xstats_reset`` return value from ``void`` to
 407   ``int`` to provide a way to report various error conditions.
 408
 409 * ethdev: changed ``rte_eth_link_get`` and ``rte_eth_link_get_nowait``
 410   return value from ``void`` to ``int`` to provide a way to report various
 411   error conditions.
 412
 413 * ethdev: changed ``rte_eth_macaddr_get`` return value from ``void`` to
 414   ``int`` to provide a way to report various error conditions.
 415
 416 * ethdev: changed ``rte_eth_dev_owner_delete`` return value from ``void`` to
 417   ``int`` to provide a way to report various error conditions.
 418
 419 * ethdev: The deprecated function ``rte_eth_dev_count`` was removed.
 420   The function ``rte_eth_dev_count_avail`` is a drop-in replacement.
 421   If the intent is to iterate over ports, ``RTE_ETH_FOREACH_*`` macros
 422   are better port iterators.
 423
 424 * ethdev: RTE_FLOW_ITEM_TYPE_META data endianness altered to host one.
 425   Due to the new dynamic metadata field in mbuf is host-endian either, there
 426   is the minor compatibility issue for applications in case of 32-bit values
 427   supported.
 428
 429 * ethdev: the tx_metadata mbuf field is moved to dymanic one.
 430   PKT_TX_METADATA flag is replaced with PKT_TX_DYNF_METADATA.
 431   DEV_TX_OFFLOAD_MATCH_METADATA offload flag is removed, now metadata
 432   support in PMD is engaged on dynamic field registration.
 433
 434 * event: The function ``rte_event_eth_tx_adapter_enqueue`` takes an additional
 435   input as ``flags``. Flag ``RTE_EVENT_ETH_TX_ADAPTER_ENQUEUE_SAME_DEST`` which
 436   has been introduced in this release is used when used when all the packets
 437   enqueued in the tx adapter are destined for the same Ethernet port & Tx queue.
 438
 439 * sched: The pipe nodes configuration parameters such as number of pipes,
 440   pipe queue sizes, pipe profiles, etc., are moved from port level structure
 441   to subport level. This allows different subports of the same port to
 442   have different configuration for the pipe nodes.
 443
 444
 445 ABI Changes
 446 -----------
 447
 448 .. This section should contain ABI changes. Sample format:
 449
 450    * sample: Add a short 1-2 sentence description of the ABI change
 451      which was announced in the previous releases and made in this release.
 452      Start with a scope label like "ethdev:".
 453      Use fixed width quotes for ``function_names`` or ``struct_names``.
 454      Use the past tense.
 455
 456    This section is a comment. Do not overwrite or remove it.
 457    Also, make sure to start the actual text at the margin.
 458    =========================================================
 459
 460 * net: The Ethernet address and other header definitions have changed
 461   attributes. They have been modified to be aligned on 2-byte boundaries.
 462   These changes should not impact normal usage because drivers naturally
 463   align the Ethernet header on receive and all known encapsulations
 464   preserve the alignment of the header.
 465
 466 * security: The field ``replay_win_sz`` has been moved from ipsec library
 467   based ``rte_ipsec_sa_prm`` structure to security library based structure
 468   ``rte_security_ipsec_xform``, which specify the Anti replay window size
 469   to enable sequence replay attack handling.
 470
 471 * ipsec: The field ``replay_win_sz`` has been removed from the structure
 472   ``rte_ipsec_sa_prm`` as it has been added to the security library.
 473
 474 * ethdev: Added 32-bit fields for maximum LRO aggregated packet size, in
 475   struct ``rte_eth_dev_info`` for the port capability and in struct
 476   ``rte_eth_rxmode`` for the port configuration.
 477   Application should use the new field in struct ``rte_eth_rxmode`` to configure
 478   the requested size.
 479   PMD should use the new field in struct ``rte_eth_dev_info`` to report the
 480   supported port capability.
 481
 482
 483 Shared Library Versions
 484 -----------------------
 485
 486 .. Update any library version updated in this release
 487    and prepend with a ``+`` sign, like this:
 488
 489      libfoo.so.1
 490    + libupdated.so.2
 491      libbar.so.1
 492
 493    This section is a comment. Do not overwrite or remove it.
 494    =========================================================
 495
 496 The libraries prepended with a plus sign were incremented in this version.
 497
 498 .. code-block:: diff
 499
 500      librte_acl.so.2
 501      librte_bbdev.so.1
 502      librte_bitratestats.so.2
 503      librte_bpf.so.1
 504      librte_bus_dpaa.so.2
 505      librte_bus_fslmc.so.2
 506      librte_bus_ifpga.so.2
 507      librte_bus_pci.so.2
 508      librte_bus_vdev.so.2
 509      librte_bus_vmbus.so.2
 510      librte_cfgfile.so.2
 511      librte_cmdline.so.2
 512      librte_compressdev.so.1
 513      librte_cryptodev.so.8
 514      librte_distributor.so.1
 515    + librte_eal.so.12
 516      librte_efd.so.1
 517    + librte_ethdev.so.13
 518    + librte_eventdev.so.8
 519    + librte_fib.so.1
 520      librte_flow_classify.so.1
 521      librte_gro.so.1
 522      librte_gso.so.1
 523      librte_hash.so.2
 524      librte_ip_frag.so.1
 525    + librte_ipsec.so.2
 526      librte_jobstats.so.1
 527      librte_kni.so.2
 528      librte_kvargs.so.1
 529      librte_latencystats.so.1
 530      librte_lpm.so.2
 531      librte_mbuf.so.5
 532      librte_member.so.1
 533      librte_mempool.so.5
 534      librte_meter.so.3
 535      librte_metrics.so.1
 536      librte_net.so.1
 537    + librte_pci.so.2
 538      librte_pdump.so.3
 539      librte_pipeline.so.3
 540      librte_pmd_bnxt.so.2
 541      librte_pmd_bond.so.2
 542      librte_pmd_i40e.so.2
 543      librte_pmd_ixgbe.so.2
 544      librte_pmd_dpaa2_qdma.so.1
 545      librte_pmd_ring.so.2
 546      librte_pmd_softnic.so.1
 547      librte_pmd_vhost.so.2
 548      librte_port.so.3
 549      librte_power.so.1
 550      librte_rawdev.so.1
 551    + librte_rib.so.1
 552      librte_rcu.so.1
 553      librte_reorder.so.1
 554      librte_ring.so.2
 555    + librte_sched.so.4
 556    + librte_security.so.3
 557      librte_stack.so.1
 558      librte_table.so.3
 559      librte_timer.so.1
 560      librte_vhost.so.4
 561
 562
 563 Known Issues
 564 ------------
 565
 566 .. This section should contain new known issues in this release. Sample format:
 567
 568    * **Add title in present tense with full stop.**
 569
 570      Add a short 1-2 sentence description of the known issue
 571      in the present tense. Add information on any known workarounds.
 572
 573    This section is a comment. Do not overwrite or remove it.
 574    Also, make sure to start the actual text at the margin.
 575    =========================================================
 576
 577
 578 Tested Platforms
 579 ----------------
 580
 581 .. This section should contain a list of platforms that were tested
 582    with this release.
 583
 584    The format is:
 585
 586    * <vendor> platform with <vendor> <type of devices> combinations
 587
 588      * List of CPU
 589      * List of OS
 590      * List of devices
 591      * Other relevant details...
 592
 593    This section is a comment. Do not overwrite or remove it.
 594    Also, make sure to start the actual text at the margin.
 595    =========================================================
 596