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 * **Updated CRC modules of the net library.**
  72
  73   * Added runtime selection of the optimal architecture-specific CRC path.
  74   * Added optimized implementations of CRC32-Ethernet and CRC16-CCITT
  75     using the AVX512 and VPCLMULQDQ instruction sets.
  76
  77 * **Added the FEC API, for a generic FEC query and config.**
  78
  79   Added the FEC API which provides functions for query FEC capabilities and
  80   current FEC mode from device. Also, API for configuring FEC mode is also provided.
  81
  82 * **Updated Broadcom bnxt driver.**
  83
  84   Updated the Broadcom bnxt driver with new features and improvements, including:
  85
  86   * Added support for 200G PAM4 link speed.
  87   * Added support for RSS hash level selection.
  88   * Updated HWRM structures to 1.10.1.70 version.
  89
  90 * **Updated Cisco enic driver.**
  91
  92   * Added support for VF representors with single-queue Tx/Rx and flow API
  93   * Added support for egress PORT_ID action
  94   * Added support for non-zero priorities for group 0 flows
  95   * Added support for VXLAN decap combined with VLAN pop
  96
  97 * **Added hns3 FEC PMD, for supporting query and config FEC mode.**
  98
  99   Added the FEC PMD which provides functions for query FEC capabilities and
 100   current FEC mode from device. Also, PMD for configuring FEC mode is also provided.
 101
 102 * **Updated Solarflare network PMD.**
 103
 104   Updated the Solarflare ``sfc_efx`` driver with changes including:
 105
 106   * Added SR-IOV PF support
 107
 108 * **Updated Virtio driver.**
 109
 110   * Added support for Vhost-vDPA backend to Virtio-user PMD.
 111   * Changed default link speed to unknown.
 112   * Added support for 200G link speed.
 113
 114 * **Updated Intel i40e driver.**
 115
 116   Updated the Intel i40e driver to use write combining stores.
 117
 118 * **Updated Intel ixgbe driver.**
 119
 120   Updated the Intel ixgbe driver to use write combining stores.
 121
 122 * **Updated Intel ice driver.**
 123
 124   Updated the Intel ice driver to use write combining stores.
 125
 126 * **Updated Intel qat driver.**
 127
 128   Updated the Intel qat driver to use write combining stores.
 129
 130 * **Added Ice Lake (Gen4) support for Intel NTB.**
 131
 132   Added NTB device support (4th generation) for Intel Ice Lake platform.
 133
 134 * **Added UDP/IPv4 GRO support for VxLAN and non-VxLAN packets.**
 135
 136   For VxLAN packets, added inner UDP/IPv4 support.
 137   For non-VxLAN packets, added UDP/IPv4 support.
 138
 139 * **Extended flow-perf application.**
 140
 141   * Started supporting user order instead of bit mask:
 142     Now the user can create any structure of rte_flow
 143     using flow performance application with any order,
 144     moreover the app also now starts to support inner
 145     items matching as well.
 146   * Added header modify actions.
 147   * Added flag action.
 148   * Added raw encap/decap actions.
 149   * Added VXLAN encap/decap actions.
 150   * Added ICMP and ICMP6 matching items.
 151   * Added option to set port mask for insertion/deletion:
 152     ``--portmask=N``
 153     where N represents the hexadecimal bitmask of ports used.
 154
 155 * **Updated the aesni_mb crypto PMD.**
 156
 157   * Added support for AES-ECB 128, 192 and 256.
 158   * Added support for ZUC-EEA3/EIA3 algorithms.
 159   * Added support for SNOW3G-UEA2/UIA2 algorithms.
 160   * Added support for KASUMI-F8/F9 algorithms.
 161
 162 * **Updated the aesni_gcm crypto PMD.**
 163
 164   * Added SGL support for AES-GMAC.
 165
 166 * **Added Broadcom BCMFS symmetric crypto PMD.**
 167
 168   Added a symmetric crypto PMD for Broadcom FlexSparc crypto units.
 169   See :doc:`../cryptodevs/bcmfs` guide for more details on this new PMD.
 170
 171 * **Updated DPAA2_SEC crypto PMD.**
 172
 173   * Added DES-CBC support for cipher_only, chain and ipsec protocol.
 174   * Added support for non-HMAC auth algorithms
 175     (MD5, SHA1, SHA224, SHA256, SHA384, SHA512).
 176
 177 * **Updated Marvell NITROX symmetric crypto PMD.**
 178
 179   * Added AES-GCM support.
 180   * Added cipher only offload support.
 181
 182 * **Updated the OCTEON TX2 crypto PMD.**
 183
 184   * Updated the OCTEON TX2 crypto PMD lookaside protocol offload for IPsec with
 185     IPv6 support.
 186
 187 * **Added Intel ACC100 bbdev PMD.**
 188
 189   Added a new ``acc100`` bbdev driver for the Intel\ |reg| ACC100 accelerator
 190   also known as Mount Bryce.  See the
 191   :doc:`../bbdevs/acc100` BBDEV guide for more details on this new driver.
 192
 193 * **Added Marvell OCTEON TX2 regex PMD.**
 194
 195   Added a new PMD driver for hardware regex offload block for OCTEON TX2 SoC.
 196
 197   See the :doc:`../regexdevs/octeontx2` for more details.
 198
 199 * **Updated ioat rawdev driver**
 200
 201   The ioat rawdev driver has been updated and enhanced. Changes include:
 202
 203   * Added support for Intel\ |reg| Data Streaming Accelerator hardware.
 204     For more information, see https://01.org/blogs/2019/introducing-intel-data-streaming-accelerator
 205   * Added support for the fill operation via the API ``rte_ioat_enqueue_fill()``,
 206     where the hardware fills an area of memory with a repeating pattern.
 207   * Added a per-device configuration flag to disable management
 208     of user-provided completion handles.
 209   * Renamed the ``rte_ioat_do_copies()`` API to ``rte_ioat_perform_ops()``,
 210     and renamed the ``rte_ioat_completed_copies()`` API to ``rte_ioat_completed_ops()``
 211     to better reflect the APIs' purposes, and remove the implication that
 212     they are limited to copy operations only.
 213     [Note: The old API is still provided but marked as deprecated in the code]
 214   * Added a new API ``rte_ioat_fence()`` to add a fence between operations.
 215     This API replaces the ``fence`` flag parameter in the ``rte_ioat_enqueue_copies()`` function,
 216     and is clearer as there is no ambiguity as to whether the flag should be
 217     set on the last operation before the fence or the first operation after it.
 218
 219 * **Updated the pipeline library for alignment with the P4 language.**
 220
 221   Added new Software Switch (SWX) pipeline type that provides more
 222   flexibility through API and feature alignment with the P4 language.
 223
 224   * The packet headers, meta-data, actions, tables and pipelines are
 225     dynamically defined instead of selected from pre-defined set.
 226   * The actions and the pipeline are defined with instructions.
 227   * Extern objects and functions can be plugged into the pipeline.
 228   * Transaction-oriented table updates.
 229
 230 * **Add new AVX512 specific classify algorithms for ACL library.**
 231
 232   * Added new ``RTE_ACL_CLASSIFY_AVX512X16`` vector implementation,
 233     which can process up to 16 flows in parallel. Requires AVX512 support.
 234
 235   * Added new ``RTE_ACL_CLASSIFY_AVX512X32`` vector implementation,
 236     which can process up to 32 flows in parallel. Requires AVX512 support.
 237
 238 * **Added support to update subport bandwidth dynamically.**
 239
 240    * Added new API ``rte_sched_port_subport_profile_add`` to add new
 241      subport bandwidth profile to subport porfile table at runtime.
 242
 243    * Added support to update subport rate dynamically.
 244
 245 * **Updated FIPS validation sample application.**
 246
 247   * Added scatter gather support.
 248   * Added NIST GCMVS complaint GMAC test method support.
 249
 250
 251 Removed Items
 252 -------------
 253
 254 .. This section should contain removed items in this release. Sample format:
 255
 256    * Add a short 1-2 sentence description of the removed item
 257      in the past tense.
 258
 259    This section is a comment. Do not overwrite or remove it.
 260    Also, make sure to start the actual text at the margin.
 261    =======================================================
 262
 263 * vhost: Dequeue zero-copy support has been removed.
 264
 265 * kernel: The module ``igb_uio`` has been moved to the git repository
 266   ``dpdk-kmods`` in a new directory ``linux/igb_uio``.
 267
 268 * Removed Python 2 support since it was EOL'd in January 2020.
 269
 270 API Changes
 271 -----------
 272
 273 .. This section should contain API changes. Sample format:
 274
 275    * sample: Add a short 1-2 sentence description of the API change
 276      which was announced in the previous releases and made in this release.
 277      Start with a scope label like "ethdev:".
 278      Use fixed width quotes for ``function_names`` or ``struct_names``.
 279      Use the past tense.
 280
 281    This section is a comment. Do not overwrite or remove it.
 282    Also, make sure to start the actual text at the margin.
 283    =======================================================
 284
 285 * build macros: The macros defining ``RTE_MACHINE_CPUFLAG_*`` are removed.
 286   The information provided by these macros is available through standard
 287   compiler macros.
 288
 289 * eal: The ``rte_logs`` struct and global symbol was made private
 290   and is no longer part of the API.
 291
 292 * eal: Made the ``rte_dev_event`` structure private to the EAL as no public API
 293   used it.
 294
 295 * eal: ``rte_cio_rmb()`` and ``rte_cio_wmb()`` were deprecated since 20.08
 296   and are removed in this release.
 297
 298 * mem: Removed the unioned field ``phys_addr`` from
 299   the structures ``rte_memseg`` and ``rte_memzone``.
 300   The field ``iova`` is remaining from the old unions.
 301
 302 * mempool: Removed the unioned fields ``phys_addr`` and ``physaddr`` from
 303   the structures ``rte_mempool_memhdr`` and ``rte_mempool_objhdr``.
 304   The field ``iova`` is remaining from the old unions.
 305   The flag name ``MEMPOOL_F_NO_PHYS_CONTIG`` is removed,
 306   while the aliased flag ``MEMPOOL_F_NO_IOVA_CONTIG`` is kept.
 307
 308 * mbuf: Removed the functions ``rte_mbuf_data_dma_addr*``
 309   and the macros ``rte_pktmbuf_mtophys*``.
 310   The same functionality is still available with the functions and macros
 311   having ``iova`` in their names instead of ``dma_addr`` or ``mtophys``.
 312
 313 * mbuf: Removed the unioned field ``buf_physaddr`` from ``rte_mbuf``.
 314   The field ``buf_iova`` is remaining from the old union.
 315
 316 * mbuf: Removed the unioned field ``refcnt_atomic`` from
 317   the structures ``rte_mbuf`` and ``rte_mbuf_ext_shared_info``.
 318   The field ``refcnt`` is remaining from the old unions.
 319
 320 * pci: Removed the ``rte_kernel_driver`` enum defined in rte_dev.h and
 321   replaced with a private enum in the PCI subsystem.
 322
 323 * pci: Removed the PCI resources map API from the public API
 324   (``pci_map_resource`` and ``pci_unmap_resource``) and moved it to the
 325   PCI bus driver along with the PCI resources lists and associated structures
 326   (``pci_map``, ``pci_msix_table``, ``mapped_pci_resource`` and
 327   ``mapped_pci_res_list``).
 328
 329 * ethdev: Removed the ``kdrv`` field in the ethdev ``rte_eth_dev_data``
 330   structure as it gave no useful abstracted information to the applications.
 331
 332 * ethdev: ``rte_eth_rx_descriptor_done()`` API has been deprecated.
 333
 334 * Renamed internal ethdev APIs:
 335
 336   * ``_rte_eth_dev_callback_process()`` -> ``rte_eth_dev_callback_process()``
 337   * ``_rte_eth_dev_reset`` -> ``rte_eth_dev_internal_reset()``
 338
 339 * ethdev: Modified field type of ``base`` and ``nb_queue`` in struct
 340   ``rte_eth_dcb_tc_queue_mapping`` from ``uint8_t`` to ``uint16_t``.
 341   As the data of ``uint8_t`` will be truncated when queue number under
 342   a TC is greater than 256.
 343
 344 * vhost: Moved vDPA APIs from experimental to stable.
 345
 346 * scheduler: Renamed functions ``rte_cryptodev_scheduler_slave_attach``,
 347   ``rte_cryptodev_scheduler_slave_detach`` and
 348   ``rte_cryptodev_scheduler_slaves_get`` to
 349   ``rte_cryptodev_scheduler_worker_attach``,
 350   ``rte_cryptodev_scheduler_worker_detach`` and
 351   ``rte_cryptodev_scheduler_workers_get`` accordingly.
 352
 353 * scheduler: Renamed the configuration value
 354   ``RTE_CRYPTODEV_SCHEDULER_MAX_NB_SLAVES`` to
 355   ``RTE_CRYPTODEV_SCHEDULER_MAX_NB_WORKERS``.
 356
 357 * ipsec: ``RTE_SATP_LOG2_NUM`` has been dropped from ``enum`` and
 358   subsequently moved ``rte_ipsec`` lib from experimental to stable.
 359
 360 * baseband/fpga_lte_fec: Renamed function ``fpga_lte_fec_configure`` to
 361   ``rte_fpga_lte_fec_configure`` and structure ``fpga_lte_fec_conf`` to
 362   ``rte_fpga_lte_fec_conf``.
 363
 364 * baseband/fpga_5gnr_fec: Renamed function ``fpga_5gnr_fec_configure`` to
 365   ``rte_fpga_5gnr_fec_configure`` and structure ``fpga_5gnr_fec_conf`` to
 366   ``rte_fpga_5gnr_fec_conf``.
 367
 368 * rawdev: Added a structure size parameter to the functions
 369   ``rte_rawdev_queue_setup()``, ``rte_rawdev_queue_conf_get()``,
 370   ``rte_rawdev_info_get()`` and ``rte_rawdev_configure()``,
 371   allowing limited driver type-checking and ABI compatibility.
 372
 373 * rawdev: Changed the return type of the function ``rte_dev_info_get()``
 374   and the function ``rte_rawdev_queue_conf_get()``
 375   from ``void`` to ``int`` allowing the return of error codes from drivers.
 376
 377 * rawdev: The running of a drivers ``selftest()`` function can now be done
 378   using the ``rawdev_autotest`` command in the ``dpdk-test`` binary. This
 379   command now calls the self-test function for each rawdev found on the
 380   system, and does not require a specific command per device type.
 381   Following this change, the ``ioat_rawdev_autotest`` command has been
 382   removed as no longer needed.
 383
 384 * raw/ioat: As noted above, the ``rte_ioat_do_copies()`` and
 385   ``rte_ioat_completed_copies()`` functions have been renamed to
 386   ``rte_ioat_perform_ops()`` and ``rte_ioat_completed_ops()`` respectively.
 387
 388 * stack: the experimental tag has been dropped from the stack library, and its
 389   interfaces are considered stable as of DPDK 20.11.
 390
 391 * bpf: ``RTE_BPF_XTYPE_NUM`` has been dropped from ``rte_bpf_xtype``.
 392
 393 * acl: ``RTE_ACL_CLASSIFY_NUM`` enum value has been removed.
 394   This enum value was not used inside DPDK, while it prevented to add new
 395   classify algorithms without causing an ABI breakage.
 396
 397 * sched: Added ``subport_profile_id`` as argument
 398   to function ``rte_sched_subport_config``.
 399
 400 * sched: Removed ``tb_rate``, ``tc_rate``, ``tc_period`` and ``tb_size``
 401   from ``struct rte_sched_subport_params``.
 402
 403
 404 ABI Changes
 405 -----------
 406
 407 .. This section should contain ABI changes. Sample format:
 408
 409    * sample: Add a short 1-2 sentence description of the ABI change
 410      which was announced in the previous releases and made in this release.
 411      Start with a scope label like "ethdev:".
 412      Use fixed width quotes for ``function_names`` or ``struct_names``.
 413      Use the past tense.
 414
 415    This section is a comment. Do not overwrite or remove it.
 416    Also, make sure to start the actual text at the margin.
 417    =======================================================
 418
 419 * eal: Removed the not implemented function ``rte_dump_registers()``.
 420
 421 * ``ethdev`` changes
 422
 423   * Following device operation function pointers moved
 424     from ``struct eth_dev_ops`` to ``struct rte_eth_dev``:
 425
 426     * ``eth_rx_queue_count_t       rx_queue_count;``
 427     * ``eth_rx_descriptor_done_t   rx_descriptor_done;``
 428     * ``eth_rx_descriptor_status_t rx_descriptor_status;``
 429     * ``eth_tx_descriptor_status_t tx_descriptor_status;``
 430
 431   * ``struct eth_dev_ops`` is no more accessible by applications,
 432     which was already internal data structure.
 433
 434   * ``ethdev`` internal functions are marked with ``__rte_internal`` tag.
 435
 436 * sched: Added new fields to ``struct rte_sched_subport_port_params``.
 437
 438
 439 Known Issues
 440 ------------
 441
 442 .. This section should contain new known issues in this release. Sample format:
 443
 444    * **Add title in present tense with full stop.**
 445
 446      Add a short 1-2 sentence description of the known issue
 447      in the present tense. Add information on any known workarounds.
 448
 449    This section is a comment. Do not overwrite or remove it.
 450    Also, make sure to start the actual text at the margin.
 451    =======================================================
 452
 453
 454 Tested Platforms
 455 ----------------
 456
 457 .. This section should contain a list of platforms that were tested
 458    with this release.
 459
 460    The format is:
 461
 462    * <vendor> platform with <vendor> <type of devices> combinations
 463
 464      * List of CPU
 465      * List of OS
 466      * List of devices
 467      * Other relevant details...
 468
 469    This section is a comment. Do not overwrite or remove it.
 470    Also, make sure to start the actual text at the margin.
 471    =======================================================