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