doc: include fail-safe PMD in release notes
[dpdk.git] / doc / guides / rel_notes / release_17_08.rst
1 DPDK Release 17.08
2 ==================
3
4 .. **Read this first.**
5
6    The text in the sections 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:
11    ``LIKE_THIS``.
12
13    Build the docs and view the output file to ensure the changes are correct::
14
15       make doc-guides-html
16
17       xdg-open build/doc/html/guides/rel_notes/release_17_08.html
18
19
20 New Features
21 ------------
22
23 .. This section should contain new features added in this release. Sample
24    format:
25
26    * **Add a title in the past tense with a full stop.**
27
28      Add a short 1-2 sentence description in the past tense. The description
29      should be enough to allow someone scanning the release notes to
30      understand the new feature.
31
32      If the feature adds a lot of sub-features you can use a bullet list like
33      this:
34
35      * Added feature foo to do something.
36      * Enhanced feature bar to do something else.
37
38      Refer to the previous release notes for examples.
39
40      This section is a comment. do not overwrite or remove it.
41      Also, make sure to start the actual text at the margin.
42      =========================================================
43
44 * **Bumped minimal x86 ISA to SSE4.2.**
45
46   Starting with version 17.08, DPDK requires SSE4.2 to run on x86.
47   Previous versions required SSE3.
48
49 * **Added Service Core functionality.**
50
51   The service core functionality added to EAL allows DPDK to run services such
52   as SW PMDs on lcores without the application manually running them. The
53   service core infrastructure allows flexibility of running multiple services
54   on the same service lcore, and provides the application with powerful APIs to
55   configure the mapping from service lcores to services.
56
57 * **Added Generic Receive Offload API.**
58
59   Generic Receive Offload (GRO) API supports to reassemble TCP/IPv4
60   packets. GRO API assumes all inputted packets are with correct
61   checksums. GRO API doesn't update checksums for merged packets. If
62   inputted packets are IP fragmented, GRO API assumes they are complete
63   packets (i.e. with L4 headers).
64
65 * **Added Fail-Safe PMD**
66
67   Added the new Fail-Safe PMD. This virtual device allows applications to
68   support seamless hotplug of devices.
69   See the :doc:`/nics/fail_safe` guide for more details about this driver.
70
71 * **Added support for generic flow API (rte_flow) on igb NIC.**
72
73   This API provides a generic means to configure hardware to match specific
74   ingress or egress traffic, alter its behavior and query related counters
75   according to any number of user-defined rules.
76
77   * Generic flow API support for Ethernet, IPv4, UDP, TCP and
78     RAW pattern items with QUEUE actions. There are four
79     type of filter support for this feature on igb.
80
81 * **Added Generic Flow API support to enic.**
82
83   Flow API support for outer Ethernet, VLAN, IPv4, IPv6, UDP, TCP, SCTP, VxLAN
84   and inner Ethernet, VLAN, IPv4, IPv6, UDP and TCP pattern items with QUEUE,
85   MARK, FLAG and VOID actions for ingress traffic.
86
87 * **Added support for Chelsio T6 family of adapters**
88
89   CXGBE PMD updated to run Chelsio T6 family of adapters.
90
91 * **Added latency and performance improvements for cxgbe**
92
93   TX and RX path reworked to improve performance.  Also reduced latency
94   for slow traffic.
95
96 * **Updated bnxt PMD.**
97
98   Major enhancements include:
99   * Support MTU modification.
100   * Support LRO.
101   * Support VLAN filter and strip functionality.
102   * Other enhancements to add support for more dev_ops.
103   * Add PMD specific APIs mainly to control VF from PF.
104   * Update HWRM version to 1.7.7
105
106 * **Added support for Rx interrupts on mlx4 driver.**
107
108   Rx queues can be armed with an interrupt which will trigger on the
109   next packet arrival.
110
111 * **Updated mlx5 driver.**
112
113   Updated the mlx5 driver, include the following changes:
114
115   * Added vectorized Rx/Tx burst for x86.
116   * Added support for isolated mode from flow API.
117   * Re-worked flow drop action to implement in hardware classifier.
118   * Improved Rx interrupts management.
119
120 * **Updated szedata2 PMD.**
121
122   Added support for firmwares with multiple Ethernet ports per physical port.
123
124 * **Updated dpaa2 PMD.**
125
126   Major enhancements include:
127   * Support MAC Filter configuration
128   * Support Segmented Buffers
129   * Support VLAN filter and strip functionality.
130   * Other enhancements to add support for more dev_ops.
131   * Optimized the packet receive path
132
133 * **Reorganized the symmetric crypto operation structure.**
134
135   The crypto operation (``rte_crypto_sym_op``) has been reorganized as follows:
136
137   * Removed field ``rte_crypto_sym_op_sess_type``.
138   * Replaced pointer and physical address of IV with offset from the start
139     of the crypto operation.
140   * Moved length and offset of cipher IV to ``rte_crypto_cipher_xform``.
141   * Removed Additional Authentication Data (AAD) length.
142   * Removed digest length.
143   * Removed AAD pointer and physical address from ``auth`` structure.
144   * Added ``aead`` structure, containing parameters for AEAD algorithms.
145
146 * **Reorganized the crypto operation structure.**
147
148   The crypto operation (``rte_crypto_op``) has been reorganized as follows:
149
150   * Added field ``rte_crypto_op_sess_type``.
151   * Enumerations ``rte_crypto_op_status`` and ``rte_crypto_op_type``
152     have been modified to be uint8_t values.
153   * Removed the field ``opaque_data``.
154   * Pointer to ``rte_crypto_sym_op`` has been replaced with a zero length array.
155
156 * **Reorganized the crypto symmetric session structure.**
157
158   The crypto symmetric session structure (``rte_cryptodev_sym_session``) has
159   been reorganized as follows:
160
161   * ``dev_id`` field has been removed.
162   * ``driver_id`` field has been removed.
163   * Mempool pointer ``mp`` has been removed.
164   * Replaced ``private`` marker with array of pointers to private data sessions
165     ``sess_private_data``.
166
167 * **Updated cryptodev library.**
168
169   * Added AEAD algorithm specific functions and structures, so it is not
170     necessary to use a combination of cipher and authentication
171     structures anymore.
172   * Added helper functions for crypto device driver identification.
173   * Added support for multi-device sessions, so a single session can be
174     used in multiple drivers.
175   * Added functions to initialize and free individual driver private data
176     with a same session.
177
178 * **Updated dpaa2_sec crypto PMD.**
179
180   Added support for AES-GCM and AES-CTR
181
182 * **Updated the AESNI MB PMD.**
183
184   The AESNI MB PMD has been updated with additional support for:
185
186     * 12-byte IV on AES Counter Mode, apart from the previous 16-byte IV.
187
188 * **Updated the AES-NI GCM PMD.**
189
190   The AES-NI GCM PMD was migrated from the ISA-L library to the Multi Buffer
191   library, as the latter library has Scatter Gather List support
192   now. The migration entailed adding additional support for:
193
194   * 192-bit key.
195
196 * **Updated the Cryptodev Scheduler PMD.**
197
198   Added a multicore based distribution mode, which distributes the enqueued
199   crypto operations among several slaves, running on different logical cores.
200
201 * **Added NXP DPAA2 Eventdev PMD.**
202
203   Added the new dpaa2 eventdev driver for NXP DPAA2 devices. See the
204   "Event Device Drivers" document for more details on this new driver.
205
206 * **Added dpdk-test-eventdev test application.**
207
208   The dpdk-test-eventdev tool is a Data Plane Development Kit (DPDK) application
209   that allows exercising various eventdev use cases.
210   This application has a generic framework to add new eventdev based test cases
211   to verify functionality and measure the performance parameters of DPDK
212   eventdev devices.
213
214
215 Resolved Issues
216 ---------------
217
218 .. This section should contain bug fixes added to the relevant
219    sections. Sample format:
220
221    * **code/section Fixed issue in the past tense with a full stop.**
222
223      Add a short 1-2 sentence description of the resolved issue in the past
224      tense.
225
226      The title should contain the code/lib section like a commit message.
227
228      Add the entries in alphabetic order in the relevant sections below.
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
235 EAL
236 ~~~
237
238
239 Drivers
240 ~~~~~~~
241
242 Libraries
243 ~~~~~~~~~
244
245
246 Examples
247 ~~~~~~~~
248
249
250 Other
251 ~~~~~
252
253
254 Known Issues
255 ------------
256
257 .. This section should contain new known issues in this release. Sample format:
258
259    * **Add title in present tense with full stop.**
260
261      Add a short 1-2 sentence description of the known issue in the present
262      tense. Add information on any known workarounds.
263
264    This section is a comment. do not overwrite or remove it.
265    Also, make sure to start the actual text at the margin.
266    =========================================================
267
268 * **Starting with version 17.08, libnuma is required to build DPDK.**
269
270
271 API Changes
272 -----------
273
274 .. This section should contain API changes. Sample format:
275
276    * Add a short 1-2 sentence description of the API change. Use fixed width
277      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
278      tense.
279
280    This section is a comment. do not overwrite or remove it.
281    Also, make sure to start the actual text at the margin.
282    =========================================================
283
284 * **Modified the _rte_eth_dev_callback_process function in the ethdev library.**
285
286   The function ``_rte_eth_dev_callback_process()`` has been modified. The return
287   value has been changed from void to int and an extra parameter ``void *ret_param``
288   has been added.
289
290 * **Moved bypass functions from the rte_ethdev library to ixgbe PMD**
291
292   * The following rte_ethdev library functions were removed:
293
294     * ``rte_eth_dev_bypass_event_show``
295     * ``rte_eth_dev_bypass_event_store``
296     * ``rte_eth_dev_bypass_init``
297     * ``rte_eth_dev_bypass_state_set``
298     * ``rte_eth_dev_bypass_state_show``
299     * ``rte_eth_dev_bypass_ver_show``
300     * ``rte_eth_dev_bypass_wd_reset``
301     * ``rte_eth_dev_bypass_wd_timeout_show``
302     * ``rte_eth_dev_wd_timeout_store``
303
304   * The following ixgbe PMD functions were added:
305
306     * ``rte_pmd_ixgbe_bypass_event_show``
307     * ``rte_pmd_ixgbe_bypass_event_store``
308     * ``rte_pmd_ixgbe_bypass_init``
309     * ``rte_pmd_ixgbe_bypass_state_set``
310     * ``rte_pmd_ixgbe_bypass_state_show``
311     * ``rte_pmd_ixgbe_bypass_ver_show``
312     * ``rte_pmd_ixgbe_bypass_wd_reset``
313     * ``rte_pmd_ixgbe_bypass_wd_timeout_show``
314     * ``rte_pmd_ixgbe_bypass_wd_timeout_store``
315
316 * **Reworked rte_cryptodev library.**
317
318   The rte_cryptodev library has been reworked and updated. The following changes
319   have been made to it:
320
321   * The crypto device type enumeration has been removed from cryptodev library.
322   * The function ``rte_crypto_count_devtype()`` has been removed, and replaced
323     by the new function ``rte_crypto_count_by_driver()``.
324   * Moved crypto device driver names definitions to the particular PMDs.
325     These names are not public anymore.
326   * ``rte_cryptodev_configure()`` does not create the session mempool
327     for the device anymore.
328   * ``rte_cryptodev_queue_pair_attach_sym_session()`` and
329     ``rte_cryptodev_queue_pair_dettach_sym_session()`` functions require
330     the new parameter ``device id``.
331   * Modified parameters of ``rte_cryptodev_sym_session_create()``, to accept
332     ``mempool``, instead of ``device id`` and ``rte_crypto_sym_xform``.
333   * Remove ``device id`` parameter from ``rte_cryptodev_sym_session_free()``.
334   * Added new field ``session_pool`` to ``rte_cryptodev_queue_pair_setup()``.
335   * Removed ``aad_size`` parameter from ``rte_cryptodev_sym_capability_check_auth()``.
336   * Added ``iv_size`` parameter to ``rte_cryptodev_sym_capability_check_auth()``.
337   * Removed ``RTE_CRYPTO_OP_STATUS_ENQUEUED`` from enum ``rte_crypto_op_status``.
338
339
340 ABI Changes
341 -----------
342
343 .. This section should contain ABI changes. Sample format:
344
345    * Add a short 1-2 sentence description of the ABI change that was announced
346      in the previous releases and made in this release. Use fixed width quotes
347      for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
348
349    This section is a comment. do not overwrite or remove it.
350    Also, make sure to start the actual text at the margin.
351    =========================================================
352
353 * **Reorganized the crypto operation structures.**
354
355   Some fields have been modified in the ``rte_crypto_op`` and ``rte_crypto_sym_op``
356   structures, as described in the `New Features`_ section.
357
358 * **Reorganized the crypto symmetric session structure.**
359
360   Some fields have been modified in the ``rte_cryptodev_sym_session``
361   structure, as described in the `New Features`_ section.
362
363 * **Reorganized the ``rte_crypto_sym_cipher_xform`` structure.**
364
365   * Added cipher IV length and offset parameters.
366   * Changed field size of key length from size_t to uint16_t.
367
368 * **Reorganized the ``rte_crypto_sym_auth_xform`` structure.**
369
370   * Added authentication IV length and offset parameters.
371   * Changed field size of AAD length from uint32_t to uint16_t.
372   * Changed field size of digest length from uint32_t to uint16_t.
373   * Removed AAD length.
374   * Changed field size of key length from size_t to uint16_t.
375
376 * Replaced ``dev_type`` enumeration with uint8_t ``driver_id`` in
377   ``rte_cryptodev_info`` and  ``rte_cryptodev`` structures.
378
379 * Removed ``session_mp`` from ``rte_cryptodev_config``.
380
381
382 Shared Library Versions
383 -----------------------
384
385 .. Update any library version updated in this release and prepend with a ``+``
386    sign, like this:
387
388      librte_acl.so.2
389    + librte_cfgfile.so.2
390      librte_cmdline.so.2
391
392    This section is a comment. do not overwrite or remove it.
393    =========================================================
394
395
396 The libraries prepended with a plus sign were incremented in this version.
397
398 .. code-block:: diff
399
400      librte_acl.so.2
401      librte_bitratestats.so.1
402      librte_cfgfile.so.2
403      librte_cmdline.so.2
404    + librte_cryptodev.so.3
405      librte_distributor.so.1
406      librte_eal.so.4
407    + librte_ethdev.so.7
408    + librte_gro.so.1
409      librte_hash.so.2
410      librte_ip_frag.so.1
411      librte_jobstats.so.1
412      librte_kni.so.2
413      librte_kvargs.so.1
414      librte_latencystats.so.1
415      librte_lpm.so.2
416      librte_mbuf.so.3
417      librte_mempool.so.2
418      librte_meter.so.1
419      librte_metrics.so.1
420      librte_net.so.1
421      librte_pdump.so.1
422      librte_pipeline.so.3
423      librte_pmd_bond.so.1
424      librte_pmd_ring.so.2
425      librte_port.so.3
426      librte_power.so.1
427      librte_reorder.so.1
428      librte_ring.so.1
429      librte_sched.so.1
430      librte_table.so.2
431      librte_timer.so.1
432      librte_vhost.so.3
433
434
435 Tested Platforms
436 ----------------
437
438 .. This section should contain a list of platforms that were tested with this
439    release.
440
441    The format is:
442
443    * <vendor> platform with <vendor> <type of devices> combinations
444
445      * List of CPU
446      * List of OS
447      * List of devices
448      * Other relevant details...
449
450    This section is a comment. do not overwrite or remove it.
451    Also, make sure to start the actual text at the margin.
452    =========================================================
453
454 * Intel(R) platforms with Mellanox(R) NICs combinations
455
456    * Platform details:
457
458      * Intel(R) Xeon(R) CPU E5-2697A v4 @ 2.60GHz
459      * Intel(R) Xeon(R) CPU E5-2697 v3 @ 2.60GHz
460      * Intel(R) Xeon(R) CPU E5-2680 v2 @ 2.80GHz
461      * Intel(R) Xeon(R) CPU E5-2640 @ 2.50GHz
462
463    * OS:
464
465      * Red Hat Enterprise Linux Server release 7.3 (Maipo)
466      * Red Hat Enterprise Linux Server release 7.2 (Maipo)
467      * Ubuntu 16.10
468      * Ubuntu 16.04
469      * Ubuntu 14.04
470
471    * MLNX_OFED: 4.1-1.0.2.0
472
473    * NICs:
474
475      * Mellanox(R) ConnectX(R)-3 Pro 40G MCX354A-FCC_Ax (2x40G)
476
477        * Host interface: PCI Express 3.0 x8
478        * Device ID: 15b3:1007
479        * Firmware version: 2.40.5030
480
481      * Mellanox(R) ConnectX(R)-4 10G MCX4111A-XCAT (1x10G)
482
483        * Host interface: PCI Express 3.0 x8
484        * Device ID: 15b3:1013
485        * Firmware version: 12.18.2000
486
487      * Mellanox(R) ConnectX(R)-4 10G MCX4121A-XCAT (2x10G)
488
489        * Host interface: PCI Express 3.0 x8
490        * Device ID: 15b3:1013
491        * Firmware version: 12.18.2000
492
493      * Mellanox(R) ConnectX(R)-4 25G MCX4111A-ACAT (1x25G)
494
495        * Host interface: PCI Express 3.0 x8
496        * Device ID: 15b3:1013
497        * Firmware version: 12.18.2000
498
499      * Mellanox(R) ConnectX(R)-4 25G MCX4121A-ACAT (2x25G)
500
501        * Host interface: PCI Express 3.0 x8
502        * Device ID: 15b3:1013
503        * Firmware version: 12.18.2000
504
505      * Mellanox(R) ConnectX(R)-4 40G MCX4131A-BCAT/MCX413A-BCAT (1x40G)
506
507        * Host interface: PCI Express 3.0 x8
508        * Device ID: 15b3:1013
509        * Firmware version: 12.18.2000
510
511      * Mellanox(R) ConnectX(R)-4 40G MCX415A-BCAT (1x40G)
512
513        * Host interface: PCI Express 3.0 x16
514        * Device ID: 15b3:1013
515        * Firmware version: 12.18.2000
516
517      * Mellanox(R) ConnectX(R)-4 50G MCX4131A-GCAT/MCX413A-GCAT (1x50G)
518
519        * Host interface: PCI Express 3.0 x8
520        * Device ID: 15b3:1013
521        * Firmware version: 12.18.2000
522
523      * Mellanox(R) ConnectX(R)-4 50G MCX414A-BCAT (2x50G)
524
525        * Host interface: PCI Express 3.0 x8
526        * Device ID: 15b3:1013
527        * Firmware version: 12.18.2000
528
529      * Mellanox(R) ConnectX(R)-4 50G MCX415A-GCAT/MCX416A-BCAT/MCX416A-GCAT (2x50G)
530
531        * Host interface: PCI Express 3.0 x16
532        * Device ID: 15b3:1013
533        * Firmware version: 12.18.2000
534
535      * Mellanox(R) ConnectX(R)-4 50G MCX415A-CCAT (1x100G)
536
537        * Host interface: PCI Express 3.0 x16
538        * Device ID: 15b3:1013
539        * Firmware version: 12.18.2000
540
541      * Mellanox(R) ConnectX(R)-4 100G MCX416A-CCAT (2x100G)
542
543        * Host interface: PCI Express 3.0 x16
544        * Device ID: 15b3:1013
545        * Firmware version: 12.18.2000
546
547      * Mellanox(R) ConnectX(R)-4 Lx 10G MCX4121A-XCAT (2x10G)
548
549        * Host interface: PCI Express 3.0 x8
550        * Device ID: 15b3:1015
551        * Firmware version: 14.18.2000
552
553      * Mellanox(R) ConnectX(R)-4 Lx 25G MCX4121A-ACAT (2x25G)
554
555        * Host interface: PCI Express 3.0 x8
556        * Device ID: 15b3:1015
557        * Firmware version: 14.18.2000
558
559      * Mellanox(R) ConnectX(R)-5 100G MCX556A-ECAT (2x100G)
560
561        * Host interface: PCI Express 3.0 x16
562        * Device ID: 15b3:1017
563        * Firmware version: 16.19.1200
564
565      * Mellanox(R) ConnectX-5 Ex EN 100G MCX516A-CDAT (2x100G)
566
567        * Host interface: PCI Express 4.0 x16
568        * Device ID: 15b3:1019
569        * Firmware version: 16.19.1200
570
571 * Intel(R) platforms with Intel(R) NICs combinations
572
573    * CPU
574
575      * Intel(R) Atom(TM) CPU C2758 @ 2.40GHz
576      * Intel(R) Xeon(R) CPU D-1540 @ 2.00GHz
577      * Intel(R) Xeon(R) CPU D-1541 @ 2.10GHz
578      * Intel(R) Xeon(R) CPU E5-4667 v3 @ 2.00GHz
579      * Intel(R) Xeon(R) CPU E5-2680 v2 @ 2.80GHz
580      * Intel(R) Xeon(R) CPU E5-2699 v3 @ 2.30GHz
581      * Intel(R) Xeon(R) CPU E5-2695 v4 @ 2.10GHz
582      * Intel(R) Xeon(R) CPU E5-2658 v2 @ 2.40GHz
583      * Intel(R) Xeon(R) CPU E5-2658 v3 @ 2.20GHz
584
585    * OS:
586
587      * CentOS 7.2
588      * Fedora 25
589      * FreeBSD 11
590      * Red Hat Enterprise Linux Server release 7.3
591      * SUSE Enterprise Linux 12
592      * Wind River Linux 8
593      * Ubuntu 16.04
594      * Ubuntu 16.10
595
596    * NICs:
597
598      * Intel(R) 82599ES 10 Gigabit Ethernet Controller
599
600        * Firmware version: 0x61bf0001
601        * Device id (pf/vf): 8086:10fb / 8086:10ed
602        * Driver version: 4.0.1-k (ixgbe)
603
604      * Intel(R) Corporation Ethernet Connection X552/X557-AT 10GBASE-T
605
606        * Firmware version: 0x800001cf
607        * Device id (pf/vf): 8086:15ad / 8086:15a8
608        * Driver version: 4.2.5 (ixgbe)
609
610      * Intel(R) Ethernet Converged Network Adapter X710-DA4 (4x10G)
611
612        * Firmware version: 6.01 0x80003205
613        * Device id (pf/vf): 8086:1572 / 8086:154c
614        * Driver version: 2.0.19 (i40e)
615
616      * Intel(R) Ethernet Converged Network Adapter X710-DA2 (2x10G)
617
618        * Firmware version: 6.01 0x80003204
619        * Device id (pf/vf): 8086:1572 / 8086:154c
620        * Driver version: 2.0.19 (i40e)
621
622      * Intel(R) Ethernet Converged Network Adapter XXV710-DA2 (2x25G)
623
624        * Firmware version: 6.01 0x80003221
625        * Device id (pf/vf): 8086:158b
626        * Driver version: 2.0.19 (i40e)
627
628      * Intel(R) Ethernet Converged Network Adapter XL710-QDA2 (2X40G)
629
630        * Firmware version: 6.01 0x8000321c
631        * Device id (pf/vf): 8086:1583 / 8086:154c
632        * Driver version: 2.0.19 (i40e)
633
634      * Intel(R) Corporation I350 Gigabit Network Connection
635
636        * Firmware version: 1.48, 0x800006e7
637        * Device id (pf/vf): 8086:1521 / 8086:1520
638        * Driver version: 5.2.13-k (igb)
639