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