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