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