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