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