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