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