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