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 * **Updated the AESNI-MB PMD.**
145 The AESNI-MB PMD has been updated with additional support for:
149 * **Updated the DPAA_SEC crypto driver to support rte_security.**
151 Updated the ``dpaa_sec`` crypto PMD to support ``rte_security`` lookaside
152 protocol offload for IPSec.
154 * **Added Wireless Base Band Device (bbdev) abstraction.**
156 The Wireless Baseband Device library is an acceleration abstraction
157 framework for 3gpp Layer 1 processing functions that provides a common
158 programming interface for seamless opeartion on integrated or discrete
159 hardware accelerators or using optimized software libraries for signal
161 The current release only supports 3GPP CRC, Turbo Coding and Rate
162 Matching operations, as specified in 3GPP TS 36.212.
164 See the :doc:`../prog_guide/bbdev` programmer's guide for more details.
166 * **Added New eventdev OPDL PMD**
168 The OPDL (Ordered Packet Distribution Library) eventdev is a specific
169 implementation of the eventdev API. It is particularly suited to packet
170 processing workloads that have high throughput and low latency requirements.
171 All packets follow the same path through the device. The order in which
172 packets follow is determinted by the order in which queues are set up.
173 Events are left on the ring until they are transmitted. As a result packets
174 do not go out of order.
176 With this change, application can use OPDL PMD by eventdev api.
178 * **Added New pipeline use case for dpdk-test-eventdev application**
180 The pipeline case can be used to simulate various stages in a real world
181 application from packet receive to transmit while maintaining the packet
182 ordering also measure the performance of the event device across the stages
185 The pipeline use case has been made generic to work will all the event
186 devices based on the capabilities.
188 * **Updated Eventdev Sample application to support event devices based on capability**
190 Updated Eventdev pipeline sample application to support various types of pipelines
191 based on the capabilities of the attached event and ethernet devices. Also,
192 renamed the application from SW PMD specific ``eventdev_pipeline_sw_pmd``
193 to PMD agnostic ``eventdev_pipeline``.
195 * **Added Rawdev, a generic device support library.**
197 Rawdev library provides support for integrating any generic device type with
198 DPDK framework. Generic devices are those which do not have a pre-defined
199 type within DPDK, for example, ethernet, crypto, event etc.
200 A set of northbound APIs have been defined which encompass a generic set of
201 operations by allowing applications to interact with device using opaque
202 structures/buffers. Also, southbound APIs provide APIs for integrating device
203 either as as part of a physical bus (PCI, FSLMC etc) or through ``vdev``.
205 See the :doc:`../prog_guide/rawdev` programmer's guide for more details.
207 * **Added new multi-process communication channel**
209 Added a generic channel in EAL for multi-process (primary/secondary) communication.
210 Consumers of this channel need to register an action with an action name to response
211 a message received; the actions will be identified by the action name and executed
212 in the context of a new dedicated thread for this channel. The list of new APIs:
214 * ``rte_mp_register`` and ``rte_mp_unregister`` are for action (un)registration.
215 * ``rte_mp_sendmsg`` is for sending a message without blocking for a response.
216 * ``rte_mp_request`` is for sending a request message and will block until
217 it gets a reply message which is sent from the peer by ``rte_mp_reply``.
219 * **Added new DPDK build system using the tools "meson" and "ninja" [EXPERIMENTAL]**
221 Added in support for building DPDK using ``meson`` and ``ninja``, which gives
222 additional features, such as automatic build-time configuration, over the
223 current build system using ``make``. For instructions on how to do a DPDK build
224 using the new system, see the instructions in ``doc/build-sdk-meson.txt``.
228 This new build system support is incomplete at this point and is added
229 as experimental in this release. The existing build system using ``make``
230 is unaffected by these changes, and can continue to be used for this
231 and subsequent releases until such time as it's deprecation is announced.
237 .. This section should contain API changes. Sample format:
239 * Add a short 1-2 sentence description of the API change. Use fixed width
240 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
243 This section is a comment. do not overwrite or remove it.
244 Also, make sure to start the actual text at the margin.
245 =========================================================
251 .. This section should contain ABI changes. Sample format:
253 * Add a short 1-2 sentence description of the ABI change that was announced
254 in the previous releases and made in this release. Use fixed width quotes
255 for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
257 This section is a comment. do not overwrite or remove it.
258 Also, make sure to start the actual text at the margin.
259 =========================================================
265 .. This section should contain removed items in this release. Sample format:
267 * Add a short 1-2 sentence description of the removed item in 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 new known issues in this release. Sample format:
280 * **Add title in present tense with full stop.**
282 Add a short 1-2 sentence description of the known issue in the present
283 tense. Add information on any known workarounds.
285 This section is a comment. do not overwrite or remove it.
286 Also, make sure to start the actual text at the margin.
287 =========================================================
290 Shared Library Versions
291 -----------------------
293 .. Update any library version updated in this release and prepend with a ``+``
297 + librte_cfgfile.so.2
300 This section is a comment. do not overwrite or remove it.
301 =========================================================
304 The libraries prepended with a plus sign were incremented in this version.
310 librte_bitratestats.so.2
312 librte_bus_fslmc.so.1
317 librte_cryptodev.so.4
318 librte_distributor.so.1
322 librte_flow_classify.so.1
330 librte_latencystats.so.1
343 librte_pmd_ixgbe.so.2
345 librte_pmd_softnic.so.1
346 librte_pmd_vhost.so.2
363 .. This section should contain a list of platforms that were tested with this
368 * <vendor> platform with <vendor> <type of devices> combinations
373 * Other relevant details...
375 This section is a comment. do not overwrite or remove it.
376 Also, make sure to start the actual text at the margin.
377 =========================================================