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