crypto/aesni_mb: support AES CMAC
[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 PMD-recommended Tx and Rx parameters**
45
46   Applications can now query drivers for device-tuned values of
47   ring sizes, burst sizes, and number of queues.
48
49 * **Added RSS hash and key update to CXGBE PMD.**
50
51   Support to update RSS hash and key has been added to CXGBE PMD.
52
53 * **Added CXGBE VF PMD.**
54
55   CXGBE VF Poll Mode Driver has been added to run DPDK over Chelsio
56   T5/T6 NIC VF instances.
57
58 * **Updated Solarflare network PMD.**
59
60   Updated the sfc_efx driver including the following changes:
61
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.
65
66 * **Added Ethernet poll mode driver for AMD XGBE devices.**
67
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
70   new driver.
71
72 * **Updated szedata2 PMD.**
73
74   Added support for new NFB-200G2QL card.
75
76 * **Added support for Broadcom NetXtreme-S (BCM58800) family of controllers (aka Stingray)**
77
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.
82
83   The ARM CPU subsystem features eight ARMv8 Cortex-A72 CPUs at 3.0 GHz, arranged in a multi-cluster
84   configuration.
85
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.
92
93 * **Added crypto workload support to vhost library.**
94
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.
98
99 * **Updated AESNI MB PMD.**
100
101   The AESNI MB PMD has been updated with additional support for:
102
103   * AES-CMAC (128-bit key).
104
105 * **Added the Event Timer Adapter Library.**
106
107   The Event Timer Adapter Library extends the event-based model by introducing
108   APIs that allow applications to arm/cancel event timers that generate
109   timer expiry events. This new type of event is scheduled by an event device
110   along with existing types of events.
111
112 * **Added device event monitor framework.**
113
114   Added a general device event monitor framework at EAL, for device dynamic management.
115   Such as device hotplug awareness and actions adopted accordingly. The list of new APIs:
116
117   * ``rte_dev_event_monitor_start`` and ``rte_dev_event_monitor_stop`` are for
118     the event monitor enable and disable.
119   * ``rte_dev_event_callback_register`` and ``rte_dev_event_callback_unregister``
120     are for the user's callbacks register and unregister.
121
122   Linux uevent is supported as backend of this device event notification framework.
123
124
125 API Changes
126 -----------
127
128 .. This section should contain API changes. Sample format:
129
130    * Add a short 1-2 sentence description of the API change. Use fixed width
131      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
132      tense.
133
134    This section is a comment. Do not overwrite or remove it.
135    Also, make sure to start the actual text at the margin.
136    =========================================================
137
138 * mbuf: The control mbuf API has been removed in v18.05. The impacted
139   functions and macros are:
140
141   - ``rte_ctrlmbuf_init()``
142   - ``rte_ctrlmbuf_alloc()``
143   - ``rte_ctrlmbuf_free()``
144   - ``rte_ctrlmbuf_data()``
145   - ``rte_ctrlmbuf_len()``
146   - ``rte_is_ctrlmbuf()``
147   - ``CTRL_MBUF_FLAG``
148
149   The packet mbuf API should be used as a replacement.
150
151 * meter: updated to accommodate configuration profiles.
152
153   The meter API is changed to support meter configuration profiles. The
154   configuration profile represents the set of configuration parameters
155   for a given meter object, such as the rates and sizes for the token
156   buckets. These configuration parameters were previously the part of meter
157   object internal data strcuture. The separation of the configuration
158   parameters from meter object data structure results in reducing its
159   memory footprint which helps in better cache utilization when large number
160   of meter objects are used.
161
162 * ethdev: The function ``rte_eth_dev_count``, often mis-used to iterate
163   over ports, is deprecated and replaced by ``rte_eth_dev_count_avail``.
164   There is also a new function ``rte_eth_dev_count_total`` to get the
165   total number of allocated ports, available or not.
166   The hotplug-proof applications should use ``RTE_ETH_FOREACH_DEV`` or
167   ``RTE_ETH_FOREACH_DEV_OWNED_BY`` as port iterators.
168
169 * ethdev, in struct ``struct rte_eth_dev_info``, field ``rte_pci_device *pci_dev``
170   replaced with field ``struct rte_device *device``.
171
172 * **Changes to semantics of rte_eth_dev_configure() parameters.**
173
174    If both the ``nb_rx_q`` and ``nb_tx_q`` parameters are zero,
175    ``rte_eth_dev_configure`` will now use PMD-recommended queue sizes, or if
176    recommendations are not provided by the PMD the function will use ethdev
177    fall-back values. Previously setting both of the parameters to zero would
178    have resulted in ``-EINVAL`` being returned.
179
180 * **Changes to semantics of rte_eth_rx_queue_setup() parameters.**
181
182    If the ``nb_rx_desc`` parameter is zero, ``rte_eth_rx_queue_setup`` will
183    now use the PMD-recommended Rx ring size, or in the case where the PMD
184    does not provide a recommendation, will use an ethdev-provided
185    fall-back value. Previously, setting ``nb_rx_desc`` to zero would have
186    resulted in an error.
187
188 * **Changes to semantics of rte_eth_tx_queue_setup() parameters.**
189
190    If the ``nb_tx_desc`` parameter is zero, ``rte_eth_tx_queue_setup`` will
191    now use the PMD-recommended Tx ring size, or in the case where the PMD
192    does not provide a recoomendation, will use an ethdev-provided
193    fall-back value. Previously, setting ``nb_tx_desc`` to zero would have
194    resulted in an error.
195
196
197 ABI Changes
198 -----------
199
200 .. This section should contain ABI changes. Sample format:
201
202    * Add a short 1-2 sentence description of the ABI change that was announced
203      in the previous releases and made in this release. Use fixed width quotes
204      for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
205
206    This section is a comment. Do not overwrite or remove it.
207    Also, make sure to start the actual text at the margin.
208    =========================================================
209
210 * ring: the alignment constraints on the ring structure has been relaxed
211   to one cache line instead of two, and an empty cache line padding is
212   added between the producer and consumer structures. The size of the
213   structure and the offset of the fields remains the same on platforms
214   with 64B cache line, but change on other platforms.
215
216 * **Additional fields in rte_eth_dev_info.**
217
218   The ``rte_eth_dev_info`` structure has had two extra entries appended to the
219   end of it: ``default_rxportconf`` and ``default_txportconf``. Each of these
220   in turn are ``rte_eth_dev_portconf`` structures containing three fields of
221   type ``uint16_t``: ``burst_size``, ``ring_size``, and ``nb_queues``. These
222   are parameter values recommended for use by the PMD.
223
224
225 Removed Items
226 -------------
227
228 .. This section should contain removed items in this release. Sample format:
229
230    * Add a short 1-2 sentence description of the removed item in the past
231      tense.
232
233    This section is a comment. Do not overwrite or remove it.
234    Also, make sure to start the actual text at the margin.
235    =========================================================
236
237
238 Known Issues
239 ------------
240
241 .. This section should contain new known issues in this release. Sample format:
242
243    * **Add title in present tense with full stop.**
244
245      Add a short 1-2 sentence description of the known issue in the present
246      tense. Add information on any known workarounds.
247
248    This section is a comment. Do not overwrite or remove it.
249    Also, make sure to start the actual text at the margin.
250    =========================================================
251
252 * **pdump is not compatible with old applications.**
253
254   As we changed to use generic multi-process communication for pdump negotiation
255   instead of previous dedicated unix socket way, pdump applications, including
256   dpdk-pdump example and any other applications using librte_pdump, cannot work
257   with older version DPDK primary applications.
258
259
260 Shared Library Versions
261 -----------------------
262
263 .. Update any library version updated in this release and prepend with a ``+``
264    sign, like this:
265
266      librte_acl.so.2
267    + librte_cfgfile.so.2
268      librte_cmdline.so.2
269
270    This section is a comment. Do not overwrite or remove it.
271    =========================================================
272
273
274 The libraries prepended with a plus sign were incremented in this version.
275
276 .. code-block:: diff
277
278      librte_acl.so.2
279      librte_bbdev.so.1
280      librte_bitratestats.so.2
281      librte_bus_dpaa.so.1
282      librte_bus_fslmc.so.1
283      librte_bus_pci.so.1
284      librte_bus_vdev.so.1
285      librte_cfgfile.so.2
286      librte_cmdline.so.2
287    + librte_common_octeontx.so.1
288      librte_cryptodev.so.4
289      librte_distributor.so.1
290    + librte_eal.so.7
291    + librte_ethdev.so.9
292      librte_eventdev.so.3
293      librte_flow_classify.so.1
294      librte_gro.so.1
295      librte_gso.so.1
296      librte_hash.so.2
297      librte_ip_frag.so.1
298      librte_jobstats.so.1
299      librte_kni.so.2
300      librte_kvargs.so.1
301      librte_latencystats.so.1
302      librte_lpm.so.2
303    + librte_mbuf.so.4
304      librte_mempool.so.3
305    + librte_meter.so.2
306      librte_metrics.so.1
307      librte_net.so.1
308      librte_pci.so.1
309      librte_pdump.so.2
310      librte_pipeline.so.3
311      librte_pmd_bnxt.so.2
312      librte_pmd_bond.so.2
313      librte_pmd_i40e.so.2
314      librte_pmd_ixgbe.so.2
315      librte_pmd_ring.so.2
316      librte_pmd_softnic.so.1
317      librte_pmd_vhost.so.2
318      librte_port.so.3
319      librte_power.so.1
320      librte_rawdev.so.1
321      librte_reorder.so.1
322    + librte_ring.so.2
323      librte_sched.so.1
324      librte_security.so.1
325      librte_table.so.3
326      librte_timer.so.1
327      librte_vhost.so.3
328
329
330 Tested Platforms
331 ----------------
332
333 .. This section should contain a list of platforms that were tested with this
334    release.
335
336    The format is:
337
338    * <vendor> platform with <vendor> <type of devices> combinations
339
340      * List of CPU
341      * List of OS
342      * List of devices
343      * Other relevant details...
344
345    This section is a comment. Do not overwrite or remove it.
346    Also, make sure to start the actual text at the margin.
347    =========================================================