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