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   * Added support for Chacha20-Poly1305.
 162   * Added support for AES-256 CCM algorithm.
 163
 164 * **Updated the aesni_gcm crypto PMD.**
 165
 166   * Added SGL support for AES-GMAC.
 167
 168 * **Added Broadcom BCMFS symmetric crypto PMD.**
 169
 170   Added a symmetric crypto PMD for Broadcom FlexSparc crypto units.
 171   See :doc:`../cryptodevs/bcmfs` guide for more details on this new PMD.
 172
 173 * **Updated DPAA2_SEC crypto PMD.**
 174
 175   * Added DES-CBC support for cipher_only, chain and ipsec protocol.
 176   * Added support for non-HMAC auth algorithms
 177     (MD5, SHA1, SHA224, SHA256, SHA384, SHA512).
 178
 179 * **Updated Marvell NITROX symmetric crypto PMD.**
 180
 181   * Added AES-GCM support.
 182   * Added cipher only offload support.
 183
 184 * **Updated the OCTEON TX2 crypto PMD.**
 185
 186   * Updated the OCTEON TX2 crypto PMD lookaside protocol offload for IPsec with
 187     IPv6 support.
 188
 189 * **Added Intel ACC100 bbdev PMD.**
 190
 191   Added a new ``acc100`` bbdev driver for the Intel\ |reg| ACC100 accelerator
 192   also known as Mount Bryce.  See the
 193   :doc:`../bbdevs/acc100` BBDEV guide for more details on this new driver.
 194
 195 * **Added Marvell OCTEON TX2 regex PMD.**
 196
 197   Added a new PMD driver for hardware regex offload block for OCTEON TX2 SoC.
 198
 199   See the :doc:`../regexdevs/octeontx2` for more details.
 200
 201 * **Updated ioat rawdev driver**
 202
 203   The ioat rawdev driver has been updated and enhanced. Changes include:
 204
 205   * Added support for Intel\ |reg| Data Streaming Accelerator hardware.
 206     For more information, see https://01.org/blogs/2019/introducing-intel-data-streaming-accelerator
 207   * Added support for the fill operation via the API ``rte_ioat_enqueue_fill()``,
 208     where the hardware fills an area of memory with a repeating pattern.
 209   * Added a per-device configuration flag to disable management
 210     of user-provided completion handles.
 211   * Renamed the ``rte_ioat_do_copies()`` API to ``rte_ioat_perform_ops()``,
 212     and renamed the ``rte_ioat_completed_copies()`` API to ``rte_ioat_completed_ops()``
 213     to better reflect the APIs' purposes, and remove the implication that
 214     they are limited to copy operations only.
 215     [Note: The old API is still provided but marked as deprecated in the code]
 216   * Added a new API ``rte_ioat_fence()`` to add a fence between operations.
 217     This API replaces the ``fence`` flag parameter in the ``rte_ioat_enqueue_copies()`` function,
 218     and is clearer as there is no ambiguity as to whether the flag should be
 219     set on the last operation before the fence or the first operation after it.
 220
 221 * **Updated the pipeline library for alignment with the P4 language.**
 222
 223   Added new Software Switch (SWX) pipeline type that provides more
 224   flexibility through API and feature alignment with the P4 language.
 225
 226   * The packet headers, meta-data, actions, tables and pipelines are
 227     dynamically defined instead of selected from pre-defined set.
 228   * The actions and the pipeline are defined with instructions.
 229   * Extern objects and functions can be plugged into the pipeline.
 230   * Transaction-oriented table updates.
 231
 232 * **Add new AVX512 specific classify algorithms for ACL library.**
 233
 234   * Added new ``RTE_ACL_CLASSIFY_AVX512X16`` vector implementation,
 235     which can process up to 16 flows in parallel. Requires AVX512 support.
 236
 237   * Added new ``RTE_ACL_CLASSIFY_AVX512X32`` vector implementation,
 238     which can process up to 32 flows in parallel. Requires AVX512 support.
 239
 240 * **Added support to update subport bandwidth dynamically.**
 241
 242    * Added new API ``rte_sched_port_subport_profile_add`` to add new
 243      subport bandwidth profile to subport porfile table at runtime.
 244
 245    * Added support to update subport rate dynamically.
 246
 247 * **Updated FIPS validation sample application.**
 248
 249   * Added scatter gather support.
 250   * Added NIST GCMVS complaint GMAC test method support.
 251
 252
 253 Removed Items
 254 -------------
 255
 256 .. This section should contain removed items in this release. Sample format:
 257
 258    * Add a short 1-2 sentence description of the removed item
 259      in the past tense.
 260
 261    This section is a comment. Do not overwrite or remove it.
 262    Also, make sure to start the actual text at the margin.
 263    =======================================================
 264
 265 * vhost: Dequeue zero-copy support has been removed.
 266
 267 * kernel: The module ``igb_uio`` has been moved to the git repository
 268   ``dpdk-kmods`` in a new directory ``linux/igb_uio``.
 269
 270 * Removed Python 2 support since it was EOL'd in January 2020.
 271
 272 API Changes
 273 -----------
 274
 275 .. This section should contain API changes. Sample format:
 276
 277    * sample: Add a short 1-2 sentence description of the API change
 278      which was announced in the previous releases and made in this release.
 279      Start with a scope label like "ethdev:".
 280      Use fixed width quotes for ``function_names`` or ``struct_names``.
 281      Use the past tense.
 282
 283    This section is a comment. Do not overwrite or remove it.
 284    Also, make sure to start the actual text at the margin.
 285    =======================================================
 286
 287 * build macros: The macros defining ``RTE_MACHINE_CPUFLAG_*`` are removed.
 288   The information provided by these macros is available through standard
 289   compiler macros.
 290
 291 * eal: The ``rte_logs`` struct and global symbol was made private
 292   and is no longer part of the API.
 293
 294 * eal: Made the ``rte_dev_event`` structure private to the EAL as no public API
 295   used it.
 296
 297 * eal: ``rte_cio_rmb()`` and ``rte_cio_wmb()`` were deprecated since 20.08
 298   and are removed in this release.
 299
 300 * mem: Removed the unioned field ``phys_addr`` from
 301   the structures ``rte_memseg`` and ``rte_memzone``.
 302   The field ``iova`` is remaining from the old unions.
 303
 304 * mempool: Removed the unioned fields ``phys_addr`` and ``physaddr`` from
 305   the structures ``rte_mempool_memhdr`` and ``rte_mempool_objhdr``.
 306   The field ``iova`` is remaining from the old unions.
 307   The flag name ``MEMPOOL_F_NO_PHYS_CONTIG`` is removed,
 308   while the aliased flag ``MEMPOOL_F_NO_IOVA_CONTIG`` is kept.
 309
 310 * mbuf: Removed the functions ``rte_mbuf_data_dma_addr*``
 311   and the macros ``rte_pktmbuf_mtophys*``.
 312   The same functionality is still available with the functions and macros
 313   having ``iova`` in their names instead of ``dma_addr`` or ``mtophys``.
 314
 315 * mbuf: Removed the unioned field ``buf_physaddr`` from ``rte_mbuf``.
 316   The field ``buf_iova`` is remaining from the old union.
 317
 318 * mbuf: Removed the unioned field ``refcnt_atomic`` from
 319   the structures ``rte_mbuf`` and ``rte_mbuf_ext_shared_info``.
 320   The field ``refcnt`` is remaining from the old unions.
 321
 322 * pci: Removed the ``rte_kernel_driver`` enum defined in rte_dev.h and
 323   replaced with a private enum in the PCI subsystem.
 324
 325 * pci: Removed the PCI resources map API from the public API
 326   (``pci_map_resource`` and ``pci_unmap_resource``) and moved it to the
 327   PCI bus driver along with the PCI resources lists and associated structures
 328   (``pci_map``, ``pci_msix_table``, ``mapped_pci_resource`` and
 329   ``mapped_pci_res_list``).
 330
 331 * ethdev: Removed the ``kdrv`` field in the ethdev ``rte_eth_dev_data``
 332   structure as it gave no useful abstracted information to the applications.
 333
 334 * ethdev: ``rte_eth_rx_descriptor_done()`` API has been deprecated.
 335
 336 * Renamed internal ethdev APIs:
 337
 338   * ``_rte_eth_dev_callback_process()`` -> ``rte_eth_dev_callback_process()``
 339   * ``_rte_eth_dev_reset`` -> ``rte_eth_dev_internal_reset()``
 340
 341 * ethdev: Modified field type of ``base`` and ``nb_queue`` in struct
 342   ``rte_eth_dcb_tc_queue_mapping`` from ``uint8_t`` to ``uint16_t``.
 343   As the data of ``uint8_t`` will be truncated when queue number under
 344   a TC is greater than 256.
 345
 346 * vhost: Moved vDPA APIs from experimental to stable.
 347
 348 * cryptodev: The structure ``rte_crypto_sym_vec`` is updated to support both
 349   cpu_crypto synchrounous operation and asynchronous raw data-path APIs.
 350
 351 * scheduler: Renamed functions ``rte_cryptodev_scheduler_slave_attach``,
 352   ``rte_cryptodev_scheduler_slave_detach`` and
 353   ``rte_cryptodev_scheduler_slaves_get`` to
 354   ``rte_cryptodev_scheduler_worker_attach``,
 355   ``rte_cryptodev_scheduler_worker_detach`` and
 356   ``rte_cryptodev_scheduler_workers_get`` accordingly.
 357
 358 * scheduler: Renamed the configuration value
 359   ``RTE_CRYPTODEV_SCHEDULER_MAX_NB_SLAVES`` to
 360   ``RTE_CRYPTODEV_SCHEDULER_MAX_NB_WORKERS``.
 361
 362 * ipsec: ``RTE_SATP_LOG2_NUM`` has been dropped from ``enum`` and
 363   subsequently moved ``rte_ipsec`` lib from experimental to stable.
 364
 365 * baseband/fpga_lte_fec: Renamed function ``fpga_lte_fec_configure`` to
 366   ``rte_fpga_lte_fec_configure`` and structure ``fpga_lte_fec_conf`` to
 367   ``rte_fpga_lte_fec_conf``.
 368
 369 * baseband/fpga_5gnr_fec: Renamed function ``fpga_5gnr_fec_configure`` to
 370   ``rte_fpga_5gnr_fec_configure`` and structure ``fpga_5gnr_fec_conf`` to
 371   ``rte_fpga_5gnr_fec_conf``.
 372
 373 * rawdev: Added a structure size parameter to the functions
 374   ``rte_rawdev_queue_setup()``, ``rte_rawdev_queue_conf_get()``,
 375   ``rte_rawdev_info_get()`` and ``rte_rawdev_configure()``,
 376   allowing limited driver type-checking and ABI compatibility.
 377
 378 * rawdev: Changed the return type of the function ``rte_dev_info_get()``
 379   and the function ``rte_rawdev_queue_conf_get()``
 380   from ``void`` to ``int`` allowing the return of error codes from drivers.
 381
 382 * rawdev: The running of a drivers ``selftest()`` function can now be done
 383   using the ``rawdev_autotest`` command in the ``dpdk-test`` binary. This
 384   command now calls the self-test function for each rawdev found on the
 385   system, and does not require a specific command per device type.
 386   Following this change, the ``ioat_rawdev_autotest`` command has been
 387   removed as no longer needed.
 388
 389 * raw/ioat: As noted above, the ``rte_ioat_do_copies()`` and
 390   ``rte_ioat_completed_copies()`` functions have been renamed to
 391   ``rte_ioat_perform_ops()`` and ``rte_ioat_completed_ops()`` respectively.
 392
 393 * stack: the experimental tag has been dropped from the stack library, and its
 394   interfaces are considered stable as of DPDK 20.11.
 395
 396 * bpf: ``RTE_BPF_XTYPE_NUM`` has been dropped from ``rte_bpf_xtype``.
 397
 398 * acl: ``RTE_ACL_CLASSIFY_NUM`` enum value has been removed.
 399   This enum value was not used inside DPDK, while it prevented to add new
 400   classify algorithms without causing an ABI breakage.
 401
 402 * sched: Added ``subport_profile_id`` as argument
 403   to function ``rte_sched_subport_config``.
 404
 405 * sched: Removed ``tb_rate``, ``tc_rate``, ``tc_period`` and ``tb_size``
 406   from ``struct rte_sched_subport_params``.
 407
 408
 409 ABI Changes
 410 -----------
 411
 412 .. This section should contain ABI changes. Sample format:
 413
 414    * sample: Add a short 1-2 sentence description of the ABI change
 415      which was announced in the previous releases and made in this release.
 416      Start with a scope label like "ethdev:".
 417      Use fixed width quotes for ``function_names`` or ``struct_names``.
 418      Use the past tense.
 419
 420    This section is a comment. Do not overwrite or remove it.
 421    Also, make sure to start the actual text at the margin.
 422    =======================================================
 423
 424 * eal: Removed the not implemented function ``rte_dump_registers()``.
 425
 426 * ``ethdev`` changes
 427
 428   * Following device operation function pointers moved
 429     from ``struct eth_dev_ops`` to ``struct rte_eth_dev``:
 430
 431     * ``eth_rx_queue_count_t       rx_queue_count;``
 432     * ``eth_rx_descriptor_done_t   rx_descriptor_done;``
 433     * ``eth_rx_descriptor_status_t rx_descriptor_status;``
 434     * ``eth_tx_descriptor_status_t tx_descriptor_status;``
 435
 436   * ``struct eth_dev_ops`` is no more accessible by applications,
 437     which was already internal data structure.
 438
 439   * ``ethdev`` internal functions are marked with ``__rte_internal`` tag.
 440
 441 * sched: Added new fields to ``struct rte_sched_subport_port_params``.
 442
 443
 444 Known Issues
 445 ------------
 446
 447 .. This section should contain new known issues in this release. Sample format:
 448
 449    * **Add title in present tense with full stop.**
 450
 451      Add a short 1-2 sentence description of the known issue
 452      in the present tense. Add information on any known workarounds.
 453
 454    This section is a comment. Do not overwrite or remove it.
 455    Also, make sure to start the actual text at the margin.
 456    =======================================================
 457
 458
 459 Tested Platforms
 460 ----------------
 461
 462 .. This section should contain a list of platforms that were tested
 463    with this release.
 464
 465    The format is:
 466
 467    * <vendor> platform with <vendor> <type of devices> combinations
 468
 469      * List of CPU
 470      * List of OS
 471      * List of devices
 472      * Other relevant details...
 473
 474    This section is a comment. Do not overwrite or remove it.
 475    Also, make sure to start the actual text at the margin.
 476    =======================================================