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