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