4 .. **Read this first.**
6 The text in the sections below explains how to update the release notes.
8 Use proper spelling, capitalization and punctuation in all sections.
10 Variable and config names should be quoted as fixed width text:
13 Build the docs and view the output file to ensure the changes are correct::
17 xdg-open build/doc/html/guides/rel_notes/release_18_02.html
23 .. This section should contain new features added in this release. Sample
26 * **Add a title in the past tense with a full stop.**
28 Add a short 1-2 sentence description in the past tense. The description
29 should be enough to allow someone scanning the release notes to
30 understand the new feature.
32 If the feature adds a lot of sub-features you can use a bullet list like
35 * Added feature foo to do something.
36 * Enhanced feature bar to do something else.
38 Refer to the previous release notes for examples.
40 This section is a comment. do not overwrite or remove it.
41 Also, make sure to start the actual text at the margin.
42 =========================================================
44 * **Add function to allow releasing internal EAL resources on exit**
46 During ``rte_eal_init()`` EAL allocates memory from hugepages to enable its
47 core libraries to perform their tasks. The ``rte_eal_cleanup()`` function
48 releases these resources, ensuring that no hugepage memory is leaked. It is
49 expected that all DPDK applications call ``rte_eal_cleanup()`` before
50 exiting. Not calling this function could result in leaking hugepages, leading
51 to failure during initialization of secondary processes.
53 * **Added the ixgbe ethernet driver to support RSS with flow API.**
55 Rte_flow actually defined to include RSS, but till now, RSS is out of
56 rte_flow. This patch is to support igb and ixgbe NIC with existing RSS
57 configuration using rte_flow API.
59 * **Add MAC loopback support for i40e.**
61 Add MAC loopback support for i40e in order to support test task asked by
62 users. According to the device configuration, it will setup TX->RX loopback
65 * **Add the support of run time determination of number of queues per i40e VF**
67 The number of queue per VF is determined by its host PF. If the PCI address
68 of an i40e PF is aaaa:bb.cc, the number of queues per VF can be configured
69 with EAL parameter like -w aaaa:bb.cc,queue-num-per-vf=n. The value n can be
70 1, 2, 4, 8 or 16. If no such parameter is configured, the number of queues
71 per VF is 4 by default.
73 * **Added the i40e ethernet driver to support RSS with flow API.**
75 Rte_flow actually defined to include RSS, but till now, RSS is out of
76 rte_flow. This patch is to support i40e NIC with existing RSS
77 configuration using rte_flow API.It also enable queue region configuration
78 using flow API for i40e.
80 * **Updated i40e driver to support PPPoE/PPPoL2TP.**
82 Updated i40e PMD to support PPPoE/PPPoL2TP with PPPoE/PPPoL2TP supporting
83 profiles which can be programmed by dynamic device personalization (DDP)
86 * **Updated mlx5 driver.**
88 Updated the mlx5 driver including the following changes:
90 * Enabled compilation as a plugin, thus removed the mandatory dependency with rdma-core.
91 With the special compilation, the rdma-core libraries will be loaded only in case
92 Mellanox device is being used. For binaries creation the PMD can be enabled, still not
93 requiring from every end user to install rdma-core.
94 * Improved multi-segment packet performance.
95 * Changed driver name to use the PCI address to be compatible with OVS-DPDK APIs.
96 * Extended statistics for physical port packet/byte counters.
97 * Converted to the new offloads API.
98 * Supported device removal check operation.
100 * **Updated mlx4 driver.**
102 Updated the mlx4 driver including the following changes:
104 * Enabled compilation as a plugin, thus removed the mandatory dependency with rdma-core.
105 With the special compilation, the rdma-core libraries will be loaded only in case
106 Mellanox device is being used. For binaries creation the PMD can be enabled, still not
107 requiring from every end user to install rdma-core.
108 * Improved data path performance.
109 * Converted to the new offloads API.
110 * Supported device removal check operation.
112 * **Added NVGRE and UDP tunnels support in Solarflare network PMD.**
114 Added support for NVGRE, VXLAN and GENEVE tunnels.
116 * Added support for UDP tunnel ports configuration.
117 * Added tunneled packets classification.
118 * Added inner checksum offload.
120 * **Added the igb ethernet driver to support RSS with flow API.**
122 Rte_flow actually defined to include RSS, but till now, RSS is out of
123 rte_flow. This patch is to support igb NIC with existing RSS configuration
126 * **Add AVF (Adaptive Virtual Function) net PMD.**
128 A new net PMD has been added, which supports IntelĀ® Ethernet Adaptive
129 Virtual Function (AVF) with features list below:
132 * SSE vectorized Rx/Tx burst
137 * Jumbo frame and MTU setting
140 * Rx/Tx descriptor status
141 * Link status update/event
143 * **Add feature supports for live migration from vhost-net to vhost-user.**
145 To make live migration from vhost-net to vhost-user possible, added
146 feature supports for vhost-user. The features include:
148 * VIRTIO_F_ANY_LAYOUT
150 * VIRTIO_NET_F_GUEST_ECN, VIRTIO_NET_F_HOST_ECN
151 * VIRTIO_NET_F_GUEST_UFO, VIRTIO_NET_F_HOST_UFO
154 * **Updated the AESNI-MB PMD.**
156 The AESNI-MB PMD has been updated with additional support for:
160 * **Updated the DPAA_SEC crypto driver to support rte_security.**
162 Updated the ``dpaa_sec`` crypto PMD to support ``rte_security`` lookaside
163 protocol offload for IPSec.
165 * **Added Wireless Base Band Device (bbdev) abstraction.**
167 The Wireless Baseband Device library is an acceleration abstraction
168 framework for 3gpp Layer 1 processing functions that provides a common
169 programming interface for seamless opeartion on integrated or discrete
170 hardware accelerators or using optimized software libraries for signal
172 The current release only supports 3GPP CRC, Turbo Coding and Rate
173 Matching operations, as specified in 3GPP TS 36.212.
175 See the :doc:`../prog_guide/bbdev` programmer's guide for more details.
177 * **Added New eventdev OPDL PMD**
179 The OPDL (Ordered Packet Distribution Library) eventdev is a specific
180 implementation of the eventdev API. It is particularly suited to packet
181 processing workloads that have high throughput and low latency requirements.
182 All packets follow the same path through the device. The order in which
183 packets follow is determinted by the order in which queues are set up.
184 Events are left on the ring until they are transmitted. As a result packets
185 do not go out of order.
187 With this change, application can use OPDL PMD by eventdev api.
189 * **Added New pipeline use case for dpdk-test-eventdev application**
191 The pipeline case can be used to simulate various stages in a real world
192 application from packet receive to transmit while maintaining the packet
193 ordering also measure the performance of the event device across the stages
196 The pipeline use case has been made generic to work will all the event
197 devices based on the capabilities.
199 * **Updated Eventdev Sample application to support event devices based on capability**
201 Updated Eventdev pipeline sample application to support various types of pipelines
202 based on the capabilities of the attached event and ethernet devices. Also,
203 renamed the application from SW PMD specific ``eventdev_pipeline_sw_pmd``
204 to PMD agnostic ``eventdev_pipeline``.
206 * **Added Rawdev, a generic device support library.**
208 Rawdev library provides support for integrating any generic device type with
209 DPDK framework. Generic devices are those which do not have a pre-defined
210 type within DPDK, for example, ethernet, crypto, event etc.
211 A set of northbound APIs have been defined which encompass a generic set of
212 operations by allowing applications to interact with device using opaque
213 structures/buffers. Also, southbound APIs provide APIs for integrating device
214 either as as part of a physical bus (PCI, FSLMC etc) or through ``vdev``.
216 See the :doc:`../prog_guide/rawdev` programmer's guide for more details.
218 * **Added new multi-process communication channel**
220 Added a generic channel in EAL for multi-process (primary/secondary) communication.
221 Consumers of this channel need to register an action with an action name to response
222 a message received; the actions will be identified by the action name and executed
223 in the context of a new dedicated thread for this channel. The list of new APIs:
225 * ``rte_mp_register`` and ``rte_mp_unregister`` are for action (un)registration.
226 * ``rte_mp_sendmsg`` is for sending a message without blocking for a response.
227 * ``rte_mp_request`` is for sending a request message and will block until
228 it gets a reply message which is sent from the peer by ``rte_mp_reply``.
230 * **Add GRO support for VxLAN-tunneled packets.**
232 Add GRO support for VxLAN-tunneled packets. Supported VxLAN packets
233 must contain an outer IPv4 header and inner TCP/IPv4 headers. VxLAN
234 GRO doesn't check if input packets have correct checksums and doesn't
235 update checksums for output packets. Additionally, it assumes the
236 packets are complete (i.e., MF==0 && frag_off==0), when IP
237 fragmentation is possible (i.e., DF==0).
239 * **Increased default Rx and Tx ring size in sample applications.**
241 Increased the default ``RX_RING_SIZE`` and ``TX_RING_SIZE`` to 1024 entries
242 in testpmd and the sample applications to give better performance in the
243 general case. The user should experiment with various Rx and Tx ring sizes
244 for their specific application to get best performance.
246 * **Added new DPDK build system using the tools "meson" and "ninja" [EXPERIMENTAL]**
248 Added in support for building DPDK using ``meson`` and ``ninja``, which gives
249 additional features, such as automatic build-time configuration, over the
250 current build system using ``make``. For instructions on how to do a DPDK build
251 using the new system, see the instructions in ``doc/build-sdk-meson.txt``.
255 This new build system support is incomplete at this point and is added
256 as experimental in this release. The existing build system using ``make``
257 is unaffected by these changes, and can continue to be used for this
258 and subsequent releases until such time as it's deprecation is announced.
264 .. This section should contain API changes. Sample format:
266 * Add a short 1-2 sentence description of the API change. Use fixed width
267 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
270 This section is a comment. do not overwrite or remove it.
271 Also, make sure to start the actual text at the margin.
272 =========================================================
278 .. This section should contain ABI changes. Sample format:
280 * Add a short 1-2 sentence description of the ABI change that was announced
281 in the previous releases and made in this release. Use fixed width quotes
282 for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
284 This section is a comment. do not overwrite or remove it.
285 Also, make sure to start the actual text at the margin.
286 =========================================================
292 .. This section should contain removed items in this release. Sample format:
294 * Add a short 1-2 sentence description of the removed item in the past
297 This section is a comment. do not overwrite or remove it.
298 Also, make sure to start the actual text at the margin.
299 =========================================================
305 .. This section should contain new known issues in this release. Sample format:
307 * **Add title in present tense with full stop.**
309 Add a short 1-2 sentence description of the known issue in the present
310 tense. Add information on any known workarounds.
312 This section is a comment. do not overwrite or remove it.
313 Also, make sure to start the actual text at the margin.
314 =========================================================
317 Shared Library Versions
318 -----------------------
320 .. Update any library version updated in this release and prepend with a ``+``
324 + librte_cfgfile.so.2
327 This section is a comment. do not overwrite or remove it.
328 =========================================================
331 The libraries prepended with a plus sign were incremented in this version.
337 librte_bitratestats.so.2
339 librte_bus_fslmc.so.1
344 librte_cryptodev.so.4
345 librte_distributor.so.1
349 librte_flow_classify.so.1
357 librte_latencystats.so.1
370 librte_pmd_ixgbe.so.2
372 librte_pmd_softnic.so.1
373 librte_pmd_vhost.so.2
390 .. This section should contain a list of platforms that were tested with this
395 * <vendor> platform with <vendor> <type of devices> combinations
400 * Other relevant details...
402 This section is a comment. do not overwrite or remove it.
403 Also, make sure to start the actual text at the margin.
404 =========================================================
406 * Intel(R) platforms with Intel(R) NICs combinations
410 * Intel(R) Atom(TM) CPU C2758 @ 2.40GHz
411 * Intel(R) Xeon(R) CPU D-1540 @ 2.00GHz
412 * Intel(R) Xeon(R) CPU D-1541 @ 2.10GHz
413 * Intel(R) Xeon(R) CPU E5-4667 v3 @ 2.00GHz
414 * Intel(R) Xeon(R) CPU E5-2680 v2 @ 2.80GHz
415 * Intel(R) Xeon(R) CPU E5-2699 v4 @ 2.20GHz
416 * Intel(R) Xeon(R) CPU E5-2695 v4 @ 2.10GHz
417 * Intel(R) Xeon(R) CPU E5-2658 v2 @ 2.40GHz
418 * Intel(R) Xeon(R) CPU E5-2658 v3 @ 2.20GHz
419 * Intel(R) Xeon(R) Platinum 8180 CPU @ 2.50GHz
428 * Red Hat Enterprise Linux Server release 7.3
429 * SUSE Enterprise Linux 12
438 * Intel(R) 82599ES 10 Gigabit Ethernet Controller
440 * Firmware version: 0x61bf0001
441 * Device id (pf/vf): 8086:10fb / 8086:10ed
442 * Driver version: 5.2.3 (ixgbe)
444 * Intel(R) Corporation Ethernet Connection X552/X557-AT 10GBASE-T
446 * Firmware version: 0x800003e7
447 * Device id (pf/vf): 8086:15ad / 8086:15a8
448 * Driver version: 4.4.6 (ixgbe)
450 * Intel(R) Ethernet Converged Network Adapter X710-DA4 (4x10G)
452 * Firmware version: 6.01 0x80003221
453 * Device id (pf/vf): 8086:1572 / 8086:154c
454 * Driver version: 2.4.3 (i40e)
456 * Intel Corporation Ethernet Connection X722 for 10GBASE-T
458 * firmware-version: 6.01 0x80003221
459 * Device id: 8086:37d2 / 8086:154c
460 * Driver version: 2.4.3 (i40e)
462 * Intel(R) Ethernet Converged Network Adapter XXV710-DA2 (2x25G)
464 * Firmware version: 6.01 0x80003221
465 * Device id (pf/vf): 8086:158b / 8086:154c
466 * Driver version: 2.4.3 (i40e)
468 * Intel(R) Ethernet Converged Network Adapter XL710-QDA2 (2X40G)
470 * Firmware version: 6.01 0x8000321c
471 * Device id (pf/vf): 8086:1583 / 8086:154c
472 * Driver version: 2.4.3 (i40e)
474 * Intel(R) Corporation I350 Gigabit Network Connection
476 * Firmware version: 1.63, 0x80000dda
477 * Device id (pf/vf): 8086:1521 / 8086:1520
478 * Driver version: 5.3.0-k (igb)
480 * Intel(R) platforms with Mellanox(R) NICs combinations
484 * Intel(R) Xeon(R) CPU E5-2697A v4 @ 2.60GHz
485 * Intel(R) Xeon(R) CPU E5-2697 v3 @ 2.60GHz
486 * Intel(R) Xeon(R) CPU E5-2680 v2 @ 2.80GHz
487 * Intel(R) Xeon(R) CPU E5-2650 v4 @ 2.20GHz
488 * Intel(R) Xeon(R) CPU E5-2640 @ 2.50GHz
489 * Intel(R) Xeon(R) CPU E5-2620 v4 @ 2.10GHz
493 * Red Hat Enterprise Linux Server release 7.5 Beta (Maipo)
494 * Red Hat Enterprise Linux Server release 7.4 (Maipo)
495 * Red Hat Enterprise Linux Server release 7.3 (Maipo)
496 * Red Hat Enterprise Linux Server release 7.2 (Maipo)
501 * MLNX_OFED: 4.2-1.0.0.0
502 * MLNX_OFED: 4.3-0.1.6.0
506 * Mellanox(R) ConnectX(R)-3 Pro 40G MCX354A-FCC_Ax (2x40G)
508 * Host interface: PCI Express 3.0 x8
509 * Device ID: 15b3:1007
510 * Firmware version: 2.42.5000
512 * Mellanox(R) ConnectX(R)-4 10G MCX4111A-XCAT (1x10G)
514 * Host interface: PCI Express 3.0 x8
515 * Device ID: 15b3:1013
516 * Firmware version: 12.21.1000 and above
518 * Mellanox(R) ConnectX(R)-4 10G MCX4121A-XCAT (2x10G)
520 * Host interface: PCI Express 3.0 x8
521 * Device ID: 15b3:1013
522 * Firmware version: 12.21.1000 and above
524 * Mellanox(R) ConnectX(R)-4 25G MCX4111A-ACAT (1x25G)
526 * Host interface: PCI Express 3.0 x8
527 * Device ID: 15b3:1013
528 * Firmware version: 12.21.1000 and above
530 * Mellanox(R) ConnectX(R)-4 25G MCX4121A-ACAT (2x25G)
532 * Host interface: PCI Express 3.0 x8
533 * Device ID: 15b3:1013
534 * Firmware version: 12.21.1000 and above
536 * Mellanox(R) ConnectX(R)-4 40G MCX4131A-BCAT/MCX413A-BCAT (1x40G)
538 * Host interface: PCI Express 3.0 x8
539 * Device ID: 15b3:1013
540 * Firmware version: 12.21.1000 and above
542 * Mellanox(R) ConnectX(R)-4 40G MCX415A-BCAT (1x40G)
544 * Host interface: PCI Express 3.0 x16
545 * Device ID: 15b3:1013
546 * Firmware version: 12.21.1000 and above
548 * Mellanox(R) ConnectX(R)-4 50G MCX4131A-GCAT/MCX413A-GCAT (1x50G)
550 * Host interface: PCI Express 3.0 x8
551 * Device ID: 15b3:1013
552 * Firmware version: 12.21.1000 and above
554 * Mellanox(R) ConnectX(R)-4 50G MCX414A-BCAT (2x50G)
556 * Host interface: PCI Express 3.0 x8
557 * Device ID: 15b3:1013
558 * Firmware version: 12.21.1000 and above
560 * Mellanox(R) ConnectX(R)-4 50G MCX415A-GCAT/MCX416A-BCAT/MCX416A-GCAT (2x50G)
562 * Host interface: PCI Express 3.0 x16
563 * Device ID: 15b3:1013
564 * Firmware version: 12.21.1000 and above
565 * Firmware version: 12.21.1000 and above
567 * Mellanox(R) ConnectX(R)-4 50G MCX415A-CCAT (1x100G)
569 * Host interface: PCI Express 3.0 x16
570 * Device ID: 15b3:1013
571 * Firmware version: 12.21.1000 and above
573 * Mellanox(R) ConnectX(R)-4 100G MCX416A-CCAT (2x100G)
575 * Host interface: PCI Express 3.0 x16
576 * Device ID: 15b3:1013
577 * Firmware version: 12.21.1000 and above
579 * Mellanox(R) ConnectX(R)-4 Lx 10G MCX4121A-XCAT (2x10G)
581 * Host interface: PCI Express 3.0 x8
582 * Device ID: 15b3:1015
583 * Firmware version: 14.21.1000 and above
585 * Mellanox(R) ConnectX(R)-4 Lx 25G MCX4121A-ACAT (2x25G)
587 * Host interface: PCI Express 3.0 x8
588 * Device ID: 15b3:1015
589 * Firmware version: 14.21.1000 and above
591 * Mellanox(R) ConnectX(R)-5 100G MCX556A-ECAT (2x100G)
593 * Host interface: PCI Express 3.0 x16
594 * Device ID: 15b3:1017
595 * Firmware version: 16.21.1000 and above
597 * Mellanox(R) ConnectX-5 Ex EN 100G MCX516A-CDAT (2x100G)
599 * Host interface: PCI Express 4.0 x16
600 * Device ID: 15b3:1019
601 * Firmware version: 16.21.1000 and above
603 * ARM platforms with Mellanox(R) NICs combinations
607 * Qualcomm ARM 1.1 2500MHz
613 * MLNX_OFED: 4.2-1.0.0.0
617 * Mellanox(R) ConnectX(R)-4 Lx 25G MCX4121A-ACAT (2x25G)
619 * Host interface: PCI Express 3.0 x8
620 * Device ID: 15b3:1015
621 * Firmware version: 14.21.1000
623 * Mellanox(R) ConnectX(R)-5 100G MCX556A-ECAT (2x100G)
625 * Host interface: PCI Express 3.0 x16
626 * Device ID: 15b3:1017
627 * Firmware version: 16.21.1000