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_05.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 * **Added bucket mempool driver.**
46 Added bucket mempool driver which provides a way to allocate contiguous
48 Number of objects in the block depends on how many objects fit in
49 RTE_DRIVER_MEMPOOL_BUCKET_SIZE_KB memory chunk which is build time option.
50 The number may be obtained using rte_mempool_ops_get_info() API.
51 Contiguous blocks may be allocated using rte_mempool_get_contig_blocks() API.
53 * **Added PMD-recommended Tx and Rx parameters**
55 Applications can now query drivers for device-tuned values of
56 ring sizes, burst sizes, and number of queues.
58 * **Added RSS hash and key update to CXGBE PMD.**
60 Support to update RSS hash and key has been added to CXGBE PMD.
62 * **Added CXGBE VF PMD.**
64 CXGBE VF Poll Mode Driver has been added to run DPDK over Chelsio
65 T5/T6 NIC VF instances.
67 * **Updated Solarflare network PMD.**
69 Updated the sfc_efx driver including the following changes:
71 * Added support for Solarflare XtremeScale X2xxx family adapters.
72 * Added support for NVGRE, VXLAN and GENEVE filters in flow API.
73 * Added support for DROP action in flow API.
74 * Added support for equal stride super-buffer Rx mode (X2xxx only).
75 * Added support for MARK and FLAG actions in flow API (X2xxx only).
77 * **Added Ethernet poll mode driver for AMD XGBE devices.**
79 Added the new ``axgbe`` ethernet poll mode driver for AMD XGBE devices.
80 See the :doc:`../nics/axgbe` nic driver guide for more details on this
83 * **Updated szedata2 PMD.**
85 Added support for new NFB-200G2QL card.
86 New API was introduced in the libsze2 library which the szedata2 PMD depends
87 on thus the new version of the library was needed.
88 New versions of the packages are available and the minimum required version
91 * **Added support for Broadcom NetXtreme-S (BCM58800) family of controllers (aka Stingray)**
93 The BCM58800 devices feature a NetXtreme E-Series advanced network controller, a high-performance
94 ARM CPU block, PCI Express (PCIe) Gen3 interfaces, key accelerators for compute offload and a high-
95 speed memory subsystem including L3 cache and DDR4 interfaces, all interconnected by a coherent
96 Network-on-chip (NOC) fabric.
98 The ARM CPU subsystem features eight ARMv8 Cortex-A72 CPUs at 3.0 GHz, arranged in a multi-cluster
101 * **Added IFCVF vDPA driver.**
103 Added IFCVF vDPA driver to support Intel FPGA 100G VF device. IFCVF works
104 as a HW vhost data path accelerator, it supports live migration and is
105 compatible with virtio 0.95 and 1.0. This driver registers ifcvf vDPA driver
106 to vhost lib, when virtio connected, with the help of the registered vDPA
107 driver the assigned VF gets configured to Rx/Tx directly to VM's virtio
110 * **Added support for virtio-user server mode.**
111 In a container environment if the vhost-user backend restarts, there's no way
112 for it to reconnect to virtio-user. To address this, support for server mode
113 is added. In this mode the socket file is created by virtio-user, which the
114 backend connects to. This means that if the backend restarts, it can reconnect
115 to virtio-user and continue communications.
117 * **Added crypto workload support to vhost library.**
119 New APIs are introduced in vhost library to enable virtio crypto support
120 including session creation/deletion handling and translating virtio-crypto
121 request into DPDK crypto operations. A sample application is also introduced.
123 * **Added virtio crypto PMD.**
125 Added a new poll mode driver for virtio crypto devices, which provides
126 AES-CBC ciphering and AES-CBC with HMAC-SHA1 algorithm-chaining. See the
127 :doc:`../cryptodevs/virtio` crypto driver guide for more details on
130 * **Added AMD CCP Crypto PMD.**
132 Added the new ``ccp`` crypto driver for AMD CCP devices. See the
133 :doc:`../cryptodevs/ccp` crypto driver guide for more details on
136 * **Updated AESNI MB PMD.**
138 The AESNI MB PMD has been updated with additional support for:
140 * AES-CMAC (128-bit key).
142 * **Added Compressdev Library, a generic compression service library.**
144 The compressdev library provides an API for offload of compression and
145 decompression operations to hardware or software accelerator devices.
147 * **Added a new compression poll mode driver using Intels ISA-L.**
149 Added the new ``ISA-L`` compression driver, for compression and decompression
150 operations in software. See the :doc:`../compressdevs/isal` compression driver
151 guide for details on this new driver.
153 * **Added the Event Timer Adapter Library.**
155 The Event Timer Adapter Library extends the event-based model by introducing
156 APIs that allow applications to arm/cancel event timers that generate
157 timer expiry events. This new type of event is scheduled by an event device
158 along with existing types of events.
160 * **Added OcteonTx TIM Driver (Event timer adapter).**
162 The OcteonTx Timer block enables software to schedule events for a future
163 time, it is exposed to an application via Event timer adapter library.
165 See the :doc:`../eventdevs/octeontx` guide for more details
167 * **Added Event Crypto Adapter Library.**
169 Added the Event Crypto Adapter Library. This library extends the
170 event-based model by introducing APIs that allow applications to
171 enqueue/dequeue crypto operations to/from cryptodev as events scheduled
174 * **Added Ifpga Bus, a generic Intel FPGA Bus library.**
176 The Ifpga Bus library provides support for integrating any Intel FPGA device with
177 the DPDK framework. It provides Intel FPGA Partial Bit Stream AFU (Accelerated
178 Function Unit) scan and drivers probe.
180 * **Added IFPGA (Intel FPGA) Rawdev Driver.**
182 Added a new Rawdev driver called IFPGA(Intel FPGA) Rawdev Driver, which cooperates
183 with OPAE (Open Programmable Acceleration Engine) share code provides common FPGA
184 management ops for FPGA operation.
186 See the :doc:`../rawdevs/ifpga_rawdev` programmer's guide for more details.
188 * **Added DPAA2 QDMA Driver (in rawdev).**
190 The DPAA2 QDMA is an implementation of the rawdev API, that provide means
191 to initiate a DMA transaction from CPU. The initiated DMA is performed
192 without CPU being involved in the actual DMA transaction.
194 See the :doc:`../rawdevs/dpaa2_qdma` guide for more details.
196 * **Added DPAA2 Command Interface Driver (in rawdev).**
198 The DPAA2 CMDIF is an implementation of the rawdev API, that provides
199 communication between the GPP and NXP's QorIQ based AIOP Block (Firmware).
200 Advanced IO Processor i.e. AIOP is clusters of programmable RISC engines
201 optimised for flexible networking and I/O operations. The communication
202 between GPP and AIOP is achieved via using DPCI devices exposed by MC for
203 GPP <--> AIOP interaction.
205 See the :doc:`../rawdevs/dpaa2_cmdif` guide for more details.
207 * **Added device event monitor framework.**
209 Added a general device event monitor framework at EAL, for device dynamic management.
210 Such as device hotplug awareness and actions adopted accordingly. The list of new APIs:
212 * ``rte_dev_event_monitor_start`` and ``rte_dev_event_monitor_stop`` are for
213 the event monitor enable and disable.
214 * ``rte_dev_event_callback_register`` and ``rte_dev_event_callback_unregister``
215 are for the user's callbacks register and unregister.
217 Linux uevent is supported as backend of this device event notification framework.
219 * **Added support for procinfo and pdump on eth vdev.**
221 For ethernet virtual devices (like tap, pcap, etc), with this feature, we can get
222 stats/xstats on shared memory from secondary process, and also pdump packets on
223 those virtual devices.
225 * **Added the BPF Library.**
227 The BPF Library provides the ability to load and execute
228 Enhanced Berkeley Packet Filter (eBPF) within user-space dpdk application.
229 Also it introduces basic framework to load/unload BPF-based filters
230 on eth devices (right now only via SW RX/TX callbacks).
231 It also adds dependency on libelf.
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 =========================================================
247 * service cores: no longer marked as experimental.
249 The service cores functions are no longer marked as experimental, and have
250 become part of the normal DPDK API and ABI. Any future ABI changes will be
251 announced at least one release before the ABI change is made. There are no
252 ABI breaking changes planned.
254 * eal: ``rte_lcore_has_role()`` return value changed.
256 This function now returns true or false, respectively,
257 rather than 0 or <0 for success or failure.
258 It makes use of the function more intuitive.
260 * mempool: capability flags and related functions have been removed.
262 Flags ``MEMPOOL_F_CAPA_PHYS_CONTIG`` and
263 ``MEMPOOL_F_CAPA_BLK_ALIGNED_OBJECTS`` were used by octeontx mempool
264 driver to customize generic mempool library behaviour.
265 Now the new driver callbacks ``calc_mem_size`` and ``populate`` may be
266 used to achieve it without specific knowledge in the generic code.
268 * mempool: xmem functions have been deprecated:
270 - ``rte_mempool_xmem_create``
271 - ``rte_mempool_xmem_size``
272 - ``rte_mempool_xmem_usage``
273 - ``rte_mempool_populate_iova_tab``
275 * mbuf: The control mbuf API has been removed in v18.05. The impacted
276 functions and macros are:
278 - ``rte_ctrlmbuf_init()``
279 - ``rte_ctrlmbuf_alloc()``
280 - ``rte_ctrlmbuf_free()``
281 - ``rte_ctrlmbuf_data()``
282 - ``rte_ctrlmbuf_len()``
283 - ``rte_is_ctrlmbuf()``
286 The packet mbuf API should be used as a replacement.
288 * meter: updated to accommodate configuration profiles.
290 The meter API is changed to support meter configuration profiles. The
291 configuration profile represents the set of configuration parameters
292 for a given meter object, such as the rates and sizes for the token
293 buckets. These configuration parameters were previously the part of meter
294 object internal data strcuture. The separation of the configuration
295 parameters from meter object data structure results in reducing its
296 memory footprint which helps in better cache utilization when large number
297 of meter objects are used.
299 * ethdev: The function ``rte_eth_dev_count``, often mis-used to iterate
300 over ports, is deprecated and replaced by ``rte_eth_dev_count_avail``.
301 There is also a new function ``rte_eth_dev_count_total`` to get the
302 total number of allocated ports, available or not.
303 The hotplug-proof applications should use ``RTE_ETH_FOREACH_DEV`` or
304 ``RTE_ETH_FOREACH_DEV_OWNED_BY`` as port iterators.
306 * ethdev, in struct ``struct rte_eth_dev_info``, field ``rte_pci_device *pci_dev``
307 replaced with field ``struct rte_device *device``.
309 * **Changes to semantics of rte_eth_dev_configure() parameters.**
311 If both the ``nb_rx_q`` and ``nb_tx_q`` parameters are zero,
312 ``rte_eth_dev_configure`` will now use PMD-recommended queue sizes, or if
313 recommendations are not provided by the PMD the function will use ethdev
314 fall-back values. Previously setting both of the parameters to zero would
315 have resulted in ``-EINVAL`` being returned.
317 * **Changes to semantics of rte_eth_rx_queue_setup() parameters.**
319 If the ``nb_rx_desc`` parameter is zero, ``rte_eth_rx_queue_setup`` will
320 now use the PMD-recommended Rx ring size, or in the case where the PMD
321 does not provide a recommendation, will use an ethdev-provided
322 fall-back value. Previously, setting ``nb_rx_desc`` to zero would have
323 resulted in an error.
325 * **Changes to semantics of rte_eth_tx_queue_setup() parameters.**
327 If the ``nb_tx_desc`` parameter is zero, ``rte_eth_tx_queue_setup`` will
328 now use the PMD-recommended Tx ring size, or in the case where the PMD
329 does not provide a recoomendation, will use an ethdev-provided
330 fall-back value. Previously, setting ``nb_tx_desc`` to zero would have
331 resulted in an error.
333 * ethdev: several changes were made to the flow API.
335 * Unused DUP action was removed.
336 * Actions semantics in flow rules: list order now matters ("first
337 to last" instead of "all simultaneously"), repeated actions are now
338 all performed, and they do not individually have (non-)terminating
340 * Flow rules are now always terminating unless a PASSTHRU action is
342 * C99-style flexible arrays were replaced with standard pointers in RSS
343 action and in RAW pattern item structures due to compatibility issues.
344 * The RSS action was modified to not rely on external
345 ``struct rte_eth_rss_conf`` anymore to instead expose its own and more
346 appropriately named configuration fields directly
347 (``rss_conf->rss_key`` => ``key``,
348 ``rss_conf->rss_key_len`` => ``key_len``,
349 ``rss_conf->rss_hf`` => ``types``,
350 ``num`` => ``queue_num``), and the addition of missing RSS parameters
351 (``func`` for RSS hash function to apply and ``level`` for the
352 encapsulation level).
353 * The VLAN pattern item (``struct rte_flow_item_vlan``) was modified to
354 include inner EtherType instead of outer TPID. Its default mask was also
355 modified to cover the VID part (lower 12 bits) of TCI only.
356 * A new transfer attribute was added to ``struct rte_flow_attr`` in order
357 to clarify the behavior of some pattern items.
358 * PF and VF pattern items are now only accepted by PMDs that implement
359 them (bnxt and i40e) when the transfer attribute is also present for
361 * Pattern item PORT was renamed PHY_PORT to avoid confusion with DPDK port
363 * An action counterpart to the PHY_PORT pattern item was added in order to
364 redirect matching traffic to a specific physical port.
365 * PORT_ID pattern item and actions were added to match and target DPDK
366 port IDs at a higher level than PHY_PORT.
368 * ethdev: change flow APIs regarding count action:
369 * ``rte_flow_create()`` API count action now requires the ``struct rte_flow_action_count``.
370 * ``rte_flow_query()`` API parameter changed from action type to action structure.
372 * ethdev: changes to offload API
374 A pure per-port offloading isn't requested to be repeated in [rt]x_conf->offloads to
375 ``rte_eth_[rt]x_queue_setup()``. Now any offloading enabled in ``rte_eth_dev_configure()``
376 can't be disabled by ``rte_eth_[rt]x_queue_setup()``. Any new added offloading which has
377 not been enabled in ``rte_eth_dev_configure()`` and is requested to be enabled in
378 ``rte_eth_[rt]x_queue_setup()`` must be per-queue type, otherwise trigger an error log.
384 .. This section should contain ABI changes. Sample format:
386 * Add a short 1-2 sentence description of the ABI change that was announced
387 in the previous releases and made in this release. Use fixed width quotes
388 for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
390 This section is a comment. Do not overwrite or remove it.
391 Also, make sure to start the actual text at the margin.
392 =========================================================
394 * ring: the alignment constraints on the ring structure has been relaxed
395 to one cache line instead of two, and an empty cache line padding is
396 added between the producer and consumer structures. The size of the
397 structure and the offset of the fields remains the same on platforms
398 with 64B cache line, but change on other platforms.
400 * mempool: ops have changed.
402 A new callback ``calc_mem_size`` has been added to ``rte_mempool_ops``
403 to allow to customize required memory size calculation.
404 A new callback ``populate`` has been added to ``rte_mempool_ops``
405 to allow to customize objects population.
406 Callback ``get_capabilities`` has been removed from ``rte_mempool_ops``
407 since its features are covered by ``calc_mem_size`` and ``populate``
409 Callback ``register_memory_area`` has been removed from ``rte_mempool_ops``
410 since the new callback ``populate`` may be used instead of it.
412 * **Additional fields in rte_eth_dev_info.**
414 The ``rte_eth_dev_info`` structure has had two extra entries appended to the
415 end of it: ``default_rxportconf`` and ``default_txportconf``. Each of these
416 in turn are ``rte_eth_dev_portconf`` structures containing three fields of
417 type ``uint16_t``: ``burst_size``, ``ring_size``, and ``nb_queues``. These
418 are parameter values recommended for use by the PMD.
420 * ethdev: ABI for all flow API functions was updated.
422 This includes functions ``rte_flow_copy``, ``rte_flow_create``,
423 ``rte_flow_destroy``, ``rte_flow_error_set``, ``rte_flow_flush``,
424 ``rte_flow_isolate``, ``rte_flow_query`` and ``rte_flow_validate``, due to
425 changes in error type definitions (``enum rte_flow_error_type``), removal
426 of the unused DUP action (``enum rte_flow_action_type``), modified
427 behavior for flow rule actions (see API changes), removal of C99 flexible
428 array from RAW pattern item (``struct rte_flow_item_raw``), complete
429 rework of the RSS action definition (``struct rte_flow_action_rss``),
430 sanity fix in the VLAN pattern item (``struct rte_flow_item_vlan``) and
431 new transfer attribute (``struct rte_flow_attr``).
433 **New parameter added to rte_bbdev_op_cap_turbo_dec.**
435 A new parameter ``max_llr_modulus`` has been added to
436 ``rte_bbdev_op_cap_turbo_dec`` structure to specify maximal LLR (likelihood
437 ratio) absolute value.
439 * **BBdev Queue Groups split into UL/DL Groups**
441 Queue Groups have been split into UL/DL Groups in Turbo Software Driver.
442 They are independent for Decode/Encode. ``rte_bbdev_driver_info`` reflects
449 .. This section should contain removed items in this release. Sample format:
451 * Add a short 1-2 sentence description of the removed item in the past
454 This section is a comment. Do not overwrite or remove it.
455 Also, make sure to start the actual text at the margin.
456 =========================================================
462 .. This section should contain new known issues in this release. Sample format:
464 * **Add title in present tense with full stop.**
466 Add a short 1-2 sentence description of the known issue in the present
467 tense. Add information on any known workarounds.
469 This section is a comment. Do not overwrite or remove it.
470 Also, make sure to start the actual text at the margin.
471 =========================================================
473 * **pdump is not compatible with old applications.**
475 As we changed to use generic multi-process communication for pdump negotiation
476 instead of previous dedicated unix socket way, pdump applications, including
477 dpdk-pdump example and any other applications using librte_pdump, cannot work
478 with older version DPDK primary applications.
481 Shared Library Versions
482 -----------------------
484 .. Update any library version updated in this release and prepend with a ``+``
488 + librte_cfgfile.so.2
491 This section is a comment. Do not overwrite or remove it.
492 =========================================================
495 The libraries prepended with a plus sign were incremented in this version.
501 librte_bitratestats.so.2
504 librte_bus_fslmc.so.1
509 + librte_common_octeontx.so.1
510 + librte_compressdev.so.1
511 librte_cryptodev.so.4
512 librte_distributor.so.1
515 + librte_eventdev.so.4
516 librte_flow_classify.so.1
524 librte_latencystats.so.1
527 + librte_mempool.so.4
537 librte_pmd_ixgbe.so.2
538 + librte_pmd_dpaa2_cmdif.so.1
539 + librte_pmd_dpaa2_qdma.so.1
541 librte_pmd_softnic.so.1
542 librte_pmd_vhost.so.2
558 .. This section should contain a list of platforms that were tested with this
563 * <vendor> platform with <vendor> <type of devices> combinations
568 * Other relevant details...
570 This section is a comment. Do not overwrite or remove it.
571 Also, make sure to start the actual text at the margin.
572 =========================================================