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 PMD-recommended Tx and Rx parameters**
46 Applications can now query drivers for device-tuned values of
47 ring sizes, burst sizes, and number of queues.
49 * **Added RSS hash and key update to CXGBE PMD.**
51 Support to update RSS hash and key has been added to CXGBE PMD.
53 * **Added CXGBE VF PMD.**
55 CXGBE VF Poll Mode Driver has been added to run DPDK over Chelsio
56 T5/T6 NIC VF instances.
58 * **Updated Solarflare network PMD.**
60 Updated the sfc_efx driver including the following changes:
62 * Added support for Solarflare XtremeScale X2xxx family adapters.
63 * Added support for NVGRE, VXLAN and GENEVE filters in flow API.
64 * Added support for DROP action in flow API.
66 * **Added Ethernet poll mode driver for AMD XGBE devices.**
68 Added the new ``axgbe`` ethernet poll mode driver for AMD XGBE devices.
69 See the :doc:`../nics/axgbe` nic driver guide for more details on this
72 * **Updated szedata2 PMD.**
74 Added support for new NFB-200G2QL card.
76 * **Added support for Broadcom NetXtreme-S (BCM58800) family of controllers (aka Stingray)**
78 The BCM58800 devices feature a NetXtreme E-Series advanced network controller, a high-performance
79 ARM CPU block, PCI Express (PCIe) Gen3 interfaces, key accelerators for compute offload and a high-
80 speed memory subsystem including L3 cache and DDR4 interfaces, all interconnected by a coherent
81 Network-on-chip (NOC) fabric.
83 The ARM CPU subsystem features eight ARMv8 Cortex-A72 CPUs at 3.0 GHz, arranged in a multi-cluster
86 * **Added support for virtio-user server mode.**
87 In a container environment if the vhost-user backend restarts, there's no way
88 for it to reconnect to virtio-user. To address this, support for server mode
89 is added. In this mode the socket file is created by virtio-user, which the
90 backend connects to. This means that if the backend restarts, it can reconnect
91 to virtio-user and continue communications.
93 * **Added crypto workload support to vhost library.**
95 New APIs are introduced in vhost library to enable virtio crypto support
96 including session creation/deletion handling and translating virtio-crypto
97 request into DPDK crypto operations. A sample application is also introduced.
99 * **Added virtio crypto PMD.**
101 Added a new poll mode driver for virtio crypto devices, which provides
102 AES-CBC ciphering and AES-CBC with HMAC-SHA1 algorithm-chaining. See the
103 :doc:`../cryptodevs/virtio` crypto driver guide for more details on
106 * **Added AMD CCP Crypto PMD.**
108 Added the new ``ccp`` crypto driver for AMD CCP devices. See the
109 :doc:`../cryptodevs/ccp` crypto driver guide for more details on
112 * **Updated AESNI MB PMD.**
114 The AESNI MB PMD has been updated with additional support for:
116 * AES-CMAC (128-bit key).
118 * **Added the Event Timer Adapter Library.**
120 The Event Timer Adapter Library extends the event-based model by introducing
121 APIs that allow applications to arm/cancel event timers that generate
122 timer expiry events. This new type of event is scheduled by an event device
123 along with existing types of events.
125 * **Added device event monitor framework.**
127 Added a general device event monitor framework at EAL, for device dynamic management.
128 Such as device hotplug awareness and actions adopted accordingly. The list of new APIs:
130 * ``rte_dev_event_monitor_start`` and ``rte_dev_event_monitor_stop`` are for
131 the event monitor enable and disable.
132 * ``rte_dev_event_callback_register`` and ``rte_dev_event_callback_unregister``
133 are for the user's callbacks register and unregister.
135 Linux uevent is supported as backend of this device event notification framework.
141 .. This section should contain API changes. Sample format:
143 * Add a short 1-2 sentence description of the API change. Use fixed width
144 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
147 This section is a comment. Do not overwrite or remove it.
148 Also, make sure to start the actual text at the margin.
149 =========================================================
151 * mempool: capability flags and related functions have been removed.
153 Flags ``MEMPOOL_F_CAPA_PHYS_CONTIG`` and
154 ``MEMPOOL_F_CAPA_BLK_ALIGNED_OBJECTS`` were used by octeontx mempool
155 driver to customize generic mempool library behaviour.
156 Now the new driver callbacks ``calc_mem_size`` and ``populate`` may be
157 used to achieve it without specific knowledge in the generic code.
159 * mempool: xmem functions have been deprecated:
161 - ``rte_mempool_xmem_create``
162 - ``rte_mempool_xmem_size``
163 - ``rte_mempool_xmem_usage``
164 - ``rte_mempool_populate_iova_tab``
166 * mbuf: The control mbuf API has been removed in v18.05. The impacted
167 functions and macros are:
169 - ``rte_ctrlmbuf_init()``
170 - ``rte_ctrlmbuf_alloc()``
171 - ``rte_ctrlmbuf_free()``
172 - ``rte_ctrlmbuf_data()``
173 - ``rte_ctrlmbuf_len()``
174 - ``rte_is_ctrlmbuf()``
177 The packet mbuf API should be used as a replacement.
179 * meter: updated to accommodate configuration profiles.
181 The meter API is changed to support meter configuration profiles. The
182 configuration profile represents the set of configuration parameters
183 for a given meter object, such as the rates and sizes for the token
184 buckets. These configuration parameters were previously the part of meter
185 object internal data strcuture. The separation of the configuration
186 parameters from meter object data structure results in reducing its
187 memory footprint which helps in better cache utilization when large number
188 of meter objects are used.
190 * ethdev: The function ``rte_eth_dev_count``, often mis-used to iterate
191 over ports, is deprecated and replaced by ``rte_eth_dev_count_avail``.
192 There is also a new function ``rte_eth_dev_count_total`` to get the
193 total number of allocated ports, available or not.
194 The hotplug-proof applications should use ``RTE_ETH_FOREACH_DEV`` or
195 ``RTE_ETH_FOREACH_DEV_OWNED_BY`` as port iterators.
197 * ethdev, in struct ``struct rte_eth_dev_info``, field ``rte_pci_device *pci_dev``
198 replaced with field ``struct rte_device *device``.
200 * **Changes to semantics of rte_eth_dev_configure() parameters.**
202 If both the ``nb_rx_q`` and ``nb_tx_q`` parameters are zero,
203 ``rte_eth_dev_configure`` will now use PMD-recommended queue sizes, or if
204 recommendations are not provided by the PMD the function will use ethdev
205 fall-back values. Previously setting both of the parameters to zero would
206 have resulted in ``-EINVAL`` being returned.
208 * **Changes to semantics of rte_eth_rx_queue_setup() parameters.**
210 If the ``nb_rx_desc`` parameter is zero, ``rte_eth_rx_queue_setup`` will
211 now use the PMD-recommended Rx ring size, or in the case where the PMD
212 does not provide a recommendation, will use an ethdev-provided
213 fall-back value. Previously, setting ``nb_rx_desc`` to zero would have
214 resulted in an error.
216 * **Changes to semantics of rte_eth_tx_queue_setup() parameters.**
218 If the ``nb_tx_desc`` parameter is zero, ``rte_eth_tx_queue_setup`` will
219 now use the PMD-recommended Tx ring size, or in the case where the PMD
220 does not provide a recoomendation, will use an ethdev-provided
221 fall-back value. Previously, setting ``nb_tx_desc`` to zero would have
222 resulted in an error.
228 .. This section should contain ABI changes. Sample format:
230 * Add a short 1-2 sentence description of the ABI change that was announced
231 in the previous releases and made in this release. Use fixed width quotes
232 for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
234 This section is a comment. Do not overwrite or remove it.
235 Also, make sure to start the actual text at the margin.
236 =========================================================
238 * ring: the alignment constraints on the ring structure has been relaxed
239 to one cache line instead of two, and an empty cache line padding is
240 added between the producer and consumer structures. The size of the
241 structure and the offset of the fields remains the same on platforms
242 with 64B cache line, but change on other platforms.
244 * mempool: ops have changed.
246 A new callback ``calc_mem_size`` has been added to ``rte_mempool_ops``
247 to allow to customize required memory size calculation.
248 A new callback ``populate`` has been added to ``rte_mempool_ops``
249 to allow to customize objects population.
250 Callback ``get_capabilities`` has been removed from ``rte_mempool_ops``
251 since its features are covered by ``calc_mem_size`` and ``populate``
253 Callback ``register_memory_area`` has been removed from ``rte_mempool_ops``
254 since the new callback ``populate`` may be used instead of it.
256 * **Additional fields in rte_eth_dev_info.**
258 The ``rte_eth_dev_info`` structure has had two extra entries appended to the
259 end of it: ``default_rxportconf`` and ``default_txportconf``. Each of these
260 in turn are ``rte_eth_dev_portconf`` structures containing three fields of
261 type ``uint16_t``: ``burst_size``, ``ring_size``, and ``nb_queues``. These
262 are parameter values recommended for use by the PMD.
268 .. This section should contain removed items in this release. Sample format:
270 * Add a short 1-2 sentence description of the removed item in the past
273 This section is a comment. Do not overwrite or remove it.
274 Also, make sure to start the actual text at the margin.
275 =========================================================
281 .. This section should contain new known issues in this release. Sample format:
283 * **Add title in present tense with full stop.**
285 Add a short 1-2 sentence description of the known issue in the present
286 tense. Add information on any known workarounds.
288 This section is a comment. Do not overwrite or remove it.
289 Also, make sure to start the actual text at the margin.
290 =========================================================
292 * **pdump is not compatible with old applications.**
294 As we changed to use generic multi-process communication for pdump negotiation
295 instead of previous dedicated unix socket way, pdump applications, including
296 dpdk-pdump example and any other applications using librte_pdump, cannot work
297 with older version DPDK primary applications.
300 Shared Library Versions
301 -----------------------
303 .. Update any library version updated in this release and prepend with a ``+``
307 + librte_cfgfile.so.2
310 This section is a comment. Do not overwrite or remove it.
311 =========================================================
314 The libraries prepended with a plus sign were incremented in this version.
320 librte_bitratestats.so.2
322 librte_bus_fslmc.so.1
327 + librte_common_octeontx.so.1
328 librte_cryptodev.so.4
329 librte_distributor.so.1
333 librte_flow_classify.so.1
341 librte_latencystats.so.1
344 + librte_mempool.so.4
354 librte_pmd_ixgbe.so.2
356 librte_pmd_softnic.so.1
357 librte_pmd_vhost.so.2
373 .. This section should contain a list of platforms that were tested with this
378 * <vendor> platform with <vendor> <type of devices> combinations
383 * Other relevant details...
385 This section is a comment. Do not overwrite or remove it.
386 Also, make sure to start the actual text at the margin.
387 =========================================================