pci: introduce library and driver
[dpdk.git] / doc / guides / rel_notes / release_17_11.rst
1 DPDK Release 17.11
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_17_11.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 * **Extended port_id range from uint8_t to uint16_t.**
45
46   Increased port_id range from 8 bits to 16 bits in order to support more than
47   256 ports in dpdk. All ethdev APIs which have port_id as parameter are changed
48   in the meantime.
49
50 * **Modified the return type of rte_eth_stats_reset.**
51
52   Changed return type of ``rte_eth_stats_reset`` from ``void`` to ``int``
53   so the caller may know whether a device supports the operation or not
54   and if the operation was carried out.
55
56 * **Added a new driver for Marvell Armada 7k/8k devices.**
57
58   Added the new mrvl net driver for Marvell Armada 7k/8k devices. See the
59   "Network Interface Controller Drivers" document for more details on this new
60   driver.
61
62 * **Updated mlx5 driver.**
63
64   Updated the mlx5 driver including the following changes:
65
66    * Enabled PMD to run on top of upstream linux kernel and rdma-core libs.
67      By that removed the dependency on specific Mellanox OFED libraries.
68    * Improved PMD latency performance.
69    * Improved PMD memory footprint.
70    * Supported vectorized Rx/Tx burst for ARMv8.
71    * Supported secondary process.
72    * Supported flow counters.
73    * Supported Rx hardware timestamp offload.
74    * Supported device removal event.
75
76 * **Added SoftNIC PMD.**
77
78   Added new SoftNIC PMD. This virtual device offers applications a software
79   fallback support for traffic management.
80
81 * **Added support for NXP DPAA Devices.**
82
83   Added support for NXP's DPAA devices - LS104x series. This includes:
84
85   * DPAA Bus driver
86   * DPAA Mempool driver for supporting offloaded packet memory pool
87   * DPAA PMD for DPAA devices
88
89   See the "Network Interface Controller Drivers" document for more details of
90   this new driver.
91
92 * **nfp: Added PF support.**
93
94   Previously Netronome's NFP PMD had just support for VFs. PF support is
95   just as a basic DPDK port and has no VF management yet.
96
97   PF support comes with firmware upload support which allows the PMD to
98   independently work from kernel netdev NFP drivers.
99
100   NFP 4000 devices are also now supported along with previous 6000 devices.
101
102 * **Updated bnxt PMD.**
103
104   Major enhancements include:
105
106    * Support for Flow API
107    * Support for Tx and Rx descriptor status functions
108
109 * **Add bus agnostic functions to cryptodev for PMD initialisation**
110
111   Adds new PMD assist functions ``rte_cryptodev_pmd_parse_input_args()``,
112   ``rte_cryptodev_pmd_create()`` and ``rte_cryptodev_pmd_destroy()`` which
113   are bus independent for driver to manage creation and destruction of new
114   device instances.
115
116 * **Updated QAT crypto PMD.**
117
118   Performance enhancements:
119
120   * Removed atomics from the internal queue pair structure.
121   * Coalesce writes to HEAD CSR on response processing.
122   * Coalesce writes to TAIL CSR on request processing.
123
124   Additional support for:
125
126   * AES CCM algorithm.
127
128 * **Updated the AESNI MB PMD.**
129
130   The AESNI MB PMD has been updated with additional support for:
131
132   * DES CBC algorithm.
133   * DES DOCSIS BPI algorithm.
134
135   This requires the IPSec Multi-buffer library 0.47. For more details,
136   check out the AESNI MB PMD documenation.
137
138 * **Updated the OpenSSL PMD.**
139
140   The OpenSSL PMD has been updated with additional support for:
141
142   * DES CBC algorithm.
143   * AES CCM algorithm.
144
145 * **Added NXP DPAA SEC crypto PMD.**
146
147   A new "dpaa_sec" hardware based crypto PMD for NXP DPAA devices has been
148   added. See the "Crypto Device Drivers" document for more details on this
149   driver.
150
151 * **Added MRVL crypto PMD.**
152
153   A new crypto PMD has been added, which provides several ciphering and hashing
154   algorithms. All cryptography operations use the MUSDK library crypto API.
155
156 * **Add new benchmarking mode to dpdk-test-crypto-perf application.**
157
158   Added new "PMD cyclecount" benchmark mode to dpdk-test-crypto-perf application
159   that displays more detailed breakdown of CPU cycles used by hardware
160   acceleration.
161
162 * **Added IOMMU support to libvhost-user**
163
164   Implemented device IOTLB in Vhost-user backend, and enabled Virtio's IOMMU
165   feature.
166
167 * **Added Membership library (rte_member).**
168
169   Added membership library. It provides an API for DPDK applications to insert a
170   new member, delete an existing member, or query the existence of a member in a
171   given set, or a group of sets. For the case of a group of sets the library
172   will return not only whether the element has been inserted before in one of
173   the sets but also which set it belongs to.
174
175   The Membership Library is an extension and generalization of a traditional
176   filter (for example Bloom Filter) structure that has multiple usages in a wide
177   variety of workloads and applications. In general, the Membership Library is a
178   data structure that provides a “set-summary” and responds to set-membership
179   queries whether a certain member belongs to a set(s).
180
181   See the :ref:`Membership Library <Member_Library>` documentation in
182   the Programmers Guide document, for more information.
183
184 * **Added the Generic Segmentation Offload Library.**
185
186   Added the Generic Segmentation Offload (GSO) library to enable
187   applications to split large packets (e.g. MTU is 64KB) into small
188   ones (e.g. MTU is 1500B). Supported packet types are:
189
190   * TCP/IPv4 packets.
191   * VxLAN packets, which must have an outer IPv4 header, and contain
192     an inner TCP/IPv4 packet.
193   * GRE packets, which must contain an outer IPv4 header, and inner
194     TCP/IPv4 headers.
195
196   The GSO library doesn't check if the input packets have correct
197   checksums, and doesn't update checksums for output packets.
198   Additionally, the GSO library doesn't process IP fragmented packets.
199
200 * **Added the Flow Classification Library.**
201
202   Added the Flow Classification library, it provides an API for DPDK
203   applications to classify an input packet by matching it against a set of flow
204   rules. It uses the librte_table API to manage the flow rules.
205
206
207 Resolved Issues
208 ---------------
209
210 .. This section should contain bug fixes added to the relevant
211    sections. Sample format:
212
213    * **code/section Fixed issue in the past tense with a full stop.**
214
215      Add a short 1-2 sentence description of the resolved issue in the past
216      tense.
217
218      The title should contain the code/lib section like a commit message.
219
220      Add the entries in alphabetic order in the relevant sections below.
221
222    This section is a comment. do not overwrite or remove it.
223    Also, make sure to start the actual text at the margin.
224    =========================================================
225
226
227 EAL
228 ~~~
229
230 * **Service core fails to call service callback due to atomic lock**
231
232   In a specific configuration of multi-thread unsafe services and service
233   cores, a service core previously did not correctly release the atomic lock
234   on the service. This would result in the cores polling the service, but it
235   looked like another thread was executing the service callback. The logic for
236   atomic locking of the services has been fixed and refactored for readability.
237
238 Drivers
239 ~~~~~~~
240
241
242 Libraries
243 ~~~~~~~~~
244
245
246 Examples
247 ~~~~~~~~
248
249
250 Other
251 ~~~~~
252
253
254 Known Issues
255 ------------
256
257 .. This section should contain new known issues in this release. Sample format:
258
259    * **Add title in present tense with full stop.**
260
261      Add a short 1-2 sentence description of the known issue in the present
262      tense. Add information on any known workarounds.
263
264    This section is a comment. do not overwrite or remove it.
265    Also, make sure to start the actual text at the margin.
266    =========================================================
267
268
269 API Changes
270 -----------
271
272 .. This section should contain API changes. Sample format:
273
274    * Add a short 1-2 sentence description of the API change. Use fixed width
275      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
276      tense.
277
278    This section is a comment. do not overwrite or remove it.
279    Also, make sure to start the actual text at the margin.
280    =========================================================
281
282 * **Ethdev device name length increased**
283
284   The size of internal device name is increased to 64 characters
285   to allow for storing longer bus specific name.
286
287 * **Ethdev flag RTE_ETH_DEV_DETACHABLE was removed**
288
289   This flag is not necessary anymore, with the new hotplug implementation.
290   It is now removed from the ether library. Its semantic is expressed at the bus
291   and PMD level.
292
293 * **Service cores API updated for usability**
294
295   The service cores API has been changed, removing pointers from the API
296   where possible, instead using integer IDs to identify each service. This
297   simplifed application code, aids debugging, and provides better
298   encapsulation. A summary of the main changes made is as follows:
299
300   * Services identified by ID not by ``rte_service_spec`` pointer
301   * Reduced API surface by using ``set`` functions instead of enable/disable
302   * Reworked ``rte_service_register`` to provide the service ID to registrar
303   * Rework start and stop APIs into ``rte_service_runstate_set``
304   * Added API to set runstate of service implementation to indicate readyness
305
306 * **The following changes made in mempool library**
307
308   * Moved ``flags`` datatype from int to unsigned int for ``rte_mempool``.
309   * Removed ``__rte_unused int flag`` param from ``rte_mempool_generic_put``
310     and ``rte_mempool_generic_get`` API.
311   * Added ``flags`` param in ``rte_mempool_xmem_size`` and
312     ``rte_mempool_xmem_usage``.
313
314 * Xen dom0 in EAL was removed, as well as xenvirt PMD and vhost_xen.
315
316 * ``rte_mem_phy2mch`` was used in Xen dom0 to obtain the physical address;
317   remove this API as Xen dom0 support was removed.
318
319 * **PCI bus API moved outside of the EAL**
320
321   The PCI bus previously implemented within the EAL has been moved.
322   A first part has been added as an RTE library providing PCI helpers to
323   parse device locations or other such utilities.
324   A second part consisting in the actual bus driver has been moved to its
325   proper subdirectory, without changing its functionalities.
326
327   As such, several PCI-related functions are not proposed by the EAL anymore:
328
329   * rte_pci_detach
330   * rte_pci_dump
331   * rte_pci_ioport_map
332   * rte_pci_ioport_read
333   * rte_pci_ioport_unmap
334   * rte_pci_ioport_write
335   * rte_pci_map_device
336   * rte_pci_probe
337   * rte_pci_probe_one
338   * rte_pci_read_config
339   * rte_pci_register
340   * rte_pci_scan
341   * rte_pci_unmap_device
342   * rte_pci_unregister
343   * rte_pci_write_config
344
345   These functions are made available either as part of ``librte_pci`` or
346   ``librte_bus_pci``.
347
348 * **Add return value to stats_get dev op API**
349
350   The ``stats_get`` dev op API return value has been changed to be int.
351   By this way PMDs can return an error value in case of failure at stats
352   getting process time.
353
354 * **Modified the rte_cryptodev_allocate_driver function in the cryptodev library.**
355
356   The function ``rte_cryptodev_allocate_driver()`` has been modified.
357   An extra parameter ``struct cryptodev_driver *crypto_drv`` has been added.
358
359 * **Removed virtual device bus specific functions from librte_cryptodev.**
360
361   The functions ``rte_cryptodev_vdev_parse_init_params()`` and
362   ``rte_cryptodev_vdev_pmd_init()`` have been removed from librte_cryptodev
363   and have been replaced by non bus specific functions
364   ``rte_cryptodev_pmd_parse_input_args()`` and ``rte_cryptodev_pmd_create()``.
365
366 * **Removed PCI device bus specific functions from librte_cryptodev.**
367
368   The functions ``rte_cryptodev_pci_generic_probe()`` and
369   ``rte_cryptodev_pci_generic_remove()`` have been removed from librte_cryptodev
370   and have been replaced by non bus specific functions
371   ``rte_cryptodev_pmd_create()`` and ``rte_cryptodev_pmd_destroy()``.
372
373 * **Removed deprecated functions to manage log level or type.**
374
375   The functions ``rte_set_log_level()``, ``rte_get_log_level()``,
376   ``rte_set_log_type()`` and ``rte_get_log_type()`` have been removed.
377   They are respectively replaced by ``rte_log_set_global_level()``,
378   ``rte_log_get_global_level()``, ``rte_log_set_level()`` and
379   ``rte_log_get_level()``.
380
381 * **Removed ``mbuf`` flags ``PKT_RX_VLAN_PKT`` and ``PKT_RX_QINQ_PKT``.**
382
383   The ``mbuf`` flags ``PKT_RX_VLAN_PKT`` and ``PKT_RX_QINQ_PKT`` have
384   been removed since their behavior were not properly described.
385
386 * **Added ``mbuf`` flags ``PKT_RX_VLAN`` and ``PKT_RX_QINQ``.**
387
388   Two ``mbuf`` flags have been added to indicate that the VLAN
389   identifier has been saved in in the ``mbuf`` structure. For instance:
390
391   - if VLAN is not stripped and TCI is saved: ``PKT_RX_VLAN``
392   - if VLAN is stripped and TCI is saved: ``PKT_RX_VLAN | PKT_RX_VLAN_STRIPPED``
393
394 * **Modified the vlan_offload_set_t function prototype in the ethdev library.**
395
396   Changed the function prototype of ``vlan_offload_set_t``.  The return value
397   has been changed from ``void`` to ``int`` so the caller to knows whether
398   the backing device supports the operation or if the operation was
399   successfully performed.
400
401
402 ABI Changes
403 -----------
404
405 .. This section should contain ABI changes. Sample format:
406
407    * Add a short 1-2 sentence description of the ABI change that was announced
408      in the previous releases and made in this release. Use fixed width quotes
409      for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
410
411    This section is a comment. do not overwrite or remove it.
412    Also, make sure to start the actual text at the margin.
413    =========================================================
414
415 * **Extended port_id range.**
416
417   The size of the field ``port_id`` in the ``rte_eth_dev_data`` structure
418   changed, as described in the `New Features` section.
419
420
421 Removed Items
422 -------------
423
424 .. This section should contain removed items in this release. Sample format:
425
426    * Add a short 1-2 sentence description of the removed item in the past
427      tense.
428
429    This section is a comment. do not overwrite or remove it.
430    Also, make sure to start the actual text at the margin.
431    =========================================================
432
433 * The crypto performance unit tests have been removed,
434   replaced by the dpdk-test-crypto-perf application.
435
436
437 Shared Library Versions
438 -----------------------
439
440 .. Update any library version updated in this release and prepend with a ``+``
441    sign, like this:
442
443      librte_acl.so.2
444    + librte_cfgfile.so.2
445      librte_cmdline.so.2
446
447    This section is a comment. do not overwrite or remove it.
448    =========================================================
449
450
451 The libraries prepended with a plus sign were incremented in this version.
452
453 .. code-block:: diff
454
455      librte_acl.so.2
456    + librte_bitratestats.so.2
457      librte_cfgfile.so.2
458      librte_cmdline.so.2
459    + librte_cryptodev.so.4
460      librte_distributor.so.1
461    + librte_eal.so.6
462    + librte_ethdev.so.8
463    + librte_eventdev.so.3
464    + librte_flow_classify.so.1
465      librte_gro.so.1
466    + librte_gso.so.1
467      librte_hash.so.2
468      librte_ip_frag.so.1
469      librte_jobstats.so.1
470      librte_kni.so.2
471      librte_kvargs.so.1
472      librte_latencystats.so.1
473      librte_lpm.so.2
474      librte_mbuf.so.3
475      librte_mempool.so.2
476      librte_meter.so.1
477      librte_metrics.so.1
478      librte_net.so.1
479    + librte_pci.so.1
480    + librte_pdump.so.2
481      librte_pipeline.so.3
482    + librte_pmd_bnxt.so.2
483    + librte_pmd_bond.so.2
484    + librte_pmd_i40e.so.2
485    + librte_pmd_ixgbe.so.2
486      librte_pmd_ring.so.2
487    + librte_pmd_softnic.so.1
488    + librte_pmd_vhost.so.2
489      librte_port.so.3
490      librte_power.so.1
491      librte_reorder.so.1
492      librte_ring.so.1
493      librte_sched.so.1
494    + librte_security.so.1
495    + librte_table.so.3
496      librte_timer.so.1
497      librte_vhost.so.3
498
499
500 Tested Platforms
501 ----------------
502
503 .. This section should contain a list of platforms that were tested with this
504    release.
505
506    The format is:
507
508    * <vendor> platform with <vendor> <type of devices> combinations
509
510      * List of CPU
511      * List of OS
512      * List of devices
513      * Other relevant details...
514
515    This section is a comment. do not overwrite or remove it.
516    Also, make sure to start the actual text at the margin.
517    =========================================================