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