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