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 * **Updated PCAP driver.**
  85
  86   Updated PCAP driver with new features and improvements, including:
  87
  88   * Support software Tx nanosecond timestamps precision.
  89
  90 * **Updated Broadcom bnxt driver.**
  91
  92   Updated the Broadcom bnxt driver with new features and improvements, including:
  93
  94   * Added support for VF representors.
  95   * Added support for multiple devices.
  96   * Added support for new resource manager API.
  97   * Added support for VXLAN encap/decap.
  98   * Added support for rte_flow_query for COUNT action.
  99   * Added support for rx_burst_mode_get and tx_burst_mode_get.
 100   * Added vector mode support for ARM CPUs.
 101   * Added support for VLAN push and pop actions.
 102   * Added support for NAT action items.
 103
 104 * **Updated Cisco enic driver.**
 105
 106   * Added support for VLAN push and pop flow actions.
 107
 108 * **Updated Mellanox mlx5 driver.**
 109
 110   Updated Mellanox mlx5 driver with new features and improvements, including:
 111
 112   * Added new PMD devarg ``reclaim_mem_mode``.
 113   * Added new devarg ``lacp_by_user``.
 114
 115 * **Added vDPA device APIs to query virtio queue statistics.**
 116
 117      A new 3 APIs has been added to query virtio queue statistics, to get their
 118      names and to reset them by a vDPA device.
 119
 120 * **Updated Mellanox mlx5 vDPA driver.**
 121
 122   Updated Mellanox mlx5 vDPA driver with new features, including:
 123
 124   * Added support for virtio queue statistics.
 125   * Added support for MTU update.
 126
 127 * **Updated Marvell octeontx2 ethdev PMD.**
 128
 129   Updated Marvell octeontx2 driver with cn98xx support.
 130
 131 * **Updated the Intel ice driver.**
 132
 133   Updated the Intel ice driver with new features and improvements, including:
 134
 135   * Added support for DCF datapath configuration.
 136   * Added support for more PPPoE packet type for switch filter.
 137
 138 * **Updated Intel i40e driver.**
 139
 140   Updated i40e PMD with new features and improvements, including:
 141
 142   * Supported cloud filter for IPv4/6_TCP/UDP/SCTP with SRC port only or DST port only.
 143   * Re-implemented get_fdir_info and get_fdir_stat in private API.
 144   * Re-implemented set_gre_key_len in private API.
 145   * Added support for flow query RSS.
 146
 147 * **Updated the Intel ixgbe driver.**
 148
 149   Updated the Intel ixgbe driver with new features and improvements, including:
 150
 151   * Re-implemented get_fdir_info and get_fdir_stat in private API.
 152
 153 * **Updated NXP dpaa ethdev PMD.**
 154
 155   Updated the NXP dpaa ethdev with new features and improvements, including:
 156
 157   * Added support for link status and interrupt
 158   * Added support to use datapath APIs from non-EAL pthread
 159
 160 * **Updated NXP dpaa2 ethdev PMD.**
 161
 162   Updated the NXP dpaa2 ethdev with new features and improvements, including:
 163
 164   * Added support to use datapath APIs from non-EAL pthread
 165   * Added support for dynamic flow management
 166
 167 * **Added DOCSIS protocol to rte_security.**
 168
 169   Added support for combined crypto and CRC operations for the DOCSIS protocol
 170   to ``rte_security`` API.
 171
 172 * **Updated the AESNI MB crypto PMD.**
 173
 174   Added support for lookaside protocol offload for DOCSIS through the
 175   ``rte_security`` API.
 176
 177 * **Updated the QuickAssist Technology (QAT) PMD.**
 178
 179   * Added support for lookaside protocol offload for DOCSIS through the
 180     ``rte_security`` API.
 181   * Added Chacha20-Poly1305 AEAD algorithm.
 182   * Improved handling of multi process in QAT crypto and compression PMDs.
 183
 184 * **Updated the OCTEON TX2 crypto PMD.**
 185
 186   Added Chacha20-Poly1305 AEAD algorithm support in OCTEON TX2 crypto PMD.
 187
 188 * **Added support for BPF_ABS/BPF_IND load instructions.**
 189
 190   Added support for two BPF non-generic instructions:
 191   ``(BPF_ABS | <size> | BPF_LD)`` and ``(BPF_IND | <size> | BPF_LD)``
 192   which are used to access packet data in a safe manner. Currently JIT support
 193   for these instructions is implemented for x86 only.
 194
 195 * **Added flow performance test application.**
 196
 197   Added new application to test ``rte_flow`` performance, including:
 198
 199   * Measure ``rte_flow`` insertion rate.
 200   * Measure ``rte_flow`` deletion rate.
 201   * Dump ``rte_flow`` memory consumption.
 202   * Measure packet per second forwarding.
 203
 204 * **Added --portmap command line parameter to l2fwd example.**
 205
 206   Added new command line option ``--portmap="(port, port)[,(port, port)]"`` to
 207   pass forwarding port details.
 208   See the :doc:`../sample_app_ug/l2_forward_real_virtual` for more
 209   details of this parameter usage.
 210
 211
 212 Removed Items
 213 -------------
 214
 215 .. This section should contain removed items in this release. Sample format:
 216
 217    * Add a short 1-2 sentence description of the removed item
 218      in the past tense.
 219
 220    This section is a comment. Do not overwrite or remove it.
 221    Also, make sure to start the actual text at the margin.
 222    =========================================================
 223
 224 * Removed ``RTE_KDRV_NONE`` based PCI device driver probing.
 225
 226
 227 API Changes
 228 -----------
 229
 230 .. This section should contain API changes. Sample format:
 231
 232    * sample: Add a short 1-2 sentence description of the API change
 233      which was announced in the previous releases and made in this release.
 234      Start with a scope label like "ethdev:".
 235      Use fixed width quotes for ``function_names`` or ``struct_names``.
 236      Use the past tense.
 237
 238    This section is a comment. Do not overwrite or remove it.
 239    Also, make sure to start the actual text at the margin.
 240    =========================================================
 241
 242 * ``rte_page_sizes`` enumeration is replaced with ``RTE_PGSIZE_xxx`` defines.
 243
 244 * vhost: The API of ``rte_vhost_host_notifier_ctrl`` was changed to be per
 245   queue and not per device, a qid parameter was added to the arguments list.
 246
 247
 248 ABI Changes
 249 -----------
 250
 251 .. This section should contain ABI changes. Sample format:
 252
 253    * sample: Add a short 1-2 sentence description of the ABI change
 254      which was announced in the previous releases and made in this release.
 255      Start with a scope label like "ethdev:".
 256      Use fixed width quotes for ``function_names`` or ``struct_names``.
 257      Use the past tense.
 258
 259    This section is a comment. Do not overwrite or remove it.
 260    Also, make sure to start the actual text at the margin.
 261    =========================================================
 262
 263 * No ABI change that would break compatibility with 19.11.
 264
 265
 266 Known Issues
 267 ------------
 268
 269 .. This section should contain new known issues in this release. Sample format:
 270
 271    * **Add title in present tense with full stop.**
 272
 273      Add a short 1-2 sentence description of the known issue
 274      in the present tense. Add information on any known workarounds.
 275
 276    This section is a comment. Do not overwrite or remove it.
 277    Also, make sure to start the actual text at the margin.
 278    =========================================================
 279
 280
 281 Tested Platforms
 282 ----------------
 283
 284 .. This section should contain a list of platforms that were tested
 285    with this release.
 286
 287    The format is:
 288
 289    * <vendor> platform with <vendor> <type of devices> combinations
 290
 291      * List of CPU
 292      * List of OS
 293      * List of devices
 294      * Other relevant details...
 295
 296    This section is a comment. Do not overwrite or remove it.
 297    Also, make sure to start the actual text at the margin.
 298    =========================================================