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