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