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