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 * **Updated PCAP driver.**
  85
  86   Updated PCAP driver with new features and improvements, including:
  87
  88   * Support software Tx nanosecond timestamps precision.
  89
  90 * **Updated Mellanox mlx5 driver.**
  91
  92   Updated Mellanox mlx5 driver with new features and improvements, including:
  93
  94   * Added new PMD devarg ``reclaim_mem_mode``.
  95   * Added new devarg ``lacp_by_user``.
  96
  97 * **Added vDPA device APIs to query virtio queue statistics.**
  98
  99      A new 3 APIs has been added to query virtio queue statistics, to get their
 100      names and to reset them by a vDPA device.
 101
 102 * **Updated Mellanox mlx5 vDPA driver.**
 103
 104   Updated Mellanox mlx5 vDPA driver with new features, including:
 105
 106   * Added support for virtio queue statistics.
 107   * Added support for MTU update.
 108
 109 * **Updated Marvell octeontx2 ethdev PMD.**
 110
 111   Updated Marvell octeontx2 driver with cn98xx support.
 112
 113 * **Updated the Intel ice driver.**
 114
 115   Updated the Intel ice driver with new features and improvements, including:
 116
 117   * Added support for DCF datapath configuration.
 118
 119 * **Added DOCSIS protocol to rte_security.**
 120
 121   Added support for combined crypto and CRC operations for the DOCSIS protocol
 122   to ``rte_security`` API.
 123
 124 * **Updated the AESNI MB crypto PMD.**
 125
 126   Added support for lookaside protocol offload for DOCSIS through the
 127   ``rte_security`` API.
 128
 129 * **Added support for BPF_ABS/BPF_IND load instructions.**
 130
 131   Added support for two BPF non-generic instructions:
 132   ``(BPF_ABS | <size> | BPF_LD)`` and ``(BPF_IND | <size> | BPF_LD)``
 133   which are used to access packet data in a safe manner. Currently JIT support
 134   for these instructions is implemented for x86 only.
 135
 136 * **Added flow performance test application.**
 137
 138   Added new application to test ``rte_flow`` performance, including:
 139
 140   * Measure ``rte_flow`` insertion rate.
 141   * Measure ``rte_flow`` deletion rate.
 142   * Dump ``rte_flow`` memory consumption.
 143   * Measure packet per second forwarding.
 144
 145 * **Added --portmap command line parameter to l2fwd example.**
 146
 147   Added new command line option ``--portmap="(port, port)[,(port, port)]"`` to
 148   pass forwarding port details.
 149   See the :doc:`../sample_app_ug/l2_forward_real_virtual` for more
 150   details of this parameter usage.
 151
 152
 153 Removed Items
 154 -------------
 155
 156 .. This section should contain removed items in this release. Sample format:
 157
 158    * Add a short 1-2 sentence description of the removed item
 159      in the past tense.
 160
 161    This section is a comment. Do not overwrite or remove it.
 162    Also, make sure to start the actual text at the margin.
 163    =========================================================
 164
 165 * Removed ``RTE_KDRV_NONE`` based PCI device driver probing.
 166
 167
 168 API Changes
 169 -----------
 170
 171 .. This section should contain API changes. Sample format:
 172
 173    * sample: Add a short 1-2 sentence description of the API change
 174      which was announced in the previous releases and made in this release.
 175      Start with a scope label like "ethdev:".
 176      Use fixed width quotes for ``function_names`` or ``struct_names``.
 177      Use the past tense.
 178
 179    This section is a comment. Do not overwrite or remove it.
 180    Also, make sure to start the actual text at the margin.
 181    =========================================================
 182
 183 * ``rte_page_sizes`` enumeration is replaced with ``RTE_PGSIZE_xxx`` defines.
 184
 185 * vhost: The API of ``rte_vhost_host_notifier_ctrl`` was changed to be per
 186   queue and not per device, a qid parameter was added to the arguments list.
 187
 188
 189 ABI Changes
 190 -----------
 191
 192 .. This section should contain ABI changes. Sample format:
 193
 194    * sample: Add a short 1-2 sentence description of the ABI change
 195      which was announced in the previous releases and made in this release.
 196      Start with a scope label like "ethdev:".
 197      Use fixed width quotes for ``function_names`` or ``struct_names``.
 198      Use the past tense.
 199
 200    This section is a comment. Do not overwrite or remove it.
 201    Also, make sure to start the actual text at the margin.
 202    =========================================================
 203
 204 * No ABI change that would break compatibility with 19.11.
 205
 206
 207 Known Issues
 208 ------------
 209
 210 .. This section should contain new known issues in this release. Sample format:
 211
 212    * **Add title in present tense with full stop.**
 213
 214      Add a short 1-2 sentence description of the known issue
 215      in the present tense. Add information on any known workarounds.
 216
 217    This section is a comment. Do not overwrite or remove it.
 218    Also, make sure to start the actual text at the margin.
 219    =========================================================
 220
 221
 222 Tested Platforms
 223 ----------------
 224
 225 .. This section should contain a list of platforms that were tested
 226    with this release.
 227
 228    The format is:
 229
 230    * <vendor> platform with <vendor> <type of devices> combinations
 231
 232      * List of CPU
 233      * List of OS
 234      * List of devices
 235      * Other relevant details...
 236
 237    This section is a comment. Do not overwrite or remove it.
 238    Also, make sure to start the actual text at the margin.
 239    =========================================================