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