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.
75 * **Added Ethernet poll mode driver for AMD XGBE devices.**
77 Added the new ``axgbe`` ethernet poll mode driver for AMD XGBE devices.
78 See the :doc:`../nics/axgbe` nic driver guide for more details on this
81 * **Updated szedata2 PMD.**
83 Added support for new NFB-200G2QL card.
85 * **Added support for Broadcom NetXtreme-S (BCM58800) family of controllers (aka Stingray)**
87 The BCM58800 devices feature a NetXtreme E-Series advanced network controller, a high-performance
88 ARM CPU block, PCI Express (PCIe) Gen3 interfaces, key accelerators for compute offload and a high-
89 speed memory subsystem including L3 cache and DDR4 interfaces, all interconnected by a coherent
90 Network-on-chip (NOC) fabric.
92 The ARM CPU subsystem features eight ARMv8 Cortex-A72 CPUs at 3.0 GHz, arranged in a multi-cluster
95 * **Added support for virtio-user server mode.**
96 In a container environment if the vhost-user backend restarts, there's no way
97 for it to reconnect to virtio-user. To address this, support for server mode
98 is added. In this mode the socket file is created by virtio-user, which the
99 backend connects to. This means that if the backend restarts, it can reconnect
100 to virtio-user and continue communications.
102 * **Added crypto workload support to vhost library.**
104 New APIs are introduced in vhost library to enable virtio crypto support
105 including session creation/deletion handling and translating virtio-crypto
106 request into DPDK crypto operations. A sample application is also introduced.
108 * **Added virtio crypto PMD.**
110 Added a new poll mode driver for virtio crypto devices, which provides
111 AES-CBC ciphering and AES-CBC with HMAC-SHA1 algorithm-chaining. See the
112 :doc:`../cryptodevs/virtio` crypto driver guide for more details on
115 * **Added AMD CCP Crypto PMD.**
117 Added the new ``ccp`` crypto driver for AMD CCP devices. See the
118 :doc:`../cryptodevs/ccp` crypto driver guide for more details on
121 * **Updated AESNI MB PMD.**
123 The AESNI MB PMD has been updated with additional support for:
125 * AES-CMAC (128-bit key).
127 * **Added the Event Timer Adapter Library.**
129 The Event Timer Adapter Library extends the event-based model by introducing
130 APIs that allow applications to arm/cancel event timers that generate
131 timer expiry events. This new type of event is scheduled by an event device
132 along with existing types of events.
134 * **Added device event monitor framework.**
136 Added a general device event monitor framework at EAL, for device dynamic management.
137 Such as device hotplug awareness and actions adopted accordingly. The list of new APIs:
139 * ``rte_dev_event_monitor_start`` and ``rte_dev_event_monitor_stop`` are for
140 the event monitor enable and disable.
141 * ``rte_dev_event_callback_register`` and ``rte_dev_event_callback_unregister``
142 are for the user's callbacks register and unregister.
144 Linux uevent is supported as backend of this device event notification framework.
146 * **Added support for procinfo and pdump on eth vdev.**
148 For ethernet virtual devices (like tap, pcap, etc), with this feature, we can get
149 stats/xstats on shared memory from secondary process, and also pdump packets on
150 those virtual devices.
156 .. This section should contain API changes. Sample format:
158 * Add a short 1-2 sentence description of the API change. Use fixed width
159 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
162 This section is a comment. Do not overwrite or remove it.
163 Also, make sure to start the actual text at the margin.
164 =========================================================
166 * service cores: no longer marked as experimental.
168 The service cores functions are no longer marked as experimental, and have
169 become part of the normal DPDK API and ABI. Any future ABI changes will be
170 announced at least one release before the ABI change is made. There are no
171 ABI breaking changes planned.
173 * eal: ``rte_lcore_has_role()`` return value changed.
175 This function now returns true or false, respectively,
176 rather than 0 or <0 for success or failure.
177 It makes use of the function more intuitive.
179 * mempool: capability flags and related functions have been removed.
181 Flags ``MEMPOOL_F_CAPA_PHYS_CONTIG`` and
182 ``MEMPOOL_F_CAPA_BLK_ALIGNED_OBJECTS`` were used by octeontx mempool
183 driver to customize generic mempool library behaviour.
184 Now the new driver callbacks ``calc_mem_size`` and ``populate`` may be
185 used to achieve it without specific knowledge in the generic code.
187 * mempool: xmem functions have been deprecated:
189 - ``rte_mempool_xmem_create``
190 - ``rte_mempool_xmem_size``
191 - ``rte_mempool_xmem_usage``
192 - ``rte_mempool_populate_iova_tab``
194 * mbuf: The control mbuf API has been removed in v18.05. The impacted
195 functions and macros are:
197 - ``rte_ctrlmbuf_init()``
198 - ``rte_ctrlmbuf_alloc()``
199 - ``rte_ctrlmbuf_free()``
200 - ``rte_ctrlmbuf_data()``
201 - ``rte_ctrlmbuf_len()``
202 - ``rte_is_ctrlmbuf()``
205 The packet mbuf API should be used as a replacement.
207 * meter: updated to accommodate configuration profiles.
209 The meter API is changed to support meter configuration profiles. The
210 configuration profile represents the set of configuration parameters
211 for a given meter object, such as the rates and sizes for the token
212 buckets. These configuration parameters were previously the part of meter
213 object internal data strcuture. The separation of the configuration
214 parameters from meter object data structure results in reducing its
215 memory footprint which helps in better cache utilization when large number
216 of meter objects are used.
218 * ethdev: The function ``rte_eth_dev_count``, often mis-used to iterate
219 over ports, is deprecated and replaced by ``rte_eth_dev_count_avail``.
220 There is also a new function ``rte_eth_dev_count_total`` to get the
221 total number of allocated ports, available or not.
222 The hotplug-proof applications should use ``RTE_ETH_FOREACH_DEV`` or
223 ``RTE_ETH_FOREACH_DEV_OWNED_BY`` as port iterators.
225 * ethdev, in struct ``struct rte_eth_dev_info``, field ``rte_pci_device *pci_dev``
226 replaced with field ``struct rte_device *device``.
228 * **Changes to semantics of rte_eth_dev_configure() parameters.**
230 If both the ``nb_rx_q`` and ``nb_tx_q`` parameters are zero,
231 ``rte_eth_dev_configure`` will now use PMD-recommended queue sizes, or if
232 recommendations are not provided by the PMD the function will use ethdev
233 fall-back values. Previously setting both of the parameters to zero would
234 have resulted in ``-EINVAL`` being returned.
236 * **Changes to semantics of rte_eth_rx_queue_setup() parameters.**
238 If the ``nb_rx_desc`` parameter is zero, ``rte_eth_rx_queue_setup`` will
239 now use the PMD-recommended Rx ring size, or in the case where the PMD
240 does not provide a recommendation, will use an ethdev-provided
241 fall-back value. Previously, setting ``nb_rx_desc`` to zero would have
242 resulted in an error.
244 * **Changes to semantics of rte_eth_tx_queue_setup() parameters.**
246 If the ``nb_tx_desc`` parameter is zero, ``rte_eth_tx_queue_setup`` will
247 now use the PMD-recommended Tx ring size, or in the case where the PMD
248 does not provide a recoomendation, will use an ethdev-provided
249 fall-back value. Previously, setting ``nb_tx_desc`` to zero would have
250 resulted in an error.
256 .. This section should contain ABI changes. Sample format:
258 * Add a short 1-2 sentence description of the ABI change that was announced
259 in the previous releases and made in this release. Use fixed width quotes
260 for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
262 This section is a comment. Do not overwrite or remove it.
263 Also, make sure to start the actual text at the margin.
264 =========================================================
266 * ring: the alignment constraints on the ring structure has been relaxed
267 to one cache line instead of two, and an empty cache line padding is
268 added between the producer and consumer structures. The size of the
269 structure and the offset of the fields remains the same on platforms
270 with 64B cache line, but change on other platforms.
272 * mempool: ops have changed.
274 A new callback ``calc_mem_size`` has been added to ``rte_mempool_ops``
275 to allow to customize required memory size calculation.
276 A new callback ``populate`` has been added to ``rte_mempool_ops``
277 to allow to customize objects population.
278 Callback ``get_capabilities`` has been removed from ``rte_mempool_ops``
279 since its features are covered by ``calc_mem_size`` and ``populate``
281 Callback ``register_memory_area`` has been removed from ``rte_mempool_ops``
282 since the new callback ``populate`` may be used instead of it.
284 * **Additional fields in rte_eth_dev_info.**
286 The ``rte_eth_dev_info`` structure has had two extra entries appended to the
287 end of it: ``default_rxportconf`` and ``default_txportconf``. Each of these
288 in turn are ``rte_eth_dev_portconf`` structures containing three fields of
289 type ``uint16_t``: ``burst_size``, ``ring_size``, and ``nb_queues``. These
290 are parameter values recommended for use by the PMD.
296 .. This section should contain removed items in this release. Sample format:
298 * Add a short 1-2 sentence description of the removed item in the past
301 This section is a comment. Do not overwrite or remove it.
302 Also, make sure to start the actual text at the margin.
303 =========================================================
309 .. This section should contain new known issues in this release. Sample format:
311 * **Add title in present tense with full stop.**
313 Add a short 1-2 sentence description of the known issue in the present
314 tense. Add information on any known workarounds.
316 This section is a comment. Do not overwrite or remove it.
317 Also, make sure to start the actual text at the margin.
318 =========================================================
320 * **pdump is not compatible with old applications.**
322 As we changed to use generic multi-process communication for pdump negotiation
323 instead of previous dedicated unix socket way, pdump applications, including
324 dpdk-pdump example and any other applications using librte_pdump, cannot work
325 with older version DPDK primary applications.
328 Shared Library Versions
329 -----------------------
331 .. Update any library version updated in this release and prepend with a ``+``
335 + librte_cfgfile.so.2
338 This section is a comment. Do not overwrite or remove it.
339 =========================================================
342 The libraries prepended with a plus sign were incremented in this version.
348 librte_bitratestats.so.2
350 librte_bus_fslmc.so.1
355 + librte_common_octeontx.so.1
356 librte_cryptodev.so.4
357 librte_distributor.so.1
361 librte_flow_classify.so.1
369 librte_latencystats.so.1
372 + librte_mempool.so.4
382 librte_pmd_ixgbe.so.2
384 librte_pmd_softnic.so.1
385 librte_pmd_vhost.so.2
401 .. This section should contain a list of platforms that were tested with this
406 * <vendor> platform with <vendor> <type of devices> combinations
411 * Other relevant details...
413 This section is a comment. Do not overwrite or remove it.
414 Also, make sure to start the actual text at the margin.
415 =========================================================