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