summaryrefslogtreecommitdiff
path: root/doc/guides/rel_notes/release_19_05.rst
blob: 4ce6b9539780d84c80c873146e7674f955e29bba (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
..  SPDX-License-Identifier: BSD-3-Clause
    Copyright 2019 The DPDK contributors

DPDK Release 19.05
==================

.. **Read this first.**

   The text in the sections below explains how to update the release notes.

   Use proper spelling, capitalization and punctuation in all sections.

   Variable and config names should be quoted as fixed width text:
   ``LIKE_THIS``.

   Build the docs and view the output file to ensure the changes are correct::

      make doc-guides-html

      xdg-open build/doc/html/guides/rel_notes/release_19_05.html


New Features
------------

.. This section should contain new features added in this release.
   Sample format:

   * **Add a title in the past tense with a full stop.**

     Add a short 1-2 sentence description in the past tense.
     The description should be enough to allow someone scanning
     the release notes to understand the new feature.

     If the feature adds a lot of sub-features you can use a bullet list
     like this:

     * Added feature foo to do something.
     * Enhanced feature bar to do something else.

     Refer to the previous release notes for examples.

     Suggested order in release notes items:
     * Core libs (EAL, mempool, ring, mbuf, buses)
     * Device abstraction libs and PMDs
       - ethdev (lib, PMDs)
       - cryptodev (lib, PMDs)
       - eventdev (lib, PMDs)
       - etc
     * Other libs
     * Apps, Examples, Tools (if significant)

     This section is a comment. Do not overwrite or remove it.
     Also, make sure to start the actual text at the margin.
     =========================================================

* **Updated KNI module and PMD.**

  Updated the KNI kernel module to set the max_mtu according to the given
  initial MTU size. Without it, the maximum MTU was 1500.

  Updated the KNI PMD driver to set the mbuf_size and MTU based on
  the given mb-pool. This provide the ability to pass jumbo frames
  if the mb-pool contains suitable buffers' size.

* **Updated Solarflare network PMD.**

  Updated the sfc_efx driver including the following changes:

  * Added support for Rx descriptor status and related API in a secondary
    process.
  * Added support for Tx descriptor status API in a secondary process.
  * Added support for RSS RETA and hash configuration get API in a secondary
    process.
  * Added support for Rx packet types list in a secondary process.

* **Updated Mellanox drivers.**

   New features and improvements were done in mlx4 and mlx5 PMDs:

   * Added firmware version reading.

* **Renamed avf to iavf.**

  Renamed Intel Ethernet Adaptive Virtual Function driver ``avf`` to ``iavf``,
  which includes the directory name, lib name, filenames, makefile, docs,
  macros, functions, structs and any other strings in the code.

* **Updated the enic driver.**

  * Fixed several flow (director) bugs related to MARK, SCTP, VLAN, VXLAN, and
    inner packet matching.
  * Added limited support for RAW.
  * Added limited support for RSS.
  * Added limited support for PASSTHRU.

* **Updated the ixgbe driver.**

  New features for VF:

  * Added promiscuous mode support.

* **Updated the ice driver.**

  * Added support of SSE and AVX2 instructions in Rx and Tx paths.
  * Added package download support.
  * Added Safe Mode support.
  * Supported RSS for UPD/TCP/SCTP+IPV4/IPV6 packets.

* **Updated the QuickAssist Technology PMD.**

  Added support for AES-XTS with 128 and 256 bit AES keys.

* **Updated the IPsec library.**

  The IPsec library has been updated with AES-CTR and 3DES-CBC cipher algorithms
  support. The related ipsec-secgw test scripts have been added.

* **Updated the testpmd application.**

  Improved testpmd application performance on ARM platform. For ``macswap``
  forwarding mode, NEON intrinsics were used to do swap to save CPU cycles.


Removed Items
-------------

.. This section should contain removed items in this release. Sample format:

   * Add a short 1-2 sentence description of the removed item
     in the past tense.

   This section is a comment. Do not overwrite or remove it.
   Also, make sure to start the actual text at the margin.
   =========================================================


API Changes
-----------

.. This section should contain API changes. Sample format:

   * sample: Add a short 1-2 sentence description of the API change
     which was announced in the previous releases and made in this release.
     Start with a scope label like "ethdev:".
     Use fixed width quotes for ``function_names`` or ``struct_names``.
     Use the past tense.

   This section is a comment. Do not overwrite or remove it.
   Also, make sure to start the actual text at the margin.
   =========================================================

* eal: the type of the ``attr_value`` parameter of the function
  ``rte_service_attr_get()`` has been changed
  from ``uint32_t *`` to ``uint64_t *``.

* vfio: Functions ``rte_vfio_container_dma_map`` and
  ``rte_vfio_container_dma_unmap`` have been extended with an option to
  request mapping or un-mapping to the default vfio container fd.


ABI Changes
-----------

.. This section should contain ABI changes. Sample format:

   * sample: Add a short 1-2 sentence description of the ABI change
     which was announced in the previous releases and made in this release.
     Start with a scope label like "ethdev:".
     Use fixed width quotes for ``function_names`` or ``struct_names``.
     Use the past tense.

   This section is a comment. Do not overwrite or remove it.
   Also, make sure to start the actual text at the margin.
   =========================================================

* cryptodev: in 18.08 new structure ``rte_crypto_asym_op`` was introduced and
  included into ``rte_crypto_op``. As ``rte_crypto_asym_op`` structure was
  defined as cache-line aligned that caused unintended changes in
  ``rte_crypto_op`` structure layout and alignment. Remove cache-line
  alignment for ``rte_crypto_asym_op`` to restore expected ``rte_crypto_op``
  layout and alignment.


Shared Library Versions
-----------------------

.. Update any library version updated in this release
   and prepend with a ``+`` sign, like this:

     libfoo.so.1
   + libupdated.so.2
     libbar.so.1

   This section is a comment. Do not overwrite or remove it.
   =========================================================

The libraries prepended with a plus sign were incremented in this version.

.. code-block:: diff

     librte_acl.so.2
     librte_bbdev.so.1
     librte_bitratestats.so.2
     librte_bpf.so.1
     librte_bus_dpaa.so.2
     librte_bus_fslmc.so.2
     librte_bus_ifpga.so.2
     librte_bus_pci.so.2
     librte_bus_vdev.so.2
     librte_bus_vmbus.so.2
     librte_cfgfile.so.2
     librte_cmdline.so.2
     librte_compressdev.so.1
   + librte_cryptodev.so.7
     librte_distributor.so.1
   + librte_eal.so.10
     librte_efd.so.1
     librte_ethdev.so.11
     librte_eventdev.so.6
     librte_flow_classify.so.1
     librte_gro.so.1
     librte_gso.so.1
     librte_hash.so.2
     librte_ip_frag.so.1
     librte_jobstats.so.1
     librte_kni.so.2
     librte_kvargs.so.1
     librte_latencystats.so.1
     librte_lpm.so.2
     librte_mbuf.so.5
     librte_member.so.1
     librte_mempool.so.5
     librte_meter.so.2
     librte_metrics.so.1
     librte_net.so.1
     librte_pci.so.1
     librte_pdump.so.3
     librte_pipeline.so.3
     librte_pmd_bnxt.so.2
     librte_pmd_bond.so.2
     librte_pmd_i40e.so.2
     librte_pmd_ixgbe.so.2
     librte_pmd_dpaa2_qdma.so.1
     librte_pmd_ring.so.2
     librte_pmd_softnic.so.1
     librte_pmd_vhost.so.2
     librte_port.so.3
     librte_power.so.1
     librte_rawdev.so.1
     librte_reorder.so.1
     librte_ring.so.2
     librte_sched.so.2
     librte_security.so.2
     librte_table.so.3
     librte_timer.so.1
     librte_vhost.so.4


Known Issues
------------

.. This section should contain new known issues in this release. Sample format:

   * **Add title in present tense with full stop.**

     Add a short 1-2 sentence description of the known issue
     in the present tense. Add information on any known workarounds.

   This section is a comment. Do not overwrite or remove it.
   Also, make sure to start the actual text at the margin.
   =========================================================

* **No software AES-XTS implementation.**

  There are currently no cryptodev software PMDs available which implement
  support for the AES-XTS algorithm, so this feature can only be used
  if compatible hardware and an associated PMD is available.


Tested Platforms
----------------

.. This section should contain a list of platforms that were tested
   with this release.

   The format is:

   * <vendor> platform with <vendor> <type of devices> combinations

     * List of CPU
     * List of OS
     * List of devices
     * Other relevant details...

   This section is a comment. Do not overwrite or remove it.
   Also, make sure to start the actual text at the margin.
   =========================================================