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