New upstream version 18.11.2
[deb_dpdk.git] / doc / guides / rel_notes / release_18_11.rst
1 ..  SPDX-License-Identifier: BSD-3-Clause
2     Copyright 2018 The DPDK contributors
3
4 DPDK Release 18.11
5 ==================
6
7 .. **Read this first.**
8
9    The text in the sections below explains how to update the release notes.
10
11    Use proper spelling, capitalization and punctuation in all sections.
12
13    Variable and config names should be quoted as fixed width text:
14    ``LIKE_THIS``.
15
16    Build the docs and view the output file to ensure the changes are correct::
17
18       make doc-guides-html
19
20       xdg-open build/doc/html/guides/rel_notes/release_18_11.html
21
22
23 New Features
24 ------------
25
26 .. This section should contain new features added in this release.
27    Sample format:
28
29    * **Add a title in the past tense with a full stop.**
30
31      Add a short 1-2 sentence description in the past tense.
32      The description should be enough to allow someone scanning
33      the release notes to understand the new feature.
34
35      If the feature adds a lot of sub-features you can use a bullet list
36      like this:
37
38      * Added feature foo to do something.
39      * Enhanced feature bar to do something else.
40
41      Refer to the previous release notes for examples.
42
43      Suggested order in release notes items:
44      * Core libs (EAL, mempool, ring, mbuf, buses)
45      * Device abstraction libs and PMDs
46        - ethdev (lib, PMDs)
47        - cryptodev (lib, PMDs)
48        - eventdev (lib, PMDs)
49        - etc
50      * Other libs
51      * Apps, Examples, Tools (if significant)
52
53      This section is a comment. Do not overwrite or remove it.
54      Also, make sure to start the actual text at the margin.
55      =========================================================
56
57 * **Added support for using externally allocated memory in DPDK.**
58
59   DPDK has added support for creating new ``rte_malloc`` heaps referencing
60   memory that was created outside of DPDK's own page allocator, and using that
61   memory natively with any other DPDK library or data structure.
62
63 * **Added check for ensuring allocated memory is addressable by devices.**
64
65   Some devices can have addressing limitations so a new function,
66   ``rte_mem_check_dma_mask()``, has been added for checking that allocated
67   memory is not out of the device range. Since memory can now be allocated
68   dynamically after initialization, a DMA mask is stored and any new allocated
69   memory will be checked against it and rejected if it is out of range. If
70   more than one device has addressing limitations, the DMA mask is the more
71   restrictive one.
72
73 * **Updated the C11 memory model version of the ring library.**
74
75   Added changes to decrease latency for architectures using the C11 memory
76   model version of the ring library.
77
78   On Cavium ThunderX2 platform, the changes decreased latency by 27-29%
79   and 3-15% for MPMC and SPSC cases respectively (with 2 lcores). The
80   real improvements may vary with the number of contending lcores and
81   the size of the ring.
82
83 * **Added hot-unplug handle mechanism.**
84
85   Added ``rte_dev_hotplug_handle_enable()`` and
86   ``rte_dev_hotplug_handle_disable()`` for enabling or disabling the hotplug
87   handle mechanism.
88
89 * **Added support for device multi-process hotplug.**
90
91   Added support for hotplug and hot-unplug in a multiprocessing scenario. Any
92   ethdev devices created in the primary process will be regarded as shared and
93   will be available for all DPDK processes. Synchronization between processes
94   will be done using DPDK IPC.
95
96 * **Added new Flow API actions to rewrite fields in packet headers.**
97
98   Added new Flow API actions to:
99
100   * Modify source and destination IP addresses in the outermost IPv4/IPv6
101     headers.
102   * Modify source and destination port numbers in the outermost TCP/UDP
103     headers.
104
105 * **Added new Flow API action to swap MAC addresses in Ethernet header.**
106
107   Added new Flow API action to swap the source and destination MAC
108   addresses in the outermost Ethernet header.
109
110 * **Add support to offload more flow match and actions for CXGBE PMD.**
111
112   The Flow API support has been enhanced for the CXGBE Poll Mode Driver to
113   offload:
114
115   * Match items: destination MAC address.
116   * Action items: push/pop/rewrite vlan header,
117     rewrite IP addresses in outermost IPv4/IPv6 header,
118     rewrite port numbers in outermost TCP/UDP header,
119     swap MAC addresses in outermost Ethernet header.
120
121 * **Added a devarg to use the latest supported vector path in i40e.**
122
123   A new devarg ``use-latest-supported-vec`` was introduced to allow users to
124   choose the latest vector path that the platform supported. For example, users
125   can use AVX2 vector path on BDW/HSW to get better performance.
126
127 * **Added support for SR-IOV in netvsc PMD.**
128
129   The ``netvsc`` poll mode driver now supports the Accelerated Networking
130   SR-IOV option in Hyper-V and Azure. This is an alternative to the previous
131   vdev_netvsc, tap, and failsafe drivers combination.
132
133 * **Added a new net driver for Marvell Armada 3k device.**
134
135   Added the new ``mvneta`` net driver for Marvell Armada 3k device. See the
136   :doc:`../nics/mvneta` NIC guide for more details on this new driver.
137
138 * **Added NXP ENETC PMD.**
139
140   Added the new enetc driver for the NXP enetc platform. See the
141   :doc:`../nics/enetc` NIC driver guide for more details on this new driver.
142
143 * **Added Ethernet poll mode driver for Aquantia aQtion family of 10G devices.**
144
145   Added the new ``atlantic`` ethernet poll mode driver for Aquantia XGBE devices.
146   See the :doc:`../nics/atlantic` NIC driver guide for more details on this
147   driver.
148
149 * **Updated mlx5 driver.**
150
151   Updated the mlx5 driver including the following changes:
152
153   * Improved security of PMD to prevent the NIC from getting stuck when
154     the application misbehaves.
155   * Reworked flow engine to supported e-switch flow rules (transfer attribute).
156   * Added support for header re-write(L2-L4), VXLAN encap/decap, count, match
157     on TCP flags and multiple flow groups with e-switch flow rules.
158   * Added support for match on metadata, VXLAN and MPLS encap/decap with flow
159     rules.
160   * Added support for ``RTE_ETH_DEV_CLOSE_REMOVE`` flag to provide better
161     support for representors.
162   * Added support for meson build.
163   * Fixed build issue with PPC.
164   * Added support for BlueField VF.
165   * Added support for externally allocated static memory for DMA.
166
167 * **Updated Solarflare network PMD.**
168
169   Updated the sfc_efx driver including the following changes:
170
171   * Added support for Rx scatter in EF10 datapath implementation.
172   * Added support for Rx descriptor status API in EF10 datapath implementation.
173   * Added support for TSO in EF10 datapath implementation.
174   * Added support for Tx descriptor status API in EF10 (ef10 and ef10_simple)
175     datapaths implementation.
176
177 * **Updated the enic driver.**
178
179   * Added AVX2-based vectorized Rx handler.
180   * Added VLAN and checksum offloads to the simple Tx handler.
181   * Added the "count" flow action.
182   * Enabled the virtual address IOVA mode.
183
184 * **Updated the failsafe driver.**
185
186   Updated the failsafe driver including the following changes:
187
188   * Added support for Rx and Tx queues start and stop.
189   * Added support for Rx and Tx queues deferred start.
190   * Added support for runtime Rx and Tx queues setup.
191   * Added support multicast MAC address set.
192
193 * **Added a devarg to use a PCAP interface physical MAC address.**
194
195   A new devarg ``phy_mac`` was introduced to allow users to use the physical
196   MAC address of the selected PCAP interface.
197
198 * **Added TAP Rx/Tx queues sharing with a secondary process.**
199
200   Added support to allow a secondary process to attach a TAP device created
201   in the primary process, probe the queues, and process Rx/Tx in a secondary
202   process.
203
204 * **Added classification and metering support to SoftNIC PMD.**
205
206   Added support for flow classification (rte_flow API), and metering and
207   policing (rte_mtr API) to the SoftNIC PMD.
208
209 * **Added Crypto support to the Softnic PMD.**
210
211   The Softnic is now capable of processing symmetric crypto workloads such
212   as cipher, cipher-authentication chaining, and AEAD encryption and
213   decryption. This is achieved by calling DPDK Cryptodev APIs.
214
215 * **Added cryptodev port to port library.**
216
217   Cryptodev port is a shim layer in the port library that interacts with DPDK
218   Cryptodev PMDs including burst enqueuing and dequeuing crypto operations.
219
220 * **Added symmetric cryptographic actions to the pipeline library.**
221
222   In the pipeline library support was added for symmetric crypto action
223   parsing and an action handler was implemented. The action allows automatic
224   preparation of the crypto operation with the rules specified such as
225   algorithm, key, and IV, etc. for the cryptodev port to process.
226
227 * **Updated the AESNI MB PMD.**
228
229   The AESNI MB PMD has been updated with additional support for the AES-GCM
230   algorithm.
231
232 * **Added NXP CAAM JR PMD.**
233
234   Added the new caam job ring driver for NXP platforms. See the
235   :doc:`../cryptodevs/caam_jr` guide for more details on this new driver.
236
237 * **Added support for GEN3 devices to Intel QAT driver.**
238
239   Added support for the third generation of Intel QuickAssist devices.
240
241 * **Updated the QAT PMD.**
242
243   The QAT PMD was updated with additional support for:
244
245   * The AES-CMAC algorithm.
246
247 * **Added support for Dynamic Huffman Encoding to Intel QAT comp PMD.**
248
249   The Intel QuickAssist (QAT) compression PMD has been updated with support
250   for Dynamic Huffman Encoding for the Deflate algorithm.
251
252 * **Added Event Ethernet Tx Adapter.**
253
254   Added event ethernet Tx adapter library that provides configuration and
255   data path APIs for the ethernet transmit stage of an event driven packet
256   processing application. These APIs abstract the implementation of the
257   transmit stage and allow the application to use eventdev PMD support or
258   a common implementation.
259
260 * **Added Distributed Software Eventdev PMD.**
261
262   Added the new Distributed Software Event Device (DSW), which is a
263   pure-software eventdev driver distributing the work of scheduling
264   among all eventdev ports and the lcores using them. DSW, compared to
265   the SW eventdev PMD, sacrifices load balancing performance to
266   gain better event scheduling throughput and scalability.
267
268 * **Added extendable bucket feature to hash library (rte_hash).**
269
270   This new "extendable bucket" feature provides 100% insertion guarantee to
271   the capacity specified by the user by extending hash table with extra
272   buckets when needed to accommodate the unlikely event of intensive hash
273   collisions. In addition, the internal hashing algorithm was changed to use
274   partial-key hashing to improve memory efficiency and lookup performance.
275
276 * **Added lock free reader/writer concurrency to hash library (rte_hash).**
277
278   Lock free reader/writer concurrency prevents the readers from getting
279   blocked due to a preempted writer thread. This allows the hash library
280   to be used in scenarios where the writer thread runs on the control plane.
281
282 * **Added Traffic Pattern Aware Power Control Library.**
283
284   Added an experimental library that extends the Power Library and provides
285   empty_poll APIs. This feature measures how many times empty_polls are
286   executed per core and uses the number of empty polls as a hint for system
287   power management.
288
289   See the :doc:`../prog_guide/power_man` section of the DPDK Programmers
290   Guide document for more information.
291
292 * **Added JSON power policy interface for containers.**
293
294   Extended the Power Library and vm_power_manager sample app to allow power
295   policies to be submitted via a FIFO using JSON formatted strings. Previously
296   limited to Virtual Machines, this feature extends power policy functionality
297   to containers and host applications that need to have their cores frequency
298   controlled based on the rules contained in the policy.
299
300 * **Added Telemetry API.**
301
302   Added a new telemetry API which allows applications to transparently expose
303   their telemetry in JSON via a UNIX socket. The JSON can be consumed by any
304   Service Assurance agent, such as CollectD.
305
306 * **Updated KNI kernel module, rte_kni library, and KNI sample application.**
307
308   Updated the KNI kernel module with a new kernel module parameter,
309   ``carrier=[on|off]`` to allow the user to control the default carrier
310   state of the KNI kernel network interfaces. The default carrier state
311   is now set to ``off``, so the interfaces cannot be used until the
312   carrier state is set to ``on`` via ``rte_kni_update_link`` or
313   by writing ``1`` to ``/sys/devices/virtual/net/<iface>/carrier``.
314   In previous versions the default carrier state was left undefined.
315   See :doc:`../prog_guide/kernel_nic_interface` for more information.
316
317   Also added the new API function ``rte_kni_update_link()`` to allow the user
318   to set the carrier state of the KNI kernel network interface.
319
320   Also added a new command line flag ``-m`` to the KNI sample application to
321   monitor and automatically reflect the physical NIC carrier state to the
322   KNI kernel network interface with the new ``rte_kni_update_link()`` API.
323   See :doc:`../sample_app_ug/kernel_nic_interface` for more information.
324
325 * **Added ability to switch queue deferred start flag on testpmd app.**
326
327   Added a console command to testpmd app, giving ability to switch
328   ``rx_deferred_start`` or ``tx_deferred_start`` flag of the specified queue of
329   the specified port. The port must be stopped before the command call in order
330   to reconfigure queues.
331
332 * **Add a new sample application for vDPA.**
333
334   The vdpa sample application creates vhost-user sockets by using the
335   vDPA backend. vDPA stands for vhost Data Path Acceleration which utilizes
336   virtio ring compatible devices to serve virtio driver directly to enable
337   datapath acceleration. As vDPA driver can help to set up vhost datapath,
338   this application doesn't need to launch dedicated worker threads for vhost
339   enqueue/dequeue operations.
340
341 * **Added cryptodev FIPS validation example application.**
342
343   Added an example application to parse and perform symmetric cryptography
344   computation to the NIST Cryptographic Algorithm Validation Program (CAVP)
345   test vectors.
346
347 * **Allow unit test binary to take parameters from the environment.**
348
349   The unit test "test", or "dpdk-test", binary is often called from scripts,
350   which can make passing additional parameters, such as a coremask,
351   difficult. Support has been added to the application to allow it to take
352   additional command-line parameter values from the ``DPDK_TEST_PARAMS``
353   environment variable to make this application easier to use.
354
355
356 API Changes
357 -----------
358
359 .. This section should contain API changes. Sample format:
360
361    * Add a short 1-2 sentence description of the API change.
362      Use fixed width quotes for ``function_names`` or ``struct_names``.
363      Use the past tense.
364
365    This section is a comment. Do not overwrite or remove it.
366    Also, make sure to start the actual text at the margin.
367    =========================================================
368
369 * eal: ``rte_memseg_list`` structure now has an additional flag indicating
370   whether the memseg list is externally allocated. This will have implications
371   for any users of memseg-walk-related functions, as they will now have to skip
372   externally allocated segments in most cases if the intent is to only iterate
373   over internal DPDK memory.
374
375   In addition the ``socket_id`` parameter across the entire DPDK has gained
376   additional meaning, as some socket ID's will now be representing externally
377   allocated memory. No changes will be required for existing code as backwards
378   compatibility will be kept, and those who do not use this feature will not
379   see these extra socket ID's. Any new API's must not check socket ID
380   parameters themselves, and must instead leave it to the memory subsystem to
381   decide whether socket ID is a valid one.
382
383 * eal: The following devargs functions, which were deprecated in 18.05,
384   were removed in 18.11:
385   ``rte_eal_parse_devargs_str()``, ``rte_eal_devargs_add()``,
386   ``rte_eal_devargs_type_count()``, and ``rte_eal_devargs_dump()``.
387
388 * eal: The parameters of the function ``rte_devargs_remove()`` have changed
389   from bus and device names to ``struct rte_devargs``.
390
391 * eal: The deprecated functions attach/detach were removed in 18.11.
392   ``rte_eal_dev_attach`` can be replaced by
393   ``rte_dev_probe`` or ``rte_eal_hotplug_add``.
394   ``rte_eal_dev_detach`` can be replaced by
395   ``rte_dev_remove`` or ``rte_eal_hotplug_remove``.
396
397 * eal: The scope of ``rte_eal_hotplug_add()``/``rte_dev_probe()``
398   and ``rte_eal_hotplug_remove()``/``rte_dev_remove()`` has been extended.
399   In the multi-process model, they will guarantee that the device is
400   attached or detached on all processes.
401
402 * mbuf: The ``__rte_mbuf_raw_free()`` and ``__rte_pktmbuf_prefree_seg()``
403   functions were deprecated since 17.05 and are replaced by
404   ``rte_mbuf_raw_free()`` and ``rte_pktmbuf_prefree_seg()``.
405
406 * ethdev: The deprecated functions attach/detach were removed in 18.11.
407   ``rte_eth_dev_attach()`` can be replaced by ``RTE_ETH_FOREACH_MATCHING_DEV``
408   and ``rte_dev_probe()`` or ``rte_eal_hotplug_add()``.
409   ``rte_eth_dev_detach()`` can be replaced by
410   ``rte_dev_remove()`` or ``rte_eal_hotplug_remove()``.
411
412 * ethdev: A call to ``rte_eth_dev_release_port()`` has been added in
413   ``rte_eth_dev_close()``. As a consequence, a closed port is freed
414   and seen as invalid because of its state ``RTE_ETH_DEV_UNUSED``.
415   This new behavior is enabled per driver for a migration period.
416
417 * A new device flag, ``RTE_ETH_DEV_NOLIVE_MAC_ADDR``, changes the order of
418   actions inside ``rte_eth_dev_start()`` regarding MAC set. Some NICs do not
419   support MAC changes once the port has started and with this new device
420   flag the MAC can be properly configured in any case. This is particularly
421   important for bonding.
422
423 * The default behavior of CRC strip offload has changed in this
424   release. Without any specific Rx offload flag, default behavior by a PMD is
425   now to strip CRC. ``DEV_RX_OFFLOAD_CRC_STRIP`` offload flag has been removed.
426   To request keeping CRC, application should set ``DEV_RX_OFFLOAD_KEEP_CRC``
427   Rx offload.
428
429 * eventdev: The type of the second parameter to
430   ``rte_event_eth_rx_adapter_caps_get()`` has been changed from uint8_t to
431   uint16_t.
432
433 * kni: By default, interface carrier status is ``off`` which means there won't
434   be any traffic. It can be set to ``on`` via ``rte_kni_update_link()`` API or
435   via ``sysfs`` interface: ``echo 1 > /sys/class/net/vEth0/carrier``.
436
437   Note interface should be ``up`` to be able to read/write sysfs interface.
438   When KNI sample application is used, ``-m`` parameter can be used to
439   automatically update the carrier status for the interface.
440
441 * kni: When ethtool support is enabled (``CONFIG_RTE_KNI_KMOD_ETHTOOL=y``)
442   ethtool commands ``ETHTOOL_GSET & ETHTOOL_SSET`` are no longer supported for
443   kernels that have ``ETHTOOL_GLINKSETTINGS & ETHTOOL_SLINKSETTINGS`` support.
444   This means ``ethtool "-a|--show-pause", "-s|--change"`` won't work, and
445   ``ethtool <iface>`` output will have less information.
446
447
448 ABI Changes
449 -----------
450
451 .. This section should contain ABI changes. Sample format:
452
453    * Add a short 1-2 sentence description of the ABI change
454      that was announced in the previous releases and made in this release.
455      Use fixed width quotes for ``function_names`` or ``struct_names``.
456      Use the past tense.
457
458    This section is a comment. Do not overwrite or remove it.
459    Also, make sure to start the actual text at the margin.
460    =========================================================
461
462 * eal: added ``legacy_mem`` and ``single_file_segments`` values to
463   ``rte_config`` structure on account of improving DPDK usability when
464   using either ``--legacy-mem`` or ``--single-file-segments`` flags.
465
466 * eal: EAL library ABI version was changed due to previously announced work on
467   supporting external memory in DPDK:
468
469   - Structure ``rte_memseg_list`` now has a new field indicating length
470     of memory addressed by the segment list
471   - Structure ``rte_memseg_list`` now has a new flag indicating whether
472     the memseg list refers to external memory
473   - Structure ``rte_malloc_heap`` now has a new field indicating socket
474     ID the malloc heap belongs to
475   - Structure ``rte_mem_config`` has had its ``malloc_heaps`` array
476     resized from ``RTE_MAX_NUMA_NODES`` to ``RTE_MAX_HEAPS`` value
477   - Structure ``rte_malloc_heap`` now has a ``heap_name`` member
478   - Structure ``rte_eal_memconfig`` has been extended to contain next
479     socket ID for externally allocated segments
480
481 * eal: Added ``dma_maskbits`` to ``rte_mem_config`` for keeping the most
482   restrictive DMA mask based on the devices addressing limitations.
483
484 * eal: The structure ``rte_device`` has a new field to reference a
485   ``rte_bus``.  It thus changes the size of the ``struct rte_device`` and the
486   inherited device structures of all buses.
487
488
489 Shared Library Versions
490 -----------------------
491
492 .. Update any library version updated in this release
493    and prepend with a ``+`` sign, like this:
494
495      librte_acl.so.2
496    + librte_cfgfile.so.2
497      librte_cmdline.so.2
498
499    This section is a comment. Do not overwrite or remove it.
500    =========================================================
501
502 The libraries prepended with a plus sign were incremented in this version.
503
504 .. code-block:: diff
505
506      librte_acl.so.2
507      librte_bbdev.so.1
508      librte_bitratestats.so.2
509      librte_bpf.so.1
510    + librte_bus_dpaa.so.2
511    + librte_bus_fslmc.so.2
512    + librte_bus_ifpga.so.2
513    + librte_bus_pci.so.2
514    + librte_bus_vdev.so.2
515    + librte_bus_vmbus.so.2
516      librte_cfgfile.so.2
517      librte_cmdline.so.2
518      librte_compressdev.so.1
519      librte_cryptodev.so.5
520      librte_distributor.so.1
521    + librte_eal.so.9
522      librte_efd.so.1
523    + librte_ethdev.so.11
524    + librte_eventdev.so.6
525      librte_flow_classify.so.1
526      librte_gro.so.1
527      librte_gso.so.1
528      librte_hash.so.2
529      librte_ip_frag.so.1
530      librte_jobstats.so.1
531      librte_kni.so.2
532      librte_kvargs.so.1
533      librte_latencystats.so.1
534      librte_lpm.so.2
535      librte_mbuf.so.4
536      librte_member.so.1
537      librte_mempool.so.5
538      librte_meter.so.2
539      librte_metrics.so.1
540      librte_net.so.1
541      librte_pci.so.1
542      librte_pdump.so.2
543      librte_pipeline.so.3
544      librte_pmd_bnxt.so.2
545      librte_pmd_bond.so.2
546      librte_pmd_i40e.so.2
547      librte_pmd_ixgbe.so.2
548      librte_pmd_dpaa2_qdma.so.1
549      librte_pmd_ring.so.2
550      librte_pmd_softnic.so.1
551      librte_pmd_vhost.so.2
552      librte_port.so.3
553      librte_power.so.1
554      librte_rawdev.so.1
555      librte_reorder.so.1
556      librte_ring.so.2
557      librte_sched.so.1
558      librte_security.so.1
559      librte_table.so.3
560      librte_timer.so.1
561      librte_vhost.so.4
562
563
564 Known Issues
565 ------------
566
567 .. This section should contain new known issues in this release. Sample format:
568
569    * **Add title in present tense with full stop.**
570
571      Add a short 1-2 sentence description of the known issue
572      in the present tense. Add information on any known workarounds.
573
574    This section is a comment. Do not overwrite or remove it.
575    Also, make sure to start the actual text at the margin.
576    =========================================================
577
578 * When using SR-IOV (VF) support with netvsc PMD and the Mellanox mlx5
579   bifurcated driver the Linux netvsc device must be brought up before the
580   netvsc device is unbound and passed to the DPDK.
581
582 * IBM Power8 is not supported in this release of DPDK. IBM Power9 is
583   supported.
584
585 * ``AVX-512`` support has been disabled for ``GCC`` builds [1] because of a
586   crash [2]. This can affect ``native`` machine type build targets on the
587   platforms that support ``AVX512F`` like ``Intel Skylake`` processors, and
588   can cause a possible performance drop. The immediate workaround is to use
589   ``clang`` compiler on these platforms. The issue has been identified as a
590   GCC defect and reported to the GCC community [3]. Further actions will be
591   taken based on the GCC defect result.
592
593   - [1]: Commit 8d07c82b239f ("mk: disable gcc AVX512F support")
594   - [2]: https://bugs.dpdk.org/show_bug.cgi?id=97
595   - [3]: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=88096
596
597
598 Tested Platforms
599 ----------------
600
601 .. This section should contain a list of platforms that were tested
602    with this release.
603
604    The format is:
605
606    * <vendor> platform with <vendor> <type of devices> combinations
607
608      * List of CPU
609      * List of OS
610      * List of devices
611      * Other relevant details...
612
613    This section is a comment. Do not overwrite or remove it.
614    Also, make sure to start the actual text at the margin.
615    =========================================================
616
617 * Intel(R) platforms with Intel(R) NICs combinations
618
619    * CPU
620
621      * Intel(R) Atom(TM) CPU C3758 @ 2.20GHz
622      * Intel(R) Xeon(R) CPU D-1541 @ 2.10GHz
623      * Intel(R) Xeon(R) CPU E5-2680 v2 @ 2.80GHz
624      * Intel(R) Xeon(R) CPU E5-2699 v3 @ 2.30GHz
625      * Intel(R) Xeon(R) CPU E5-2699 v4 @ 2.20GHz
626      * Intel(R) Xeon(R) Platinum 8180 CPU @ 2.50GHz
627
628    * OS:
629
630      * CentOS 7.5
631      * Fedora 25
632      * Fedora 28
633      * FreeBSD 11.2
634      * Red Hat Enterprise Linux Server release 7.5
635      * Open SUSE 15
636      * Wind River Linux 8
637      * Ubuntu 14.04
638      * Ubuntu 16.04
639      * Ubuntu 16.10
640      * Ubuntu 17.10
641      * Ubuntu 18.04
642
643    * NICs:
644
645      * Intel(R) 82599ES 10 Gigabit Ethernet Controller
646
647        * Firmware version: 0x61bf0001
648        * Device id (pf/vf): 8086:10fb / 8086:10ed
649        * Driver version: 5.2.3 (ixgbe)
650
651      * Intel(R) Corporation Ethernet Connection X552/X557-AT 10GBASE-T
652
653        * Firmware version: 0x800003e7
654        * Device id (pf/vf): 8086:15ad / 8086:15a8
655        * Driver version: 4.4.6 (ixgbe)
656
657      * Intel(R) Ethernet Converged Network Adapter X710-DA4 (4x10G)
658
659        * Firmware version: 6.01 0x80003221
660        * Device id (pf/vf): 8086:1572 / 8086:154c
661        * Driver version: 2.4.6 (i40e)
662
663      * Intel(R) Corporation Ethernet Connection X722 for 10GbE SFP+ (4x10G)
664
665        * Firmware version: 3.33 0x80000fd5 0.0.0
666        * Device id (pf/vf): 8086:37d0 / 8086:37cd
667        * Driver version: 2.4.6 (i40e)
668
669      * Intel(R) Ethernet Converged Network Adapter XXV710-DA2 (2x25G)
670
671        * Firmware version: 6.01 0x80003221
672        * Device id (pf/vf): 8086:158b / 8086:154c
673        * Driver version: 2.4.6 (i40e)
674
675      * Intel(R) Ethernet Converged Network Adapter XL710-QDA2 (2X40G)
676
677        * Firmware version: 6.01 0x8000321c
678        * Device id (pf/vf): 8086:1583 / 8086:154c
679        * Driver version: 2.4.6 (i40e)
680
681      * Intel(R) Corporation I350 Gigabit Network Connection
682
683        * Firmware version: 1.63, 0x80000dda
684        * Device id (pf/vf): 8086:1521 / 8086:1520
685        * Driver version: 5.4.0-k (igb)
686
687 * Intel(R) platforms with Mellanox(R) NICs combinations
688
689    * CPU:
690
691      * Intel(R) Xeon(R) Gold 6154 CPU @ 3.00GHz
692      * Intel(R) Xeon(R) CPU E5-2697A v4 @ 2.60GHz
693      * Intel(R) Xeon(R) CPU E5-2697 v3 @ 2.60GHz
694      * Intel(R) Xeon(R) CPU E5-2680 v2 @ 2.80GHz
695      * Intel(R) Xeon(R) CPU E5-2650 v4 @ 2.20GHz
696      * Intel(R) Xeon(R) CPU E5-2640 @ 2.50GHz
697      * Intel(R) Xeon(R) CPU E5-2620 v4 @ 2.10GHz
698
699    * OS:
700
701      * Red Hat Enterprise Linux Server release 7.6 (Maipo)
702      * Red Hat Enterprise Linux Server release 7.5 (Maipo)
703      * Red Hat Enterprise Linux Server release 7.4 (Maipo)
704      * Red Hat Enterprise Linux Server release 7.3 (Maipo)
705      * Red Hat Enterprise Linux Server release 7.2 (Maipo)
706      * Ubuntu 18.10
707      * Ubuntu 18.04
708      * Ubuntu 17.10
709      * Ubuntu 16.04
710      * SUSE Linux Enterprise Server 15
711
712    * MLNX_OFED: 4.4-2.0.1.0
713    * MLNX_OFED: 4.5-0.3.1.0
714
715    * NICs:
716
717      * Mellanox(R) ConnectX(R)-3 Pro 40G MCX354A-FCC_Ax (2x40G)
718
719        * Host interface: PCI Express 3.0 x8
720        * Device ID: 15b3:1007
721        * Firmware version: 2.42.5000
722
723      * Mellanox(R) ConnectX(R)-4 10G MCX4111A-XCAT (1x10G)
724
725        * Host interface: PCI Express 3.0 x8
726        * Device ID: 15b3:1013
727        * Firmware version: 12.23.8022 and above
728
729      * Mellanox(R) ConnectX(R)-4 10G MCX4121A-XCAT (2x10G)
730
731        * Host interface: PCI Express 3.0 x8
732        * Device ID: 15b3:1013
733        * Firmware version: 12.23.8022 and above
734
735      * Mellanox(R) ConnectX(R)-4 25G MCX4111A-ACAT (1x25G)
736
737        * Host interface: PCI Express 3.0 x8
738        * Device ID: 15b3:1013
739        * Firmware version: 12.23.8022 and above
740
741      * Mellanox(R) ConnectX(R)-4 25G MCX4121A-ACAT (2x25G)
742
743        * Host interface: PCI Express 3.0 x8
744        * Device ID: 15b3:1013
745        * Firmware version: 12.23.8022 and above
746
747      * Mellanox(R) ConnectX(R)-4 40G MCX4131A-BCAT/MCX413A-BCAT (1x40G)
748
749        * Host interface: PCI Express 3.0 x8
750        * Device ID: 15b3:1013
751        * Firmware version: 12.23.8022 and above
752
753      * Mellanox(R) ConnectX(R)-4 40G MCX415A-BCAT (1x40G)
754
755        * Host interface: PCI Express 3.0 x16
756        * Device ID: 15b3:1013
757        * Firmware version: 12.23.8022 and above
758
759      * Mellanox(R) ConnectX(R)-4 50G MCX4131A-GCAT/MCX413A-GCAT (1x50G)
760
761        * Host interface: PCI Express 3.0 x8
762        * Device ID: 15b3:1013
763        * Firmware version: 12.23.8022 and above
764
765      * Mellanox(R) ConnectX(R)-4 50G MCX414A-BCAT (2x50G)
766
767        * Host interface: PCI Express 3.0 x8
768        * Device ID: 15b3:1013
769        * Firmware version: 12.23.8022 and above
770
771      * Mellanox(R) ConnectX(R)-4 50G MCX415A-GCAT/MCX416A-BCAT/MCX416A-GCAT (2x50G)
772
773        * Host interface: PCI Express 3.0 x16
774        * Device ID: 15b3:1013
775        * Firmware version: 12.23.8022 and above
776        * Firmware version: 12.23.8022 and above
777
778      * Mellanox(R) ConnectX(R)-4 50G MCX415A-CCAT (1x100G)
779
780        * Host interface: PCI Express 3.0 x16
781        * Device ID: 15b3:1013
782        * Firmware version: 12.23.8022 and above
783
784      * Mellanox(R) ConnectX(R)-4 100G MCX416A-CCAT (2x100G)
785
786        * Host interface: PCI Express 3.0 x16
787        * Device ID: 15b3:1013
788        * Firmware version: 12.23.8022 and above
789
790      * Mellanox(R) ConnectX(R)-4 Lx 10G MCX4121A-XCAT (2x10G)
791
792        * Host interface: PCI Express 3.0 x8
793        * Device ID: 15b3:1015
794        * Firmware version: 14.23.8022 and above
795
796      * Mellanox(R) ConnectX(R)-4 Lx 25G MCX4121A-ACAT (2x25G)
797
798        * Host interface: PCI Express 3.0 x8
799        * Device ID: 15b3:1015
800        * Firmware version: 14.23.8022 and above
801
802      * Mellanox(R) ConnectX(R)-5 100G MCX556A-ECAT (2x100G)
803
804        * Host interface: PCI Express 3.0 x16
805        * Device ID: 15b3:1017
806        * Firmware version: 16.23.8022 and above
807
808      * Mellanox(R) ConnectX(R)-5 Ex EN 100G MCX516A-CDAT (2x100G)
809
810        * Host interface: PCI Express 4.0 x16
811        * Device ID: 15b3:1019
812        * Firmware version: 16.23.8022 and above
813
814 * ARM platforms with Mellanox(R) NICs combinations
815
816    * CPU:
817
818      * Qualcomm ARM 1.1 2500MHz
819
820    * OS:
821
822      * Red Hat Enterprise Linux Server release 7.5 (Maipo)
823
824    * NICs:
825
826      * Mellanox(R) ConnectX(R)-4 Lx 25G MCX4121A-ACAT (2x25G)
827
828        * Host interface: PCI Express 3.0 x8
829        * Device ID: 15b3:1015
830        * Firmware version: 14.24.0220
831
832      * Mellanox(R) ConnectX(R)-5 100G MCX556A-ECAT (2x100G)
833
834        * Host interface: PCI Express 3.0 x16
835        * Device ID: 15b3:1017
836        * Firmware version: 16.24.0220
837
838 * Mellanox(R) BlueField SmartNIC
839
840    * Mellanox(R) BlueField SmartNIC MT416842 (2x25G)
841
842        * Host interface: PCI Express 3.0 x16
843        * Device ID: 15b3:a2d2
844        * Firmware version: 18.24.0246
845
846    * SoC ARM cores running OS:
847
848      * CentOS Linux release 7.4.1708 (AltArch)
849      * MLNX_OFED 4.4-2.5.3.0
850
851   * DPDK application running on ARM cores inside SmartNIC
852
853 * ARM SoC combinations from NXP (with integrated NICs)
854
855    * SoC:
856
857      * NXP/Freescale QorIQ LS1046A with ARM Cortex A72
858      * NXP/Freescale QorIQ LS2088A with ARM Cortex A72
859
860    * OS:
861
862      * Ubuntu 18.04.1 LTS with NXP QorIQ LSDK 1809 support packages
863      * Ubuntu 16.04.3 LTS with NXP QorIQ LSDK 1803 support packages
864
865 18.11.1  Release Notes
866 ----------------------
867
868 18.11.1 Fixes
869 ~~~~~~~~~~~~~
870
871 * app/bbdev: fix return value check
872 * app/eventdev: detect deadlock for timer event producer
873 * app/pdump: fix vdev cleanup
874 * app/testpmd: expand RED queue thresholds to 64 bits
875 * app/testpmd: fix MPLS BoS bit default value
876 * app/testpmd: fix MPLSoGRE encapsulation
877 * app/testpmd: fix MPLSoUDP encapsulation
878 * app/testpmd: fix quit to stop all ports before close
879 * app/testpmd: fix Tx metadata show command
880 * bb/turbo_sw: fix dynamic linking
881 * build: fix meson check for binutils 2.30
882 * build: fix variable name in dependency error message
883 * build: mention -march in pkg-config description
884 * build: use static deps for pkg-config libs.private
885 * bus/dpaa: do nothing if bus not present
886 * bus/dpaa: fix logical to physical core affine logic
887 * bus/fslmc: fix parse method for bus devices
888 * bus/fslmc: fix ring mode to use correct cache settings
889 * bus/fslmc: fix to convert error msg to warning
890 * bus/fslmc: fix to reset portal memory before use
891 * bus/fslmc: fix to use correct physical core for logical core
892 * bus/ifpga: fix AFU probe failure handler
893 * bus/ifpga: fix build for cpp applications
894 * bus/ifpga: fix forcing optional devargs
895 * bus/vmbus: fix race in subchannel creation
896 * common/qat: remove check of valid firmware response
897 * compressdev: fix structure comment
898 * compress/qat: fix dequeue error counter
899 * compress/qat: fix returned status on overflow
900 * compress/qat: fix return on building request error
901 * config: enable C11 memory model for armv8 with meson
902 * crypto/dpaa2_sec: fix FLC address for physical mode
903 * crypto/qat: fix block size error handling
904 * crypto/qat: fix digest in wireless auth case
905 * crypto/qat: fix message for CCM when setting unused counter
906 * crypto/qat: fix message for NULL algo setting unused counter
907 * devtools: fix build check for whether meson has run
908 * devtools: fix return of forbidden addition checks
909 * devtools: fix symbol check when adding experimental section
910 * devtools: fix wrong headline lowercase for arm
911 * doc: add dependency for PDF in contributing guide
912 * doc: add GCM AAD limitation in qat guide
913 * doc: add GRO limitations in programmers guide
914 * doc: add missing loopback option in testpmd guide
915 * doc: clarify libnuma requirement for NUMA systems
916 * doc: fix AESNI_MB guide
917 * doc: fix a parameter name in testpmd guide
918 * doc: fix a typo in power management guide
919 * doc: fix a typo in testpmd guide
920 * doc: fix a typo in testpmd guide
921 * doc: fix flow action command names in testpmd guide
922 * doc: fix garbage text in generated HTML guides
923 * doc: fix ifc naming
924 * doc: fix MAC address rewrite actions in prog guide
925 * doc: fix references in power management guide
926 * doc: remove note on memory mode limitation in multi-process
927 * drivers/crypto: fix PMDs memory leak
928 * drivers: fix sprintf with snprintf
929 * drivers/net: fix several Tx prepare functions
930 * eal/bsd: remove clean up of files at startup
931 * eal: check string parameter lengths
932 * eal: clean up unused files on initialization
933 * eal: close multi-process socket during cleanup
934 * eal: fix build of external app with clang on armv8
935 * eal: fix clang build with intrinsics forced
936 * eal: fix core number validation
937 * eal: fix detection of duplicate option register
938 * eal: fix leak on multi-process request error
939 * eal: fix log level of error in option register
940 * eal: fix missing newline in a log
941 * eal: fix out of bound access when no CPU available
942 * eal: fix strdup usages in internal config
943 * eal/linux: fix parsing zero socket memory and limits
944 * efd: fix tail queue leak
945 * ethdev: declare Tx prepare API as not experimental
946 * ethdev: fix errno to have positive value
947 * ethdev: fix typo in queue setup error log
948 * eventdev: fix error log in eth Rx adapter
949 * eventdev: fix eth Tx adapter queue count checks
950 * eventdev: fix xstats documentation typo
951 * eventdev: remove redundant timer adapter function prototypes
952 * examples/bond: fix crash when there is no active slave
953 * examples/bond: fix initialization order
954 * examples/flow_filtering: fix example documentation
955 * examples/ipsec-secgw: fix crypto-op might never get dequeued
956 * examples/ipsec-secgw: fix inbound SA checking
957 * examples/ipsec-secgw: fix outbound codepath for single SA
958 * examples/ipsec-secgw: make local variables static
959 * examples/kni: fix crash while handling userspace request
960 * examples/tep_term: remove unused constant
961 * examples/vhost_crypto: fix bracket
962 * examples/vhost: fix a typo
963 * examples/vhost: fix path allocation failure handling
964 * gro: check invalid TCP header length
965 * gro: fix overflow of payload length calculation
966 * gso: fix VxLAN/GRE tunnel checks
967 * hash: fix out-of-bound write while freeing key slot
968 * hash: fix return of bulk lookup
969 * ip_frag: fix IPv6 when MTU sizes not aligned to 8 bytes
970 * kni: fix build for dev_open in Linux 5.0
971 * kni: fix build for igb_ndo_bridge_setlink in Linux 5.0
972 * kni: fix build on RHEL 8
973 * kni: fix build on RHEL8 for arm and Power9
974 * malloc: fix deadlock when reading stats
975 * malloc: fix duplicate mem event notification
976 * malloc: fix finding maximum contiguous IOVA size
977 * malloc: make alignment requirements more stringent
978 * malloc: notify primary process about hotplug in secondary
979 * mem: check for memfd support in segment fd API
980 * mem: fix segment fd API error code for external segment
981 * mem: fix storing old policy
982 * mem: fix variable shadowing
983 * memzone: fix unlock on initialization failure
984 * mk: do not install meson.build in usertools
985 * mk: fix scope of disabling AVX512F support
986 * net/af_packet: fix setting MTU decrements sockaddr twice
987 * net/avf/base: fix comment referencing internal data
988 * net/bnx2x: cleanup info logs
989 * net/bnx2x: fix segfaults due to stale interrupt status
990 * net/bonding: fix possible null pointer reference
991 * net/bonding: fix reset active slave
992 * net/cxgbe: fix control queue mbuf pool naming convention
993 * net/cxgbe: fix overlapping regions in TID table
994 * net/cxgbe: skip parsing match items with no spec
995 * net/dpaa2: fix bad check for not-null
996 * net/dpaa2: fix device init for secondary process
997 * net/dpaa: fix secondary process
998 * net/ena: add reset reason in Rx error
999 * net/ena: add supported RSS offloads types
1000 * net/ena: destroy queues if start failed
1001 * net/ena: do not reconfigure queues on reset
1002 * net/ena: fix cleanup for out of order packets
1003 * net/ena: fix dev init with multi-process
1004 * net/ena: fix errno to positive value
1005 * net/ena: fix invalid reference to variable in union
1006 * net/ena: skip packet with wrong request id
1007 * net/ena: update completion queue after cleanup
1008 * net/enic: remove useless include
1009 * net: fix underflow for checksum of invalid IPv4 packets
1010 * net/fm10k: fix internal switch initial status
1011 * net/i40e: clear VF reset flags after reset
1012 * net/i40e: fix config name in comment
1013 * net/i40e: fix get RSS conf
1014 * net/i40e: fix getting RSS configuration
1015 * net/i40e: fix overwriting RSS RETA
1016 * net/i40e: fix port close
1017 * net/i40e: fix queue region DCB configure
1018 * net/i40e: fix statistics
1019 * net/i40e: fix statistics inconsistency
1020 * net/i40e: fix using recovery mode firmware
1021 * net/i40e: fix VF overwrite PF RSS LUT for X722
1022 * net/i40e: perform basic validation on VF messages
1023 * net/i40e: remove redundant reset of queue number
1024 * net/i40e: revert fix offload not supported mask
1025 * net/ifc: store only registered device instance
1026 * net/ifcvf: fix typo on struct name
1027 * net/igb: fix LSC interrupt when using MSI-X
1028 * net/ixgbe/base: add LHA ID
1029 * net/ixgbe: fix crash on remove
1030 * net/ixgbe: fix over using multicast table for VF
1031 * net/ixgbe: fix overwriting RSS RETA
1032 * net/ixgbe: fix Rx LRO capability offload for x550
1033 * net/mlx5: fix build for armv8
1034 * net/mlx5: fix deprecated library API for Rx padding
1035 * net/mlx5: fix function documentation
1036 * net/mlx5: fix instruction hotspot on replenishing Rx buffer
1037 * net/mlx5: fix Multi-Packet RQ mempool free
1038 * net/mlx5: fix Rx packet padding
1039 * net/mlx5: fix shared counter allocation logic
1040 * net/mlx5: fix TC rule handle assignment
1041 * net/mlx5: fix typos and code style
1042 * net/mlx5: fix validation of Rx queue number
1043 * net/mlx5: fix VXLAN port registration race condition
1044 * net/mlx5: fix VXLAN without decap action for E-Switch
1045 * net/mlx5: remove checks for outer tunnel items on E-Switch
1046 * net/mlx5: support ethernet type for tunnels on E-Switch
1047 * net/mlx5: support tunnel inner items on E-Switch
1048 * net/mlx5: validate ethernet type on E-Switch
1049 * net/mlx5: validate tunnel inner items on E-Switch
1050 * net/netvsc: disable multi-queue on older servers
1051 * net/netvsc: enable SR-IOV
1052 * net/netvsc: fix probe when VF not found
1053 * net/netvsc: fix transmit descriptor pool cleanup
1054 * net/qede: fix performance bottleneck in Rx path
1055 * net/qede: remove prefetch in Tx path
1056 * net/sfc: add missing header guard to TSO header file
1057 * net/sfc/base: fix Tx descriptor max number check
1058 * net/sfc: discard last seen VLAN TCI if Tx packet is dropped
1059 * net/sfc: fix crash in EF10 TSO if no payload
1060 * net/sfc: fix datapath name references in logs
1061 * net/sfc: fix port ID log
1062 * net/sfc: fix Rx packets counter
1063 * net/sfc: fix typo in preprocessor check
1064 * net/sfc: fix VF error/missed stats mapping
1065 * net/sfc: pass HW Tx queue index on creation
1066 * net/tap: add buffer overflow checks before checksum
1067 * net/tap: allow full length names
1068 * net/tap: fix possible uninitialized variable access
1069 * net/tap: let kernel choose tun device name
1070 * net/vhost: fix double free of MAC address
1071 * net/virtio: add barrier before reading the flags
1072 * net/virtio-user: fix used ring in cvq handling
1073 * raw/ifpga: fix memory leak
1074 * Revert "net/mlx5: fix instruction hotspot on replenishing Rx buffer"
1075 * sched: fix memory leak on init failure
1076 * telemetry: fix using ports of different types
1077 * test: check zero socket memory as valid
1078 * test/crypto: fix misleading trace message
1079 * test/fbarray: add to meson
1080 * test/hash: fix perf result
1081 * test/mem: add external mem autotest to meson
1082 * test/metrics: fix a negative case
1083 * timer: fix race condition
1084 * version: 18.11.1-rc1
1085 * version: 18.11.1-rc2
1086 * vfio: allow secondary process to query IOMMU type
1087 * vfio: do not unregister callback in secondary process
1088 * vfio: fix error message
1089 * vhost/crypto: fix possible dead loop
1090 * vhost/crypto: fix possible out of bound access
1091 * vhost: enforce avail index and desc read ordering
1092 * vhost: enforce desc flags and content read ordering
1093 * vhost: ensure event idx is mapped when negotiated
1094 * vhost: fix access for indirect descriptors
1095 * vhost: fix crash after mmap failure
1096 * vhost: fix deadlock in driver unregister
1097 * vhost: fix double read of descriptor flags
1098 * vhost: fix memory leak on realloc failure
1099 * vhost: fix possible dead loop in vector filling
1100 * vhost: fix possible out of bound access in vector filling
1101 * vhost: fix race condition when adding fd in the fdset
1102
1103 18.11.1 Validation
1104 ~~~~~~~~~~~~~~~~~~
1105
1106 * Intel(R) Testing
1107
1108    * 18.11.1 LTS release passed the basic Intel(R) NIC(ixgbe and i40e) testing
1109
1110    * cryptodev
1111    * virtio and Intel NIC/virtio performance
1112    * vlan
1113    * vxlan
1114    * Jumbo frames
1115    * Generic filter
1116    * Flow director
1117    * PF and VF
1118
1119 * Mellanox(R) Testing
1120
1121    * Basic functionality
1122
1123       * Send and receive multiple types of traffic
1124       * testpmd xstats counter test
1125       * testpmd timestamp test
1126
1127    * Changing/checking link status through testpmd
1128
1129       * RTE flow and flow_director tests
1130       * Some RSS tests
1131       * VLAN stripping and insertion tests
1132       * Checksum and TSO tests
1133       * ptype tests
1134       * Port interrupt testing
1135       * Multi-process testing
1136
1137    * Drivers tested
1138
1139       * MLNX_OFED_LINUX-4.5-1.0.1.0
1140       * MLNX_OFED_LINUX-4.4-2.0.1.0
1141       * rdma-core upstream commit 0ea43f6
1142
1143    * Tested NICs
1144
1145       * ConnectX-4 Lx (fw 14.24.1000)
1146       * ConnectX-5 (fw 16.24.1000)
1147
1148    * OSes tested
1149
1150       * RHEL7.4 (kernel 5.0.0)
1151       * RHEL7.4 (kernel 3.10.0-693.el7.x86_64)
1152
1153
1154 * OVS Testing Intel(R)
1155
1156    * OVS testing against head OVS Master and OVS 2.11.0 with VSPERF
1157    * Tested with i40e (X710), ixgbe (82599ES) and igb(I350) devices
1158
1159       * PVP
1160       * P2P
1161       * Multiqueue
1162       * Vhostuserclient reconnect
1163       * Vhost cross-NUMA awareness
1164       * Jumbo frames
1165       * Rate limiting
1166       * QoS policer
1167
1168 * Microsoft(R) Azure Testing
1169
1170    * SRIOV/Failsafe
1171    * DPDK-OVS
1172
1173 * Red Hat(R) Virtualization Testing
1174
1175    * PF
1176    * VF
1177    * vhost single/multi queues and cross-NUMA
1178    * vhostclient reconnect
1179    * vhost live migration with single/multi queues and cross-NUMA
1180
1181 18.11.2  Release Notes
1182 ----------------------
1183
1184 18.11.2 Fixes
1185 ~~~~~~~~~~~~~
1186
1187 * acl: fix compiler flags with meson and AVX2 runtime
1188 * app/bbdev: replace sprintf with snprintf or strlcpy
1189 * app/crypto-perf: check range of socket id
1190 * app/pdump: remove only created vdevs
1191 * app/test: fix build with musl libc
1192 * app/test: fix flags with meson
1193 * app/test: fix sprintf with strlcat
1194 * app/testpmd: add missing newline when showing statistics
1195 * app/testpmd: extend forwarding statistics to 64 bits
1196 * app/testpmd: fix a typo in log message
1197 * app/testpmd: fix help info for interactive commands
1198 * app/testpmd: fix hex string parser support for flow API
1199 * app/testpmd: fix mempool free on exit
1200 * app/testpmd: fix offload flags after port config
1201 * app/testpmd: fix return value check
1202 * app/testpmd: fix stdout flush after printing stats
1203 * app/testpmd: fix Tx QinQ set
1204 * app/testpmd: fix Tx VLAN and QinQ dependency
1205 * app/testpmd: fix typo in comment
1206 * app/testpmd: fix unintentional integer overflow
1207 * app/testpmd: fix variable use before null check
1208 * app/testpmd: remove unused field from port struct
1209 * app/testpmd: remove useless casts on statistics
1210 * bitrate: fix unchecked return value
1211 * build: fix crash by disabling AVX512 with binutils 2.31
1212 * build: fix meson binutils workaround
1213 * build: fix ninja install on FreeBSD
1214 * build: remove meson warning for Arm
1215 * build: use default flags for default Arm machine
1216 * bus/dpaa: fix Rx discard register mask
1217 * bus/fslmc: decrease log level for unsupported devices
1218 * bus/fslmc: fix build with musl libc
1219 * bus/fslmc: fix warning with GCC 9
1220 * bus/fslmc: fix warning with GCC 9
1221 * bus/fslmc: remove unused include of error.h
1222 * bus/vdev: fix debug message on probing
1223 * bus/vdev: fix hotplug twice
1224 * bus/vmbus: fix check for mmap failure
1225 * bus/vmbus: fix resource leak on error
1226 * bus/vmbus: fix secondary process setup
1227 * bus/vmbus: map ring in secondary process
1228 * bus/vmbus: stop mapping if empty resource found
1229 * cfgfile: replace strcat with strlcat
1230 * ci: add a distinguisher to the extra Travis builds
1231 * ci: enable ccache in Travis
1232 * ci: introduce Travis builds for GitHub repositories
1233 * common/cpt: fix null auth only
1234 * compress/isal: fix compression stream initialization
1235 * compress/isal: fix getting information about CPU
1236 * compress/qat: fix setup inter buffers
1237 * crypto/caam_jr: fix memory leak and illegal access
1238 * crypto/caam_jr: fix shared descriptor endianness
1239 * crypto/caam_jr: fix total length in auth only s/g
1240 * cryptodev: fix driver name comparison
1241 * crypto/dpaa2_sec: fix offset calculation for GCM
1242 * crypto/dpaa2_sec: fix session clearing
1243 * crypto/dpaa: fix session destroy
1244 * crypto/kasumi: fix dependency check
1245 * crypto/openssl: fix big numbers after computations
1246 * crypto/openssl: fix modexp
1247 * crypto/qat: fix null cipher algo for non 8-byte multiple
1248 * crypto/snow3g: add to meson build
1249 * crypto/virtio: fix IV offset
1250 * crypto/virtio: use local log type
1251 * crypto/zuc: fix dependency check
1252 * devtools: accept experimental symbol promotion
1253 * devtools: add libelf dependency to build test
1254 * devtools: fix build test on FreeBSD
1255 * devtools: fix check of symbol added as stable API
1256 * devtools: fix result of svg include check
1257 * devtools: fix symbol name in check log
1258 * devtools: fix test of some build options
1259 * devtools: skip meson build for missing compilers
1260 * devtools: support older compilers with meson test
1261 * devtools: test build of zlib PMD
1262 * doc: add flow API to qede NIC features
1263 * doc: add missing algorithms for AESNI-MB PMD
1264 * doc: fix ABI check script examples
1265 * doc: fix a minor typo in testpmd guide
1266 * doc: fix broken link in LPM guide
1267 * doc: fix examples in bonding guide
1268 * doc: fix formatting in testpmd guide
1269 * doc: fix heading levels in bbdev test guide
1270 * doc: fix interactive commands in testpmd guide
1271 * doc: fix JSON interface for power sample
1272 * doc: fix link in Linux getting started guide
1273 * doc: fix links to doxygen and sphinx sites
1274 * doc: fix missing asymmetric crypto table
1275 * doc: fix PCI whitelist typo in prog guide
1276 * doc: fix spelling in testpmd guide
1277 * doc: fix spelling reported by aspell in comments
1278 * doc: fix spelling reported by aspell in guides
1279 * doc: fix tag for inner RSS feature
1280 * doc: fix two typos in contributing guide
1281 * doc: fix typo in IPC guide
1282 * doc: fix typo in mlx5 guide
1283 * doc: fix typos in mlx5 guide
1284 * doc: fix typos in testpmd user guide
1285 * doc: remove reference to rte.doc.mk in programmers guide
1286 * doc: update cross Arm toolchain in Linux guide
1287 * drivers/event: disable OcteonTx for buggy Arm compilers
1288 * drivers: fix SPDX license id consistency
1289 * drivers/net: fix possible overflow using strlcat
1290 * drivers/net: fix shifting 32-bit signed variable 31 times
1291 * drivers/qat: fix queue pair NUMA node
1292 * eal: fix check when retrieving current CPU affinity
1293 * eal: fix cleanup in no-shconf mode
1294 * eal: fix control threads pinnning
1295 * eal: fix core list validation with disabled cores
1296 * eal: fix formatting of hotplug error message
1297 * eal: fix typo in comment of vector function
1298 * eal: initialize alarms early
1299 * eal/linux: fix log levels for pagemap reading failure
1300 * eal/linux: remove thread ID from debug message
1301 * eal/ppc: fix global memory barrier
1302 * eal: remove dead code in core list parsing
1303 * eal: restrict control threads to startup CPU affinity
1304 * eal: support strlcat function
1305 * eal: tighten permissions on shared memory files
1306 * ethdev: fix a typo
1307 * ethdev: fix method name in doxygen comment
1308 * ethdev: fix typo in error messages
1309 * ethdev: remove unused variable
1310 * eventdev: fix crypto adapter
1311 * eventdev: fix Rx adapter event flush
1312 * eventdev: update references to removed function
1313 * event/dsw: fix capability flags
1314 * event/dsw: ignore scheduling type for single-link queues
1315 * event/opdl: replace sprintf with snprintf
1316 * event/sw: fix enqueue checks in self-test
1317 * examples/ethtool: fix two typos
1318 * examples/fips_validation: fix CMAC test
1319 * examples/ip_pipeline: disable build when no epoll
1320 * examples/ipsec-secgw: fix AES-CTR block size
1321 * examples/ipsec-secgw: fix build error log
1322 * examples/ipsec-secgw: fix debug logs
1323 * examples/ipsec-secgw: fix SPD no-match case
1324 * examples/l2fwd-cat: fix build on FreeBSD
1325 * examples/multi_process: fix buffer underrun
1326 * examples/power: fix buffer overrun
1327 * examples/power: fix build with some disabled PMDs
1328 * examples/power: fix json null termination
1329 * examples/power: fix overflowed value
1330 * examples/power: fix resource leak
1331 * examples/power: fix string null termination
1332 * examples/power: fix string overflow
1333 * examples/power: fix unreachable VF MAC init
1334 * examples/vhost_crypto: fix dependency on vhost library
1335 * examples/vhost_scsi: fix null-check for parameter
1336 * hash: fix doc about thread/process safety
1337 * hash: fix position returned in free slots
1338 * hash: fix total entries count
1339 * ipc: add warnings about correct API usage
1340 * ipc: add warnings about not using IPC with memory API
1341 * ipc: fix memory leak on request failure
1342 * ipc: fix send error handling
1343 * ipc: handle more invalid parameter cases
1344 * ipc: harden message receive
1345 * ipc: unlock on failure
1346 * kni: fix build with Linux 5.1
1347 * kni: fix type for MAC address
1348 * maintainers: update for IBM POWER
1349 * malloc: fix documentation of realloc function
1350 * malloc: fix IPC message initialization
1351 * mbuf: fix a typo
1352 * mbuf: update Tx VLAN and QinQ flags documentation
1353 * mem: limit use of address hint
1354 * mempool/dpaa2: fix continuous print on empty pool
1355 * mem: warn user when running without NUMA support
1356 * mk: disable packed member pointer warning for telemetry
1357 * mk: disable warning for packed member pointer
1358 * mk: fix AVX512 disabled warning on non x86
1359 * mk: fix build of shared library with libbsd
1360 * net/atlantic: bad logic with offsets talking with firmware
1361 * net/atlantic: eeprom get/set should consider offset
1362 * net/atlantic: eliminate excessive log levels on Rx/Tx
1363 * net/atlantic: enable broadcast traffic
1364 * net/atlantic: error handling for mailbox access
1365 * net/atlantic: extra line at eof
1366 * net/atlantic: fix buffer overflow
1367 * net/atlantic: fix EEPROM get for small and uneven lengths
1368 * net/atlantic: fix link configuration
1369 * net/atlantic: fix max eeprom size
1370 * net/atlantic: fix missing VLAN filter offload
1371 * net/atlantic: fix negative error codes
1372 * net/atlantic: fix xstats return
1373 * net/atlantic: flow control settings synchronization on rx
1374 * net/atlantic: remove extra checks for error codes
1375 * net/atlantic: remove unused variable
1376 * net/atlantic: use capability bits to detect eeprom access
1377 * net/atlantic: validity check for eeprom dev address
1378 * net/avf: fix admin queue interrupt for ICE
1379 * net/bnx2x: fix DMAE timeout
1380 * net/bnx2x: fix memory leak
1381 * net/bnx2x: fix MTU for jumbo frame
1382 * net/bnx2x: fix optic module verification
1383 * net/bnx2x: fix race for periodic flags
1384 * net/bnx2x: fix ramrod timeout
1385 * net/bnxt: fix big endian build
1386 * net/bnxt: fix Rx VLAN offload flags
1387 * net/bnxt: silence IOVA warnings
1388 * net/bnxt: support IOVA VA mode
1389 * net/bnxt: suppress spurious error log
1390 * net/bonding: avoid warning for invalid port
1391 * net/bonding: fix buffer length when printing strings
1392 * net/bonding: fix LACP negotiation
1393 * net/bonding: fix link status
1394 * net/bonding: fix packet count type for LACP
1395 * net/bonding: fix port id types
1396 * net/bonding: fix queue index types
1397 * net/bonding: fix slave id types
1398 * net/bonding: fix slave Tx burst for mode 4
1399 * net/bonding: fix Tx in 802.3ad mode
1400 * net/bonding: fix values of descriptor limits
1401 * net/cxgbe: fix colliding function names
1402 * net/cxgbe: fix missing checksum flags and packet type
1403 * net/cxgbe: update Chelsio T5/T6 NIC device ids
1404 * net/enetc: fix big endian build and buffer allocation
1405 * net/enetc: fix crash at high speed traffic
1406 * net/enetc: fix SMMU unhandled context fault
1407 * net/enic: allow flow mark ID 0
1408 * net/enic: check for unsupported flow item types
1409 * net/enic: fix endianness in VLAN match
1410 * net/enic: fix flow director SCTP matching
1411 * net/enic: fix inner packet matching
1412 * net/enic: fix max MTU calculation
1413 * net/enic: fix SCTP match for flow API
1414 * net/enic: fix VLAN inner type matching for old hardware
1415 * net/enic: fix VXLAN match
1416 * net/enic: move arguments into struct
1417 * net/enic: reset VXLAN port regardless of overlay offload
1418 * net: fix Tx VLAN flag for offload emulation
1419 * net/fm10k: fix VLAN strip offload flag
1420 * net/i40e: fix dereference before check when getting EEPROM
1421 * net/i40e: fix dereference before null check in mbuf release
1422 * net/i40e: fix link speed for X722
1423 * net/i40e: fix logging on VF close
1424 * net/i40e: fix queue number check
1425 * net/i40e: fix scattered Rx enabling
1426 * net/i40e: fix time sync for 25G
1427 * net/i40e: forbid two RSS flow rules
1428 * net/i40e: log when provided RSS key is not valid
1429 * net/iavf: fix info get
1430 * net/ixgbe: fix warning with GCC 9
1431 * net/ixgbe: restore VLAN filter for VF
1432 * net/kni: fix return value check
1433 * net/mlx4: change device reference for secondary process
1434 * net/mlx4: fix memory region cleanup
1435 * net/mlx5: check Tx queue size overflow
1436 * net/mlx5: fix comments mixing Rx and Tx
1437 * net/mlx5: fix errno typos in comments
1438 * net/mlx5: fix external memory registration
1439 * net/mlx5: fix flow priorities probing error path
1440 * net/mlx5: fix hex dump of error completion
1441 * net/mlx5: fix instruction hotspot on replenishing Rx buffer
1442 * net/mlx5: fix max number of queues for NEON Tx
1443 * net/mlx5: fix memory event on secondary process
1444 * net/mlx5: fix memory region cleanup
1445 * net/mlx5: fix Multi-Packet RQ mempool name
1446 * net/mlx5: fix packet inline on Tx queue wraparound
1447 * net/mlx5: fix release of Rx queue object
1448 * net/mlx5: fix RSS validation function
1449 * net/mlx5: fix sync when handling Tx completions
1450 * net/mlx5: fix Tx metadata for multi-segment packet
1451 * net/mlx: prefix private structure
1452 * net/mlx: remove debug messages on datapath
1453 * net/netvsc: fix include of fcntl.h
1454 * net/netvsc: fix VF support with secondary process
1455 * net/netvsc: remove useless condition
1456 * net/netvsc: reset mbuf port on VF Rx
1457 * net/nfp: check return value
1458 * net/nfp: fix build with musl libc
1459 * net/nfp: fix file descriptor check
1460 * net/nfp: fix memory leak
1461 * net/nfp: fix possible buffer overflow
1462 * net/nfp: fix potential integer overflow
1463 * net/nfp: fix RSS query
1464 * net/nfp: fix setting MAC address
1465 * net/octeontx: fix vdev name
1466 * net/pcap: fix memory leak
1467 * net/qede: fix Rx packet drop
1468 * net/qede: fix Tx packet prepare for tunnel packets
1469 * net/qede: support IOVA VA mode
1470 * net/ring: avoid hard-coded length
1471 * net/ring: check length of ring name
1472 * net/ring: fix coding style
1473 * net/ring: fix return value check
1474 * net/ring: use calloc style where appropriate
1475 * net/sfc: fix logging from secondary process
1476 * net/sfc: fix MTU change to check Rx scatter consistency
1477 * net/sfc: fix speed capabilities reported in device info
1478 * net/sfc: improve TSO header length check in EF10 datapath
1479 * net/sfc: improve TSO header length check in EFX datapath
1480 * net/sfc: log port ID as 16-bit unsigned integer on panic
1481 * net/sfc: remove control path logging from Rx queue count
1482 * net/softnic: fix possible buffer overflow
1483 * net/tap: fix getting max iovec
1484 * net/tap: fix memory leak on IPC request
1485 * net/tap: fix multi process reply buffer
1486 * net/tap: fix multi-process request
1487 * net/tap: fix potential IPC buffer overrun
1488 * net/vdev_netvsc: fix device cast
1489 * net/virtio: add barrier in interrupt enable
1490 * net/virtio: add barriers for extra descriptors on Rx split
1491 * net/virtio: fix buffer leak on VLAN insert
1492 * net/virtio: fix dangling pointer on failure
1493 * net/virtio: fix duplicate naming of include guard
1494 * net/virtio: fix in-order Tx path for split ring
1495 * net/virtio: remove forward declaration
1496 * net/virtio: remove useless condition
1497 * net/virtio: set offload flag for jumbo frames
1498 * net/virtio-user: fix multi-process support
1499 * net/virtio-user: fix multiqueue with vhost kernel
1500 * net/virtio-user: fix return value check
1501 * net/vmxnet3: add VLAN filter capability
1502 * power: fix cache line alignment
1503 * power: fix governor storage to trim newlines
1504 * power: fix thread-safety environment modification
1505 * power: remove unused variable
1506 * raw/dpaa2_cmdif: fix warnings with GCC 9
1507 * raw/dpaa2_qdma: fix spin lock release
1508 * raw/dpaa2_qdma: fix to support multiprocess execution
1509 * raw/ifpga: fix file descriptor leak in error path
1510 * raw/ifpga: modify log output
1511 * raw/skeleton: fix warnings with GCC 9
1512 * Revert "app/testpmd: fix offload flags after port config"
1513 * ring: enforce reading tail before slots
1514 * ring: fix an error message
1515 * ring: fix namesize macro documentation block
1516 * rwlock: reimplement with atomic builtins
1517 * spinlock: reimplement with atomic one-way barrier
1518 * table: fix arm64 hash function selection
1519 * telemetry: fix mapping of statistics
1520 * test/barrier: fix allocation check
1521 * test/barrier: fix for Power CPUs
1522 * test/barrier: fix typo in log
1523 * test/bonding: fix MAC assignment for re-run
1524 * test: clean remaining trace of devargs autotest
1525 * test/compress: fix missing header include
1526 * test/crypto: fix duplicate id used by CCP device
1527 * test/crypto: fix possible overflow using strlcat
1528 * test/distributor: replace sprintf with strlcpy
1529 * test/event: replace sprintf with snprintf
1530 * test/hash: replace sprintf with snprintf
1531 * test/pmd_perf: fix the way to drain the port
1532 * test/spinlock: amortize the cost of getting time
1533 * test/spinlock: remove delay for correct benchmarking
1534 * version: 18.11.2-rc1
1535 * vfio: document multiprocess limitation for container API
1536 * vhost/crypto: fix parens
1537 * vhost: fix device leak on connection add failure
1538 * vhost: fix interrupt suppression for the split ring
1539 * vhost: fix null pointer checking
1540 * vhost: fix passing destroyed device to destroy callback
1541 * vhost: fix potential use-after-free for memory region
1542 * vhost: fix potential use-after-free for zero copy mbuf
1543 * vhost: fix silent queue enabling with legacy guests
1544 * vhost: fix sprintf with snprintf
1545 * vhost: prevent disabled rings to be processed with zero-copy
1546 * vhost: restore mbuf first when freeing zmbuf
1547
1548 18.11.2 Validation
1549 ~~~~~~~~~~~~~~~~~~
1550
1551 * IBM(R) Testing
1552
1553    * Tests run
1554
1555       * Single port stability test using l3fwd (16 cpus) and TRex
1556       * 64 and 1500 byte packets at a 0.0% drop rate for 4 hours each
1557
1558    * System tested
1559
1560       * IBM Power9 Model 8335-101 CPU: 2.3 (pvr 004e 1203)
1561
1562    * Tested NICs
1563
1564       * ConnectX-5 (fw 16.23.1020).
1565
1566    * OS Tested
1567
1568       * Ubuntu 18.04.2 LTS (kernel 4.15.0-47-generic)
1569
1570 * Intel(R) Openvswitch Testing
1571
1572    * OVS testing against head OVS Master and OVS 2.11.0 with VSPERF
1573
1574    * Tested NICs
1575
1576       * i40e (X710) and i40eVF
1577       * ixgbe (82599ES) and ixgbeVF
1578       * igb (I350) and igbVF
1579
1580    * Functionality
1581
1582       * P2P
1583       * PVP
1584       * PVVP
1585       * PV-PV in parallel
1586       * Hotplug
1587       * Multiqueue
1588       * Vhostuserclient reconnect
1589       * Vhost cross-NUMA awareness
1590       * Jumbo frames
1591       * Rate limiting
1592       * QoS policer
1593
1594 * Mellanox(R) Testing
1595
1596    * Basic functionality
1597
1598       * Send and receive multiple types of traffic
1599       * testpmd xstats counter test
1600       * testpmd timestamp test
1601       * Changing/checking link status through testpmd
1602       * RTE flow and flow_director tests
1603       * Some RSS tests
1604       * VLAN stripping and insertion tests
1605       * Checksum and TSO tests
1606       * ptype tests
1607       * Port interrupt testing
1608       * Multi-process testing
1609
1610    * OFED versions tested
1611
1612       * MLNX_OFED_LINUX-4.5-1.0.1.0
1613       * MLNX_OFED_LINUX-4.6-1.0.1.1
1614
1615    * Tested NICs
1616
1617       * ConnectX-4 Lx (fw 14.25.1010).
1618       * ConnectX-5 (fw 16.25.1010).
1619
1620    * OS tested
1621
1622    * RHEL7.4 (kernel 3.10.0-693.el7.x86_64).
1623
1624 * Microsoft(R) Azure Testing
1625
1626    * Images
1627
1628       * Canonical UbuntuServer 16.04-LTS latest
1629       * Canonical UbuntuServer 18.04-DAILY-LTS latest
1630       * RedHat RHEL 7-RAW latest
1631       * RedHat RHEL 7.5 latest
1632       * Openlogic CentOS 7.5 latest
1633       * SUSE SLES 15 latest
1634
1635    * Drivers
1636
1637       * Mellanox and netvsc poll-mode drivers
1638
1639    * Functionality
1640
1641       * VM to VM traffic
1642       * SRIOV/Failsafe
1643       * Single and multicore performance
1644
1645 * Red Hat(R) Testing
1646
1647    * RHEL 7 and RHEL 8
1648    * Functionality
1649
1650       * PF
1651       * VF
1652       * vhost single/multi queues and cross-NUMA
1653       * vhostclient reconnect
1654       * vhost live migration with single/multi queues and cross-NUMA
1655       * OVS PVP
1656
1657    * Tested NICs
1658
1659       * X540-AT2 NIC(ixgbe, 10G)
1660
1661 * Intel(R) Testing
1662
1663    * Basic Intel(R) NIC(ixgbe and i40e) testing
1664
1665       * vlan
1666       * vxlan
1667       * Jumbo frames
1668       * Generic filter
1669       * Flow director
1670       * PF and VF
1671       * Intel NIC single core/NIC performance
1672
1673    * Basic cryptodev and virtio testing
1674
1675       * cryptodev
1676       * vhost/virtio basic loopback, PVP and performance test
1677
1678 18.11.2 Known Issues
1679 ~~~~~~~~~~~~~~~~~~~~
1680
1681 * DPDK 18.11.2 contains fixes up to DPDK v19.05. Issues identified/fixed in DPDK master branch after DPDK v19.05 may be present in DPDK 18.11.2
1682 * testpmd: queue specific offloads may be over-written by the default config. This is not a regression from earlier DPDK 18.11 releases.
1683
1684 Fixes skipped and status unresolved
1685 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1686
1687 * dcfbc594f net/iavf: fix queue interrupt for ice (18.02)
1688 * 281bd1aa3 net/iavf: fix stats reset (18.02)
1689 * fe252fb69 test/rwlock: benchmark on all available cores (1.2.3r0)
1690 * 6fef1ae4f test/rwlock: amortize the cost of getting time (1.2.3r0)