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 * **Introduced FIFO for NTB PMD.**
 225
 226   Introduced FIFO for NTB (Non-transparent Bridge) PMD to support
 227   packet based processing.
 228
 229 * **Added eBPF JIT support for arm64.**
 230
 231   Added eBPF JIT support for arm64 architecture to improve the eBPF program
 232   performance.
 233
 234 * **Added RIB and FIB (Routing/Forwarding Information Base) libraries.**
 235
 236   RIB and FIB can replace the LPM (Longest Prefix Match) library
 237   with better control plane (RIB) performance.
 238   The data plane (FIB) can be extended with new algorithms.
 239
 240 * **Updated testpmd.**
 241
 242   * Added a console command to testpmd app, ``show port (port_id) ptypes`` which
 243     gives ability to print port supported ptypes in different protocol layers.
 244
 245 * **Added new example l2fwd-event application.**
 246
 247   Added an example application `l2fwd-event` that adds event device support to
 248   traditional l2fwd example. It demonstrates usage of poll and event mode IO
 249   mechanism under a single application.
 250
 251 * **Added build support for Link Time Optimization.**
 252
 253   LTO is an optimization technique used by the compiler to perform whole
 254   program analysis and optimization at link time.  In order to do that
 255   compilers store their internal representation of the source code that
 256   the linker uses at the final stage of compilation process.
 257
 258   See :doc:`../prog_guide/lto` for more information:
 259
 260
 261 Removed Items
 262 -------------
 263
 264 .. This section should contain removed items in this release. Sample format:
 265
 266    * Add a short 1-2 sentence description of the removed item
 267      in the past tense.
 268
 269    This section is a comment. Do not overwrite or remove it.
 270    Also, make sure to start the actual text at the margin.
 271    =========================================================
 272
 273 * Removed duplicated set of commands for Rx offload configuration from testpmd::
 274
 275     port config all crc-strip|scatter|rx-cksum|rx-timestamp|
 276                     hw-vlan|hw-vlan-filter|hw-vlan-strip|hw-vlan-extend on|off
 277
 278   The testpmd commands set that can be used instead
 279   in order to enable or disable Rx offloading on all Rx queues of a port is::
 280
 281     port config <port_id> rx_offload crc_strip|scatter|
 282                                      ipv4_cksum|udp_cksum|tcp_cksum|timestamp|
 283                                      vlan_strip|vlan_filter|vlan_extend on|off
 284
 285 * Removed AF_XDP pmd_zero copy vdev argument. Support is now auto-detected.
 286
 287 * The following sample applications have been removed in this release:
 288
 289   * Exception Path
 290   * L3 Forwarding in a Virtualization Environment
 291   * Load Balancer
 292   * Netmap Compatibility
 293   * Quota and Watermark
 294   * vhost-scsi
 295
 296 * Removed arm64-dpaa2-* build config. arm64-dpaa-* can now build for both
 297   dpaa and dpaa2 platforms.
 298
 299
 300 API Changes
 301 -----------
 302
 303 .. This section should contain API changes. Sample format:
 304
 305    * sample: Add a short 1-2 sentence description of the API change
 306      which was announced in the previous releases and made in this release.
 307      Start with a scope label like "ethdev:".
 308      Use fixed width quotes for ``function_names`` or ``struct_names``.
 309      Use the past tense.
 310
 311    This section is a comment. Do not overwrite or remove it.
 312    Also, make sure to start the actual text at the margin.
 313    =========================================================
 314
 315 * eal: made the ``lcore_config`` struct and global symbol private.
 316
 317 * eal: removed the ``rte_cpu_check_supported`` function, replaced by
 318   ``rte_cpu_is_supported`` since dpdk v17.08.
 319
 320 * eal: removed the ``rte_malloc_virt2phy`` function, replaced by
 321   ``rte_malloc_virt2iova`` since v17.11.
 322
 323 * eal: made the ``rte_config`` struct and ``rte_eal_get_configuration``
 324   function private.
 325
 326 * mem: hid the internal ``malloc_heap`` structure and the
 327   ``rte_malloc_heap.h`` header.
 328
 329 * vfio: removed ``rte_vfio_dma_map`` and ``rte_vfio_dma_unmap`` that have
 330   been marked as deprecated in release 19.05.
 331   ``rte_vfio_container_dma_map`` and ``rte_vfio_container_dma_unmap`` can
 332   be used as substitutes.
 333
 334 * pci: removed the following functions deprecated since dpdk v17.11:
 335
 336   - ``eal_parse_pci_BDF`` replaced by ``rte_pci_addr_parse``
 337   - ``eal_parse_pci_DomBDF`` replaced by ``rte_pci_addr_parse``
 338   - ``rte_eal_compare_pci_addr`` replaced by ``rte_pci_addr_cmp``
 339
 340 * The network structure ``esp_tail`` has been prefixed by ``rte_``.
 341
 342 * The network definitions of PPPoE ethertypes have been prefixed by ``RTE_``.
 343
 344 * The network structure for MPLS has been prefixed by ``rte_``.
 345
 346 * ethdev: changed ``rte_eth_dev_infos_get`` return value from ``void`` to
 347   ``int`` to provide a way to report various error conditions.
 348
 349 * ethdev: changed ``rte_eth_promiscuous_enable`` and
 350   ``rte_eth_promiscuous_disable`` return value from ``void`` to ``int`` to
 351   provide a way to report various error conditions.
 352
 353 * ethdev: changed ``rte_eth_allmulticast_enable`` and
 354   ``rte_eth_allmulticast_disable`` return value from ``void`` to ``int`` to
 355   provide a way to report various error conditions.
 356
 357 * ethdev: changed ``rte_eth_dev_xstats_reset`` return value from ``void`` to
 358   ``int`` to provide a way to report various error conditions.
 359
 360 * ethdev: changed ``rte_eth_link_get`` and ``rte_eth_link_get_nowait``
 361   return value from ``void`` to ``int`` to provide a way to report various
 362   error conditions.
 363
 364 * ethdev: changed ``rte_eth_macaddr_get`` return value from ``void`` to
 365   ``int`` to provide a way to report various error conditions.
 366
 367 * ethdev: changed ``rte_eth_dev_owner_delete`` return value from ``void`` to
 368   ``int`` to provide a way to report various error conditions.
 369
 370 * event: The function ``rte_event_eth_tx_adapter_enqueue`` takes an additional
 371   input as ``flags``. Flag ``RTE_EVENT_ETH_TX_ADAPTER_ENQUEUE_SAME_DEST`` which
 372   has been introduced in this release is used when used when all the packets
 373   enqueued in the tx adapter are destined for the same Ethernet port & Tx queue.
 374
 375 * sched: The pipe nodes configuration parameters such as number of pipes,
 376   pipe queue sizes, pipe profiles, etc., are moved from port level structure
 377   to subport level. This allows different subports of the same port to
 378   have different configuration for the pipe nodes.
 379
 380
 381 ABI Changes
 382 -----------
 383
 384 .. This section should contain ABI changes. Sample format:
 385
 386    * sample: Add a short 1-2 sentence description of the ABI change
 387      which was announced in the previous releases and made in this release.
 388      Start with a scope label like "ethdev:".
 389      Use fixed width quotes for ``function_names`` or ``struct_names``.
 390      Use the past tense.
 391
 392    This section is a comment. Do not overwrite or remove it.
 393    Also, make sure to start the actual text at the margin.
 394    =========================================================
 395
 396 * net: The Ethernet address and other header definitions have changed
 397   attributes. They have been modified to be aligned on 2-byte boundaries.
 398   These changes should not impact normal usage because drivers naturally
 399   align the Ethernet header on receive and all known encapsulations
 400   preserve the alignment of the header.
 401
 402
 403 Shared Library Versions
 404 -----------------------
 405
 406 .. Update any library version updated in this release
 407    and prepend with a ``+`` sign, like this:
 408
 409      libfoo.so.1
 410    + libupdated.so.2
 411      libbar.so.1
 412
 413    This section is a comment. Do not overwrite or remove it.
 414    =========================================================
 415
 416 The libraries prepended with a plus sign were incremented in this version.
 417
 418 .. code-block:: diff
 419
 420      librte_acl.so.2
 421      librte_bbdev.so.1
 422      librte_bitratestats.so.2
 423      librte_bpf.so.1
 424      librte_bus_dpaa.so.2
 425      librte_bus_fslmc.so.2
 426      librte_bus_ifpga.so.2
 427      librte_bus_pci.so.2
 428      librte_bus_vdev.so.2
 429      librte_bus_vmbus.so.2
 430      librte_cfgfile.so.2
 431      librte_cmdline.so.2
 432      librte_compressdev.so.1
 433      librte_cryptodev.so.8
 434      librte_distributor.so.1
 435    + librte_eal.so.12
 436      librte_efd.so.1
 437    + librte_ethdev.so.13
 438    + librte_eventdev.so.8
 439    + librte_fib.so.1
 440      librte_flow_classify.so.1
 441      librte_gro.so.1
 442      librte_gso.so.1
 443      librte_hash.so.2
 444      librte_ip_frag.so.1
 445      librte_ipsec.so.1
 446      librte_jobstats.so.1
 447      librte_kni.so.2
 448      librte_kvargs.so.1
 449      librte_latencystats.so.1
 450      librte_lpm.so.2
 451      librte_mbuf.so.5
 452      librte_member.so.1
 453      librte_mempool.so.5
 454      librte_meter.so.3
 455      librte_metrics.so.1
 456      librte_net.so.1
 457    + librte_pci.so.2
 458      librte_pdump.so.3
 459      librte_pipeline.so.3
 460      librte_pmd_bnxt.so.2
 461      librte_pmd_bond.so.2
 462      librte_pmd_i40e.so.2
 463      librte_pmd_ixgbe.so.2
 464      librte_pmd_dpaa2_qdma.so.1
 465      librte_pmd_ring.so.2
 466      librte_pmd_softnic.so.1
 467      librte_pmd_vhost.so.2
 468      librte_port.so.3
 469      librte_power.so.1
 470      librte_rawdev.so.1
 471    + librte_rib.so.1
 472      librte_rcu.so.1
 473      librte_reorder.so.1
 474      librte_ring.so.2
 475    + librte_sched.so.4
 476      librte_security.so.2
 477      librte_stack.so.1
 478      librte_table.so.3
 479      librte_timer.so.1
 480      librte_vhost.so.4
 481
 482
 483 Known Issues
 484 ------------
 485
 486 .. This section should contain new known issues in this release. Sample format:
 487
 488    * **Add title in present tense with full stop.**
 489
 490      Add a short 1-2 sentence description of the known issue
 491      in the present tense. Add information on any known workarounds.
 492
 493    This section is a comment. Do not overwrite or remove it.
 494    Also, make sure to start the actual text at the margin.
 495    =========================================================
 496
 497
 498 Tested Platforms
 499 ----------------
 500
 501 .. This section should contain a list of platforms that were tested
 502    with this release.
 503
 504    The format is:
 505
 506    * <vendor> platform with <vendor> <type of devices> combinations
 507
 508      * List of CPU
 509      * List of OS
 510      * List of devices
 511      * Other relevant details...
 512
 513    This section is a comment. Do not overwrite or remove it.
 514    Also, make sure to start the actual text at the margin.
 515    =========================================================
 516