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