net/virtio: support LRO
[dpdk.git] / doc / guides / rel_notes / release_16_11.rst
1 DPDK Release 16.11
2 ==================
3
4 .. **Read this first.**
5
6    The text below explains how to update the release notes.
7
8    Use proper spelling, capitalization and punctuation in all sections.
9
10    Variable and config names should be quoted as fixed width text: ``LIKE_THIS``.
11
12    Build the docs and view the output file to ensure the changes are correct::
13
14       make doc-guides-html
15
16       firefox build/doc/html/guides/rel_notes/release_16_11.html
17
18
19 New Features
20 ------------
21
22 .. This section should contain new features added in this release. Sample format:
23
24    * **Add a title in the past tense with a full stop.**
25
26      Add a short 1-2 sentence description in the past tense. The description
27      should be enough to allow someone scanning the release notes to understand
28      the new feature.
29
30      If the feature adds a lot of sub-features you can use a bullet list like this.
31
32      * Added feature foo to do something.
33      * Enhanced feature bar to do something else.
34
35      Refer to the previous release notes for examples.
36
37      This section is a comment. Make sure to start the actual text at the margin.
38
39
40 * **Added software parser for packet type.**
41
42   * Added a new function ``rte_pktmbuf_read()`` to read the packet data from an
43     mbuf chain, linearizing if required.
44   * Added a new function ``rte_net_get_ptype()`` to parse an Ethernet packet
45     in an mbuf chain and retrieve its packet type by software.
46   * Added new functions ``rte_get_ptype_*()`` to dump a packet type as a string.
47
48 * **Improved offloads support in mbuf.**
49
50   * Added a new function ``rte_raw_cksum_mbuf()`` to process the checksum of
51     data embedded in an mbuf chain.
52   * Added new Rx checksum flags in mbufs to describe more states: unknown,
53     good, bad, or not present (useful for virtual drivers). This modification
54     was done for IP and L4.
55   * Added a new RX LRO mbuf flag, used when packets are coalesced. This
56     flag indicates that the segment size of original packets is known.
57
58 * **Added vhost-user dequeue zero copy support**
59
60   The copy in dequeue path is saved, which is meant to improve the performance.
61   In the VM2VM case, the boost is quite impressive. The bigger the packet size,
62   the bigger performance boost you may get. However, for VM2NIC case, there
63   are some limitations, yet the boost is not that impressive as VM2VM case.
64   It may even drop quite a bit for small packets.
65
66   For such reason, this feature is disabled by default. It can be enabled when
67   ``RTE_VHOST_USER_DEQUEUE_ZERO_COPY`` flag is given. Check the vhost section
68   at programming guide for more information.
69
70 * **Added vhost-user indirect descriptors support.**
71
72   If indirect descriptor feature is negotiated, each packet sent by the guest
73   will take exactly one slot in the enqueue virtqueue. Without the feature, in
74   current version, even 64 bytes packets take two slots with Virtio PMD on guest
75   side.
76
77   The main impact is better performance for 0% packet loss use-cases, as it
78   behaves as if the virtqueue size was enlarged, so more packets can be buffered
79   in case of system perturbations. On the downside, small performance degradation
80   is measured when running micro-benchmarks.
81
82 * **Added vhost PMD xstats.**
83
84   Added extended statistics to vhost PMD from per port perspective.
85
86 * **Supported offloads with virtio.**
87
88   * Rx/Tx checksums
89   * LRO
90
91 * **Added virtio NEON support for ARM.**
92
93 * **Updated the ixgbe base driver.**
94
95   Updated the ixgbe base driver, including the following changes:
96
97   * add X550em_a 10G PHY support
98   * support flow control auto negotiation for X550em_a 1G PHY
99   * add X550em_a FW ALEF support
100   * increase mailbox version to ixgbe_mbox_api_13
101   * add two MAC ops for Hyper-V support
102
103 * **Updated the QAT PMD.**
104
105   The QAT PMD was updated with following support:
106
107   * MD5_HMAC algorithm
108   * SHA224-HMAC algorithm
109   * SHA384-HMAC algorithm
110   * GMAC algorithm
111   * KASUMI (F8 and F9) algorithm
112   * 3DES algorithm
113   * NULL algorithm
114   * C3XXX device
115   * C62XX device
116
117 * **Added libcrypto PMD.**
118
119   A new crypto PMD has been added, which provides several ciphering and hashing.
120   All cryptography operations are using Openssl library crypto API.
121
122 * **Updated the IPsec example with following support:**
123
124   * configuration file
125   * AES CBC IV generation with cipher forward function
126   * AES GCM/CTR mode
127
128 * **Added support for new gcc -march option.**
129
130   The GCC 4.9 ``-march`` option supports the Intel processor code names.
131   The config option ``RTE_MACHINE`` can be used to pass code names to the compiler as ``-march`` flag.
132
133
134 Resolved Issues
135 ---------------
136
137 .. This section should contain bug fixes added to the relevant sections. Sample format:
138
139    * **code/section Fixed issue in the past tense with a full stop.**
140
141      Add a short 1-2 sentence description of the resolved issue in the past tense.
142      The title should contain the code/lib section like a commit message.
143      Add the entries in alphabetic order in the relevant sections below.
144
145    This section is a comment. Make sure to start the actual text at the margin.
146
147
148 EAL
149 ~~~
150
151
152 Drivers
153 ~~~~~~~
154
155
156 Libraries
157 ~~~~~~~~~
158
159
160 Examples
161 ~~~~~~~~
162
163
164 Other
165 ~~~~~
166
167
168 Known Issues
169 ------------
170
171 .. This section should contain new known issues in this release. Sample format:
172
173    * **Add title in present tense with full stop.**
174
175      Add a short 1-2 sentence description of the known issue in the present
176      tense. Add information on any known workarounds.
177
178    This section is a comment. Make sure to start the actual text at the margin.
179
180
181 API Changes
182 -----------
183
184 .. This section should contain API changes. Sample format:
185
186    * Add a short 1-2 sentence description of the API change. Use fixed width
187      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
188
189    This section is a comment. Make sure to start the actual text at the margin.
190
191 * The driver names have been changed. It especially impacts ``--vdev`` arguments.
192   Examples: ``eth_pcap`` becomes ``net_pcap``
193   and ``cryptodev_aesni_mb_pmd`` becomes ``crypto_aesni_mb``.
194
195 * The log history is removed.
196
197 * The ``rte_ivshmem`` feature (including library and EAL code) has been removed
198   in 16.11 because it had some design issues which were not planned to be fixed.
199
200 * The ``file_name`` data type of ``struct rte_port_source_params`` and
201   ``struct rte_port_sink_params`` is changed from `char *`` to ``const char *``.
202
203
204 ABI Changes
205 -----------
206
207 .. This section should contain ABI changes. Sample format:
208
209    * Add a short 1-2 sentence description of the ABI change that was announced in
210      the previous releases and made in this release. Use fixed width quotes for
211      ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
212
213    This section is a comment. Make sure to start the actual text at the margin.
214
215
216
217 Shared Library Versions
218 -----------------------
219
220 .. Update any library version updated in this release and prepend with a ``+``
221    sign, like this:
222
223      libethdev.so.4
224      librte_acl.so.2
225    + librte_cfgfile.so.2
226      librte_cmdline.so.2
227
228
229
230 The libraries prepended with a plus sign were incremented in this version.
231
232 .. code-block:: diff
233
234      libethdev.so.4
235      librte_acl.so.2
236      librte_cfgfile.so.2
237      librte_cmdline.so.2
238      librte_cryptodev.so.1
239      librte_distributor.so.1
240    + librte_eal.so.3
241      librte_hash.so.2
242      librte_ip_frag.so.1
243      librte_jobstats.so.1
244      librte_kni.so.2
245      librte_kvargs.so.1
246      librte_lpm.so.2
247      librte_mbuf.so.2
248      librte_mempool.so.2
249      librte_meter.so.1
250      librte_pdump.so.1
251      librte_pipeline.so.3
252      librte_pmd_bond.so.1
253      librte_pmd_ring.so.2
254      librte_port.so.3
255      librte_power.so.1
256      librte_reorder.so.1
257      librte_ring.so.1
258      librte_sched.so.1
259      librte_table.so.2
260      librte_timer.so.1
261      librte_vhost.so.3
262
263
264 Tested Platforms
265 ----------------
266
267 .. This section should contain a list of platforms that were tested with this release.
268
269    The format is:
270
271    #. Platform name.
272
273       * Platform details.
274       * Platform details.
275
276    This section is a comment. Make sure to start the actual text at the margin.
277
278
279 Tested NICs
280 -----------
281
282 .. This section should contain a list of NICs that were tested with this release.
283
284    The format is:
285
286    #. NIC name.
287
288       * NIC details.
289       * NIC details.
290
291    This section is a comment. Make sure to start the actual text at the margin.
292
293
294 Tested OSes
295 -----------
296
297 .. This section should contain a list of OSes that were tested with this release.
298    The format is as follows, in alphabetical order:
299
300    * CentOS 7.0
301    * Fedora 23
302    * Fedora 24
303    * FreeBSD 10.3
304    * Red Hat Enterprise Linux 7.2
305    * SUSE Enterprise Linux 12
306    * Ubuntu 15.10
307    * Ubuntu 16.04 LTS
308    * Wind River Linux 8
309
310    This section is a comment. Make sure to start the actual text at the margin.