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 * **Added support for --base-virtaddr EAL option to FreeBSD.**
  60
  61   The FreeBSD version of DPDK now also supports setting base virtual address
  62   for mapping pages and resources into its address space.
  63
  64 * **Added Lock-free Stack for aarch64.**
  65
  66   Enabled the lock-free stack implementation for aarch64 platforms.
  67
  68 * **Extended pktmbuf mempool private structure.**
  69
  70   rte_pktmbuf_pool_private structure was extended to include flags field
  71   for future compatibility.
  72   As per 19.11 release this field is reserved and should be set to 0
  73   by the user.
  74
  75 +* **Changed mempool allocation behavior.**
  76
  77   Changed the mempool allocation behaviour so that objects no longer cross
  78   pages by default. Note, this may consume more memory when using small memory
  79   pages.
  80
  81 * **Added support for dynamic fields and flags in mbuf.**
  82
  83   This new feature adds the ability to dynamically register some room
  84   for a field or a flag in the mbuf structure. This is typically used
  85   for specific offload features, where adding a static field or flag
  86   in the mbuf is not justified.
  87
  88 * **Added support for hairpin queues.**
  89
  90   On supported NICs, we can now setup hairpin queues which will offload packets
  91   from the wire, back to the wire.
  92
  93 * **Added flow tag in rte_flow.**
  94
  95   The ``SET_TAG`` action and ``TAG`` item have been added to support transient
  96   flow tag.
  97
  98 * **Extended metadata support in rte_flow.**
  99
 100   Flow metadata has been extended to both Rx and Tx.
 101
 102   * Tx metadata can also be set by SET_META action of rte_flow.
 103   * Rx metadata is delivered to the host via a dynamic field of ``rte_mbuf``
 104     with ``PKT_RX_DYNF_METADATA``.
 105
 106 * **Added ethdev API to set supported packet types.**
 107
 108   * Added new API ``rte_eth_dev_set_ptypes`` which allows an application to
 109     inform a PMD about a reduced range of packet types to handle.
 110   * This scheme will allow PMDs to avoid lookup of internal ptype table on Rx
 111     and thereby improve Rx performance if the application wishes to do so.
 112
 113 * **Added Rx offload flag to enable or disable RSS update.**
 114
 115   * Added new Rx offload flag ``DEV_RX_OFFLOAD_RSS_HASH`` which can be used to
 116     enable/disable PMDs write to ``rte_mbuf::hash::rss``.
 117   * PMDs notify the validity of ``rte_mbuf::hash:rss`` to the application
 118     by enabling ``PKT_RX_RSS_HASH`` flag in ``rte_mbuf::ol_flags``.
 119
 120 * **Added Rx/Tx packet burst mode "get" API.**
 121
 122   Added two new functions ``rte_eth_rx_burst_mode_get`` and
 123   ``rte_eth_tx_burst_mode_get`` that allow an application
 124   to retrieve the mode information about Rx/Tx packet burst
 125   such as Scalar or Vector, and Vector technology like AVX2.
 126
 127 * **Added Hisilicon hns3 PMD.**
 128
 129   Added the new ``hns3`` net driver for the inbuilt Hisilicon Network
 130   Subsystem 3 (HNS3) network engine found in the Hisilicon Kunpeng 920 SoC.
 131   See the :doc:`../nics/hns3` guide for more details on this new driver.
 132
 133 * **Added NXP PFE PMD.**
 134
 135   Added the new PFE driver for the NXP LS1012A platform. See the
 136   :doc:`../nics/pfe` NIC driver guide for more details on this new driver.
 137
 138 * **Updated Broadcom bnxt driver.**
 139
 140   Updated Broadcom bnxt driver with new features and improvements, including:
 141
 142   * Added support for hot firmware upgrade.
 143   * Added support for error recovery.
 144   * Added support for querying and using COS classification in hardware.
 145   * Added LRO support Thor devices.
 146   * Update HWRM API to version 1.10.1.6
 147
 148 * **Updated the enic driver.**
 149
 150   * Added support for Geneve with options offload.
 151   * Added flow API implementation based on VIC Flow Manager API.
 152
 153 * **Updated iavf PMD.**
 154
 155   Enable AVX2 data path for iavf PMD.
 156
 157 * **Updated the Intel e1000 driver.**
 158
 159   Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
 160
 161 * **Updated the Intel ixgbe driver.**
 162
 163   Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
 164
 165 * **Updated the Intel i40e driver.**
 166
 167   Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
 168
 169 * **Updated the Intel fm10k driver.**
 170
 171   Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
 172
 173 * **Updated the Intel ice driver.**
 174
 175   Updated the Intel ice driver with new features and improvements, including:
 176
 177   * Added support for device-specific DDP package loading.
 178   * Added support for handling Receive Flex Descriptor.
 179   * Added support for protocol extraction on per Rx queue.
 180   * Added support for Flow Director filter based on generic filter framework.
 181   * Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
 182   * Generic filter enhancement
 183     - Supported pipeline mode.
 184     - Supported new packet type like PPPoE for switch filter.
 185   * Supported input set change and symmetric hash by rte_flow RSS action.
 186   * Added support for GTP Tx checksum offload.
 187   * Added new device IDs to support E810_XXV devices.
 188
 189 * **Updated the Huawei hinic driver.**
 190
 191   Updated the Huawei hinic driver with new features and improvements, including:
 192
 193   * Enabled SR-IOV - Partially supported at this point, VFIO only.
 194   * Supported VLAN filter and VLAN offload.
 195   * Supported Unicast MAC filter and Multicast MAC filter.
 196   * Supported Flow API for LACP, VRRP, BGP and so on.
 197   * Supported FW version get.
 198
 199 * **Updated Mellanox mlx5 driver.**
 200
 201   Updated Mellanox mlx5 driver with new features and improvements, including:
 202
 203   * Added support for VLAN pop flow offload command.
 204   * Added support for VLAN push flow offload command.
 205   * Added support for VLAN set PCP offload command.
 206   * Added support for VLAN set VID offload command.
 207   * Added support for matching on packets withe Geneve tunnel header.
 208   * Added hairpin support.
 209   * Added ConnectX-6 Dx support.
 210   * Flow engine selected based on RDMA Core library version.
 211     DV flow engine selected if version is rdma-core-24.0 or higher.
 212     Verbs flow engine selected otherwise.
 213
 214 * **Updated the AF_XDP PMD.**
 215
 216   Updated the AF_XDP PMD. The new features include:
 217
 218   * Enabled zero copy between application mempools and UMEM by enabling the
 219     ``XDP_UMEM_UNALIGNED_CHUNKS UMEM`` flag.
 220
 221 * **Added cryptodev asymmetric session-less operation.**
 222
 223   Added a session-less option to the cryptodev asymmetric structure. It works
 224   the same way as symmetric crypto, and the corresponding transform is used
 225   directly by the crypto operation.
 226
 227 * **Added Marvell NITROX symmetric crypto PMD.**
 228
 229   Added a symmetric crypto PMD for Marvell NITROX V security processor.
 230   See the :doc:`../cryptodevs/nitrox` guide for more details on this new PMD.
 231
 232 * **Added asymmetric support to Marvell OCTEON TX crypto PMD.**
 233
 234   Added support for asymmetric operations to Marvell OCTEON TX crypto PMD.
 235   Supports RSA and modexp operations.
 236
 237 * **Added Marvell OCTEON TX2 crypto PMD.**
 238
 239   Added a new PMD driver for hardware crypto offload block on ``OCTEON TX2``
 240   SoC.
 241
 242   See :doc:`../cryptodevs/octeontx2` for more details
 243
 244 * **Updated NXP crypto PMDs for PDCP support.**
 245
 246   Added PDCP support to the DPAA_SEC and DPAA2_SEC PMDs using rte_security
 247   APIs.  Support has been added for all sequence number sizes for control and
 248   user plane.  Test and test-crypto-perf applications have been updated for
 249   unit testing.
 250
 251 * **Updated the AESNI-MB PMD.**
 252
 253   * Added support for intel-ipsec-mb version 0.53.
 254
 255 * **Updated the AESNI-GCM PMD.**
 256
 257   * Added support for intel-ipsec-mb version 0.53.
 258   * Added support for in-place chained mbufs with AES-GCM algorithm.
 259
 260 * **Enabled Single Pass GCM acceleration on QAT GEN3.**
 261
 262   Added support for Single Pass GCM, available on QAT GEN3 only (Intel
 263   QuickAssist Technology P5xxx). It is automatically chosen instead of the
 264   classic 2-pass mode when running on QAT GEN3, significantly improving
 265   the performance of AES GCM operations.
 266
 267 * **Updated the Intel QuickAssist Technology (QAT) asymmetric crypto PMD.**
 268
 269   * Added support for asymmetric session-less operations.
 270   * Added support for RSA algorithm with pair ``(n, d)`` private key
 271     representation.
 272   * Added support for RSA algorithm with quintuple private key representation.
 273
 274 * **Updated the Intel QuickAssist Technology (QAT) compression PMD.**
 275
 276   Added stateful decompression support in the Intel QuickAssist Technology PMD.
 277   Please note that stateful compression is not supported.
 278
 279 * **Added external buffers support for dpdk-test-compress-perf tool.**
 280
 281   Added a command line option to the ``dpdk-test-compress-perf`` tool to
 282   allocate and use memory zones as external buffers instead of keeping the
 283   data directly in mbuf areas.
 284
 285 * **Updated the IPSec library.**
 286
 287   * Added Security Associations (SA) Database API to ``librte_ipsec``. A new
 288     test-sad application has also been introduced to evaluate and perform
 289     custom functional and performance tests for an IPsec SAD implementation.
 290
 291   * Support fragmented packets in inline crypto processing mode with fallback
 292     ``lookaside-none`` session. Corresponding changes are also added in the
 293     IPsec Security Gateway application.
 294
 295 * **Introduced FIFO for NTB PMD.**
 296
 297   Introduced FIFO for NTB (Non-transparent Bridge) PMD to support
 298   packet based processing.
 299
 300 * **Added eBPF JIT support for arm64.**
 301
 302   Added eBPF JIT support for arm64 architecture to improve the eBPF program
 303   performance.
 304
 305 * **Added RIB and FIB (Routing/Forwarding Information Base) libraries.**
 306
 307   Added Routing and Forwarding Information Base (RIB/FIB) libraries. RIB and
 308   FIB can replace the LPM (Longest Prefix Match) library with better control
 309   plane (RIB) performance. The data plane (FIB) can be extended with new
 310   algorithms.
 311
 312 * **Updated testpmd with a command for ptypes.**
 313
 314   * Added a console command to testpmd app, ``show port (port_id) ptypes`` which
 315     gives ability to print port supported ptypes in different protocol layers.
 316   * Packet type detection disabled by default for the supported PMDs.
 317
 318 * **Added new l2fwd-event sample application.**
 319
 320   Added an example application ``l2fwd-event`` that adds event device support to
 321   the traditional l2fwd example. It demonstrates usage of poll and event mode IO
 322   mechanism under a single application.
 323
 324 * **Added build support for Link Time Optimization.**
 325
 326   LTO is an optimization technique used by the compiler to perform whole
 327   program analysis and optimization at link time.  In order to do that
 328   compilers store their internal representation of the source code that
 329   the linker uses at the final stage of the compilation process.
 330
 331   See :doc:`../prog_guide/lto` for more information:
 332
 333 * **Added IOVA as VA support for KNI.**
 334
 335   * Added IOVA = VA support for KNI. KNI can operate in IOVA = VA mode when
 336     ``iova-mode=va`` EAL option is passed to the application or when bus IOVA
 337     scheme is selected as RTE_IOVA_VA. This mode only works on Linux Kernel
 338     versions 4.10.0 and above.
 339
 340   * Due to IOVA to KVA address translations, based on the KNI use case there
 341     can be a performance impact. For mitigation, forcing IOVA to PA via EAL
 342     ``--iova-mode=pa`` option can be used, IOVA_DC bus iommu scheme can also
 343     result in IOVA as PA.
 344
 345
 346 Removed Items
 347 -------------
 348
 349 .. This section should contain removed items in this release. Sample format:
 350
 351    * Add a short 1-2 sentence description of the removed item
 352      in the past tense.
 353
 354    This section is a comment. Do not overwrite or remove it.
 355    Also, make sure to start the actual text at the margin.
 356    =========================================================
 357
 358 * Removed library-level ABI versions. These have been replaced with a single
 359   project-level ABI version for non-experimental libraries and an ABI version of
 360   ``0`` for experimental libraries. Review the :doc:`../contributing/abi_policy`
 361   and :doc:`../contributing/abi_versioning` guides for more information.
 362
 363 * Removed duplicated set of commands for Rx offload configuration from testpmd::
 364
 365     port config all crc-strip|scatter|rx-cksum|rx-timestamp|
 366                     hw-vlan|hw-vlan-filter|hw-vlan-strip|hw-vlan-extend on|off
 367
 368   The testpmd command set that can be used instead in order to enable or
 369   disable Rx offloading on all Rx queues of a port is::
 370
 371     port config <port_id> rx_offload crc_strip|scatter|
 372                                      ipv4_cksum|udp_cksum|tcp_cksum|timestamp|
 373                                      vlan_strip|vlan_filter|vlan_extend on|off
 374
 375 * Removed AF_XDP pmd_zero copy vdev argument. Support is now auto-detected.
 376
 377 * The following sample applications have been removed in this release:
 378
 379   * Exception Path
 380   * L3 Forwarding in a Virtualization Environment
 381   * Load Balancer
 382   * Netmap Compatibility
 383   * Quota and Watermark
 384   * vhost-scsi
 385
 386 * Removed arm64-dpaa2-* build config. arm64-dpaa-* can now build for both
 387   dpaa and dpaa2 platforms.
 388
 389
 390 API Changes
 391 -----------
 392
 393 .. This section should contain API changes. Sample format:
 394
 395    * sample: Add a short 1-2 sentence description of the API change
 396      which was announced in the previous releases and made in this release.
 397      Start with a scope label like "ethdev:".
 398      Use fixed width quotes for ``function_names`` or ``struct_names``.
 399      Use the past tense.
 400
 401    This section is a comment. Do not overwrite or remove it.
 402    Also, make sure to start the actual text at the margin.
 403    =========================================================
 404
 405 * eal: made the ``lcore_config`` struct and global symbol private.
 406
 407 * eal: removed the ``rte_cpu_check_supported`` function, replaced by
 408   ``rte_cpu_is_supported`` since dpdk v17.08.
 409
 410 * eal: removed the ``rte_malloc_virt2phy`` function, replaced by
 411   ``rte_malloc_virt2iova`` since v17.11.
 412
 413 * eal: made the ``rte_config`` struct and ``rte_eal_get_configuration``
 414   function private.
 415
 416 * mem: hid the internal ``malloc_heap`` structure and the
 417   ``rte_malloc_heap.h`` header.
 418
 419 * vfio: removed ``rte_vfio_dma_map`` and ``rte_vfio_dma_unmap`` that have
 420   been marked as deprecated in release 19.05.
 421   ``rte_vfio_container_dma_map`` and ``rte_vfio_container_dma_unmap`` can
 422   be used as substitutes.
 423
 424 * pci: removed the following functions deprecated since dpdk v17.11:
 425
 426   - ``eal_parse_pci_BDF`` replaced by ``rte_pci_addr_parse``
 427   - ``eal_parse_pci_DomBDF`` replaced by ``rte_pci_addr_parse``
 428   - ``rte_eal_compare_pci_addr`` replaced by ``rte_pci_addr_cmp``
 429
 430 * The network structure ``esp_tail`` has been prefixed by ``rte_``.
 431
 432 * The network definitions of PPPoE ethertypes have been prefixed by ``RTE_``.
 433
 434 * The network structure for MPLS has been prefixed by ``rte_``.
 435
 436 * ethdev: changed ``rte_eth_dev_infos_get`` return value from ``void`` to
 437   ``int`` to provide a way to report various error conditions.
 438
 439 * ethdev: changed ``rte_eth_promiscuous_enable`` and
 440   ``rte_eth_promiscuous_disable`` return value from ``void`` to ``int`` to
 441   provide a way to report various error conditions.
 442
 443 * ethdev: changed ``rte_eth_allmulticast_enable`` and
 444   ``rte_eth_allmulticast_disable`` return value from ``void`` to ``int`` to
 445   provide a way to report various error conditions.
 446
 447 * ethdev: changed ``rte_eth_dev_xstats_reset`` return value from ``void`` to
 448   ``int`` to provide a way to report various error conditions.
 449
 450 * ethdev: changed ``rte_eth_link_get`` and ``rte_eth_link_get_nowait``
 451   return value from ``void`` to ``int`` to provide a way to report various
 452   error conditions.
 453
 454 * ethdev: changed ``rte_eth_macaddr_get`` return value from ``void`` to
 455   ``int`` to provide a way to report various error conditions.
 456
 457 * ethdev: changed ``rte_eth_dev_owner_delete`` return value from ``void`` to
 458   ``int`` to provide a way to report various error conditions.
 459
 460 * ethdev: The deprecated function ``rte_eth_dev_count`` was removed.
 461   The function ``rte_eth_dev_count_avail`` is a drop-in replacement.
 462   If the intent is to iterate over ports, ``RTE_ETH_FOREACH_*`` macros
 463   are better port iterators.
 464
 465 * ethdev: ``RTE_FLOW_ITEM_TYPE_META`` data endianness altered to host one.
 466   Due to the new dynamic metadata field in mbuf is host-endian either, there
 467   is a minor compatibility issue for applications in case of 32-bit values
 468   supported.
 469
 470 * ethdev: the tx_metadata mbuf field is moved to dynamic one.
 471   ``PKT_TX_METADATA`` flag is replaced with ``PKT_TX_DYNF_METADATA``.
 472   ``DEV_TX_OFFLOAD_MATCH_METADATA`` offload flag is removed, now metadata
 473   support in PMD is engaged on dynamic field registration.
 474
 475 * event: The function ``rte_event_eth_tx_adapter_enqueue`` takes an additional
 476   input as ``flags``. Flag ``RTE_EVENT_ETH_TX_ADAPTER_ENQUEUE_SAME_DEST`` which
 477   has been introduced in this release is used when all the packets enqueued in
 478   the Tx adapter are destined for the same Ethernet port and Tx queue.
 479
 480 * sched: The pipe nodes configuration parameters such as number of pipes,
 481   pipe queue sizes, pipe profiles, etc., are moved from port level structure
 482   to subport level. This allows different subports of the same port to
 483   have different configuration for the pipe nodes.
 484
 485
 486 ABI Changes
 487 -----------
 488
 489 .. This section should contain ABI changes. Sample format:
 490
 491    * sample: Add a short 1-2 sentence description of the ABI change
 492      which was announced in the previous releases and made in this release.
 493      Start with a scope label like "ethdev:".
 494      Use fixed width quotes for ``function_names`` or ``struct_names``.
 495      Use the past tense.
 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 * policy: Please note the revisions to the :doc:`../contributing/abi_policy`
 502   introducing major ABI versions, with DPDK 19.11 becoming the first major
 503   version ``v20``. ABI changes to add new features continue to be permitted in
 504   subsequent releases, with the condition that ABI compatibility with the major
 505   ABI version is maintained.
 506
 507 * net: The Ethernet address and other header definitions have changed
 508   attributes. They have been modified to be aligned on 2-byte boundaries.
 509   These changes should not impact normal usage because drivers naturally
 510   align the Ethernet header on receive and all known encapsulations
 511   preserve the alignment of the header.
 512
 513 * security: The field ``replay_win_sz`` has been moved from the ipsec library
 514   based ``rte_ipsec_sa_prm`` structure to security library based structure
 515   ``rte_security_ipsec_xform``, which specify the anti-replay window size
 516   to enable sequence replay attack handling.
 517
 518 * ipsec: The field ``replay_win_sz`` has been removed from the structure
 519   ``rte_ipsec_sa_prm`` as it has been added to the security library.
 520
 521 * ethdev: Added 32-bit fields for maximum LRO aggregated packet size, in
 522   struct ``rte_eth_dev_info`` for the port capability and in struct
 523   ``rte_eth_rxmode`` for the port configuration.
 524   Application should use the new field in struct ``rte_eth_rxmode`` to configure
 525   the requested size.
 526   PMD should use the new field in struct ``rte_eth_dev_info`` to report the
 527   supported port capability.
 528
 529
 530 Shared Library Versions
 531 -----------------------
 532
 533 .. Update any library version updated in this release
 534    and prepend with a ``+`` sign, like this:
 535
 536      libfoo.so.1
 537    + libupdated.so.2
 538      libbar.so.1
 539
 540    This section is a comment. Do not overwrite or remove it.
 541    =========================================================
 542
 543 The libraries prepended with a plus sign were incremented in this version.
 544
 545 .. code-block:: diff
 546
 547      librte_acl.so.2
 548      librte_bbdev.so.1
 549      librte_bitratestats.so.2
 550      librte_bpf.so.1
 551      librte_bus_dpaa.so.2
 552      librte_bus_fslmc.so.2
 553      librte_bus_ifpga.so.2
 554      librte_bus_pci.so.2
 555      librte_bus_vdev.so.2
 556      librte_bus_vmbus.so.2
 557      librte_cfgfile.so.2
 558      librte_cmdline.so.2
 559      librte_compressdev.so.1
 560      librte_cryptodev.so.8
 561      librte_distributor.so.1
 562    + librte_eal.so.12
 563      librte_efd.so.1
 564    + librte_ethdev.so.13
 565    + librte_eventdev.so.8
 566    + librte_fib.so.1
 567      librte_flow_classify.so.1
 568      librte_gro.so.1
 569      librte_gso.so.1
 570      librte_hash.so.2
 571      librte_ip_frag.so.1
 572    + librte_ipsec.so.2
 573      librte_jobstats.so.1
 574      librte_kni.so.2
 575      librte_kvargs.so.1
 576      librte_latencystats.so.1
 577      librte_lpm.so.2
 578      librte_mbuf.so.5
 579      librte_member.so.1
 580      librte_mempool.so.5
 581      librte_meter.so.3
 582      librte_metrics.so.1
 583      librte_net.so.1
 584    + librte_pci.so.2
 585      librte_pdump.so.3
 586      librte_pipeline.so.3
 587      librte_pmd_bnxt.so.2
 588      librte_pmd_bond.so.2
 589      librte_pmd_i40e.so.2
 590      librte_pmd_ixgbe.so.2
 591      librte_pmd_dpaa2_qdma.so.1
 592      librte_pmd_ring.so.2
 593      librte_pmd_softnic.so.1
 594      librte_pmd_vhost.so.2
 595      librte_port.so.3
 596      librte_power.so.1
 597      librte_rawdev.so.1
 598    + librte_rib.so.1
 599      librte_rcu.so.1
 600      librte_reorder.so.1
 601      librte_ring.so.2
 602    + librte_sched.so.4
 603    + librte_security.so.3
 604      librte_stack.so.1
 605      librte_table.so.3
 606      librte_timer.so.1
 607      librte_vhost.so.4
 608
 609
 610 Known Issues
 611 ------------
 612
 613 .. This section should contain new known issues in this release. Sample format:
 614
 615    * **Add title in present tense with full stop.**
 616
 617      Add a short 1-2 sentence description of the known issue
 618      in the present tense. Add information on any known workarounds.
 619
 620    This section is a comment. Do not overwrite or remove it.
 621    Also, make sure to start the actual text at the margin.
 622    =========================================================
 623
 624
 625 Tested Platforms
 626 ----------------
 627
 628 .. This section should contain a list of platforms that were tested
 629    with this release.
 630
 631    The format is:
 632
 633    * <vendor> platform with <vendor> <type of devices> combinations
 634
 635      * List of CPU
 636      * List of OS
 637      * List of devices
 638      * Other relevant details...
 639
 640    This section is a comment. Do not overwrite or remove it.
 641    Also, make sure to start the actual text at the margin.
 642    =========================================================
 643
 644 * Intel\ |reg| platforms with Intel\ |reg| NICs combinations
 645
 646   * CPU
 647
 648     * Intel\ |reg| Atom\ |trade| CPU C3758 @ 2.20GHz
 649     * Intel\ |reg| Atom\ |trade| CPU C3858 @ 2.00GHz
 650     * Intel\ |reg| Atom\ |trade| CPU C3958 @ 2.00GHz
 651     * Intel\ |reg| Xeon\ |reg| CPU D-1541 @ 2.10GHz
 652     * Intel\ |reg| Xeon\ |reg| CPU D-1553N @ 2.30GHz
 653     * Intel\ |reg| Xeon\ |reg| CPU E5-2680 0 @ 2.70GHz
 654     * Intel\ |reg| Xeon\ |reg| CPU E5-2680 v2 @ 2.80GHz
 655     * Intel\ |reg| Xeon\ |reg| CPU E5-2699 v3 @ 2.30GHz
 656     * Intel\ |reg| Xeon\ |reg| CPU E5-2699 v4 @ 2.20GHz
 657     * Intel\ |reg| Xeon\ |reg| Gold 6139 CPU @ 2.30GHz
 658     * Intel\ |reg| Xeon\ |reg| Gold 6252N CPU @ 2.30GHz
 659     * Intel\ |reg| Xeon\ |reg| Platinum 8180 CPU @ 2.50GHz
 660     * Intel\ |reg| Xeon\ |reg| Platinum 8280M CPU @ 2.70GHz
 661
 662   * OS:
 663
 664     * CentOS 7.6
 665     * Fedora 30
 666     * FreeBSD 12.0
 667     * Red Hat Enterprise Linux Server release 8.0
 668     * Red Hat Enterprise Linux Server release 7.6
 669     * Suse12SP3
 670     * Ubuntu 14.04
 671     * Ubuntu 16.04
 672     * Ubuntu 16.10
 673     * Ubuntu 18.04
 674     * Ubuntu 19.04
 675
 676   * NICs:
 677
 678     * Intel\ |reg| Corporation Ethernet Controller E810-C for SFP (2x25G)
 679
 680       * Firmware version: 1.02 0x80002084 1.2538.0/1.02 0x80002082 1.2538.0
 681       * Device id (pf): 8086:1593
 682       * Driver version: 0.12.25 (ice)
 683
 684     * Intel\ |reg| Corporation Ethernet Controller E810-C for SFP (2x100G)
 685
 686       * Firmware version: 1.02 0x80002081 1.2538.0
 687       * Device id (pf): 8086:1592
 688       * Driver version: 0.12.25 (ice)
 689
 690     * Intel\ |reg| 82599ES 10 Gigabit Ethernet Controller
 691
 692       * Firmware version: 0x61bf0001
 693       * Device id (pf/vf): 8086:10fb / 8086:10ed
 694       * Driver version: 5.6.1 (ixgbe)
 695
 696     * Intel\ |reg| Corporation Ethernet Connection X552/X557-AT 10GBASE-T
 697
 698       * Firmware version: 0x800003e7
 699       * Device id (pf/vf): 8086:15ad / 8086:15a8
 700       * Driver version: 5.1.0 (ixgbe)
 701
 702     * Intel\ |reg| Corporation Ethernet Controller 10G X550T
 703
 704       * Firmware version: 0x80000482
 705       * Device id (pf): 8086:1563
 706       * Driver version: 5.6.1 (ixgbe)
 707
 708     * Intel\ |reg| Ethernet Converged Network Adapter X710-DA4 (4x10G)
 709
 710       * Firmware version: 7.00 0x80004cdb
 711       * Device id (pf/vf): 8086:1572 / 8086:154c
 712       * Driver version: 2.9.21 (i40e)
 713
 714     * Intel\ |reg| Corporation Ethernet Connection X722 for 10GbE SFP+ (4x10G)
 715
 716       * Firmware version: 4.10 0x80001a3c
 717       * Device id (pf/vf): 8086:37d0 / 8086:37cd
 718       * Driver version: 2.9.21 (i40e)
 719
 720     * Intel\ |reg| Ethernet Converged Network Adapter XXV710-DA2 (2x25G)
 721
 722       * Firmware version: 7.00 0x80004cf8
 723       * Device id (pf/vf): 8086:158b / 8086:154c
 724       * Driver version: 2.9.21 (i40e)
 725
 726     * Intel\ |reg| Ethernet Converged Network Adapter XL710-QDA2 (2X40G)
 727
 728       * Firmware version: 7.00 0x80004c97
 729       * Device id (pf/vf): 8086:1583 / 8086:154c
 730       * Driver version: 2.9.21 (i40e)
 731
 732     * Intel\ |reg| Corporation I350 Gigabit Network Connection
 733
 734       * Firmware version: 1.63, 0x80000cbc
 735       * Device id (pf/vf): 8086:1521 / 8086:1520
 736       * Driver version: 5.4.0-k (igb)
 737
 738     * Intel\ |reg| Corporation I210 Gigabit Network Connection
 739
 740       * Firmware version: 3.25, 0x800006eb
 741       * Device id (pf): 8086:1533
 742       * Driver version: 5.4.0-k(igb)
 743
 744 * ARMv8 SoC combinations from Marvell (with integrated NICs)
 745
 746   * SoC:
 747
 748     * CN83xx, CN96xx, CN93xx
 749
 750   * OS (Based on Marvell OCTEON TX SDK-10.1.2.0):
 751
 752     * Arch Linux
 753     * Buildroot 2018.11
 754     * Ubuntu 16.04.1 LTS
 755     * Ubuntu 16.10
 756     * Ubuntu 18.04.1
 757     * Ubuntu 19.04
 758
 759 * Intel\ |reg| platforms with Mellanox\ |reg| NICs combinations
 760
 761   * CPU:
 762
 763     * Intel\ |reg| Xeon\ |reg| Gold 6154 CPU @ 3.00GHz
 764     * Intel\ |reg| Xeon\ |reg| CPU E5-2697A v4 @ 2.60GHz
 765     * Intel\ |reg| Xeon\ |reg| CPU E5-2697 v3 @ 2.60GHz
 766     * Intel\ |reg| Xeon\ |reg| CPU E5-2680 v2 @ 2.80GHz
 767     * Intel\ |reg| Xeon\ |reg| CPU E5-2650 v4 @ 2.20GHz
 768     * Intel\ |reg| Xeon\ |reg| CPU E5-2640 @ 2.50GHz
 769     * Intel\ |reg| Xeon\ |reg| CPU E5-2620 v4 @ 2.10GHz
 770
 771   * OS:
 772
 773     * Red Hat Enterprise Linux Server release 8.0 (Maipo)
 774     * Red Hat Enterprise Linux Server release 7.7 (Maipo)
 775     * Red Hat Enterprise Linux Server release 7.6 (Maipo)
 776     * Red Hat Enterprise Linux Server release 7.5 (Maipo)
 777     * Red Hat Enterprise Linux Server release 7.4 (Maipo)
 778     * Red Hat Enterprise Linux Server release 7.3 (Maipo)
 779     * Red Hat Enterprise Linux Server release 7.2 (Maipo)
 780     * Ubuntu 19.04
 781     * Ubuntu 18.10
 782     * Ubuntu 18.04
 783     * Ubuntu 16.04
 784     * SUSE Linux Enterprise Server 15
 785
 786   * OFED:
 787
 788     * MLNX_OFED 4.6-1.0.1.1
 789     * MLNX_OFED 4.7-1.0.0.1
 790     * MLNX_OFED 4.7-3.1.9.0 and above
 791
 792   * upstream kernel:
 793
 794     * Linux 5.3 and above
 795
 796   * rdma-core:
 797
 798     * rdma-core-24.1-1 and above
 799
 800   * NICs:
 801
 802     * Mellanox\ |reg| ConnectX\ |reg|-3 Pro 40G MCX354A-FCC_Ax (2x40G)
 803
 804       * Host interface: PCI Express 3.0 x8
 805       * Device ID: 15b3:1007
 806       * Firmware version: 2.42.5000
 807
 808     * Mellanox\ |reg| ConnectX\ |reg|-4 10G MCX4111A-XCAT (1x10G)
 809
 810       * Host interface: PCI Express 3.0 x8
 811       * Device ID: 15b3:1013
 812       * Firmware version: 12.26.2032 and above
 813
 814     * Mellanox\ |reg| ConnectX\ |reg|-4 10G MCX4121A-XCAT (2x10G)
 815
 816       * Host interface: PCI Express 3.0 x8
 817       * Device ID: 15b3:1013
 818       * Firmware version: 12.26.2032 and above
 819
 820     * Mellanox\ |reg| ConnectX\ |reg|-4 25G MCX4111A-ACAT (1x25G)
 821
 822       * Host interface: PCI Express 3.0 x8
 823       * Device ID: 15b3:1013
 824       * Firmware version: 12.26.2032 and above
 825
 826     * Mellanox\ |reg| ConnectX\ |reg|-4 25G MCX4121A-ACAT (2x25G)
 827
 828       * Host interface: PCI Express 3.0 x8
 829       * Device ID: 15b3:1013
 830       * Firmware version: 12.26.2032 and above
 831
 832     * Mellanox\ |reg| ConnectX\ |reg|-4 40G MCX4131A-BCAT/MCX413A-BCAT (1x40G)
 833
 834       * Host interface: PCI Express 3.0 x8
 835       * Device ID: 15b3:1013
 836       * Firmware version: 12.26.2032 and above
 837
 838     * Mellanox\ |reg| ConnectX\ |reg|-4 40G MCX415A-BCAT (1x40G)
 839
 840       * Host interface: PCI Express 3.0 x16
 841       * Device ID: 15b3:1013
 842       * Firmware version: 12.26.2032 and above
 843
 844     * Mellanox\ |reg| ConnectX\ |reg|-4 50G MCX4131A-GCAT/MCX413A-GCAT (1x50G)
 845
 846       * Host interface: PCI Express 3.0 x8
 847       * Device ID: 15b3:1013
 848       * Firmware version: 12.26.2032 and above
 849
 850     * Mellanox\ |reg| ConnectX\ |reg|-4 50G MCX414A-BCAT (2x50G)
 851
 852       * Host interface: PCI Express 3.0 x8
 853       * Device ID: 15b3:1013
 854       * Firmware version: 12.26.2032 and above
 855
 856     * Mellanox\ |reg| ConnectX\ |reg|-4 50G MCX415A-GCAT/MCX416A-BCAT/MCX416A-GCAT (2x50G)
 857
 858       * Host interface: PCI Express 3.0 x16
 859       * Device ID: 15b3:1013
 860       * Firmware version: 12.26.2032 and above
 861       * Firmware version: 12.26.2032 and above
 862
 863     * Mellanox\ |reg| ConnectX\ |reg|-4 50G MCX415A-CCAT (1x100G)
 864
 865       * Host interface: PCI Express 3.0 x16
 866       * Device ID: 15b3:1013
 867       * Firmware version: 12.26.2032 and above
 868
 869     * Mellanox\ |reg| ConnectX\ |reg|-4 100G MCX416A-CCAT (2x100G)
 870
 871       * Host interface: PCI Express 3.0 x16
 872       * Device ID: 15b3:1013
 873       * Firmware version: 12.26.2032 and above
 874
 875     * Mellanox\ |reg| ConnectX\ |reg|-4 Lx 10G MCX4121A-XCAT (2x10G)
 876
 877       * Host interface: PCI Express 3.0 x8
 878       * Device ID: 15b3:1015
 879       * Firmware version: 14.26.2032 and above
 880
 881     * Mellanox\ |reg| ConnectX\ |reg|-4 Lx 25G MCX4121A-ACAT (2x25G)
 882
 883       * Host interface: PCI Express 3.0 x8
 884       * Device ID: 15b3:1015
 885       * Firmware version: 14.26.2032 and above
 886
 887     * Mellanox\ |reg| ConnectX\ |reg|-5 100G MCX556A-ECAT (2x100G)
 888
 889       * Host interface: PCI Express 3.0 x16
 890       * Device ID: 15b3:1017
 891       * Firmware version: 16.26.2032 and above
 892
 893     * Mellanox\ |reg| ConnectX\ |reg|-5 Ex EN 100G MCX516A-CDAT (2x100G)
 894
 895       * Host interface: PCI Express 4.0 x16
 896       * Device ID: 15b3:1019
 897       * Firmware version: 16.26.2032 and above
 898
 899 * IBM Power 9 platforms with Mellanox\ |reg| NICs combinations
 900
 901   * CPU:
 902
 903     * POWER9 2.2 (pvr 004e 1202) 2300MHz
 904
 905   * OS:
 906
 907     * Ubuntu 18.04.1 LTS (Bionic Beaver)
 908
 909   * NICs:
 910
 911     * Mellanox\ |reg| ConnectX\ |reg|-5 100G MCX556A-ECAT (2x100G)
 912
 913       * Host interface: PCI Express 3.0 x16
 914       * Device ID: 15b3:1017
 915       * Firmware version: 16.26.1040
 916
 917   * OFED:
 918
 919     * MLNX_OFED 4.7-1.0.0.2