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