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