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