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