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