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