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