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