c4e6bdb5cbf888937b45ac66ebc6d43a8932430a
[dpdk.git] / doc / guides / rel_notes / release_18_05.rst
1 DPDK Release 18.05
2 ==================
3
4 .. **Read this first.**
5
6    The text in the sections below explains how to update the release notes.
7
8    Use proper spelling, capitalization and punctuation in all sections.
9
10    Variable and config names should be quoted as fixed width text:
11    ``LIKE_THIS``.
12
13    Build the docs and view the output file to ensure the changes are correct::
14
15       make doc-guides-html
16
17       xdg-open build/doc/html/guides/rel_notes/release_18_05.html
18
19
20 New Features
21 ------------
22
23 .. This section should contain new features added in this release. Sample
24    format:
25
26    * **Add a title in the past tense with a full stop.**
27
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.
31
32      If the feature adds a lot of sub-features you can use a bullet list like
33      this:
34
35      * Added feature foo to do something.
36      * Enhanced feature bar to do something else.
37
38      Refer to the previous release notes for examples.
39
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      =========================================================
43
44 * **Added bucket mempool driver.**
45
46   Added bucket mempool driver which provides a way to allocate contiguous
47   block of objects.
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.
52
53 * **Added PMD-recommended Tx and Rx parameters**
54
55   Applications can now query drivers for device-tuned values of
56   ring sizes, burst sizes, and number of queues.
57
58 * **Added RSS hash and key update to CXGBE PMD.**
59
60   Support to update RSS hash and key has been added to CXGBE PMD.
61
62 * **Added CXGBE VF PMD.**
63
64   CXGBE VF Poll Mode Driver has been added to run DPDK over Chelsio
65   T5/T6 NIC VF instances.
66
67 * **Updated Solarflare network PMD.**
68
69   Updated the sfc_efx driver including the following changes:
70
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).
76
77 * **Added Ethernet poll mode driver for AMD XGBE devices.**
78
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
81   new driver.
82
83 * **Updated szedata2 PMD.**
84
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
89   is 4.4.1.
90
91 * **Added support for Broadcom NetXtreme-S (BCM58800) family of controllers (aka Stingray)**
92
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.
97
98   The ARM CPU subsystem features eight ARMv8 Cortex-A72 CPUs at 3.0 GHz, arranged in a multi-cluster
99   configuration.
100
101 * **Added IFCVF vDPA driver.**
102
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
108   vrings.
109
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.
116
117 * **Added crypto workload support to vhost library.**
118
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.
122
123 * **Added virtio crypto PMD.**
124
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
128   this new driver.
129
130 * **Added AMD CCP Crypto PMD.**
131
132   Added the new ``ccp`` crypto driver for AMD CCP devices. See the
133   :doc:`../cryptodevs/ccp` crypto driver guide for more details on
134   this new driver.
135
136 * **Updated AESNI MB PMD.**
137
138   The AESNI MB PMD has been updated with additional support for:
139
140   * AES-CMAC (128-bit key).
141
142 * **Added the Event Timer Adapter Library.**
143
144   The Event Timer Adapter Library extends the event-based model by introducing
145   APIs that allow applications to arm/cancel event timers that generate
146   timer expiry events. This new type of event is scheduled by an event device
147   along with existing types of events.
148
149 * **Added OcteonTx TIM Driver (Event timer adapter).**
150
151   The OcteonTx Timer block enables software to schedule events for a future
152   time, it is exposed to an application via Event timer adapter library.
153
154   See the :doc:`../eventdevs/octeontx` guide for more details
155
156 * **Added DPAA2 QDMA Driver (in rawdev).**
157
158   The DPAA2 QDMA is an implementation of the rawdev API, that provide means
159   to initiate a DMA transaction from CPU. The initiated DMA is performed
160   without CPU being involved in the actual DMA transaction.
161
162   See the :doc:`../rawdevs/dpaa2_qdma` guide for more details.
163
164 * **Added DPAA2 Command Interface Driver (in rawdev).**
165
166   The DPAA2 CMDIF is an implementation of the rawdev API, that provides
167   communication between the GPP and NXP's QorIQ based AIOP Block (Firmware).
168   Advanced IO Processor i.e. AIOP is clusters of programmable RISC engines
169   optimised for flexible networking and I/O operations. The communication
170   between GPP and AIOP is achieved via using DPCI devices exposed by MC for
171   GPP <--> AIOP interaction.
172
173   See the :doc:`../rawdevs/dpaa2_cmdif` guide for more details.
174
175 * **Added device event monitor framework.**
176
177   Added a general device event monitor framework at EAL, for device dynamic management.
178   Such as device hotplug awareness and actions adopted accordingly. The list of new APIs:
179
180   * ``rte_dev_event_monitor_start`` and ``rte_dev_event_monitor_stop`` are for
181     the event monitor enable and disable.
182   * ``rte_dev_event_callback_register`` and ``rte_dev_event_callback_unregister``
183     are for the user's callbacks register and unregister.
184
185   Linux uevent is supported as backend of this device event notification framework.
186
187 * **Added support for procinfo and pdump on eth vdev.**
188
189   For ethernet virtual devices (like tap, pcap, etc), with this feature, we can get
190   stats/xstats on shared memory from secondary process, and also pdump packets on
191   those virtual devices.
192
193
194 API Changes
195 -----------
196
197 .. This section should contain API changes. Sample format:
198
199    * Add a short 1-2 sentence description of the API change. Use fixed width
200      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
201      tense.
202
203    This section is a comment. Do not overwrite or remove it.
204    Also, make sure to start the actual text at the margin.
205    =========================================================
206
207 * service cores: no longer marked as experimental.
208
209   The service cores functions are no longer marked as experimental, and have
210   become part of the normal DPDK API and ABI. Any future ABI changes will be
211   announced at least one release before the ABI change is made. There are no
212   ABI breaking changes planned.
213
214 * eal: ``rte_lcore_has_role()`` return value changed.
215
216   This function now returns true or false, respectively,
217   rather than 0 or <0 for success or failure.
218   It makes use of the function more intuitive.
219
220 * mempool: capability flags and related functions have been removed.
221
222   Flags ``MEMPOOL_F_CAPA_PHYS_CONTIG`` and
223   ``MEMPOOL_F_CAPA_BLK_ALIGNED_OBJECTS`` were used by octeontx mempool
224   driver to customize generic mempool library behaviour.
225   Now the new driver callbacks ``calc_mem_size`` and ``populate`` may be
226   used to achieve it without specific knowledge in the generic code.
227
228 * mempool: xmem functions have been deprecated:
229
230   - ``rte_mempool_xmem_create``
231   - ``rte_mempool_xmem_size``
232   - ``rte_mempool_xmem_usage``
233   - ``rte_mempool_populate_iova_tab``
234
235 * mbuf: The control mbuf API has been removed in v18.05. The impacted
236   functions and macros are:
237
238   - ``rte_ctrlmbuf_init()``
239   - ``rte_ctrlmbuf_alloc()``
240   - ``rte_ctrlmbuf_free()``
241   - ``rte_ctrlmbuf_data()``
242   - ``rte_ctrlmbuf_len()``
243   - ``rte_is_ctrlmbuf()``
244   - ``CTRL_MBUF_FLAG``
245
246   The packet mbuf API should be used as a replacement.
247
248 * meter: updated to accommodate configuration profiles.
249
250   The meter API is changed to support meter configuration profiles. The
251   configuration profile represents the set of configuration parameters
252   for a given meter object, such as the rates and sizes for the token
253   buckets. These configuration parameters were previously the part of meter
254   object internal data strcuture. The separation of the configuration
255   parameters from meter object data structure results in reducing its
256   memory footprint which helps in better cache utilization when large number
257   of meter objects are used.
258
259 * ethdev: The function ``rte_eth_dev_count``, often mis-used to iterate
260   over ports, is deprecated and replaced by ``rte_eth_dev_count_avail``.
261   There is also a new function ``rte_eth_dev_count_total`` to get the
262   total number of allocated ports, available or not.
263   The hotplug-proof applications should use ``RTE_ETH_FOREACH_DEV`` or
264   ``RTE_ETH_FOREACH_DEV_OWNED_BY`` as port iterators.
265
266 * ethdev, in struct ``struct rte_eth_dev_info``, field ``rte_pci_device *pci_dev``
267   replaced with field ``struct rte_device *device``.
268
269 * **Changes to semantics of rte_eth_dev_configure() parameters.**
270
271    If both the ``nb_rx_q`` and ``nb_tx_q`` parameters are zero,
272    ``rte_eth_dev_configure`` will now use PMD-recommended queue sizes, or if
273    recommendations are not provided by the PMD the function will use ethdev
274    fall-back values. Previously setting both of the parameters to zero would
275    have resulted in ``-EINVAL`` being returned.
276
277 * **Changes to semantics of rte_eth_rx_queue_setup() parameters.**
278
279    If the ``nb_rx_desc`` parameter is zero, ``rte_eth_rx_queue_setup`` will
280    now use the PMD-recommended Rx ring size, or in the case where the PMD
281    does not provide a recommendation, will use an ethdev-provided
282    fall-back value. Previously, setting ``nb_rx_desc`` to zero would have
283    resulted in an error.
284
285 * **Changes to semantics of rte_eth_tx_queue_setup() parameters.**
286
287    If the ``nb_tx_desc`` parameter is zero, ``rte_eth_tx_queue_setup`` will
288    now use the PMD-recommended Tx ring size, or in the case where the PMD
289    does not provide a recoomendation, will use an ethdev-provided
290    fall-back value. Previously, setting ``nb_tx_desc`` to zero would have
291    resulted in an error.
292
293 * ethdev: several changes were made to the flow API.
294
295   * Unused DUP action was removed.
296   * Actions semantics in flow rules: list order now matters ("first
297     to last" instead of "all simultaneously"), repeated actions are now
298     all performed, and they do not individually have (non-)terminating
299     properties anymore.
300   * Flow rules are now always terminating unless a PASSTHRU action is
301     present.
302   * C99-style flexible arrays were replaced with standard pointers in RSS
303     action and in RAW pattern item structures due to compatibility issues.
304   * The RSS action was modified to not rely on external
305     ``struct rte_eth_rss_conf`` anymore to instead expose its own and more
306     appropriately named configuration fields directly
307     (``rss_conf->rss_key`` => ``key``,
308     ``rss_conf->rss_key_len`` => ``key_len``,
309     ``rss_conf->rss_hf`` => ``types``,
310     ``num`` => ``queue_num``), and the addition of missing RSS parameters
311     (``func`` for RSS hash function to apply and ``level`` for the
312     encapsulation level).
313   * The VLAN pattern item (``struct rte_flow_item_vlan``) was modified to
314     include inner EtherType instead of outer TPID. Its default mask was also
315     modified to cover the VID part (lower 12 bits) of TCI only.
316   * A new transfer attribute was added to ``struct rte_flow_attr`` in order
317     to clarify the behavior of some pattern items.
318   * PF and VF pattern items are now only accepted by PMDs that implement
319     them (bnxt and i40e) when the transfer attribute is also present for
320     consistency.
321   * Pattern item PORT was renamed PHY_PORT to avoid confusion with DPDK port
322     IDs.
323   * An action counterpart to the PHY_PORT pattern item was added in order to
324     redirect matching traffic to a specific physical port.
325   * PORT_ID pattern item and actions were added to match and target DPDK
326     port IDs at a higher level than PHY_PORT.
327
328 * ethdev: change flow APIs regarding count action:
329   * ``rte_flow_create()`` API count action now requires the ``struct rte_flow_action_count``.
330   * ``rte_flow_query()`` API parameter changed from action type to action structure.
331
332
333 ABI Changes
334 -----------
335
336 .. This section should contain ABI changes. Sample format:
337
338    * Add a short 1-2 sentence description of the ABI change that was announced
339      in the previous releases and made in this release. Use fixed width quotes
340      for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
341
342    This section is a comment. Do not overwrite or remove it.
343    Also, make sure to start the actual text at the margin.
344    =========================================================
345
346 * ring: the alignment constraints on the ring structure has been relaxed
347   to one cache line instead of two, and an empty cache line padding is
348   added between the producer and consumer structures. The size of the
349   structure and the offset of the fields remains the same on platforms
350   with 64B cache line, but change on other platforms.
351
352 * mempool: ops have changed.
353
354   A new callback ``calc_mem_size`` has been added to ``rte_mempool_ops``
355   to allow to customize required memory size calculation.
356   A new callback ``populate`` has been added to ``rte_mempool_ops``
357   to allow to customize objects population.
358   Callback ``get_capabilities`` has been removed from ``rte_mempool_ops``
359   since its features are covered by ``calc_mem_size`` and ``populate``
360   callbacks.
361   Callback ``register_memory_area`` has been removed from ``rte_mempool_ops``
362   since the new callback ``populate`` may be used instead of it.
363
364 * **Additional fields in rte_eth_dev_info.**
365
366   The ``rte_eth_dev_info`` structure has had two extra entries appended to the
367   end of it: ``default_rxportconf`` and ``default_txportconf``. Each of these
368   in turn are ``rte_eth_dev_portconf`` structures containing three fields of
369   type ``uint16_t``: ``burst_size``, ``ring_size``, and ``nb_queues``. These
370   are parameter values recommended for use by the PMD.
371
372 * ethdev: ABI for all flow API functions was updated.
373
374   This includes functions ``rte_flow_copy``, ``rte_flow_create``,
375   ``rte_flow_destroy``, ``rte_flow_error_set``, ``rte_flow_flush``,
376   ``rte_flow_isolate``, ``rte_flow_query`` and ``rte_flow_validate``, due to
377   changes in error type definitions (``enum rte_flow_error_type``), removal
378   of the unused DUP action (``enum rte_flow_action_type``), modified
379   behavior for flow rule actions (see API changes), removal of C99 flexible
380   array from RAW pattern item (``struct rte_flow_item_raw``), complete
381   rework of the RSS action definition (``struct rte_flow_action_rss``),
382   sanity fix in the VLAN pattern item (``struct rte_flow_item_vlan``) and
383   new transfer attribute (``struct rte_flow_attr``).
384
385
386 Removed Items
387 -------------
388
389 .. This section should contain removed items in this release. Sample format:
390
391    * Add a short 1-2 sentence description of the removed item in the past
392      tense.
393
394    This section is a comment. Do not overwrite or remove it.
395    Also, make sure to start the actual text at the margin.
396    =========================================================
397
398
399 Known Issues
400 ------------
401
402 .. This section should contain new known issues in this release. Sample format:
403
404    * **Add title in present tense with full stop.**
405
406      Add a short 1-2 sentence description of the known issue in the present
407      tense. Add information on any known workarounds.
408
409    This section is a comment. Do not overwrite or remove it.
410    Also, make sure to start the actual text at the margin.
411    =========================================================
412
413 * **pdump is not compatible with old applications.**
414
415   As we changed to use generic multi-process communication for pdump negotiation
416   instead of previous dedicated unix socket way, pdump applications, including
417   dpdk-pdump example and any other applications using librte_pdump, cannot work
418   with older version DPDK primary applications.
419
420
421 Shared Library Versions
422 -----------------------
423
424 .. Update any library version updated in this release and prepend with a ``+``
425    sign, like this:
426
427      librte_acl.so.2
428    + librte_cfgfile.so.2
429      librte_cmdline.so.2
430
431    This section is a comment. Do not overwrite or remove it.
432    =========================================================
433
434
435 The libraries prepended with a plus sign were incremented in this version.
436
437 .. code-block:: diff
438
439      librte_acl.so.2
440      librte_bbdev.so.1
441      librte_bitratestats.so.2
442      librte_bus_dpaa.so.1
443      librte_bus_fslmc.so.1
444      librte_bus_pci.so.1
445      librte_bus_vdev.so.1
446      librte_cfgfile.so.2
447      librte_cmdline.so.2
448    + librte_common_octeontx.so.1
449      librte_cryptodev.so.4
450      librte_distributor.so.1
451    + librte_eal.so.7
452    + librte_ethdev.so.9
453      librte_eventdev.so.3
454      librte_flow_classify.so.1
455      librte_gro.so.1
456      librte_gso.so.1
457      librte_hash.so.2
458      librte_ip_frag.so.1
459      librte_jobstats.so.1
460      librte_kni.so.2
461      librte_kvargs.so.1
462      librte_latencystats.so.1
463      librte_lpm.so.2
464    + librte_mbuf.so.4
465    + librte_mempool.so.4
466    + librte_meter.so.2
467      librte_metrics.so.1
468      librte_net.so.1
469      librte_pci.so.1
470      librte_pdump.so.2
471      librte_pipeline.so.3
472      librte_pmd_bnxt.so.2
473      librte_pmd_bond.so.2
474      librte_pmd_i40e.so.2
475      librte_pmd_ixgbe.so.2
476    + librte_pmd_dpaa2_cmdif.so.1
477    + librte_pmd_dpaa2_qdma.so.1
478      librte_pmd_ring.so.2
479      librte_pmd_softnic.so.1
480      librte_pmd_vhost.so.2
481      librte_port.so.3
482      librte_power.so.1
483      librte_rawdev.so.1
484      librte_reorder.so.1
485    + librte_ring.so.2
486      librte_sched.so.1
487      librte_security.so.1
488      librte_table.so.3
489      librte_timer.so.1
490      librte_vhost.so.3
491
492
493 Tested Platforms
494 ----------------
495
496 .. This section should contain a list of platforms that were tested with this
497    release.
498
499    The format is:
500
501    * <vendor> platform with <vendor> <type of devices> combinations
502
503      * List of CPU
504      * List of OS
505      * List of devices
506      * Other relevant details...
507
508    This section is a comment. Do not overwrite or remove it.
509    Also, make sure to start the actual text at the margin.
510    =========================================================