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