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