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