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