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 support for RTS and HTS modes into mempool ring driver.**
  73
  74   Added ability to select new ring synchronisation modes:
  75   ``relaxed tail sync (ring_mt_rts)`` and ``head/tail sync (ring_mt_hts)``
  76   via mempool ops API.
  77
  78 * **Added the support for vfio-pci new VF token interface.**
  79
  80   From Linux 5.7, vfio-pci supports to bind both SR-IOV PF and the created VFs,
  81   it uses a shared VF token (UUID) to represent the collaboration between PF
  82   and VFs. Update DPDK PCI driver to gain the access to the PF and VFs devices
  83   by appending the VF token parameter.
  84
  85 * **Added the RegEx Library, a generic RegEx service library.**
  86
  87   Added the RegEx library which provides an API for offload of regular
  88   expressions search operations to hardware or software accelerator devices.
  89
  90   Added Mellanox RegEx PMD, allowing to offload RegEx searches.
  91
  92 * **Added eCPRI protocol support in rte_flow.**
  93
  94   The ``ECPRI`` item has been added to support eCPRI packet offloading for
  95   5G network.
  96
  97 * **Introduced send packet scheduling on the timestamps.**
  98
  99    Added the new mbuf dynamic field and flag to provide timestamp on what packet
 100    transmitting can be synchronized. The device Tx offload flag is added to
 101    indicate the PMD supports send scheduling.
 102
 103 * **Updated PCAP driver.**
 104
 105   Updated PCAP driver with new features and improvements, including:
 106
 107   * Support software Tx nanosecond timestamps precision.
 108
 109 * **Updated Broadcom bnxt driver.**
 110
 111   Updated the Broadcom bnxt driver with new features and improvements, including:
 112
 113   * Added support for VF representors.
 114   * Added support for multiple devices.
 115   * Added support for new resource manager API.
 116   * Added support for VXLAN encap/decap.
 117   * Added support for rte_flow_query for COUNT action.
 118   * Added support for rx_burst_mode_get and tx_burst_mode_get.
 119   * Added vector mode support for ARM CPUs.
 120   * Added support for VLAN push and pop actions.
 121   * Added support for NAT action items.
 122
 123 * **Updated Cisco enic driver.**
 124
 125   * Added support for VLAN push and pop flow actions.
 126
 127 * **Updated Mellanox mlx5 driver.**
 128
 129   Updated Mellanox mlx5 driver with new features and improvements, including:
 130
 131   * Added new PMD devarg ``reclaim_mem_mode``.
 132   * Added new devarg ``lacp_by_user``.
 133
 134 * **Added vDPA device APIs to query virtio queue statistics.**
 135
 136      A new 3 APIs has been added to query virtio queue statistics, to get their
 137      names and to reset them by a vDPA device.
 138
 139 * **Updated Mellanox mlx5 vDPA driver.**
 140
 141   Updated Mellanox mlx5 vDPA driver with new features, including:
 142
 143   * Added support for virtio queue statistics.
 144   * Added support for MTU update.
 145
 146 * **Updated Marvell octeontx2 ethdev PMD.**
 147
 148   Updated Marvell octeontx2 driver with cn98xx support.
 149
 150 * **Updated the Intel ice driver.**
 151
 152   Updated the Intel ice driver with new features and improvements, including:
 153
 154   * Added support for DCF datapath configuration.
 155   * Added support for more PPPoE packet type for switch filter.
 156
 157 * **Updated Intel i40e driver.**
 158
 159   Updated i40e PMD with new features and improvements, including:
 160
 161   * Supported cloud filter for IPv4/6_TCP/UDP/SCTP with SRC port only or DST port only.
 162   * Re-implemented get_fdir_info and get_fdir_stat in private API.
 163   * Re-implemented set_gre_key_len in private API.
 164   * Added support for flow query RSS.
 165
 166 * **Updated the Intel ixgbe driver.**
 167
 168   Updated the Intel ixgbe driver with new features and improvements, including:
 169
 170   * Re-implemented get_fdir_info and get_fdir_stat in private API.
 171
 172 * **Updated NXP dpaa ethdev PMD.**
 173
 174   Updated the NXP dpaa ethdev with new features and improvements, including:
 175
 176   * Added support for link status and interrupt
 177   * Added support to use datapath APIs from non-EAL pthread
 178
 179 * **Updated NXP dpaa2 ethdev PMD.**
 180
 181   Updated the NXP dpaa2 ethdev with new features and improvements, including:
 182
 183   * Added support to use datapath APIs from non-EAL pthread
 184   * Added support for dynamic flow management
 185
 186 * **Added DOCSIS protocol to rte_security.**
 187
 188   Added support for combined crypto and CRC operations for the DOCSIS protocol
 189   to ``rte_security`` API.
 190
 191 * **Updated the AESNI MB crypto PMD.**
 192
 193   Added support for lookaside protocol offload for DOCSIS through the
 194   ``rte_security`` API.
 195
 196 * **Updated the QuickAssist Technology (QAT) PMD.**
 197
 198   * Added support for lookaside protocol offload for DOCSIS through the
 199     ``rte_security`` API.
 200   * Added Chacha20-Poly1305 AEAD algorithm.
 201   * Improved handling of multi process in QAT crypto and compression PMDs.
 202
 203 * **Updated the OCTEON TX2 crypto PMD.**
 204
 205   * Added Chacha20-Poly1305 AEAD algorithm support in OCTEON TX2 crypto PMD.
 206
 207   * Updated the OCTEON TX2 crypto PMD to support ``rte_security`` lookaside
 208     protocol offload for IPsec.
 209
 210 * **Added support for BPF_ABS/BPF_IND load instructions.**
 211
 212   Added support for two BPF non-generic instructions:
 213   ``(BPF_ABS | <size> | BPF_LD)`` and ``(BPF_IND | <size> | BPF_LD)``
 214   which are used to access packet data in a safe manner. Currently JIT support
 215   for these instructions is implemented for x86 only.
 216
 217 * **Added new testpmd forward mode.**
 218
 219   Added new ``5tswap`` forward mode to testpmd.
 220   the  ``5tswap`` swaps source and destination in layers 2,3,4
 221   for ipv4 and ipv6 in L3 and UDP and TCP in L4.
 222
 223 * **Added flow performance test application.**
 224
 225   Added new application to test ``rte_flow`` performance, including:
 226
 227   * Measure ``rte_flow`` insertion rate.
 228   * Measure ``rte_flow`` deletion rate.
 229   * Dump ``rte_flow`` memory consumption.
 230   * Measure packet per second forwarding.
 231
 232 * **Added --portmap command line parameter to l2fwd example.**
 233
 234   Added new command line option ``--portmap="(port, port)[,(port, port)]"`` to
 235   pass forwarding port details.
 236   See the :doc:`../sample_app_ug/l2_forward_real_virtual` for more
 237   details of this parameter usage.
 238
 239 * **Updated ipsec-secgw sample application.**
 240
 241   Added ``rte_flow`` based rules, which allows hardware parsing and steering
 242   of ingress packets to specific NIC queues.
 243   See the :doc:`../sample_app_ug/ipsec_secgw` for more details.
 244
 245
 246 Removed Items
 247 -------------
 248
 249 .. This section should contain removed items in this release. Sample format:
 250
 251    * Add a short 1-2 sentence description of the removed item
 252      in the past tense.
 253
 254    This section is a comment. Do not overwrite or remove it.
 255    Also, make sure to start the actual text at the margin.
 256    =========================================================
 257
 258 * Removed ``RTE_KDRV_NONE`` based PCI device driver probing.
 259
 260
 261 API Changes
 262 -----------
 263
 264 .. This section should contain API changes. Sample format:
 265
 266    * sample: Add a short 1-2 sentence description of the API change
 267      which was announced in the previous releases and made in this release.
 268      Start with a scope label like "ethdev:".
 269      Use fixed width quotes for ``function_names`` or ``struct_names``.
 270      Use the past tense.
 271
 272    This section is a comment. Do not overwrite or remove it.
 273    Also, make sure to start the actual text at the margin.
 274    =========================================================
 275
 276 * ``rte_page_sizes`` enumeration is replaced with ``RTE_PGSIZE_xxx`` defines.
 277
 278 * vhost: The API of ``rte_vhost_host_notifier_ctrl`` was changed to be per
 279   queue and not per device, a qid parameter was added to the arguments list.
 280
 281
 282 ABI Changes
 283 -----------
 284
 285 .. This section should contain ABI changes. Sample format:
 286
 287    * sample: Add a short 1-2 sentence description of the ABI change
 288      which was announced in the previous releases and made in this release.
 289      Start with a scope label like "ethdev:".
 290      Use fixed width quotes for ``function_names`` or ``struct_names``.
 291      Use the past tense.
 292
 293    This section is a comment. Do not overwrite or remove it.
 294    Also, make sure to start the actual text at the margin.
 295    =========================================================
 296
 297 * No ABI change that would break compatibility with 19.11.
 298
 299
 300 Known Issues
 301 ------------
 302
 303 .. This section should contain new known issues in this release. Sample format:
 304
 305    * **Add title in present tense with full stop.**
 306
 307      Add a short 1-2 sentence description of the known issue
 308      in the present tense. Add information on any known workarounds.
 309
 310    This section is a comment. Do not overwrite or remove it.
 311    Also, make sure to start the actual text at the margin.
 312    =========================================================
 313
 314
 315 Tested Platforms
 316 ----------------
 317
 318 .. This section should contain a list of platforms that were tested
 319    with this release.
 320
 321    The format is:
 322
 323    * <vendor> platform with <vendor> <type of devices> combinations
 324
 325      * List of CPU
 326      * List of OS
 327      * List of devices
 328      * Other relevant details...
 329
 330    This section is a comment. Do not overwrite or remove it.
 331    Also, make sure to start the actual text at the margin.
 332    =========================================================