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