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 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 * **Updated the enic driver.**
 105
 106   * Added support for Geneve with options offload.
 107   * Added flow API implementation based on VIC Flow Manager API.
 108
 109 * **Added Hisilicon hns3 PMD.**
 110
 111   Added the new ``hns3`` net driver for the inbuilt Hisilicon Network
 112   Subsystem 3(HNS3) network engine found in the Hisilicon Kunpeng 920 SoC.
 113   See the :doc:`../nics/hns3` guide for more details on this new driver.
 114
 115 * **Added NXP PFE PMD.**
 116
 117   Added the new PFE driver for the NXP LS1012A platform. See the
 118   :doc:`../nics/pfe` NIC driver guide for more details on this new driver.
 119
 120 * **Updated iavf PMD.**
 121
 122   Enable AVX2 data path for iavf PMD.
 123
 124 * **Updated the Intel e1000 driver.**
 125
 126   Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
 127
 128 * **Updated the Intel ixgbe driver.**
 129
 130   Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
 131
 132 * **Updated the Intel i40e driver.**
 133
 134   Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
 135
 136 * **Updated the Intel fm10k driver.**
 137
 138   Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
 139
 140 * **Added RX/TX packet burst mode get API.**
 141
 142   Added two new functions ``rte_eth_rx_burst_mode_get`` and
 143   ``rte_eth_tx_burst_mode_get`` that allow an application
 144   to retrieve the mode information about RX/TX packet burst
 145   such as Scalar or Vector, and Vector technology like AVX2.
 146
 147 * **Updated the Intel ice driver.**
 148
 149   Updated the Intel ice driver with new features and improvements, including:
 150
 151   * Added support for device-specific DDP package loading.
 152   * Added support for handling Receive Flex Descriptor.
 153   * Added support for protocol extraction on per Rx queue.
 154   * Added support for Flow Director filter based on generic filter framework.
 155   * Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
 156   * Generic filter enhancement
 157     - Supported pipeline mode.
 158     - Supported new packet type like PPPoE for switch filter.
 159   * Supported input set change and symmetric hash by rte_flow RSS action.
 160   * Added support for GTP Tx checksum offload.
 161   * Added new device IDs to support E810_XXV devices.
 162
 163 * **Added cryptodev asymmetric session-less operation.**
 164
 165   Added session-less option to cryptodev asymmetric structure. It works the same
 166   way as symmetric crypto, corresponding xform is used directly by the crypto op.
 167
 168 * **Updated the Huawei hinic driver.**
 169
 170   Updated the Huawei hinic driver with new features and improvements, including:
 171
 172   * Enabled SR-IOV - Partially supported at this point, VFIO only.
 173   * Supported VLAN filter and VLAN offload.
 174   * Supported Unicast MAC filter and Multicast MAC filter.
 175   * Supported Flow API for LACP, VRRP, BGP and so on.
 176   * Supported FW version get.
 177
 178 * **Updated Mellanox mlx5 driver.**
 179
 180   Updated Mellanox mlx5 driver with new features and improvements, including:
 181
 182   * Added support for VLAN pop flow offload command.
 183   * Added support for VLAN push flow offload command.
 184   * Added support for VLAN set PCP offload command.
 185   * Added support for VLAN set VID offload command.
 186   * Added support for matching on packets withe Geneve tunnel header.
 187   * Added hairpin support.
 188   * Added ConnectX6-DX support.
 189
 190 * **Updated the AF_XDP PMD.**
 191
 192   Updated the AF_XDP PMD. The new features include:
 193
 194   * Enabled zero copy between application mempools and UMEM by enabling the
 195     XDP_UMEM_UNALIGNED_CHUNKS UMEM flag.
 196
 197 * **Added Marvell NITROX symmetric crypto PMD.**
 198
 199   Added a symmetric crypto PMD for Marvell NITROX V security processor.
 200   See the :doc:`../cryptodevs/nitrox` guide for more details on this new
 201
 202 * **Added asymmetric support to Marvell OCTEON TX crypto PMD.**
 203
 204   Added support for asymmetric operations in Marvell OCTEON TX cypto PMD.
 205   Supports RSA and modexp operations.
 206
 207 * **Added Marvell OCTEON TX2 crypto PMD**
 208
 209   Added a new PMD driver for h/w crypto offload block on ``OCTEON TX2`` SoC.
 210
 211   See :doc:`../cryptodevs/octeontx2` for more details
 212
 213 * **Updated NXP crypto PMDs for PDCP support.**
 214
 215   PDCP support is added to DPAA_SEC and DPAA2_SEC PMDs using rte_security APIs.
 216   Support is added for all sequence number sizes for control and user plane.
 217   Test application is updated for unit testing.
 218
 219 * **Enabled Single Pass GCM acceleration on QAT GEN3.**
 220
 221   Added support for Single Pass GCM, available on QAT GEN3 only (Intel
 222   QuickAssist Technology C4xxx). It is automatically chosen instead of the
 223   classic 2-pass mode when running on QAT GEN3, significantly improving
 224   the performance of AES GCM operations.
 225
 226 * **Updated the Intel QuickAssist Technology (QAT) asymmetric crypto PMD.**
 227
 228   * Added support for asymmetric session-less operations.
 229   * Added support for RSA algorithm with pair (n, d) private key representation.
 230   * Added support for RSA algorithm with quintuple private key representation.
 231
 232 * **Updated the Intel QuickAssist Technology (QAT) compression PMD.**
 233
 234   Added stateful decompression support in the Intel QuickAssist Technology PMD.
 235   Please note that stateful compression is not supported.
 236
 237 * **Added external buffers support for dpdk-test-compress-perf tool.**
 238
 239   Added a command line option to dpdk-test-compress-perf tool to allocate
 240   and use memory zones as external buffers instead of keeping the data directly
 241   in mbuf areas.
 242
 243 * **Updated the IPSec library.**
 244
 245   * Added SA Database API to ``librte_ipsec``. A new test-sad application is also
 246     introduced to evaluate and perform custom functional and performance tests
 247     for IPsec SAD implementation.
 248
 249   * Support fragmented packets in inline crypto processing mode with fallback
 250     ``lookaside-none`` session. Corresponding changes are also added in IPsec
 251     Security Gateway application.
 252
 253 * **Introduced FIFO for NTB PMD.**
 254
 255   Introduced FIFO for NTB (Non-transparent Bridge) PMD to support
 256   packet based processing.
 257
 258 * **Added eBPF JIT support for arm64.**
 259
 260   Added eBPF JIT support for arm64 architecture to improve the eBPF program
 261   performance.
 262
 263 * **Added RIB and FIB (Routing/Forwarding Information Base) libraries.**
 264
 265   RIB and FIB can replace the LPM (Longest Prefix Match) library
 266   with better control plane (RIB) performance.
 267   The data plane (FIB) can be extended with new algorithms.
 268
 269 * **Updated testpmd.**
 270
 271   * Added a console command to testpmd app, ``show port (port_id) ptypes`` which
 272     gives ability to print port supported ptypes in different protocol layers.
 273
 274 * **Added new example l2fwd-event application.**
 275
 276   Added an example application `l2fwd-event` that adds event device support to
 277   traditional l2fwd example. It demonstrates usage of poll and event mode IO
 278   mechanism under a single application.
 279
 280 * **Added build support for Link Time Optimization.**
 281
 282   LTO is an optimization technique used by the compiler to perform whole
 283   program analysis and optimization at link time.  In order to do that
 284   compilers store their internal representation of the source code that
 285   the linker uses at the final stage of compilation process.
 286
 287   See :doc:`../prog_guide/lto` for more information:
 288
 289
 290
 291 Removed Items
 292 -------------
 293
 294 .. This section should contain removed items in this release. Sample format:
 295
 296    * Add a short 1-2 sentence description of the removed item
 297      in the past tense.
 298
 299    This section is a comment. Do not overwrite or remove it.
 300    Also, make sure to start the actual text at the margin.
 301    =========================================================
 302
 303 * Removed duplicated set of commands for Rx offload configuration from testpmd::
 304
 305     port config all crc-strip|scatter|rx-cksum|rx-timestamp|
 306                     hw-vlan|hw-vlan-filter|hw-vlan-strip|hw-vlan-extend on|off
 307
 308   The testpmd commands set that can be used instead
 309   in order to enable or disable Rx offloading on all Rx queues of a port is::
 310
 311     port config <port_id> rx_offload crc_strip|scatter|
 312                                      ipv4_cksum|udp_cksum|tcp_cksum|timestamp|
 313                                      vlan_strip|vlan_filter|vlan_extend on|off
 314
 315 * Removed AF_XDP pmd_zero copy vdev argument. Support is now auto-detected.
 316
 317 * The following sample applications have been removed in this release:
 318
 319   * Exception Path
 320   * L3 Forwarding in a Virtualization Environment
 321   * Load Balancer
 322   * Netmap Compatibility
 323   * Quota and Watermark
 324   * vhost-scsi
 325
 326 * Removed arm64-dpaa2-* build config. arm64-dpaa-* can now build for both
 327   dpaa and dpaa2 platforms.
 328
 329
 330 API Changes
 331 -----------
 332
 333 .. This section should contain API changes. Sample format:
 334
 335    * sample: Add a short 1-2 sentence description of the API change
 336      which was announced in the previous releases and made in this release.
 337      Start with a scope label like "ethdev:".
 338      Use fixed width quotes for ``function_names`` or ``struct_names``.
 339      Use the past tense.
 340
 341    This section is a comment. Do not overwrite or remove it.
 342    Also, make sure to start the actual text at the margin.
 343    =========================================================
 344
 345 * eal: made the ``lcore_config`` struct and global symbol private.
 346
 347 * eal: removed the ``rte_cpu_check_supported`` function, replaced by
 348   ``rte_cpu_is_supported`` since dpdk v17.08.
 349
 350 * eal: removed the ``rte_malloc_virt2phy`` function, replaced by
 351   ``rte_malloc_virt2iova`` since v17.11.
 352
 353 * eal: made the ``rte_config`` struct and ``rte_eal_get_configuration``
 354   function private.
 355
 356 * mem: hid the internal ``malloc_heap`` structure and the
 357   ``rte_malloc_heap.h`` header.
 358
 359 * vfio: removed ``rte_vfio_dma_map`` and ``rte_vfio_dma_unmap`` that have
 360   been marked as deprecated in release 19.05.
 361   ``rte_vfio_container_dma_map`` and ``rte_vfio_container_dma_unmap`` can
 362   be used as substitutes.
 363
 364 * pci: removed the following functions deprecated since dpdk v17.11:
 365
 366   - ``eal_parse_pci_BDF`` replaced by ``rte_pci_addr_parse``
 367   - ``eal_parse_pci_DomBDF`` replaced by ``rte_pci_addr_parse``
 368   - ``rte_eal_compare_pci_addr`` replaced by ``rte_pci_addr_cmp``
 369
 370 * The network structure ``esp_tail`` has been prefixed by ``rte_``.
 371
 372 * The network definitions of PPPoE ethertypes have been prefixed by ``RTE_``.
 373
 374 * The network structure for MPLS has been prefixed by ``rte_``.
 375
 376 * ethdev: changed ``rte_eth_dev_infos_get`` return value from ``void`` to
 377   ``int`` to provide a way to report various error conditions.
 378
 379 * ethdev: changed ``rte_eth_promiscuous_enable`` and
 380   ``rte_eth_promiscuous_disable`` return value from ``void`` to ``int`` to
 381   provide a way to report various error conditions.
 382
 383 * ethdev: changed ``rte_eth_allmulticast_enable`` and
 384   ``rte_eth_allmulticast_disable`` return value from ``void`` to ``int`` to
 385   provide a way to report various error conditions.
 386
 387 * ethdev: changed ``rte_eth_dev_xstats_reset`` return value from ``void`` to
 388   ``int`` to provide a way to report various error conditions.
 389
 390 * ethdev: changed ``rte_eth_link_get`` and ``rte_eth_link_get_nowait``
 391   return value from ``void`` to ``int`` to provide a way to report various
 392   error conditions.
 393
 394 * ethdev: changed ``rte_eth_macaddr_get`` return value from ``void`` to
 395   ``int`` to provide a way to report various error conditions.
 396
 397 * ethdev: changed ``rte_eth_dev_owner_delete`` return value from ``void`` to
 398   ``int`` to provide a way to report various error conditions.
 399
 400 * ethdev: The deprecated function ``rte_eth_dev_count`` was removed.
 401   The function ``rte_eth_dev_count_avail`` is a drop-in replacement.
 402   If the intent is to iterate over ports, ``RTE_ETH_FOREACH_*`` macros
 403   are better port iterators.
 404
 405 * ethdev: RTE_FLOW_ITEM_TYPE_META data endianness altered to host one.
 406   Due to the new dynamic metadata field in mbuf is host-endian either, there
 407   is the minor compatibility issue for applications in case of 32-bit values
 408   supported.
 409
 410 * ethdev: the tx_metadata mbuf field is moved to dymanic one.
 411   PKT_TX_METADATA flag is replaced with PKT_TX_DYNF_METADATA.
 412   DEV_TX_OFFLOAD_MATCH_METADATA offload flag is removed, now metadata
 413   support in PMD is engaged on dynamic field registration.
 414
 415 * event: The function ``rte_event_eth_tx_adapter_enqueue`` takes an additional
 416   input as ``flags``. Flag ``RTE_EVENT_ETH_TX_ADAPTER_ENQUEUE_SAME_DEST`` which
 417   has been introduced in this release is used when used when all the packets
 418   enqueued in the tx adapter are destined for the same Ethernet port & Tx queue.
 419
 420 * sched: The pipe nodes configuration parameters such as number of pipes,
 421   pipe queue sizes, pipe profiles, etc., are moved from port level structure
 422   to subport level. This allows different subports of the same port to
 423   have different configuration for the pipe nodes.
 424
 425
 426 ABI Changes
 427 -----------
 428
 429 .. This section should contain ABI changes. Sample format:
 430
 431    * sample: Add a short 1-2 sentence description of the ABI change
 432      which was announced in the previous releases and made in this release.
 433      Start with a scope label like "ethdev:".
 434      Use fixed width quotes for ``function_names`` or ``struct_names``.
 435      Use 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 * net: The Ethernet address and other header definitions have changed
 442   attributes. They have been modified to be aligned on 2-byte boundaries.
 443   These changes should not impact normal usage because drivers naturally
 444   align the Ethernet header on receive and all known encapsulations
 445   preserve the alignment of the header.
 446
 447 * security: The field ``replay_win_sz`` has been moved from ipsec library
 448   based ``rte_ipsec_sa_prm`` structure to security library based structure
 449   ``rte_security_ipsec_xform``, which specify the Anti replay window size
 450   to enable sequence replay attack handling.
 451
 452 * ipsec: The field ``replay_win_sz`` has been removed from the structure
 453   ``rte_ipsec_sa_prm`` as it has been added to the security library.
 454
 455
 456 Shared Library Versions
 457 -----------------------
 458
 459 .. Update any library version updated in this release
 460    and prepend with a ``+`` sign, like this:
 461
 462      libfoo.so.1
 463    + libupdated.so.2
 464      libbar.so.1
 465
 466    This section is a comment. Do not overwrite or remove it.
 467    =========================================================
 468
 469 The libraries prepended with a plus sign were incremented in this version.
 470
 471 .. code-block:: diff
 472
 473      librte_acl.so.2
 474      librte_bbdev.so.1
 475      librte_bitratestats.so.2
 476      librte_bpf.so.1
 477      librte_bus_dpaa.so.2
 478      librte_bus_fslmc.so.2
 479      librte_bus_ifpga.so.2
 480      librte_bus_pci.so.2
 481      librte_bus_vdev.so.2
 482      librte_bus_vmbus.so.2
 483      librte_cfgfile.so.2
 484      librte_cmdline.so.2
 485      librte_compressdev.so.1
 486      librte_cryptodev.so.8
 487      librte_distributor.so.1
 488    + librte_eal.so.12
 489      librte_efd.so.1
 490    + librte_ethdev.so.13
 491    + librte_eventdev.so.8
 492    + librte_fib.so.1
 493      librte_flow_classify.so.1
 494      librte_gro.so.1
 495      librte_gso.so.1
 496      librte_hash.so.2
 497      librte_ip_frag.so.1
 498    + librte_ipsec.so.2
 499      librte_jobstats.so.1
 500      librte_kni.so.2
 501      librte_kvargs.so.1
 502      librte_latencystats.so.1
 503      librte_lpm.so.2
 504      librte_mbuf.so.5
 505      librte_member.so.1
 506      librte_mempool.so.5
 507      librte_meter.so.3
 508      librte_metrics.so.1
 509      librte_net.so.1
 510    + librte_pci.so.2
 511      librte_pdump.so.3
 512      librte_pipeline.so.3
 513      librte_pmd_bnxt.so.2
 514      librte_pmd_bond.so.2
 515      librte_pmd_i40e.so.2
 516      librte_pmd_ixgbe.so.2
 517      librte_pmd_dpaa2_qdma.so.1
 518      librte_pmd_ring.so.2
 519      librte_pmd_softnic.so.1
 520      librte_pmd_vhost.so.2
 521      librte_port.so.3
 522      librte_power.so.1
 523      librte_rawdev.so.1
 524    + librte_rib.so.1
 525      librte_rcu.so.1
 526      librte_reorder.so.1
 527      librte_ring.so.2
 528    + librte_sched.so.4
 529    + librte_security.so.3
 530      librte_stack.so.1
 531      librte_table.so.3
 532      librte_timer.so.1
 533      librte_vhost.so.4
 534
 535
 536 Known Issues
 537 ------------
 538
 539 .. This section should contain new known issues in this release. Sample format:
 540
 541    * **Add title in present tense with full stop.**
 542
 543      Add a short 1-2 sentence description of the known issue
 544      in the present tense. Add information on any known workarounds.
 545
 546    This section is a comment. Do not overwrite or remove it.
 547    Also, make sure to start the actual text at the margin.
 548    =========================================================
 549
 550
 551 Tested Platforms
 552 ----------------
 553
 554 .. This section should contain a list of platforms that were tested
 555    with this release.
 556
 557    The format is:
 558
 559    * <vendor> platform with <vendor> <type of devices> combinations
 560
 561      * List of CPU
 562      * List of OS
 563      * List of devices
 564      * Other relevant details...
 565
 566    This section is a comment. Do not overwrite or remove it.
 567    Also, make sure to start the actual text at the margin.
 568    =========================================================
 569