doc/guides/rel_notes/release_19_02.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright 2018 The DPDK contributors
   3
   4 DPDK Release 19.02
   5 ==================
   6
   7 .. **Read this first.**
   8
   9    The text in the sections below explains how to update the release notes.
  10
  11    Use proper spelling, capitalization and punctuation in all sections.
  12
  13    Variable and config names should be quoted as fixed width text:
  14    ``LIKE_THIS``.
  15
  16    Build the docs and view the output file to ensure the changes are correct::
  17
  18       make doc-guides-html
  19
  20       xdg-open build/doc/html/guides/rel_notes/release_19_02.html
  21
  22
  23 New Features
  24 ------------
  25
  26 .. This section should contain new features added in this release.
  27    Sample format:
  28
  29    * **Add a title in the past tense with a full stop.**
  30
  31      Add a short 1-2 sentence description in the past tense.
  32      The description should be enough to allow someone scanning
  33      the release notes to understand the new feature.
  34
  35      If the feature adds a lot of sub-features you can use a bullet list
  36      like this:
  37
  38      * Added feature foo to do something.
  39      * Enhanced feature bar to do something else.
  40
  41      Refer to the previous release notes for examples.
  42
  43      Suggested order in release notes items:
  44      * Core libs (EAL, mempool, ring, mbuf, buses)
  45      * Device abstraction libs and PMDs
  46        - ethdev (lib, PMDs)
  47        - cryptodev (lib, PMDs)
  48        - eventdev (lib, PMDs)
  49        - etc
  50      * Other libs
  51      * Apps, Examples, Tools (if significant)
  52
  53      This section is a comment. Do not overwrite or remove it.
  54      Also, make sure to start the actual text at the margin.
  55      =========================================================
  56
  57 * **Added support to free hugepages exactly as originally allocated.**
  58
  59   Some applications using memory event callbacks (especially for managing
  60   RDMA memory regions) require that memory be freed back to the system
  61   exactly as it was originally allocated. These applications typically
  62   also require that a malloc allocation not span across two separate
  63   hugepage allocations.  A new ``--match-allocations`` EAL init flag has
  64   been added to fulfill both of these requirements.
  65
  66 * **Added API to register external memory in DPDK.**
  67
  68   A new ``rte_extmem_register``/``rte_extmem_unregister`` API was added to allow
  69   chunks of external memory to be registered with DPDK without adding them to
  70   the malloc heap.
  71
  72 * **Support for using virtio-user without hugepages**
  73
  74   The --no-huge mode was augmented to use memfd-backed memory (on systems that
  75   support memfd), to allow using virtio-user-based NICs without hugepages.
  76
  77 * **Updated the enic driver.**
  78
  79   * Added support for ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
  80   * Added the handler to get firmware version string.
  81   * Added support for multicast filtering.
  82
  83 * **Added support for SW-assisted VDPA live migration.**
  84
  85   This SW-assisted VDPA live migration facility helps VDPA devices without
  86   logging capability to perform live migration, a mediated SW relay can help
  87   devices to track dirty pages caused by DMA. IFC driver has enabled this
  88   SW-assisted live migration mode.
  89
  90 * **Added a compression performance test tool.**
  91
  92   Added a new performance test tool to test the compressdev PMD. The tool tests
  93   compression ratio and compression throughput.
  94
  95
  96 Removed Items
  97 -------------
  98
  99 .. This section should contain removed items in this release. Sample format:
 100
 101    * Add a short 1-2 sentence description of the removed item
 102      in the past tense.
 103
 104    This section is a comment. Do not overwrite or remove it.
 105    Also, make sure to start the actual text at the margin.
 106    =========================================================
 107
 108
 109 API Changes
 110 -----------
 111
 112 .. This section should contain API changes. Sample format:
 113
 114    * sample: Add a short 1-2 sentence description of the API change
 115      which was announced in the previous releases and made in this release.
 116      Start with a scope label like "ethdev:".
 117      Use fixed width quotes for ``function_names`` or ``struct_names``.
 118      Use the past tense.
 119
 120    This section is a comment. Do not overwrite or remove it.
 121    Also, make sure to start the actual text at the margin.
 122    =========================================================
 123
 124 * eal: Function ``rte_bsf64`` in ``rte_bitmap.h`` has been renamed to
 125   ``rte_bsf64_safe`` and moved to ``rte_common.h``. A new ``rte_bsf64`` function
 126   has been added in ``rte_common.h`` that follows convention set by existing
 127   ``rte_bsf32`` function.
 128
 129 * eal: Segment fd API on Linux now sets error code to ``ENOTSUP`` in more cases
 130   where segment fd API is not expected to be supported:
 131
 132   - On attempt to get segment fd for an externally allocated memory segment
 133   - In cases where memfd support would have been required to provide segment
 134     fd's (such as in-memory or no-huge mode)
 135
 136 * eal: Functions ``rte_malloc_dump_stats()``, ``rte_malloc_dump_heaps()`` and
 137   ``rte_malloc_get_socket_stats()`` are no longer safe to call concurrently with
 138   ``rte_malloc_heap_create()`` or ``rte_malloc_heap_destroy()`` function calls.
 139
 140 * pdump: The ``rte_pdump_set_socket_dir()``, the parameter ``path`` of
 141   ``rte_pdump_init()`` and enum ``rte_pdump_socktype`` were deprecated
 142   since 18.05 and are removed in this release.
 143
 144
 145 ABI Changes
 146 -----------
 147
 148 .. This section should contain ABI changes. Sample format:
 149
 150    * sample: Add a short 1-2 sentence description of the ABI change
 151      which was announced in the previous releases and made in this release.
 152      Start with a scope label like "ethdev:".
 153      Use fixed width quotes for ``function_names`` or ``struct_names``.
 154      Use the past tense.
 155
 156    This section is a comment. Do not overwrite or remove it.
 157    Also, make sure to start the actual text at the margin.
 158    =========================================================
 159
 160
 161 Shared Library Versions
 162 -----------------------
 163
 164 .. Update any library version updated in this release
 165    and prepend with a ``+`` sign, like this:
 166
 167      libfoo.so.1
 168    + libupdated.so.2
 169      libbar.so.1
 170
 171    This section is a comment. Do not overwrite or remove it.
 172    =========================================================
 173
 174 The libraries prepended with a plus sign were incremented in this version.
 175
 176 .. code-block:: diff
 177
 178      librte_acl.so.2
 179      librte_bbdev.so.1
 180      librte_bitratestats.so.2
 181      librte_bpf.so.1
 182      librte_bus_dpaa.so.2
 183      librte_bus_fslmc.so.2
 184      librte_bus_ifpga.so.2
 185      librte_bus_pci.so.2
 186      librte_bus_vdev.so.2
 187      librte_bus_vmbus.so.2
 188      librte_cfgfile.so.2
 189      librte_cmdline.so.2
 190      librte_compressdev.so.1
 191      librte_cryptodev.so.5
 192      librte_distributor.so.1
 193      librte_eal.so.9
 194      librte_efd.so.1
 195      librte_ethdev.so.11
 196      librte_eventdev.so.6
 197      librte_flow_classify.so.1
 198      librte_gro.so.1
 199      librte_gso.so.1
 200      librte_hash.so.2
 201      librte_ip_frag.so.1
 202      librte_jobstats.so.1
 203      librte_kni.so.2
 204      librte_kvargs.so.1
 205      librte_latencystats.so.1
 206      librte_lpm.so.2
 207      librte_mbuf.so.4
 208      librte_member.so.1
 209      librte_mempool.so.5
 210      librte_meter.so.2
 211      librte_metrics.so.1
 212      librte_net.so.1
 213      librte_pci.so.1
 214    + librte_pdump.so.3
 215      librte_pipeline.so.3
 216      librte_pmd_bnxt.so.2
 217      librte_pmd_bond.so.2
 218      librte_pmd_i40e.so.2
 219      librte_pmd_ixgbe.so.2
 220      librte_pmd_dpaa2_qdma.so.1
 221      librte_pmd_ring.so.2
 222      librte_pmd_softnic.so.1
 223      librte_pmd_vhost.so.2
 224      librte_port.so.3
 225      librte_power.so.1
 226      librte_rawdev.so.1
 227      librte_reorder.so.1
 228      librte_ring.so.2
 229      librte_sched.so.1
 230      librte_security.so.1
 231      librte_table.so.3
 232      librte_timer.so.1
 233      librte_vhost.so.4
 234
 235
 236 Known Issues
 237 ------------
 238
 239 .. This section should contain new known issues in this release. Sample format:
 240
 241    * **Add title in present tense with full stop.**
 242
 243      Add a short 1-2 sentence description of the known issue
 244      in the present tense. Add information on any known workarounds.
 245
 246    This section is a comment. Do not overwrite or remove it.
 247    Also, make sure to start the actual text at the margin.
 248    =========================================================
 249
 250
 251 Tested Platforms
 252 ----------------
 253
 254 .. This section should contain a list of platforms that were tested
 255    with this release.
 256
 257    The format is:
 258
 259    * <vendor> platform with <vendor> <type of devices> combinations
 260
 261      * List of CPU
 262      * List of OS
 263      * List of devices
 264      * Other relevant details...
 265
 266    This section is a comment. Do not overwrite or remove it.
 267    Also, make sure to start the actual text at the margin.
 268    =========================================================