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