ethdev: introduce Rx buffer split
[dpdk.git] / doc / guides / rel_notes / release_20_11.rst
1 .. SPDX-License-Identifier: BSD-3-Clause
2    Copyright 2020 The DPDK contributors
3
4 .. include:: <isonum.txt>
5
6 DPDK Release 20.11
7 ==================
8
9 .. **Read this first.**
10
11    The text in the sections below explains how to update the release notes.
12
13    Use proper spelling, capitalization and punctuation in all sections.
14
15    Variable and config names should be quoted as fixed width text:
16    ``LIKE_THIS``.
17
18    Build the docs and view the output file to ensure the changes are correct::
19
20       make doc-guides-html
21       xdg-open build/doc/html/guides/rel_notes/release_20_11.html
22
23
24 New Features
25 ------------
26
27 .. This section should contain new features added in this release.
28    Sample format:
29
30    * **Add a title in the past tense with a full stop.**
31
32      Add a short 1-2 sentence description in the past tense.
33      The description should be enough to allow someone scanning
34      the release notes to understand the new feature.
35
36      If the feature adds a lot of sub-features you can use a bullet list
37      like this:
38
39      * Added feature foo to do something.
40      * Enhanced feature bar to do something else.
41
42      Refer to the previous release notes for examples.
43
44      Suggested order in release notes items:
45      * Core libs (EAL, mempool, ring, mbuf, buses)
46      * Device abstraction libs and PMDs
47        - ethdev (lib, PMDs)
48        - cryptodev (lib, PMDs)
49        - eventdev (lib, PMDs)
50        - etc
51      * Other libs
52      * Apps, Examples, Tools (if significant)
53
54      This section is a comment. Do not overwrite or remove it.
55      Also, make sure to start the actual text at the margin.
56      =======================================================
57
58 * **Added write combining store APIs.**
59
60   Added ``rte_write32_wc`` and ``rte_write32_wc_relaxed`` APIs
61   that enable write combining stores (depending on architecture).
62   The functions are provided as a generic stubs and
63   x86 specific implementation.
64
65 * **Added prefetch with intention to write APIs.**
66
67   Added new prefetch function variants e.g. ``rte_prefetch0_write``,
68   which allow the programmer to prefetch a cache line and also indicate
69   the intention to write.
70
71 * **Added the rte_cldemote API.**
72
73   Added a hardware hint CLDEMOTE, which is similar to prefetch in reverse.
74   CLDEMOTE moves the cache line to the more remote cache, where it expects
75   sharing to be efficient. Moving the cache line to a level more distant from
76   the processor helps to accelerate core-to-core communication.
77   This API is specific to x86 and implemented as a stub for other
78   architectures.
79
80 * **Updated CRC modules of the net library.**
81
82   * Added runtime selection of the optimal architecture-specific CRC path.
83   * Added optimized implementations of CRC32-Ethernet and CRC16-CCITT
84     using the AVX512 and VPCLMULQDQ instruction sets.
85
86 * **Introduced extended buffer description for receiving.**
87
88   Added the extended Rx buffer description for Rx queue setup routine
89   providing the individual settings for each Rx segment with maximal size,
90   buffer offset and memory pool to allocate data buffers from.
91
92 * **Added the FEC API, for a generic FEC query and config.**
93
94   Added the FEC API which provides functions for query FEC capabilities and
95   current FEC mode from device. Also, API for configuring FEC mode is also provided.
96
97 * **Added thread safety to rte_flow functions.**
98
99   Added ``RTE_ETH_DEV_FLOW_OPS_THREAD_SAFE`` device flag to indicate
100   whether PMD supports thread safe operations. If PMD doesn't set the flag,
101   rte_flow API level functions will protect the flow operations with mutex.
102
103 * **Added flow-based traffic sampling support.**
104
105   Added new action: ``RTE_FLOW_ACTION_TYPE_SAMPLE`` to duplicate the matching
106   packets with specified ratio, and apply with own set of actions with a fate
107   action. When the ratio is set to 1 then the packets will be 100% mirrored.
108
109 * **Added support of shared action in flow API.**
110
111   Added shared action support to utilize single flow action in multiple flow
112   rules. An update of shared action configuration alters the behavior of all
113   flow rules using it.
114
115   * Added new action: ``RTE_FLOW_ACTION_TYPE_SHARED`` to use shared action
116     as flow action.
117   * Added new flow APIs to create/update/destroy/query shared action.
118
119 * **Flow rules allowed to use private PMD items / actions.**
120
121   * Flow rule verification was updated to accept private PMD
122     items and actions.
123
124 * **Added generic API to offload tunneled traffic and restore missed packet.**
125
126   * Added a new hardware independent helper to flow API that
127     offloads tunneled traffic and restores missed packets.
128
129 * **Updated the ethdev library to support hairpin between two ports.**
130
131   New APIs are introduced to support binding / unbinding 2 ports hairpin.
132   Hairpin Tx part flow rules can be inserted explicitly.
133   New API is added to get the hairpin peer ports list.
134
135 * **Updated Broadcom bnxt driver.**
136
137   Updated the Broadcom bnxt driver with new features and improvements, including:
138
139   * Added support for 200G PAM4 link speed.
140   * Added support for RSS hash level selection.
141   * Updated HWRM structures to 1.10.1.70 version.
142   * Added TRUFLOW support for Stingray devices.
143
144 * **Updated Cisco enic driver.**
145
146   * Added support for VF representors with single-queue Tx/Rx and flow API
147   * Added support for egress PORT_ID action
148   * Added support for non-zero priorities for group 0 flows
149   * Added support for VXLAN decap combined with VLAN pop
150
151 * **Added hns3 FEC PMD, for supporting query and config FEC mode.**
152
153   Added the FEC PMD which provides functions for query FEC capabilities and
154   current FEC mode from device. Also, PMD for configuring FEC mode is also provided.
155
156 * **Updated Solarflare network PMD.**
157
158   Updated the Solarflare ``sfc_efx`` driver with changes including:
159
160   * Added SR-IOV PF support
161   * Added Alveo SN1000 SmartNICs (EF100 architecture) support
162
163 * **Updated Virtio driver.**
164
165   * Added support for Vhost-vDPA backend to Virtio-user PMD.
166   * Changed default link speed to unknown.
167   * Added support for 200G link speed.
168
169 * **Updated Intel i40e driver.**
170
171   Updated the Intel i40e driver to use write combining stores.
172
173 * **Updated Intel ixgbe driver.**
174
175   Updated the Intel ixgbe driver to use write combining stores.
176
177 * **Updated Intel ice driver.**
178
179   Updated the Intel ice driver to use write combining stores.
180
181 * **Updated Intel qat driver.**
182
183   Updated the Intel qat driver to use write combining stores.
184
185 * **Updated Memif PMD.**
186
187   * Added support for abstract socket address.
188   * Changed default socket address type to abstract.
189
190 * **Added Ice Lake (Gen4) support for Intel NTB.**
191
192   Added NTB device support (4th generation) for Intel Ice Lake platform.
193
194 * **Added UDP/IPv4 GRO support for VxLAN and non-VxLAN packets.**
195
196   For VxLAN packets, added inner UDP/IPv4 support.
197   For non-VxLAN packets, added UDP/IPv4 support.
198
199 * **Extended flow-perf application.**
200
201   * Started supporting user order instead of bit mask:
202     Now the user can create any structure of rte_flow
203     using flow performance application with any order,
204     moreover the app also now starts to support inner
205     items matching as well.
206   * Added header modify actions.
207   * Added flag action.
208   * Added raw encap/decap actions.
209   * Added VXLAN encap/decap actions.
210   * Added ICMP(code/type/identifier/sequence number) and ICMP6(code/type) matching items.
211   * Added option to set port mask for insertion/deletion:
212     ``--portmask=N``
213     where N represents the hexadecimal bitmask of ports used.
214
215 * **Added raw data-path APIs for cryptodev library.**
216
217   Cryptodev is added with raw data-path APIs to accelerate external
218   libraries or applications which need to avail fast cryptodev
219   enqueue/dequeue operations but does not necessarily depends on
220   mbufs and cryptodev operation mempools.
221
222 * **Updated the aesni_mb crypto PMD.**
223
224   * Added support for AES-ECB 128, 192 and 256.
225   * Added support for ZUC-EEA3/EIA3 algorithms.
226   * Added support for SNOW3G-UEA2/UIA2 algorithms.
227   * Added support for KASUMI-F8/F9 algorithms.
228   * Added support for Chacha20-Poly1305.
229   * Added support for AES-256 CCM algorithm.
230
231 * **Updated the aesni_gcm crypto PMD.**
232
233   * Added SGL support for AES-GMAC.
234
235 * **Added Broadcom BCMFS symmetric crypto PMD.**
236
237   Added a symmetric crypto PMD for Broadcom FlexSparc crypto units.
238   See :doc:`../cryptodevs/bcmfs` guide for more details on this new PMD.
239
240 * **Updated DPAA2_SEC crypto PMD.**
241
242   * Added DES-CBC support for cipher_only, chain and ipsec protocol.
243   * Added support for non-HMAC auth algorithms
244     (MD5, SHA1, SHA224, SHA256, SHA384, SHA512).
245
246 * **Updated Marvell NITROX symmetric crypto PMD.**
247
248   * Added AES-GCM support.
249   * Added cipher only offload support.
250
251 * **Updated the OCTEON TX2 crypto PMD.**
252
253   * Updated the OCTEON TX2 crypto PMD lookaside protocol offload for IPsec with
254     IPv6 support.
255
256 * **Updated QAT crypto PMD.**
257
258   * Added Raw Data-path APIs support.
259
260 * **Added Intel ACC100 bbdev PMD.**
261
262   Added a new ``acc100`` bbdev driver for the Intel\ |reg| ACC100 accelerator
263   also known as Mount Bryce.  See the
264   :doc:`../bbdevs/acc100` BBDEV guide for more details on this new driver.
265
266 * **Updated rte_security library to support SDAP.**
267
268   ``rte_security_pdcp_xform`` in ``rte_security`` lib is updated to enable
269   5G NR processing of SDAP header in PMDs.
270
271 * **Added Marvell OCTEON TX2 regex PMD.**
272
273   Added a new PMD driver for hardware regex offload block for OCTEON TX2 SoC.
274
275   See the :doc:`../regexdevs/octeontx2` for more details.
276
277 * **Updated Software Eventdev driver.**
278
279   Added performance tuning arguments to allow tuning the scheduler for
280   better throughtput in high core count use cases.
281
282 * **Updated ioat rawdev driver**
283
284   The ioat rawdev driver has been updated and enhanced. Changes include:
285
286   * Added support for Intel\ |reg| Data Streaming Accelerator hardware.
287     For more information, see https://01.org/blogs/2019/introducing-intel-data-streaming-accelerator
288   * Added support for the fill operation via the API ``rte_ioat_enqueue_fill()``,
289     where the hardware fills an area of memory with a repeating pattern.
290   * Added a per-device configuration flag to disable management
291     of user-provided completion handles.
292   * Renamed the ``rte_ioat_do_copies()`` API to ``rte_ioat_perform_ops()``,
293     and renamed the ``rte_ioat_completed_copies()`` API to ``rte_ioat_completed_ops()``
294     to better reflect the APIs' purposes, and remove the implication that
295     they are limited to copy operations only.
296     [Note: The old API is still provided but marked as deprecated in the code]
297   * Added a new API ``rte_ioat_fence()`` to add a fence between operations.
298     This API replaces the ``fence`` flag parameter in the ``rte_ioat_enqueue_copies()`` function,
299     and is clearer as there is no ambiguity as to whether the flag should be
300     set on the last operation before the fence or the first operation after it.
301
302 * **Updated the pipeline library for alignment with the P4 language.**
303
304   Added new Software Switch (SWX) pipeline type that provides more
305   flexibility through API and feature alignment with the P4 language.
306
307   * The packet headers, meta-data, actions, tables and pipelines are
308     dynamically defined instead of selected from pre-defined set.
309   * The actions and the pipeline are defined with instructions.
310   * Extern objects and functions can be plugged into the pipeline.
311   * Transaction-oriented table updates.
312
313 * **Add new AVX512 specific classify algorithms for ACL library.**
314
315   * Added new ``RTE_ACL_CLASSIFY_AVX512X16`` vector implementation,
316     which can process up to 16 flows in parallel. Requires AVX512 support.
317
318   * Added new ``RTE_ACL_CLASSIFY_AVX512X32`` vector implementation,
319     which can process up to 32 flows in parallel. Requires AVX512 support.
320
321 * **Added support to update subport bandwidth dynamically.**
322
323    * Added new API ``rte_sched_port_subport_profile_add`` to add new
324      subport bandwidth profile to subport porfile table at runtime.
325
326    * Added support to update subport rate dynamically.
327
328 * **Updated FIPS validation sample application.**
329
330   * Added scatter gather support.
331   * Added NIST GCMVS complaint GMAC test method support.
332
333
334 Removed Items
335 -------------
336
337 .. This section should contain removed items in this release. Sample format:
338
339    * Add a short 1-2 sentence description of the removed item
340      in 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 * vhost: Dequeue zero-copy support has been removed.
347
348 * kernel: The module ``igb_uio`` has been moved to the git repository
349   ``dpdk-kmods`` in a new directory ``linux/igb_uio``.
350
351 * Removed Python 2 support since it was EOL'd in January 2020.
352
353 API Changes
354 -----------
355
356 .. This section should contain API changes. Sample format:
357
358    * sample: Add a short 1-2 sentence description of the API change
359      which was announced in the previous releases and made in this release.
360      Start with a scope label like "ethdev:".
361      Use fixed width quotes for ``function_names`` or ``struct_names``.
362      Use the past tense.
363
364    This section is a comment. Do not overwrite or remove it.
365    Also, make sure to start the actual text at the margin.
366    =======================================================
367
368 * build macros: The macros defining ``RTE_MACHINE_CPUFLAG_*`` are removed.
369   The information provided by these macros is available through standard
370   compiler macros.
371
372 * eal: The ``rte_logs`` struct and global symbol was made private
373   and is no longer part of the API.
374
375 * eal: Made the ``rte_dev_event`` structure private to the EAL as no public API
376   used it.
377
378 * eal: ``rte_cio_rmb()`` and ``rte_cio_wmb()`` were deprecated since 20.08
379   and are removed in this release.
380
381 * mem: Removed the unioned field ``phys_addr`` from
382   the structures ``rte_memseg`` and ``rte_memzone``.
383   The field ``iova`` is remaining from the old unions.
384
385 * mempool: Removed the unioned fields ``phys_addr`` and ``physaddr`` from
386   the structures ``rte_mempool_memhdr`` and ``rte_mempool_objhdr``.
387   The field ``iova`` is remaining from the old unions.
388   The flag name ``MEMPOOL_F_NO_PHYS_CONTIG`` is removed,
389   while the aliased flag ``MEMPOOL_F_NO_IOVA_CONTIG`` is kept.
390
391 * mbuf: Removed the functions ``rte_mbuf_data_dma_addr*``
392   and the macros ``rte_pktmbuf_mtophys*``.
393   The same functionality is still available with the functions and macros
394   having ``iova`` in their names instead of ``dma_addr`` or ``mtophys``.
395
396 * mbuf: Removed the unioned field ``buf_physaddr`` from ``rte_mbuf``.
397   The field ``buf_iova`` is remaining from the old union.
398
399 * mbuf: Removed the unioned field ``refcnt_atomic`` from
400   the structures ``rte_mbuf`` and ``rte_mbuf_ext_shared_info``.
401   The field ``refcnt`` is remaining from the old unions.
402
403 * pci: Removed the ``rte_kernel_driver`` enum defined in rte_dev.h and
404   replaced with a private enum in the PCI subsystem.
405
406 * pci: Removed the PCI resources map API from the public API
407   (``pci_map_resource`` and ``pci_unmap_resource``) and moved it to the
408   PCI bus driver along with the PCI resources lists and associated structures
409   (``pci_map``, ``pci_msix_table``, ``mapped_pci_resource`` and
410   ``mapped_pci_res_list``).
411
412 * ethdev: Removed the ``kdrv`` field in the ethdev ``rte_eth_dev_data``
413   structure as it gave no useful abstracted information to the applications.
414
415 * ethdev: ``rte_eth_rx_descriptor_done()`` API has been deprecated.
416
417 * ethdev: Renamed basic statistics per queue. An underscore is inserted
418   between the queue number and the rest of the xstat name:
419
420   * ``rx_qN*`` -> ``rx_qN_*``
421   * ``tx_qN*`` -> ``tx_qN_*``
422
423 * ethdev: Added capability to query age flow action.
424
425 * ethdev: Renamed internal functions:
426
427   * ``_rte_eth_dev_callback_process()`` -> ``rte_eth_dev_callback_process()``
428   * ``_rte_eth_dev_reset`` -> ``rte_eth_dev_internal_reset()``
429
430 * ethdev: Modified field type of ``base`` and ``nb_queue`` in struct
431   ``rte_eth_dcb_tc_queue_mapping`` from ``uint8_t`` to ``uint16_t``.
432   As the data of ``uint8_t`` will be truncated when queue number under
433   a TC is greater than 256.
434
435 * vhost: Moved vDPA APIs from experimental to stable.
436
437 * vhost: Add a new function ``rte_vhost_crypto_driver_start`` to be called
438   instead of ``rte_vhost_driver_start`` by crypto applications.
439
440 * cryptodev: The structure ``rte_crypto_sym_vec`` is updated to support both
441   cpu_crypto synchrounous operation and asynchronous raw data-path APIs.
442
443 * cryptodev: ``RTE_CRYPTO_AEAD_LIST_END`` from ``enum rte_crypto_aead_algorithm``,
444   ``RTE_CRYPTO_CIPHER_LIST_END`` from ``enum rte_crypto_cipher_algorithm`` and
445   ``RTE_CRYPTO_AUTH_LIST_END`` from ``enum rte_crypto_auth_algorithm``
446   are removed to avoid future ABI breakage while adding new algorithms.
447
448 * scheduler: Renamed functions ``rte_cryptodev_scheduler_slave_attach``,
449   ``rte_cryptodev_scheduler_slave_detach`` and
450   ``rte_cryptodev_scheduler_slaves_get`` to
451   ``rte_cryptodev_scheduler_worker_attach``,
452   ``rte_cryptodev_scheduler_worker_detach`` and
453   ``rte_cryptodev_scheduler_workers_get`` accordingly.
454
455 * scheduler: Renamed the configuration value
456   ``RTE_CRYPTODEV_SCHEDULER_MAX_NB_SLAVES`` to
457   ``RTE_CRYPTODEV_SCHEDULER_MAX_NB_WORKERS``.
458
459 * security: ``hfn_ovrd`` field in ``rte_security_pdcp_xform`` is changed from
460   ``uint32_t`` to ``uint8_t`` so that a new field ``sdap_enabled`` can be added
461   to support SDAP.
462
463 * ipsec: ``RTE_SATP_LOG2_NUM`` has been dropped from ``enum`` and
464   subsequently moved ``rte_ipsec`` lib from experimental to stable.
465
466 * baseband/fpga_lte_fec: Renamed function ``fpga_lte_fec_configure`` to
467   ``rte_fpga_lte_fec_configure`` and structure ``fpga_lte_fec_conf`` to
468   ``rte_fpga_lte_fec_conf``.
469
470 * baseband/fpga_5gnr_fec: Renamed function ``fpga_5gnr_fec_configure`` to
471   ``rte_fpga_5gnr_fec_configure`` and structure ``fpga_5gnr_fec_conf`` to
472   ``rte_fpga_5gnr_fec_conf``.
473
474 * rawdev: Added a structure size parameter to the functions
475   ``rte_rawdev_queue_setup()``, ``rte_rawdev_queue_conf_get()``,
476   ``rte_rawdev_info_get()`` and ``rte_rawdev_configure()``,
477   allowing limited driver type-checking and ABI compatibility.
478
479 * rawdev: Changed the return type of the function ``rte_dev_info_get()``
480   and the function ``rte_rawdev_queue_conf_get()``
481   from ``void`` to ``int`` allowing the return of error codes from drivers.
482
483 * rawdev: The running of a drivers ``selftest()`` function can now be done
484   using the ``rawdev_autotest`` command in the ``dpdk-test`` binary. This
485   command now calls the self-test function for each rawdev found on the
486   system, and does not require a specific command per device type.
487   Following this change, the ``ioat_rawdev_autotest`` command has been
488   removed as no longer needed.
489
490 * raw/ioat: As noted above, the ``rte_ioat_do_copies()`` and
491   ``rte_ioat_completed_copies()`` functions have been renamed to
492   ``rte_ioat_perform_ops()`` and ``rte_ioat_completed_ops()`` respectively.
493
494 * stack: the experimental tag has been dropped from the stack library, and its
495   interfaces are considered stable as of DPDK 20.11.
496
497 * bpf: ``RTE_BPF_XTYPE_NUM`` has been dropped from ``rte_bpf_xtype``.
498
499 * acl: ``RTE_ACL_CLASSIFY_NUM`` enum value has been removed.
500   This enum value was not used inside DPDK, while it prevented to add new
501   classify algorithms without causing an ABI breakage.
502
503 * sched: Added ``subport_profile_id`` as argument
504   to function ``rte_sched_subport_config``.
505
506 * sched: Removed ``tb_rate``, ``tc_rate``, ``tc_period`` and ``tb_size``
507   from ``struct rte_sched_subport_params``.
508
509
510 ABI Changes
511 -----------
512
513 .. This section should contain ABI changes. Sample format:
514
515    * sample: Add a short 1-2 sentence description of the ABI change
516      which was announced in the previous releases and made in this release.
517      Start with a scope label like "ethdev:".
518      Use fixed width quotes for ``function_names`` or ``struct_names``.
519      Use the past tense.
520
521    This section is a comment. Do not overwrite or remove it.
522    Also, make sure to start the actual text at the margin.
523    =======================================================
524
525 * eal: Removed the not implemented function ``rte_dump_registers()``.
526
527 * ``ethdev`` changes
528
529   * Following device operation function pointers moved
530     from ``struct eth_dev_ops`` to ``struct rte_eth_dev``:
531
532     * ``eth_rx_queue_count_t       rx_queue_count;``
533     * ``eth_rx_descriptor_done_t   rx_descriptor_done;``
534     * ``eth_rx_descriptor_status_t rx_descriptor_status;``
535     * ``eth_tx_descriptor_status_t tx_descriptor_status;``
536
537   * ``struct eth_dev_ops`` is no more accessible by applications,
538     which was already internal data structure.
539
540   * ``ethdev`` internal functions are marked with ``__rte_internal`` tag.
541
542   * Added extensions' attributes to struct ``rte_flow_item_ipv6``.
543     A set of additional values added to struct, indicating the existence of
544     every defined extension header type.
545     Applications should use the new values for identification of existing
546     extensions in the packet header.
547
548   * Added fields ``rx_seg`` and ``rx_nseg`` to ``rte_eth_rxconf`` structure
549     to provide extended description of the receiving buffer.
550
551   * ``struct rte_eth_hairpin_conf`` has two new members:
552
553     * ``uint32_t tx_explicit:1;``
554     * ``uint32_t manual_bind:1;``
555
556   * Added new field ``has_vlan`` to structure ``rte_flow_item_eth``,
557     indicating that packet header contains at least one VLAN.
558
559   * Added new field ``has_more_vlan`` to structure
560     ``rte_flow_item_vlan``, indicating that packet header contains
561     at least one more VLAN, after this VLAN.
562
563 * eventdev: Following structures are modified to support DLB/DLB2 PMDs
564   and future extensions:
565
566   * ``rte_event_dev_info``
567   * ``rte_event_dev_config``
568   * ``rte_event_port_conf``
569
570 * sched: Added new fields to ``struct rte_sched_subport_port_params``.
571
572
573 Known Issues
574 ------------
575
576 .. This section should contain new known issues in this release. Sample format:
577
578    * **Add title in present tense with full stop.**
579
580      Add a short 1-2 sentence description of the known issue
581      in the present tense. Add information on any known workarounds.
582
583    This section is a comment. Do not overwrite or remove it.
584    Also, make sure to start the actual text at the margin.
585    =======================================================
586
587
588 Tested Platforms
589 ----------------
590
591 .. This section should contain a list of platforms that were tested
592    with this release.
593
594    The format is:
595
596    * <vendor> platform with <vendor> <type of devices> combinations
597
598      * List of CPU
599      * List of OS
600      * List of devices
601      * Other relevant details...
602
603    This section is a comment. Do not overwrite or remove it.
604    Also, make sure to start the actual text at the margin.
605    =======================================================