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