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