aboutsummaryrefslogtreecommitdiffstats
path: root/doc/guides/rel_notes/release_17_11.rst
blob: fad7a7eb20dabb9fd3db2a88e8e4232eb27ce4d2 (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
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
DPDK Release 17.11
==================

.. **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_17_11.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.

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

* **Extended port_id range from uint8_t to uint16_t.**

  Increased the ``port_id`` range from 8 bits to 16 bits in order to support
  more than 256 ports in DPDK. All ethdev APIs which have ``port_id`` as
  parameter have been changed.

* **Modified the return type of rte_eth_stats_reset.**

  Changed return type of ``rte_eth_stats_reset`` from ``void`` to ``int`` so
  that the caller can determine whether a device supports the operation or not
  and if the operation was carried out.

* **Added a new driver for Marvell Armada 7k/8k devices.**

  Added the new ``mrvl`` net driver for Marvell Armada 7k/8k devices. See the
  :doc:`../nics/mrvl` NIC guide for more details on this new driver.

* **Updated mlx4 driver.**

  Updated the mlx4 driver including the following changes:

   * Isolated mode (rte_flow) can now be enabled anytime, not only during
     initial device configuration.
   * Flow rules now support up to 4096 priority levels usable at will by
     applications.
   * Enhanced error message to help debugging invalid/unsupported flow rules.
   * Flow rules matching all multicast and promiscuous traffic are now allowed.
   * No more software restrictions on flow rules with the RSS action, their
     configuration is much more flexible.
   * Significantly reduced memory footprint for Rx and Tx queue objects.
   * While supported, UDP RSS is temporarily disabled due to a remaining issue
     with its support in the Linux kernel.
   * The new RSS implementation does not automatically spread traffic according
     to the inner packet of VXLAN frames anymore, only the outer one (like
     other PMDs).
   * Partial (Tx only) support for secondary processes was broken and had to be
     removed.
   * Refactored driver to get rid of dependency on the components provided by
     Mellanox OFED and instead rely on the current and public rdma-core
     package and Linux version from now on.
   * Removed compile-time limitation on number of device instances the PMD
     can support.

* **Updated mlx5 driver.**

  Updated the mlx5 driver including the following changes:

   * Enabled the PMD to run on top of upstream Linux kernel and rdma-core
     libs, removing the dependency on specific Mellanox OFED libraries.
   * Improved PMD latency performance.
   * Improved PMD memory footprint.
   * Added support for vectorized Rx/Tx burst for ARMv8.
   * Added support for secondary process.
   * Added support for flow counters.
   * Added support for Rx hardware timestamp offload.
   * Added support for device removal event.

* **Added SoftNIC PMD.**

  Added a new SoftNIC PMD. This virtual device provides applications with
  software fallback support for traffic management.

* **Added support for NXP DPAA Devices.**

  Added support for NXP's DPAA devices - LS104x series. This includes:

  * DPAA Bus driver
  * DPAA Mempool driver for supporting offloaded packet memory pool
  * DPAA PMD for DPAA devices

  See the :doc:`../nics/dpaa` document for more details of this new driver.

* **Updated support for Cavium OCTEONTX Device.**

  Updated support for Cavium's OCTEONTX device (CN83xx). This includes:

  * OCTEONTX Mempool driver for supporting offloaded packet memory pool
  * OCTEONTX Ethdev PMD
  * OCTEONTX Eventdev-Ethdev Rx adapter

  See the :doc:`../nics/octeontx` document for more details of this new driver.

* **Added PF support to the Netronome NFP PMD.**

  Added PF support to the Netronome NFP PMD. Previously the NFP PMD only
  supported VFs. PF support is just as a basic DPDK port and has no VF
  management yet.

  PF support comes with firmware upload support which allows the PMD to
  independently work from kernel netdev NFP drivers.

  NFP 4000 devices are also now supported along with previous 6000 devices.

* **Updated bnxt PMD.**

  Major enhancements include:

   * Support for Flow API
   * Support for Tx and Rx descriptor status functions

* **Added bus agnostic functions to cryptodev for PMD initialization**

  Added new PMD assist, bus independent, functions
  ``rte_cryptodev_pmd_parse_input_args()``, ``rte_cryptodev_pmd_create()`` and
  ``rte_cryptodev_pmd_destroy()`` for drivers to manage creation and
  destruction of new device instances.

* **Updated QAT crypto PMD.**

  Added several performance enhancements:

  * Removed atomics from the internal queue pair structure.
  * Added coalesce writes to HEAD CSR on response processing.
  * Added coalesce writes to TAIL CSR on request processing.

  In addition support was added for the AES CCM algorithm.

* **Updated the AESNI MB PMD.**

  The AESNI MB PMD has been updated with additional support for:

  * The DES CBC algorithm.
  * The DES DOCSIS BPI algorithm.

  This change requires version 0.47 of the IPSec Multi-buffer library. For
  more details see the :doc:`../cryptodevs/aesni_mb` documentation.

* **Updated the OpenSSL PMD.**

  The OpenSSL PMD has been updated with additional support for:

  * The DES CBC algorithm.
  * The AES CCM algorithm.

* **Added NXP DPAA SEC crypto PMD.**

  A new ``dpaa_sec`` hardware based crypto PMD for NXP DPAA devices has been
  added. See the :doc:`../cryptodevs/dpaa_sec` document for more details.

* **Added MRVL crypto PMD.**

  A new crypto PMD has been added, which provides several ciphering and hashing
  algorithms. All cryptography operations use the MUSDK library crypto API.
  See the :doc:`../cryptodevs/mrvl` document for more details.

* **Add new benchmarking mode to dpdk-test-crypto-perf application.**

  Added a new "PMD cyclecount" benchmark mode to the ``dpdk-test-crypto-perf``
  application to display a detailed breakdown of CPU cycles used by hardware
  acceleration.

* **Added the Security Offload Library.**

  Added an experimental library - ``rte_security``. This provide security APIs
  for protocols like IPSec using inline ipsec offload to ethernet devices or
  full protocol offload with lookaside crypto devices.

  See the :doc:`../prog_guide/rte_security` section of the DPDK Programmers
  Guide document for more information.

* **Updated the DPAA2_SEC crypto driver to support rte_security.**

  Updated the ``dpaa2_sec`` crypto PMD to support ``rte_security`` lookaside
  protocol offload for IPSec.

* **Updated the IXGBE ethernet driver to support rte_security.**

  Updated ixgbe ethernet PMD to support ``rte_security`` inline IPSec offload.

* **Updated ipsec-secgw application to support rte_security.**

  Updated the ``ipsec-secgw`` sample application to support ``rte_security``
  actions for ipsec inline and full protocol offload using lookaside crypto
  offload.

* **Added IOMMU support to libvhost-user**

  Implemented device IOTLB in the Vhost-user backend, and enabled Virtio's
  IOMMU feature. The feature is disabled by default, and can be enabled by
  setting ``RTE_VHOST_USER_IOMMU_SUPPORT`` flag at vhost device registration
  time.

* **Added the Event Ethernet Adapter Library.**

  Added the Event Ethernet Adapter library. This library provides APIs for
  eventdev applications to configure the ethdev for eventdev packet flow.

* **Updated DPAA2 Event PMD for the Event Ethernet Adapter.**

  Added support for the eventdev ethernet adapter for DPAA2.

* **Added Membership library (rte_member).**

  Added a new data structure library called the Membership Library.

  The Membership Library is an extension and generalization of a traditional
  filter (for example Bloom Filter) structure that has multiple usages in a
  wide variety of workloads and applications. In general, the Membership
  Library is a data structure that provides a "set-summary" and responds to
  set-membership queries whether a certain member belongs to a set(s).

  The library provides APIs for DPDK applications to insert a new member,
  delete an existing member, and query the existence of a member in a given
  set, or a group of sets. For the case of a group of sets the library will
  return not only whether the element has been inserted in one of the sets but
  also which set it belongs to.

  See the :doc:`../prog_guide/member_lib` documentation in the Programmers
  Guide, for more information.

* **Added the Generic Segmentation Offload Library.**

  Added the Generic Segmentation Offload (GSO) library to enable
  applications to split large packets (e.g. MTU is 64KB) into small
  ones (e.g. MTU is 1500B). Supported packet types are:

  * TCP/IPv4 packets.
  * VxLAN packets, which must have an outer IPv4 header, and contain
    an inner TCP/IPv4 packet.
  * GRE packets, which must contain an outer IPv4 header, and inner
    TCP/IPv4 headers.

  The GSO library doesn't check if the input packets have correct
  checksums, and doesn't update checksums for output packets.
  Additionally, the GSO library doesn't process IP fragmented packets.

* **Added the Flow Classification Library.**

  Added an experimental Flow Classification library to provide APIs for DPDK
  applications to classify an input packet by matching it against a set of
  flow rules. It uses the ``librte_table`` API to manage the flow rules.


Resolved Issues
---------------

.. This section should contain bug fixes added to the relevant
   sections. Sample format:

   * **code/section Fixed issue in the past tense with a full stop.**

     Add a short 1-2 sentence description of the resolved issue in the past
     tense.

     The title should contain the code/lib section like a commit message.

     Add the entries in alphabetic order in the relevant sections below.

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


* **Service core fails to call service callback due to atomic lock**

  In a specific configuration of multi-thread unsafe services and service
  cores, a service core previously did not correctly release the atomic lock
  on the service. This would result in the cores polling the service, but it
  looked like another thread was executing the service callback. The logic for
  atomic locking of the services has been fixed and refactored for readability.


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

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

   * Add a short 1-2 sentence description of the API change. Use fixed width
     quotes for ``rte_function_names`` or ``rte_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.
   =========================================================

* **Ethdev device name length increased.**

  The size of internal device name has been increased to 64 characters
  to allow for storing longer bus specific names.

* **Removed the Ethdev RTE_ETH_DEV_DETACHABLE flag.**

  Removed the Ethdev ``RTE_ETH_DEV_DETACHABLE`` flag. This flag is not
  required anymore, with the new hotplug implementation. It has been removed
  from the ether library. Its semantics are now expressed at the bus and PMD
  level.

* **Service cores API updated for usability**

  The service cores API has been changed, removing pointers from the API where
  possible, and instead using integer IDs to identify each service. This
  simplifies application code, aids debugging, and provides better
  encapsulation. A summary of the main changes made is as follows:

  * Services identified by ID not by ``rte_service_spec`` pointer
  * Reduced API surface by using ``set`` functions instead of enable/disable
  * Reworked ``rte_service_register`` to provide the service ID to registrar
  * Reworked start and stop APIs into ``rte_service_runstate_set``
  * Added API to set runstate of service implementation to indicate readiness

* **The following changes have been made in the mempool library**

  * Moved ``flags`` datatype from ``int`` to ``unsigned int`` for
    ``rte_mempool``.
  * Removed ``__rte_unused int flag`` param from ``rte_mempool_generic_put``
    and ``rte_mempool_generic_get`` API.
  * Added ``flags`` param in ``rte_mempool_xmem_size`` and
    ``rte_mempool_xmem_usage``.
  * ``rte_mem_phy2mch`` was used in Xen dom0 to obtain the physical address;
    remove this API as Xen dom0 support was removed.

* **Added IOVA aliases related to physical address handling.**

  Some data types, structure members and functions related to physical address
  handling are deprecated and have new aliases with IOVA wording. For example:

  * ``phys_addr_t`` can be often replaced by ``rte_iova_t`` of same size.
  * ``RTE_BAD_PHYS_ADDR`` is often replaced by ``RTE_BAD_IOVA`` of same value.
  * ``rte_memseg.phys_addr`` is aliased with ``rte_memseg.iova_addr``.
  * ``rte_mem_virt2phy()`` can often be replaced by ``rte_mem_virt2iova``.
  * ``rte_malloc_virt2phy`` is aliased with ``rte_malloc_virt2iova``.
  * ``rte_memzone.phys_addr`` is aliased with ``rte_memzone.iova``.
  * ``rte_mempool_objhdr.physaddr`` is aliased with
    ``rte_mempool_objhdr.iova``.
  * ``rte_mempool_memhdr.phys_addr`` is aliased with
    ``rte_mempool_memhdr.iova``.
  * ``rte_mempool_virt2phy()`` can be replaced by ``rte_mempool_virt2iova()``.
  * ``rte_mempool_populate_phys*()`` are aliased with
    ``rte_mempool_populate_iova*()``
  * ``rte_mbuf.buf_physaddr`` is aliased with ``rte_mbuf.buf_iova``.
  * ``rte_mbuf_data_dma_addr*()`` are aliased with ``rte_mbuf_data_iova*()``.
  * ``rte_pktmbuf_mtophys*`` are aliased with ``rte_pktmbuf_iova*()``.

* **PCI bus API moved outside of the EAL**

  The PCI bus previously implemented within the EAL has been moved.
  A first part has been added as an RTE library providing PCI helpers to
  parse device locations or other such utilities.
  A second part consisting of the actual bus driver has been moved to its
  proper subdirectory, without changing its functionalities.

  As such, several PCI-related functions are not exposed by the EAL anymore:

  * ``rte_pci_detach``
  * ``rte_pci_dump``
  * ``rte_pci_ioport_map``
  * ``rte_pci_ioport_read``
  * ``rte_pci_ioport_unmap``
  * ``rte_pci_ioport_write``
  * ``rte_pci_map_device``
  * ``rte_pci_probe``
  * ``rte_pci_probe_one``
  * ``rte_pci_read_config``
  * ``rte_pci_register``
  * ``rte_pci_scan``
  * ``rte_pci_unmap_device``
  * ``rte_pci_unregister``
  * ``rte_pci_write_config``

  These functions are made available either as part of ``librte_pci`` or
  ``librte_bus_pci``.

* **Moved vdev bus APIs outside of the EAL**

  Moved the following APIs from ``librte_eal`` to ``librte_bus_vdev``:

  * ``rte_vdev_init``
  * ``rte_vdev_register``
  * ``rte_vdev_uninit``
  * ``rte_vdev_unregister``

* **Add return value to stats_get dev op API**

  The ``stats_get`` dev op API return value has been changed to be int.
  In this way PMDs can return an error value in case of failure at stats
  getting process time.

* **Modified the rte_cryptodev_allocate_driver function.**

  Modified the ``rte_cryptodev_allocate_driver()`` function in the cryptodev
  library. An extra parameter ``struct cryptodev_driver *crypto_drv`` has been
  added.

* **Removed virtual device bus specific functions from librte_cryptodev.**

  The functions ``rte_cryptodev_vdev_parse_init_params()`` and
  ``rte_cryptodev_vdev_pmd_init()`` have been removed from librte_cryptodev
  and have been replaced by non bus specific functions
  ``rte_cryptodev_pmd_parse_input_args()`` and ``rte_cryptodev_pmd_create()``.

  The ``rte_cryptodev_create_vdev()`` function was removed to avoid the
  dependency on vdev in librte_cryptodev; instead, users can call
  ``rte_vdev_init()`` directly.

* **Removed PCI device bus specific functions from librte_cryptodev.**

  The functions ``rte_cryptodev_pci_generic_probe()`` and
  ``rte_cryptodev_pci_generic_remove()`` have been removed from librte_cryptodev
  and have been replaced by non bus specific functions
  ``rte_cryptodev_pmd_create()`` and ``rte_cryptodev_pmd_destroy()``.

* **Removed deprecated functions to manage log level or type.**

  The functions ``rte_set_log_level()``, ``rte_get_log_level()``,
  ``rte_set_log_type()`` and ``rte_get_log_type()`` have been removed.

  They are respectively replaced by ``rte_log_set_global_level()``,
  ``rte_log_get_global_level()``, ``rte_log_set_level()`` and
  ``rte_log_get_level()``.

* **Removed mbuf flags PKT_RX_VLAN_PKT and PKT_RX_QINQ_PKT.**

  The ``mbuf`` flags ``PKT_RX_VLAN_PKT`` and ``PKT_RX_QINQ_PKT`` have
  been removed since their behavior was not properly described.

* **Added mbuf flags PKT_RX_VLAN and PKT_RX_QINQ.**

  Two ``mbuf`` flags have been added to indicate that the VLAN
  identifier has been saved in in the ``mbuf`` structure. For instance:

  - If VLAN is not stripped and TCI is saved: ``PKT_RX_VLAN``
  - If VLAN is stripped and TCI is saved: ``PKT_RX_VLAN | PKT_RX_VLAN_STRIPPED``

* **Modified the vlan_offload_set_t function prototype in the ethdev library.**

  Modified the ``vlan_offload_set_t`` function prototype in the ethdev
  library.  The return value has been changed from ``void`` to ``int`` so the
  caller can determine whether the backing device supports the operation or if
  the operation was successfully performed.


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

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

   * Add a short 1-2 sentence description of the ABI change that was announced
     in the previous releases and made in this release. Use fixed width quotes
     for ``rte_function_names`` or ``rte_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.
   =========================================================

* **Extended port_id range.**

  The size of the field ``port_id`` in the ``rte_eth_dev_data`` structure
  has changed, as described in the `New Features` section above.

* **New parameter added to rte_eth_dev.**

  A new parameter ``security_ctx`` has been added to ``rte_eth_dev`` to
  support security operations like IPSec inline.

* **New parameter added to rte_cryptodev.**

  A new parameter ``security_ctx`` has been added to ``rte_cryptodev`` to
  support security operations like lookaside crypto.


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.
   =========================================================

* Xen dom0 in EAL has been removed, as well as the xenvirt PMD and vhost_xen.

* The crypto performance unit tests have been removed,
  replaced by the ``dpdk-test-crypto-perf`` application.


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

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

     librte_acl.so.2
   + librte_cfgfile.so.2
     librte_cmdline.so.2

   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_bitratestats.so.2
   + librte_bus_dpaa.so.1
   + librte_bus_fslmc.so.1
   + librte_bus_pci.so.1
   + librte_bus_vdev.so.1
     librte_cfgfile.so.2
     librte_cmdline.so.2
   + librte_cryptodev.so.4
     librte_distributor.so.1
   + librte_eal.so.6
   + librte_ethdev.so.8
   + librte_eventdev.so.3
   + 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.3
   + librte_mempool.so.3
     librte_meter.so.1
     librte_metrics.so.1
     librte_net.so.1
   + librte_pci.so.1
   + librte_pdump.so.2
     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_ring.so.2
   + librte_pmd_softnic.so.1
   + librte_pmd_vhost.so.2
     librte_port.so.3
     librte_power.so.1
     librte_reorder.so.1
     librte_ring.so.1
     librte_sched.so.1
   + librte_security.so.1
   + librte_table.so.3
     librte_timer.so.1
     librte_vhost.so.3


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.
   =========================================================

* Intel(R) platforms with Intel(R) NICs combinations

   * CPU

     * Intel(R) Atom(TM) CPU C2758 @ 2.40GHz
     * Intel(R) Xeon(R) CPU D-1540 @ 2.00GHz
     * Intel(R) Xeon(R) CPU D-1541 @ 2.10GHz
     * Intel(R) Xeon(R) CPU E5-4667 v3 @ 2.00GHz
     * Intel(R) Xeon(R) CPU E5-2680 v2 @ 2.80GHz
     * Intel(R) Xeon(R) CPU E5-2699 v3 @ 2.30GHz
     * Intel(R) Xeon(R) CPU E5-2695 v4 @ 2.10GHz
     * Intel(R) Xeon(R) CPU E5-2658 v2 @ 2.40GHz
     * Intel(R) Xeon(R) CPU E5-2658 v3 @ 2.20GHz

   * OS:

     * CentOS 7.2
     * Fedora 25
     * Fedora 26
     * FreeBSD 11
     * Red Hat Enterprise Linux Server release 7.3
     * SUSE Enterprise Linux 12
     * Wind River Linux 8
     * Ubuntu 16.04
     * Ubuntu 16.10

   * NICs:

     * Intel(R) 82599ES 10 Gigabit Ethernet Controller

       * Firmware version: 0x61bf0001
       * Device id (pf/vf): 8086:10fb / 8086:10ed
       * Driver version: 5.2.3 (ixgbe)

     * Intel(R) Corporation Ethernet Connection X552/X557-AT 10GBASE-T

       * Firmware version: 0x800003e7
       * Device id (pf/vf): 8086:15ad / 8086:15a8
       * Driver version: 4.4.6 (ixgbe)

     * Intel(R) Ethernet Converged Network Adapter X710-DA4 (4x10G)

       * Firmware version: 6.01 0x80003205
       * Device id (pf/vf): 8086:1572 / 8086:154c
       * Driver version: 2.1.26 (i40e)

     * Intel(R) Ethernet Converged Network Adapter X710-DA2 (2x10G)

       * Firmware version: 6.01 0x80003204
       * Device id (pf/vf): 8086:1572 / 8086:154c
       * Driver version: 2.1.26 (i40e)

     * Intel(R) Ethernet Converged Network Adapter XXV710-DA2 (2x25G)

       * Firmware version: 6.01 0x80003221
       * Device id (pf/vf): 8086:158b
       * Driver version: 2.1.26 (i40e)

     * Intel(R) Ethernet Converged Network Adapter XL710-QDA2 (2X40G)

       * Firmware version: 6.01 0x8000321c
       * Device id (pf/vf): 8086:1583 / 8086:154c
       * Driver version: 2.1.26 (i40e)

     * Intel(R) Corporation I350 Gigabit Network Connection

       * Firmware version: 1.63, 0x80000dda
       * Device id (pf/vf): 8086:1521 / 8086:1520
       * Driver version: 5.3.0-k (igb)

* Intel(R) platforms with Mellanox(R) NICs combinations

   * Platform details:

     * Intel(R) Xeon(R) CPU E5-2697A v4 @ 2.60GHz
     * Intel(R) Xeon(R) CPU E5-2697 v3 @ 2.60GHz
     * Intel(R) Xeon(R) CPU E5-2680 v2 @ 2.80GHz
     * Intel(R) Xeon(R) CPU E5-2650 v4 @ 2.20GHz
     * Intel(R) Xeon(R) CPU E5-2640 @ 2.50GHz
     * Intel(R) Xeon(R) CPU E5-2620 v4 @ 2.10GHz

   * OS:

     * Red Hat Enterprise Linux Server release 7.3 (Maipo)
     * Red Hat Enterprise Linux Server release 7.2 (Maipo)
     * Ubuntu 16.10
     * Ubuntu 16.04
     * Ubuntu 14.04

   * MLNX_OFED: 4.2-1.0.0.0

   * NICs:

     * Mellanox(R) ConnectX(R)-3 Pro 40G MCX354A-FCC_Ax (2x40G)

       * Host interface: PCI Express 3.0 x8
       * Device ID: 15b3:1007
       * Firmware version: 2.42.5000

     * Mellanox(R) ConnectX(R)-4 10G MCX4111A-XCAT (1x10G)

       * Host interface: PCI Express 3.0 x8
       * Device ID: 15b3:1013
       * Firmware version: 12.21.1000

     * Mellanox(R) ConnectX(R)-4 10G MCX4121A-XCAT (2x10G)

       * Host interface: PCI Express 3.0 x8
       * Device ID: 15b3:1013
       * Firmware version: 12.21.1000

     * Mellanox(R) ConnectX(R)-4 25G MCX4111A-ACAT (1x25G)

       * Host interface: PCI Express 3.0 x8
       * Device ID: 15b3:1013
       * Firmware version: 12.21.1000

     * Mellanox(R) ConnectX(R)-4 25G MCX4121A-ACAT (2x25G)

       * Host interface: PCI Express 3.0 x8
       * Device ID: 15b3:1013
       * Firmware version: 12.21.1000

     * Mellanox(R) ConnectX(R)-4 40G MCX4131A-BCAT/MCX413A-BCAT (1x40G)

       * Host interface: PCI Express 3.0 x8
       * Device ID: 15b3:1013
       * Firmware version: 12.21.1000

     * Mellanox(R) ConnectX(R)-4 40G MCX415A-BCAT (1x40G)

       * Host interface: PCI Express 3.0 x16
       * Device ID: 15b3:1013
       * Firmware version: 12.21.1000

     * Mellanox(R) ConnectX(R)-4 50G MCX4131A-GCAT/MCX413A-GCAT (1x50G)

       * Host interface: PCI Express 3.0 x8
       * Device ID: 15b3:1013
       * Firmware version: 12.21.1000

     * Mellanox(R) ConnectX(R)-4 50G MCX414A-BCAT (2x50G)

       * Host interface: PCI Express 3.0 x8
       * Device ID: 15b3:1013
       * Firmware version: 12.21.1000

     * Mellanox(R) ConnectX(R)-4 50G MCX415A-GCAT/MCX416A-BCAT/MCX416A-GCAT
       (2x50G)

       * Host interface: PCI Express 3.0 x16
       * Device ID: 15b3:1013
       * Firmware version: 12.21.1000

     * Mellanox(R) ConnectX(R)-4 50G MCX415A-CCAT (1x100G)

       * Host interface: PCI Express 3.0 x16
       * Device ID: 15b3:1013
       * Firmware version: 12.21.1000

     * Mellanox(R) ConnectX(R)-4 100G MCX416A-CCAT (2x100G)

       * Host interface: PCI Express 3.0 x16
       * Device ID: 15b3:1013
       * Firmware version: 12.21.1000

     * Mellanox(R) ConnectX(R)-4 Lx 10G MCX4121A-XCAT (2x10G)

       * Host interface: PCI Express 3.0 x8
       * Device ID: 15b3:1015
       * Firmware version: 14.21.1000

     * Mellanox(R) ConnectX(R)-4 Lx 25G MCX4121A-ACAT (2x25G)

       * Host interface: PCI Express 3.0 x8
       * Device ID: 15b3:1015
       * Firmware version: 14.21.1000

     * Mellanox(R) ConnectX(R)-5 100G MCX556A-ECAT (2x100G)

       * Host interface: PCI Express 3.0 x16
       * Device ID: 15b3:1017
       * Firmware version: 16.21.1000

     * Mellanox(R) ConnectX-5 Ex EN 100G MCX516A-CDAT (2x100G)

       * Host interface: PCI Express 4.0 x16
       * Device ID: 15b3:1019
       * Firmware version: 16.21.1000

* ARM platforms with Mellanox(R) NICs combinations

   * Platform details:

     * Qualcomm ARM 1.1 2500MHz

   * OS:

     * Ubuntu 16.04

   * MLNX_OFED: 4.2-1.0.0.0

   * NICs:

     * Mellanox(R) ConnectX(R)-4 Lx 25G MCX4121A-ACAT (2x25G)

       * Host interface: PCI Express 3.0 x8
       * Device ID: 15b3:1015
       * Firmware version: 14.21.1000

     * Mellanox(R) ConnectX(R)-5 100G MCX556A-ECAT (2x100G)

       * Host interface: PCI Express 3.0 x16
       * Device ID: 15b3:1017
       * Firmware version: 16.21.1000

Fixes in 17.11 LTS Release
--------------------------

17.11.1
~~~~~~~

* app/procinfo: add compilation option in config
* app/testpmd: fix crash of txonly with multiple segments
* app/testpmd: fix flow director filter
* app/testpmd: fix flowgen forwarding offload flags
* app/testpmd: fix invalid Rx queue number setting
* app/testpmd: fix invalid Tx queue number setting
* app/testpmd: fix port configuration print
* app/testpmd: fix port id allocation
* app/testpmd: fix port index in RSS forward config
* app/testpmd: fix port topology in RSS forward config
* app/testpmd: fix port validation
* app/testpmd: remove xenvirt again
* bus/dpaa: fix ARM big endian build
* bus/dpaa: fix build when assert enabled
* bus/dpaa: fix default IOVA mode
* bus/fslmc: fix build with latest glibc
* bus/fslmc: fix the cplusplus macro closure
* bus/pci: fix interrupt handler type
* bus/pci: forbid IOVA mode if IOMMU address width too small
* bus/vdev: continue probing after a device failure
* cmdline: avoid garbage in unused fields of parsed result
* cmdline: fix dynamic tokens parsing
* cryptodev: add missing CPU flag string
* cryptodev: fix function prototype
* cryptodev: fix session pointer cast
* crypto/dpaa2_sec: fix enum conversion for GCM
* crypto: fix pedantic compilation
* crypto/qat: fix allocation check and leak
* crypto/qat: fix null auth algo overwrite
* crypto/qat: fix out-of-bounds access
* crypto/qat: fix parameter type
* crypto/scheduler: fix strncpy
* doc: fix format in OpenSSL installation guide
* doc: fix lists of supported crypto algorithms
* drivers: change the deprecated memseg physaddr to IOVA
* eal/arm64: remove the braces in memory barrier macros
* eal/ppc64: revert arch-specific TSC freq query
* eal/ppc: remove the braces in memory barrier macros
* ethdev: fix link autonegotiation value
* ethdev: fix missing imissed counter in xstats
* ethdev: fix port data reset timing
* ethdev: fix port id allocation
* eventdev: fix doxygen comments
* eventdev: set error code in port link/unlink functions
* event/octeontx: fix Rx adapter port id mapping
* event/sw: fix debug logging config option
* event/sw: fix queue memory leak and multi-link bug
* examples/bond: check mbuf allocation
* examples/bond: fix vdev name
* examples/ip_pipeline: fix timer period unit
* examples/ipsec-secgw: fix corner case for SPI value
* examples/ipsec-secgw: fix missing ingress flow attribute
* examples/ipsec-secgw: fix SPI byte order in flow item
* examples/ipsec-secgw: fix usage of incorrect port
* examples/l3fwd-power: fix frequency detection
* examples/l3fwd-power: fix Rx without interrupt
* examples/vhost: fix sending ARP packet to self
* examples/vhost: fix startup check
* flow_classify: fix ISO C in exported header
* igb_uio: allow multi-process access
* keepalive: fix state alignment
* kni: fix build dependency
* kni: fix build with kernel 4.15
* lib: fix missing includes in exported headers
* log: fix memory leak in regexp level set
* lpm: fix ARM big endian build
* malloc: fix end for bounded elements
* malloc: protect stats with lock
* mbuf: fix NULL freeing when debug enabled
* mbuf: fix performance of freeing with non atomic refcnt
* member: fix ISO C in exported header
* member: fix memory leak on error
* mempool: fix first memory area notification
* mempool: fix physical contiguous check
* mempool/octeontx: fix improper memory barrier
* mempool/octeontx: fix memory area registration
* mempool/octeontx: fix natural alignment being optimized out
* memzone: fix leak on allocation error
* mk: fix external build
* mk: remove TILE-Gx machine type
* mk: support renamed Makefile in external project
* net/bnxt: fix check for ether type
* net/bnxt: fix double increment of idx during Tx ring alloc
* net/bnxt: fix duplicate filter pattern creation error
* net/bnxt: fix duplicate pattern for 5tuple filter
* net/bnxt: fix group info usage
* net/bnxt: fix link speed setting with autoneg off
* net/bnxt: fix number of pools for RSS
* net/bnxt: fix return code in MAC address set
* net/bnxt: fix Rx checksum flags
* net/bnxt: fix size of Tx ring in HW
* net/bnxt: free the aggregation ring
* net/bnxt: parse checksum offload flags
* net/bonding: check error of MAC address setting
* net/bonding: fix activated slave in 8023ad mode
* net/bonding: fix bonding in 8023ad mode
* net/bonding: fix setting slave MAC addresses
* net/dpaa: fix FW version code
* net/dpaa: fix potential memory leak
* net/dpaa: fix the mbuf packet type if zero
* net/dpaa: fix uninitialized and unused variables
* net/e1000: fix null pointer check
* net/e1000: fix VF Rx interrupt enabling
* net/ena: do not set Tx L4 offloads in Rx path
* net/enic: fix crash due to static max number of queues
* net/enic: fix L4 Rx ptype comparison
* net/failsafe: fix invalid free
* net/failsafe: fix Rx safe check compiler hint
* net: fix ESP header byte ordering definition
* net/fm10k: fix logical port delete
* net/i40e: add debug logs when writing global registers
* net/i40e: add FDIR NVGRE parameter check
* net/i40e: check multi-driver option parsing
* net/i40e: exclude LLDP packet count
* net/i40e: fix ARM big endian build
* net/i40e: fix FDIR input set conflict
* net/i40e: fix FDIR rule confiliction issue
* net/i40e: fix flag for MAC address write
* net/i40e: fix flow director Rx resource defect
* net/i40e: fix interrupt conflict with multi-driver
* net/i40e: fix ISO C in exported header
* net/i40e: fix memory leak
* net/i40e: fix multiple DDP packages conflict
* net/i40e: fix multiple driver support
* net/i40e: fix packet type for X722
* net/i40e: fix port segmentation fault when restart
* net/i40e: fix Rx interrupt
* net/i40e: fix setting MAC address of VF
* net/i40e: fix setting of MAC address on i40evf
* net/i40e: fix VF reset stats crash
* net/i40e: fix VF Rx interrupt enabling
* net/i40e: fix VLAN offload setting
* net/i40e: fix VLAN offload setting issue
* net/i40e: fix VSI MAC filter on primary address change
* net/i40e: warn when writing global registers
* net/igb: fix Tx queue number assignment
* net/ixgbe: fix ARM big endian build
* net/ixgbe: fix max queue number for VF
* net/ixgbe: fix parsing FDIR NVGRE issue
* net/ixgbe: fix reset error handling
* net/ixgbe: fix the failure of number of Tx queue check
* net/ixgbe: fix tunnel filter fail problem
* net/ixgbe: fix VF Rx interrupt enabling
* net/ixgbe: fix wrong PBA setting
* net/mlx4: fix drop flow resources leak
* net/mlx4: fix Rx offload non-fragmented indication
* net/mlx4: fix Tx packet drop application report
* net/mlx4: fix unnecessary include
* net/mlx4: revert workaround for broken Verbs
* net/mlx5: cleanup allocation of ethtool stats
* net/mlx5: fix calculation of flow ID flag
* net/mlx5: fix deadlock of link status alarm
* net/mlx5: fix flow item validation
* net/mlx5: fix flow priority on queue action
* net/mlx5: fix flow RSS configuration
* net/mlx5: fix handling link status event
* net/mlx5: fix HW checksum offload for outer IP
* net/mlx5: fix link state on device start
* net/mlx5: fix memory region boundary checks
* net/mlx5: fix memory region cache last index
* net/mlx5: fix memory region cache lookup
* net/mlx5: fix memory region lookup
* net/mlx5: fix Memory Region registration
* net/mlx5: fix missing attribute size for drop action
* net/mlx5: fix missing RSS capability
* net/mlx5: fix overflow of Memory Region cache
* net/mlx5: fix overwriting bit-fields in SW Rx queue
* net/mlx5: fix port stop by verify flows are still present
* net/mlx5: fix return value of start operation
* net/mlx5: fix RSS key configuration
* net/mlx5: fix secondary process verification
* net/mlx5: fix Tx checksum offloads
* net/mlx5: fix UAR remapping on non configured queues
* net/mlx5: fix un-supported RSS hash fields use
* net/mlx5: fix VLAN configuration after port stop
* net/mlx5: remove parser/flow drop queue
* net/mlx5: use PCI address as port name
* net/mrvl: fix HIF objects allocation
* net/mrvl: fix multiple probe
* net/mrvl: fix oversize bpool handling
* net/mrvl: fix shadow queue tail and size calculations
* net/mrvl: keep shadow Txqs inside PMD Txq
* net/nfp: fix CRC strip check behaviour
* net/nfp: fix jumbo settings
* net/nfp: fix MTU settings
* net/octeontx: add channel to port id mapping
* net/pcap: fix the NUMA id display in logs
* net/qede/base: fix VF LRO tunnel configuration
* net/qede: check tunnel L3 header
* net/qede: fix clearing of queue stats
* net/qede: fix few log messages
* net/qede: fix MTU set and max Rx length
* net/qede: fix to enable LRO over tunnels
* net/qede: fix to reject config with no Rx queue
* net/qede: fix tunnel header size in Tx BD configuration
* net/qede: replace config option with run-time arg
* net/sfc: do not hold management event queue lock while MCDI
* net/sfc: fix DMA memory leak after kvarg processing failure
* net/sfc: fix flow RSS check in error handling
* net/sfc: fix incorrect bitwise ORing of L3/L4 packet types
* net/sfc: fix initialization of flow structure
* net/sfc: fix label name to be consistent
* net/sfc: fix main MAC address handling
* net/sfc: fix multicast address list copy memory leak
* net/sfc: stop periodic DMA if MAC stats upload fails
* net/szedata2: fix check of mmap return value
* net/tap: fix cleanup on allocation failure
* net/tap: remove unused kernel version definitions
* net/thunderx: fix multi segment Tx function return
* net/virtio: fix incorrect cast
* net/virtio: fix memory leak when reinitializing device
* net/virtio: fix queue flushing with vector Rx enabled
* net/virtio: fix Rx and Tx handler selection for ARM32
* net/virtio: fix typo in LRO support
* net/virtio: fix vector Rx flushing
* net/virtio-user: fix crash as features change
* pdump: fix error check when creating/canceling thread
* pmdinfogen: fix cross compilation for ARM big endian
* security: fix device operation type
* security: fix enum start value
* security: fix pedantic compilation
* service: fix lcore role after delete
* service: fix number mapped cores count
* service: fix possible mem leak on initialize
* service: fix service core launch
* test/bitmap: fix memory leak
* test/crypto: fix missing include
* test/eventdev: use CPU event type
* test/memzone: fix freeing test
* test/memzone: fix NULL freeing
* test/memzone: fix wrong test
* test: register test as failed if setup failed
* test/reorder: fix memory leak
* test/ring: fix memory leak
* test/ring_perf: fix memory leak
* test/table: fix memory leak
* test/table: fix uninitialized parameter
* test/timer_perf: fix memory leak
* timer: fix reset on service cores
* usertools/devbind: fix kernel module reporting
* vfio: fix enabled check on error
* vhost: fix crash
* vhost: fix dequeue zero copy with virtio1
* vhost: fix error code check when creating thread
* vhost: fix IOTLB pool out-of-memory handling
* vhost: fix mbuf free
* vhost: protect active rings from async ring changes
* vhost: remove pending IOTLB entry if miss request failed

17.11.2
~~~~~~~

* examples/vhost: move to safe GPA translation API
* examples/vhost_scsi: move to safe GPA translation API
* vhost: add support for non-contiguous indirect descs tables (fixes CVE-2018-1059)
* vhost: check all range is mapped when translating GPAs (fixes CVE-2018-1059)
* vhost: deprecate unsafe GPA translation API (fixes CVE-2018-1059)
* vhost: ensure all range is mapped when translating QVAs (fixes CVE-2018-1059)
* vhost: fix indirect descriptors table translation size (fixes CVE-2018-1059)
* vhost: handle virtually non-contiguous buffers in Rx (fixes CVE-2018-1059)
* vhost: handle virtually non-contiguous buffers in Rx-mrg (fixes CVE-2018-1059)
* vhost: handle virtually non-contiguous buffers in Tx (fixes CVE-2018-1059)
* vhost: introduce safe API for GPA translation (fixes CVE-2018-1059)