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