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 * **Updated CRC modules of the net library.**
  66
  67   * Added runtime selection of the optimal architecture-specific CRC path.
  68   * Added optimized implementations of CRC32-Ethernet and CRC16-CCITT
  69     using the AVX512 and VPCLMULQDQ instruction sets.
  70
  71 * **Added the FEC API, for a generic FEC query and config.**
  72
  73   Added the FEC API which provides functions for query FEC capabilities and
  74   current FEC mode from device. Also, API for configuring FEC mode is also provided.
  75
  76 * **Updated Broadcom bnxt driver.**
  77
  78   Updated the Broadcom bnxt driver with new features and improvements, including:
  79
  80   * Added support for 200G PAM4 link speed.
  81   * Added support for RSS hash level selection.
  82   * Updated HWRM structures to 1.10.1.70 version.
  83
  84 * **Updated Cisco enic driver.**
  85
  86   * Added support for VF representors with single-queue Tx/Rx and flow API
  87   * Added support for egress PORT_ID action
  88   * Added support for non-zero priorities for group 0 flows
  89   * Added support for VXLAN decap combined with VLAN pop
  90
  91 * **Added hns3 FEC PMD, for supporting query and config FEC mode.**
  92
  93   Added the FEC PMD which provides functions for query FEC capabilities and
  94   current FEC mode from device. Also, PMD for configuring FEC mode is also provided.
  95
  96 * **Updated Solarflare network PMD.**
  97
  98   Updated the Solarflare ``sfc_efx`` driver with changes including:
  99
 100   * Added SR-IOV PF support
 101
 102 * **Updated Virtio driver.**
 103
 104   * Added support for Vhost-vDPA backend to Virtio-user PMD.
 105   * Changed default link speed to unknown.
 106   * Added support for 200G link speed.
 107
 108 * **Updated Intel i40e driver.**
 109
 110   Updated the Intel i40e driver to use write combining stores.
 111
 112 * **Updated Intel ixgbe driver.**
 113
 114   Updated the Intel ixgbe driver to use write combining stores.
 115
 116 * **Updated Intel ice driver.**
 117
 118   Updated the Intel ice driver to use write combining stores.
 119
 120 * **Updated Intel qat driver.**
 121
 122   Updated the Intel qat driver to use write combining stores.
 123
 124 * **Added Ice Lake (Gen4) support for Intel NTB.**
 125
 126   Added NTB device support (4th generation) for Intel Ice Lake platform.
 127
 128 * **Added UDP/IPv4 GRO support for VxLAN and non-VxLAN packets.**
 129
 130   For VxLAN packets, added inner UDP/IPv4 support.
 131   For non-VxLAN packets, added UDP/IPv4 support.
 132
 133 * **Extended flow-perf application.**
 134
 135   * Started supporting user order instead of bit mask:
 136     Now the user can create any structure of rte_flow
 137     using flow performance application with any order,
 138     moreover the app also now starts to support inner
 139     items matching as well.
 140   * Added header modify actions.
 141   * Added flag action.
 142   * Added raw encap/decap actions.
 143   * Added VXLAN encap/decap actions.
 144   * Added ICMP and ICMP6 matching items.
 145   * Added option to set port mask for insertion/deletion:
 146     ``--portmask=N``
 147     where N represents the hexadecimal bitmask of ports used.
 148
 149 * **Added Marvell OCTEON TX2 regex PMD.**
 150
 151   Added a new PMD driver for hardware regex offload block for OCTEON TX2 SoC.
 152
 153   See the :doc:`../regexdevs/octeontx2` for more details.
 154
 155 * **Updated ioat rawdev driver**
 156
 157   The ioat rawdev driver has been updated and enhanced. Changes include:
 158
 159   * Added support for Intel\ |reg| Data Streaming Accelerator hardware.
 160     For more information, see https://01.org/blogs/2019/introducing-intel-data-streaming-accelerator
 161   * Added support for the fill operation via the API ``rte_ioat_enqueue_fill()``,
 162     where the hardware fills an area of memory with a repeating pattern.
 163   * Added a per-device configuration flag to disable management
 164     of user-provided completion handles.
 165   * Renamed the ``rte_ioat_do_copies()`` API to ``rte_ioat_perform_ops()``,
 166     and renamed the ``rte_ioat_completed_copies()`` API to ``rte_ioat_completed_ops()``
 167     to better reflect the APIs' purposes, and remove the implication that
 168     they are limited to copy operations only.
 169     [Note: The old API is still provided but marked as deprecated in the code]
 170   * Added a new API ``rte_ioat_fence()`` to add a fence between operations.
 171     This API replaces the ``fence`` flag parameter in the ``rte_ioat_enqueue_copies()`` function,
 172     and is clearer as there is no ambiguity as to whether the flag should be
 173     set on the last operation before the fence or the first operation after it.
 174
 175 * **Updated the pipeline library for alignment with the P4 language.**
 176
 177   Added new Software Switch (SWX) pipeline type that provides more
 178   flexibility through API and feature alignment with the P4 language.
 179
 180   * The packet headers, meta-data, actions, tables and pipelines are
 181     dynamically defined instead of selected from pre-defined set.
 182   * The actions and the pipeline are defined with instructions.
 183   * Extern objects and functions can be plugged into the pipeline.
 184   * Transaction-oriented table updates.
 185
 186 * **Add new AVX512 specific classify algorithms for ACL library.**
 187
 188   * Added new ``RTE_ACL_CLASSIFY_AVX512X16`` vector implementation,
 189     which can process up to 16 flows in parallel. Requires AVX512 support.
 190
 191
 192 Removed Items
 193 -------------
 194
 195 .. This section should contain removed items in this release. Sample format:
 196
 197    * Add a short 1-2 sentence description of the removed item
 198      in the past tense.
 199
 200    This section is a comment. Do not overwrite or remove it.
 201    Also, make sure to start the actual text at the margin.
 202    =======================================================
 203
 204 * vhost: Dequeue zero-copy support has been removed.
 205
 206 * kernel: The module ``igb_uio`` has been moved to the git repository
 207   ``dpdk-kmods`` in a new directory ``linux/igb_uio``.
 208
 209 * Removed Python 2 support since it was EOL'd in January 2020.
 210
 211 API Changes
 212 -----------
 213
 214 .. This section should contain API changes. Sample format:
 215
 216    * sample: Add a short 1-2 sentence description of the API change
 217      which was announced in the previous releases and made in this release.
 218      Start with a scope label like "ethdev:".
 219      Use fixed width quotes for ``function_names`` or ``struct_names``.
 220      Use the past tense.
 221
 222    This section is a comment. Do not overwrite or remove it.
 223    Also, make sure to start the actual text at the margin.
 224    =======================================================
 225
 226 * build macros: The macros defining ``RTE_MACHINE_CPUFLAG_*`` are removed.
 227   The information provided by these macros is available through standard
 228   compiler macros.
 229
 230 * eal: The ``rte_logs`` struct and global symbol was made private
 231   and is no longer part of the API.
 232
 233 * eal: Made the ``rte_dev_event`` structure private to the EAL as no public API
 234   used it.
 235
 236 * eal: ``rte_cio_rmb()`` and ``rte_cio_wmb()`` were deprecated since 20.08
 237   and are removed in this release.
 238
 239 * mem: Removed the unioned field ``phys_addr`` from
 240   the structures ``rte_memseg`` and ``rte_memzone``.
 241   The field ``iova`` is remaining from the old unions.
 242
 243 * mempool: Removed the unioned fields ``phys_addr`` and ``physaddr`` from
 244   the structures ``rte_mempool_memhdr`` and ``rte_mempool_objhdr``.
 245   The field ``iova`` is remaining from the old unions.
 246   The flag name ``MEMPOOL_F_NO_PHYS_CONTIG`` is removed,
 247   while the aliased flag ``MEMPOOL_F_NO_IOVA_CONTIG`` is kept.
 248
 249 * mbuf: Removed the functions ``rte_mbuf_data_dma_addr*``
 250   and the macros ``rte_pktmbuf_mtophys*``.
 251   The same functionality is still available with the functions and macros
 252   having ``iova`` in their names instead of ``dma_addr`` or ``mtophys``.
 253
 254 * mbuf: Removed the unioned field ``buf_physaddr`` from ``rte_mbuf``.
 255   The field ``buf_iova`` is remaining from the old union.
 256
 257 * mbuf: Removed the unioned field ``refcnt_atomic`` from
 258   the structures ``rte_mbuf`` and ``rte_mbuf_ext_shared_info``.
 259   The field ``refcnt`` is remaining from the old unions.
 260
 261 * pci: Removed the ``rte_kernel_driver`` enum defined in rte_dev.h and
 262   replaced with a private enum in the PCI subsystem.
 263
 264 * pci: Removed the PCI resources map API from the public API
 265   (``pci_map_resource`` and ``pci_unmap_resource``) and moved it to the
 266   PCI bus driver along with the PCI resources lists and associated structures
 267   (``pci_map``, ``pci_msix_table``, ``mapped_pci_resource`` and
 268   ``mapped_pci_res_list``).
 269
 270 * ethdev: Removed the ``kdrv`` field in the ethdev ``rte_eth_dev_data``
 271   structure as it gave no useful abstracted information to the applications.
 272
 273 * ethdev: ``rte_eth_rx_descriptor_done()`` API has been deprecated.
 274
 275 * Renamed internal ethdev APIs:
 276
 277   * ``_rte_eth_dev_callback_process()`` -> ``rte_eth_dev_callback_process()``
 278   * ``_rte_eth_dev_reset`` -> ``rte_eth_dev_internal_reset()``
 279
 280 * ethdev: Modified field type of ``base`` and ``nb_queue`` in struct
 281   ``rte_eth_dcb_tc_queue_mapping`` from ``uint8_t`` to ``uint16_t``.
 282   As the data of ``uint8_t`` will be truncated when queue number under
 283   a TC is greater than 256.
 284
 285 * vhost: Moved vDPA APIs from experimental to stable.
 286
 287 * rawdev: Added a structure size parameter to the functions
 288   ``rte_rawdev_queue_setup()``, ``rte_rawdev_queue_conf_get()``,
 289   ``rte_rawdev_info_get()`` and ``rte_rawdev_configure()``,
 290   allowing limited driver type-checking and ABI compatibility.
 291
 292 * rawdev: Changed the return type of the function ``rte_dev_info_get()``
 293   and the function ``rte_rawdev_queue_conf_get()``
 294   from ``void`` to ``int`` allowing the return of error codes from drivers.
 295
 296 * rawdev: The running of a drivers ``selftest()`` function can now be done
 297   using the ``rawdev_autotest`` command in the ``dpdk-test`` binary. This
 298   command now calls the self-test function for each rawdev found on the
 299   system, and does not require a specific command per device type.
 300   Following this change, the ``ioat_rawdev_autotest`` command has been
 301   removed as no longer needed.
 302
 303 * raw/ioat: As noted above, the ``rte_ioat_do_copies()`` and
 304   ``rte_ioat_completed_copies()`` functions have been renamed to
 305   ``rte_ioat_perform_ops()`` and ``rte_ioat_completed_ops()`` respectively.
 306
 307 * stack: the experimental tag has been dropped from the stack library, and its
 308   interfaces are considered stable as of DPDK 20.11.
 309
 310 * bpf: ``RTE_BPF_XTYPE_NUM`` has been dropped from ``rte_bpf_xtype``.
 311
 312 * acl: ``RTE_ACL_CLASSIFY_NUM`` enum value has been removed.
 313   This enum value was not used inside DPDK, while it prevented to add new
 314   classify algorithms without causing an ABI breakage.
 315
 316
 317 ABI Changes
 318 -----------
 319
 320 .. This section should contain ABI changes. Sample format:
 321
 322    * sample: Add a short 1-2 sentence description of the ABI change
 323      which was announced in the previous releases and made in this release.
 324      Start with a scope label like "ethdev:".
 325      Use fixed width quotes for ``function_names`` or ``struct_names``.
 326      Use the past tense.
 327
 328    This section is a comment. Do not overwrite or remove it.
 329    Also, make sure to start the actual text at the margin.
 330    =======================================================
 331
 332 * ``ethdev`` changes
 333
 334   * Following device operation function pointers moved
 335     from ``struct eth_dev_ops`` to ``struct rte_eth_dev``:
 336
 337     * ``eth_rx_queue_count_t       rx_queue_count;``
 338     * ``eth_rx_descriptor_done_t   rx_descriptor_done;``
 339     * ``eth_rx_descriptor_status_t rx_descriptor_status;``
 340     * ``eth_tx_descriptor_status_t tx_descriptor_status;``
 341
 342   * ``struct eth_dev_ops`` is no more accessible by applications,
 343     which was already internal data structure.
 344
 345   * ``ethdev`` internal functions are marked with ``__rte_internal`` tag.
 346
 347
 348 Known Issues
 349 ------------
 350
 351 .. This section should contain new known issues in this release. Sample format:
 352
 353    * **Add title in present tense with full stop.**
 354
 355      Add a short 1-2 sentence description of the known issue
 356      in the present tense. Add information on any known workarounds.
 357
 358    This section is a comment. Do not overwrite or remove it.
 359    Also, make sure to start the actual text at the margin.
 360    =======================================================
 361
 362
 363 Tested Platforms
 364 ----------------
 365
 366 .. This section should contain a list of platforms that were tested
 367    with this release.
 368
 369    The format is:
 370
 371    * <vendor> platform with <vendor> <type of devices> combinations
 372
 373      * List of CPU
 374      * List of OS
 375      * List of devices
 376      * Other relevant details...
 377
 378    This section is a comment. Do not overwrite or remove it.
 379    Also, make sure to start the actual text at the margin.
 380    =======================================================