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