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