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 * **Updated ioat rawdev driver**
 150
 151   The ioat rawdev driver has been updated and enhanced. Changes include:
 152
 153   * Added support for Intel\ |reg| Data Streaming Accelerator hardware.
 154     For more information, see https://01.org/blogs/2019/introducing-intel-data-streaming-accelerator
 155   * Added support for the fill operation via the API ``rte_ioat_enqueue_fill()``,
 156     where the hardware fills an area of memory with a repeating pattern.
 157   * Added a per-device configuration flag to disable management
 158     of user-provided completion handles.
 159   * Renamed the ``rte_ioat_do_copies()`` API to ``rte_ioat_perform_ops()``,
 160     and renamed the ``rte_ioat_completed_copies()`` API to ``rte_ioat_completed_ops()``
 161     to better reflect the APIs' purposes, and remove the implication that
 162     they are limited to copy operations only.
 163     [Note: The old API is still provided but marked as deprecated in the code]
 164   * Added a new API ``rte_ioat_fence()`` to add a fence between operations.
 165     This API replaces the ``fence`` flag parameter in the ``rte_ioat_enqueue_copies()`` function,
 166     and is clearer as there is no ambiguity as to whether the flag should be
 167     set on the last operation before the fence or the first operation after it.
 168
 169 * **Updated the pipeline library for alignment with the P4 language.**
 170
 171   Added new Software Switch (SWX) pipeline type that provides more
 172   flexibility through API and feature alignment with the P4 language.
 173
 174   * The packet headers, meta-data, actions, tables and pipelines are
 175     dynamically defined instead of selected from pre-defined set.
 176   * The actions and the pipeline are defined with instructions.
 177   * Extern objects and functions can be plugged into the pipeline.
 178   * Transaction-oriented table updates.
 179
 180
 181 Removed Items
 182 -------------
 183
 184 .. This section should contain removed items in this release. Sample format:
 185
 186    * Add a short 1-2 sentence description of the removed item
 187      in the past tense.
 188
 189    This section is a comment. Do not overwrite or remove it.
 190    Also, make sure to start the actual text at the margin.
 191    =======================================================
 192
 193 * vhost: Dequeue zero-copy support has been removed.
 194
 195 * kernel: The module ``igb_uio`` has been moved to the git repository
 196   ``dpdk-kmods`` in a new directory ``linux/igb_uio``.
 197
 198 * Removed Python 2 support since it was EOL'd in January 2020.
 199
 200 API Changes
 201 -----------
 202
 203 .. This section should contain API changes. Sample format:
 204
 205    * sample: Add a short 1-2 sentence description of the API change
 206      which was announced in the previous releases and made in this release.
 207      Start with a scope label like "ethdev:".
 208      Use fixed width quotes for ``function_names`` or ``struct_names``.
 209      Use the past tense.
 210
 211    This section is a comment. Do not overwrite or remove it.
 212    Also, make sure to start the actual text at the margin.
 213    =======================================================
 214
 215 * build macros: The macros defining ``RTE_MACHINE_CPUFLAG_*`` are removed.
 216   The information provided by these macros is available through standard
 217   compiler macros.
 218
 219 * eal: The ``rte_logs`` struct and global symbol was made private
 220   and is no longer part of the API.
 221
 222 * eal: Made the ``rte_dev_event`` structure private to the EAL as no public API
 223   used it.
 224
 225 * eal: ``rte_cio_rmb()`` and ``rte_cio_wmb()`` were deprecated since 20.08
 226   and are removed in this release.
 227
 228 * mem: Removed the unioned field ``phys_addr`` from
 229   the structures ``rte_memseg`` and ``rte_memzone``.
 230   The field ``iova`` is remaining from the old unions.
 231
 232 * mempool: Removed the unioned fields ``phys_addr`` and ``physaddr`` from
 233   the structures ``rte_mempool_memhdr`` and ``rte_mempool_objhdr``.
 234   The field ``iova`` is remaining from the old unions.
 235   The flag name ``MEMPOOL_F_NO_PHYS_CONTIG`` is removed,
 236   while the aliased flag ``MEMPOOL_F_NO_IOVA_CONTIG`` is kept.
 237
 238 * mbuf: Removed the functions ``rte_mbuf_data_dma_addr*``
 239   and the macros ``rte_pktmbuf_mtophys*``.
 240   The same functionality is still available with the functions and macros
 241   having ``iova`` in their names instead of ``dma_addr`` or ``mtophys``.
 242
 243 * mbuf: Removed the unioned field ``buf_physaddr`` from ``rte_mbuf``.
 244   The field ``buf_iova`` is remaining from the old union.
 245
 246 * mbuf: Removed the unioned field ``refcnt_atomic`` from
 247   the structures ``rte_mbuf`` and ``rte_mbuf_ext_shared_info``.
 248   The field ``refcnt`` is remaining from the old unions.
 249
 250 * pci: Removed the ``rte_kernel_driver`` enum defined in rte_dev.h and
 251   replaced with a private enum in the PCI subsystem.
 252
 253 * pci: Removed the PCI resources map API from the public API
 254   (``pci_map_resource`` and ``pci_unmap_resource``) and moved it to the
 255   PCI bus driver along with the PCI resources lists and associated structures
 256   (``pci_map``, ``pci_msix_table``, ``mapped_pci_resource`` and
 257   ``mapped_pci_res_list``).
 258
 259 * ethdev: Removed the ``kdrv`` field in the ethdev ``rte_eth_dev_data``
 260   structure as it gave no useful abstracted information to the applications.
 261
 262 * ethdev: ``rte_eth_rx_descriptor_done()`` API has been deprecated.
 263
 264 * Renamed internal ethdev APIs:
 265
 266   * ``_rte_eth_dev_callback_process()`` -> ``rte_eth_dev_callback_process()``
 267   * ``_rte_eth_dev_reset`` -> ``rte_eth_dev_internal_reset()``
 268
 269 * ethdev: Modified field type of ``base`` and ``nb_queue`` in struct
 270   ``rte_eth_dcb_tc_queue_mapping`` from ``uint8_t`` to ``uint16_t``.
 271   As the data of ``uint8_t`` will be truncated when queue number under
 272   a TC is greater than 256.
 273
 274 * vhost: Moved vDPA APIs from experimental to stable.
 275
 276 * rawdev: Added a structure size parameter to the functions
 277   ``rte_rawdev_queue_setup()``, ``rte_rawdev_queue_conf_get()``,
 278   ``rte_rawdev_info_get()`` and ``rte_rawdev_configure()``,
 279   allowing limited driver type-checking and ABI compatibility.
 280
 281 * rawdev: Changed the return type of the function ``rte_dev_info_get()``
 282   and the function ``rte_rawdev_queue_conf_get()``
 283   from ``void`` to ``int`` allowing the return of error codes from drivers.
 284
 285 * rawdev: The running of a drivers ``selftest()`` function can now be done
 286   using the ``rawdev_autotest`` command in the ``dpdk-test`` binary. This
 287   command now calls the self-test function for each rawdev found on the
 288   system, and does not require a specific command per device type.
 289   Following this change, the ``ioat_rawdev_autotest`` command has been
 290   removed as no longer needed.
 291
 292 * raw/ioat: As noted above, the ``rte_ioat_do_copies()`` and
 293   ``rte_ioat_completed_copies()`` functions have been renamed to
 294   ``rte_ioat_perform_ops()`` and ``rte_ioat_completed_ops()`` respectively.
 295
 296 * stack: the experimental tag has been dropped from the stack library, and its
 297   interfaces are considered stable as of DPDK 20.11.
 298
 299 * bpf: ``RTE_BPF_XTYPE_NUM`` has been dropped from ``rte_bpf_xtype``.
 300
 301
 302 ABI Changes
 303 -----------
 304
 305 .. This section should contain ABI changes. Sample format:
 306
 307    * sample: Add a short 1-2 sentence description of the ABI change
 308      which was announced in the previous releases and made in this release.
 309      Start with a scope label like "ethdev:".
 310      Use fixed width quotes for ``function_names`` or ``struct_names``.
 311      Use the past tense.
 312
 313    This section is a comment. Do not overwrite or remove it.
 314    Also, make sure to start the actual text at the margin.
 315    =======================================================
 316
 317 * ``ethdev`` changes
 318
 319   * Following device operation function pointers moved
 320     from ``struct eth_dev_ops`` to ``struct rte_eth_dev``:
 321
 322     * ``eth_rx_queue_count_t       rx_queue_count;``
 323     * ``eth_rx_descriptor_done_t   rx_descriptor_done;``
 324     * ``eth_rx_descriptor_status_t rx_descriptor_status;``
 325     * ``eth_tx_descriptor_status_t tx_descriptor_status;``
 326
 327   * ``struct eth_dev_ops`` is no more accessible by applications,
 328     which was already internal data structure.
 329
 330   * ``ethdev`` internal functions are marked with ``__rte_internal`` tag.
 331
 332
 333 Known Issues
 334 ------------
 335
 336 .. This section should contain new known issues in this release. Sample format:
 337
 338    * **Add title in present tense with full stop.**
 339
 340      Add a short 1-2 sentence description of the known issue
 341      in the present tense. Add information on any known workarounds.
 342
 343    This section is a comment. Do not overwrite or remove it.
 344    Also, make sure to start the actual text at the margin.
 345    =======================================================
 346
 347
 348 Tested Platforms
 349 ----------------
 350
 351 .. This section should contain a list of platforms that were tested
 352    with this release.
 353
 354    The format is:
 355
 356    * <vendor> platform with <vendor> <type of devices> combinations
 357
 358      * List of CPU
 359      * List of OS
 360      * List of devices
 361      * Other relevant details...
 362
 363    This section is a comment. Do not overwrite or remove it.
 364    Also, make sure to start the actual text at the margin.
 365    =======================================================