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