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 ICE net PMD**
  84
  85   Added the new ``ice`` net driver for Intel® Ethernet Network Adapters E810.
  86   See the :doc:`../nics/ice` NIC guide for more details on this new driver.
  87
  88 * **Added support for SW-assisted VDPA live migration.**
  89
  90   This SW-assisted VDPA live migration facility helps VDPA devices without
  91   logging capability to perform live migration, a mediated SW relay can help
  92   devices to track dirty pages caused by DMA. IFC driver has enabled this
  93   SW-assisted live migration mode.
  94
  95 * **Added a compression performance test tool.**
  96
  97   Added a new performance test tool to test the compressdev PMD. The tool tests
  98   compression ratio and compression throughput.
  99
 100
 101 Removed Items
 102 -------------
 103
 104 .. This section should contain removed items in this release. Sample format:
 105
 106    * Add a short 1-2 sentence description of the removed item
 107      in the past tense.
 108
 109    This section is a comment. Do not overwrite or remove it.
 110    Also, make sure to start the actual text at the margin.
 111    =========================================================
 112
 113
 114 API Changes
 115 -----------
 116
 117 .. This section should contain API changes. Sample format:
 118
 119    * sample: Add a short 1-2 sentence description of the API change
 120      which was announced in the previous releases and made in this release.
 121      Start with a scope label like "ethdev:".
 122      Use fixed width quotes for ``function_names`` or ``struct_names``.
 123      Use the past tense.
 124
 125    This section is a comment. Do not overwrite or remove it.
 126    Also, make sure to start the actual text at the margin.
 127    =========================================================
 128
 129 * eal: Function ``rte_bsf64`` in ``rte_bitmap.h`` has been renamed to
 130   ``rte_bsf64_safe`` and moved to ``rte_common.h``. A new ``rte_bsf64`` function
 131   has been added in ``rte_common.h`` that follows convention set by existing
 132   ``rte_bsf32`` function.
 133
 134 * eal: Segment fd API on Linux now sets error code to ``ENOTSUP`` in more cases
 135   where segment fd API is not expected to be supported:
 136
 137   - On attempt to get segment fd for an externally allocated memory segment
 138   - In cases where memfd support would have been required to provide segment
 139     fd's (such as in-memory or no-huge mode)
 140
 141 * eal: Functions ``rte_malloc_dump_stats()``, ``rte_malloc_dump_heaps()`` and
 142   ``rte_malloc_get_socket_stats()`` are no longer safe to call concurrently with
 143   ``rte_malloc_heap_create()`` or ``rte_malloc_heap_destroy()`` function calls.
 144
 145 * pdump: The ``rte_pdump_set_socket_dir()``, the parameter ``path`` of
 146   ``rte_pdump_init()`` and enum ``rte_pdump_socktype`` were deprecated
 147   since 18.05 and are removed in this release.
 148
 149
 150 ABI Changes
 151 -----------
 152
 153 .. This section should contain ABI changes. Sample format:
 154
 155    * sample: Add a short 1-2 sentence description of the ABI change
 156      which was announced in the previous releases and made in this release.
 157      Start with a scope label like "ethdev:".
 158      Use fixed width quotes for ``function_names`` or ``struct_names``.
 159      Use the past tense.
 160
 161    This section is a comment. Do not overwrite or remove it.
 162    Also, make sure to start the actual text at the margin.
 163    =========================================================
 164
 165
 166 Shared Library Versions
 167 -----------------------
 168
 169 .. Update any library version updated in this release
 170    and prepend with a ``+`` sign, like this:
 171
 172      libfoo.so.1
 173    + libupdated.so.2
 174      libbar.so.1
 175
 176    This section is a comment. Do not overwrite or remove it.
 177    =========================================================
 178
 179 The libraries prepended with a plus sign were incremented in this version.
 180
 181 .. code-block:: diff
 182
 183      librte_acl.so.2
 184      librte_bbdev.so.1
 185      librte_bitratestats.so.2
 186      librte_bpf.so.1
 187      librte_bus_dpaa.so.2
 188      librte_bus_fslmc.so.2
 189      librte_bus_ifpga.so.2
 190      librte_bus_pci.so.2
 191      librte_bus_vdev.so.2
 192      librte_bus_vmbus.so.2
 193      librte_cfgfile.so.2
 194      librte_cmdline.so.2
 195      librte_compressdev.so.1
 196      librte_cryptodev.so.5
 197      librte_distributor.so.1
 198      librte_eal.so.9
 199      librte_efd.so.1
 200      librte_ethdev.so.11
 201      librte_eventdev.so.6
 202      librte_flow_classify.so.1
 203      librte_gro.so.1
 204      librte_gso.so.1
 205      librte_hash.so.2
 206      librte_ip_frag.so.1
 207      librte_jobstats.so.1
 208      librte_kni.so.2
 209      librte_kvargs.so.1
 210      librte_latencystats.so.1
 211      librte_lpm.so.2
 212      librte_mbuf.so.4
 213      librte_member.so.1
 214      librte_mempool.so.5
 215      librte_meter.so.2
 216      librte_metrics.so.1
 217      librte_net.so.1
 218      librte_pci.so.1
 219    + librte_pdump.so.3
 220      librte_pipeline.so.3
 221      librte_pmd_bnxt.so.2
 222      librte_pmd_bond.so.2
 223      librte_pmd_i40e.so.2
 224      librte_pmd_ixgbe.so.2
 225      librte_pmd_dpaa2_qdma.so.1
 226      librte_pmd_ring.so.2
 227      librte_pmd_softnic.so.1
 228      librte_pmd_vhost.so.2
 229      librte_port.so.3
 230      librte_power.so.1
 231      librte_rawdev.so.1
 232      librte_reorder.so.1
 233      librte_ring.so.2
 234      librte_sched.so.1
 235      librte_security.so.1
 236      librte_table.so.3
 237      librte_timer.so.1
 238      librte_vhost.so.4
 239
 240
 241 Known Issues
 242 ------------
 243
 244 .. This section should contain new known issues in this release. Sample format:
 245
 246    * **Add title in present tense with full stop.**
 247
 248      Add a short 1-2 sentence description of the known issue
 249      in the present tense. Add information on any known workarounds.
 250
 251    This section is a comment. Do not overwrite or remove it.
 252    Also, make sure to start the actual text at the margin.
 253    =========================================================
 254
 255
 256 Tested Platforms
 257 ----------------
 258
 259 .. This section should contain a list of platforms that were tested
 260    with this release.
 261
 262    The format is:
 263
 264    * <vendor> platform with <vendor> <type of devices> combinations
 265
 266      * List of CPU
 267      * List of OS
 268      * List of devices
 269      * Other relevant details...
 270
 271    This section is a comment. Do not overwrite or remove it.
 272    Also, make sure to start the actual text at the margin.
 273    =========================================================