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