doc/guides/rel_notes/release_20_08.rst

   1 .. SPDX-License-Identifier: BSD-3-Clause
   2    Copyright 2020 The DPDK contributors
   3
   4 .. include:: <isonum.txt>
   5
   6 DPDK Release 20.08
   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_20_08.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 * **Added non-EAL threads registration API.**
  60
  61   Added a new API to register non-EAL threads as lcores. This can be used by
  62   applications to have its threads known of DPDK without suffering from the
  63   non-EAL previous limitations in terms of performance.
  64
  65 * **rte_*mb APIs are updated to use DMB instruction for ARMv8.**
  66
  67   ARMv8 memory model has been strengthened to require other-multi-copy
  68   atomicity. This allows for using DMB instruction instead of DSB for IO
  69   barriers. rte_*mb APIs, for ARMv8 platforms, are changed to use DMB
  70   instruction to reflect this.
  71
  72 * **Added the support for vfio-pci new VF token interface.**
  73
  74   From Linux 5.7, vfio-pci supports to bind both SR-IOV PF and the created VFs,
  75   it uses a shared VF token (UUID) to represent the collaboration between PF
  76   and VFs. Update DPDK PCI driver to gain the access to the PF and VFs devices
  77   by appending the VF token parameter.
  78
  79 * **Added the RegEx Library, a generic RegEx service library.**
  80
  81   Added the RegEx library which provides an API for offload of regular
  82   expressions search operations to hardware or software accelerator devices.
  83
  84
  85 * **Introduced send packet scheduling on the timestamps.**
  86
  87    Added the new mbuf dynamic field and flag to provide timestamp on what packet
  88    transmitting can be synchronized. The device Tx offload flag is added to
  89    indicate the PMD supports send scheduling.
  90
  91 * **Updated PCAP driver.**
  92
  93   Updated PCAP driver with new features and improvements, including:
  94
  95   * Support software Tx nanosecond timestamps precision.
  96
  97 * **Updated Broadcom bnxt driver.**
  98
  99   Updated the Broadcom bnxt driver with new features and improvements, including:
 100
 101   * Added support for VF representors.
 102   * Added support for multiple devices.
 103   * Added support for new resource manager API.
 104   * Added support for VXLAN encap/decap.
 105   * Added support for rte_flow_query for COUNT action.
 106   * Added support for rx_burst_mode_get and tx_burst_mode_get.
 107   * Added vector mode support for ARM CPUs.
 108   * Added support for VLAN push and pop actions.
 109   * Added support for NAT action items.
 110
 111 * **Updated Cisco enic driver.**
 112
 113   * Added support for VLAN push and pop flow actions.
 114
 115 * **Updated Mellanox mlx5 driver.**
 116
 117   Updated Mellanox mlx5 driver with new features and improvements, including:
 118
 119   * Added new PMD devarg ``reclaim_mem_mode``.
 120   * Added new devarg ``lacp_by_user``.
 121
 122 * **Added vDPA device APIs to query virtio queue statistics.**
 123
 124      A new 3 APIs has been added to query virtio queue statistics, to get their
 125      names and to reset them by a vDPA device.
 126
 127 * **Updated Mellanox mlx5 vDPA driver.**
 128
 129   Updated Mellanox mlx5 vDPA driver with new features, including:
 130
 131   * Added support for virtio queue statistics.
 132   * Added support for MTU update.
 133
 134 * **Updated Marvell octeontx2 ethdev PMD.**
 135
 136   Updated Marvell octeontx2 driver with cn98xx support.
 137
 138 * **Updated the Intel ice driver.**
 139
 140   Updated the Intel ice driver with new features and improvements, including:
 141
 142   * Added support for DCF datapath configuration.
 143   * Added support for more PPPoE packet type for switch filter.
 144
 145 * **Updated Intel i40e driver.**
 146
 147   Updated i40e PMD with new features and improvements, including:
 148
 149   * Supported cloud filter for IPv4/6_TCP/UDP/SCTP with SRC port only or DST port only.
 150   * Re-implemented get_fdir_info and get_fdir_stat in private API.
 151   * Re-implemented set_gre_key_len in private API.
 152   * Added support for flow query RSS.
 153
 154 * **Updated the Intel ixgbe driver.**
 155
 156   Updated the Intel ixgbe driver with new features and improvements, including:
 157
 158   * Re-implemented get_fdir_info and get_fdir_stat in private API.
 159
 160 * **Updated NXP dpaa ethdev PMD.**
 161
 162   Updated the NXP dpaa ethdev with new features and improvements, including:
 163
 164   * Added support for link status and interrupt
 165   * Added support to use datapath APIs from non-EAL pthread
 166
 167 * **Updated NXP dpaa2 ethdev PMD.**
 168
 169   Updated the NXP dpaa2 ethdev with new features and improvements, including:
 170
 171   * Added support to use datapath APIs from non-EAL pthread
 172   * Added support for dynamic flow management
 173
 174 * **Added DOCSIS protocol to rte_security.**
 175
 176   Added support for combined crypto and CRC operations for the DOCSIS protocol
 177   to ``rte_security`` API.
 178
 179 * **Updated the AESNI MB crypto PMD.**
 180
 181   Added support for lookaside protocol offload for DOCSIS through the
 182   ``rte_security`` API.
 183
 184 * **Updated the QuickAssist Technology (QAT) PMD.**
 185
 186   * Added support for lookaside protocol offload for DOCSIS through the
 187     ``rte_security`` API.
 188   * Added Chacha20-Poly1305 AEAD algorithm.
 189   * Improved handling of multi process in QAT crypto and compression PMDs.
 190
 191 * **Updated the OCTEON TX2 crypto PMD.**
 192
 193   Added Chacha20-Poly1305 AEAD algorithm support in OCTEON TX2 crypto PMD.
 194
 195 * **Added support for BPF_ABS/BPF_IND load instructions.**
 196
 197   Added support for two BPF non-generic instructions:
 198   ``(BPF_ABS | <size> | BPF_LD)`` and ``(BPF_IND | <size> | BPF_LD)``
 199   which are used to access packet data in a safe manner. Currently JIT support
 200   for these instructions is implemented for x86 only.
 201
 202 * **Added flow performance test application.**
 203
 204   Added new application to test ``rte_flow`` performance, including:
 205
 206   * Measure ``rte_flow`` insertion rate.
 207   * Measure ``rte_flow`` deletion rate.
 208   * Dump ``rte_flow`` memory consumption.
 209   * Measure packet per second forwarding.
 210
 211 * **Added --portmap command line parameter to l2fwd example.**
 212
 213   Added new command line option ``--portmap="(port, port)[,(port, port)]"`` to
 214   pass forwarding port details.
 215   See the :doc:`../sample_app_ug/l2_forward_real_virtual` for more
 216   details of this parameter usage.
 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 ``RTE_KDRV_NONE`` based PCI device driver probing.
 232
 233
 234 API Changes
 235 -----------
 236
 237 .. This section should contain API changes. Sample format:
 238
 239    * sample: Add a short 1-2 sentence description of the API change
 240      which was announced in the previous releases and made in this release.
 241      Start with a scope label like "ethdev:".
 242      Use fixed width quotes for ``function_names`` or ``struct_names``.
 243      Use the past tense.
 244
 245    This section is a comment. Do not overwrite or remove it.
 246    Also, make sure to start the actual text at the margin.
 247    =========================================================
 248
 249 * ``rte_page_sizes`` enumeration is replaced with ``RTE_PGSIZE_xxx`` defines.
 250
 251 * vhost: The API of ``rte_vhost_host_notifier_ctrl`` was changed to be per
 252   queue and not per device, a qid parameter was added to the arguments list.
 253
 254
 255 ABI Changes
 256 -----------
 257
 258 .. This section should contain ABI changes. Sample format:
 259
 260    * sample: Add a short 1-2 sentence description of the ABI change
 261      which was announced in the previous releases and made in this release.
 262      Start with a scope label like "ethdev:".
 263      Use fixed width quotes for ``function_names`` or ``struct_names``.
 264      Use the past tense.
 265
 266    This section is a comment. Do not overwrite or remove it.
 267    Also, make sure to start the actual text at the margin.
 268    =========================================================
 269
 270 * No ABI change that would break compatibility with 19.11.
 271
 272
 273 Known Issues
 274 ------------
 275
 276 .. This section should contain new known issues in this release. Sample format:
 277
 278    * **Add title in present tense with full stop.**
 279
 280      Add a short 1-2 sentence description of the known issue
 281      in the present tense. Add information on any known workarounds.
 282
 283    This section is a comment. Do not overwrite or remove it.
 284    Also, make sure to start the actual text at the margin.
 285    =========================================================
 286
 287
 288 Tested Platforms
 289 ----------------
 290
 291 .. This section should contain a list of platforms that were tested
 292    with this release.
 293
 294    The format is:
 295
 296    * <vendor> platform with <vendor> <type of devices> combinations
 297
 298      * List of CPU
 299      * List of OS
 300      * List of devices
 301      * Other relevant details...
 302
 303    This section is a comment. Do not overwrite or remove it.
 304    Also, make sure to start the actual text at the margin.
 305    =========================================================