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