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