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 * **Updated the ipsec-secgw sample application.**
 127
 128   The ``ipsec-secgw`` sample application has been updated to use the new
 129   ``librte_ipsec`` library also added in this release.
 130   The original functionality of ipsec-secgw is retained, a new command line
 131   parameter ``-l`` has  been added to ipsec-secgw to use the IPsec library,
 132   instead of the existing IPsec code in the application.
 133
 134   The IPsec library does not support all the functionality of the existing
 135   ipsec-secgw application, its is planned to add the outstanding functionality
 136   in future releases.
 137
 138   See :doc:`../sample_app_ug/ipsec_secgw` for more information.
 139
 140 * **Enabled checksum support in the ISA-L compressdev driver.**
 141
 142   Added support for both adler and crc32 checksums in the ISA-L PMD.
 143   This aids data integrity across both compression and decompression.
 144
 145 * **Added a compression performance test tool.**
 146
 147   Added a new performance test tool to test the compressdev PMD. The tool tests
 148   compression ratio and compression throughput.
 149
 150 * **Added intel_pstate support to Power Management library.**
 151
 152   Previously, using the power management library required the
 153   disabling of the intel_pstate kernel driver, and the enabling of the
 154   acpi_cpufreq kernel driver. This is no longer the case, as the use of
 155   the intel_pstate kernel driver is now supported, and automatically
 156   detected by the library.
 157
 158
 159 Removed Items
 160 -------------
 161
 162 .. This section should contain removed items in this release. Sample format:
 163
 164    * Add a short 1-2 sentence description of the removed item
 165      in the past tense.
 166
 167    This section is a comment. Do not overwrite or remove it.
 168    Also, make sure to start the actual text at the margin.
 169    =========================================================
 170
 171
 172 API Changes
 173 -----------
 174
 175 .. This section should contain API changes. Sample format:
 176
 177    * sample: Add a short 1-2 sentence description of the API 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 * eal: Function ``rte_bsf64`` in ``rte_bitmap.h`` has been renamed to
 188   ``rte_bsf64_safe`` and moved to ``rte_common.h``. A new ``rte_bsf64`` function
 189   has been added in ``rte_common.h`` that follows convention set by existing
 190   ``rte_bsf32`` function.
 191
 192 * eal: Segment fd API on Linux now sets error code to ``ENOTSUP`` in more cases
 193   where segment fd API is not expected to be supported:
 194
 195   - On attempt to get segment fd for an externally allocated memory segment
 196   - In cases where memfd support would have been required to provide segment
 197     fd's (such as in-memory or no-huge mode)
 198
 199 * eal: Functions ``rte_malloc_dump_stats()``, ``rte_malloc_dump_heaps()`` and
 200   ``rte_malloc_get_socket_stats()`` are no longer safe to call concurrently with
 201   ``rte_malloc_heap_create()`` or ``rte_malloc_heap_destroy()`` function calls.
 202
 203 * mbuf: ``RTE_MBUF_INDIRECT()``, which was deprecated in 18.05, was replaced
 204   with ``RTE_MBUF_CLONED()`` and removed in 19.02.
 205
 206 * sched: As result of the new format of the mbuf sched field, the
 207   functions ``rte_sched_port_pkt_write()`` and
 208   ``rte_sched_port_pkt_read_tree_path()`` got an additional parameter of
 209   type ``struct rte_sched_port``.
 210
 211 * pdump: The ``rte_pdump_set_socket_dir()``, the parameter ``path`` of
 212   ``rte_pdump_init()`` and enum ``rte_pdump_socktype`` were deprecated
 213   since 18.05 and are removed in this release.
 214
 215 * cryptodev: The parameter ``session_pool`` in the function
 216   ``rte_cryptodev_queue_pair_setup()`` is removed.
 217
 218 * cryptodev: a new function ``rte_cryptodev_sym_session_pool_create()`` is
 219   introduced. This function is now mandatory when creating symmetric session
 220   header mempool. Please note all crypto applications are required to use this
 221   function from now on. Failed to do so will cause
 222   ``rte_cryptodev_sym_session_create()`` function call return error.
 223
 224
 225 ABI Changes
 226 -----------
 227
 228 .. This section should contain ABI changes. Sample format:
 229
 230    * sample: Add a short 1-2 sentence description of the ABI change
 231      which was announced in the previous releases and made in this release.
 232      Start with a scope label like "ethdev:".
 233      Use fixed width quotes for ``function_names`` or ``struct_names``.
 234      Use the past tense.
 235
 236    This section is a comment. Do not overwrite or remove it.
 237    Also, make sure to start the actual text at the margin.
 238    =========================================================
 239
 240 * mbuf: The format of the sched field of ``rte_mbuf`` has been changed
 241   to include the following fields: ``queue ID``, ``traffic class``, ``color``.
 242
 243 * cryptodev: as shown in the the 18.11 deprecation notice, the structure
 244   ``rte_cryptodev_qp_conf`` has been added two parameters of symmetric session
 245   mempool and symmetric session private data mempool.
 246
 247 * cryptodev: as shown in the the 18.11 deprecation notice, the structure
 248   ``rte_cryptodev_sym_session`` has been updated to contain more information
 249   to ensure safely accessing the session and session private data.
 250
 251 * security: New field ``uint64_t opaque_data`` is added into
 252   ``rte_security_session`` structure. That would allow upper layer to easily
 253   associate/de-associate some user defined data with the security session.
 254
 255
 256 Shared Library Versions
 257 -----------------------
 258
 259 .. Update any library version updated in this release
 260    and prepend with a ``+`` sign, like this:
 261
 262      libfoo.so.1
 263    + libupdated.so.2
 264      libbar.so.1
 265
 266    This section is a comment. Do not overwrite or remove it.
 267    =========================================================
 268
 269 The libraries prepended with a plus sign were incremented in this version.
 270
 271 .. code-block:: diff
 272
 273      librte_acl.so.2
 274      librte_bbdev.so.1
 275      librte_bitratestats.so.2
 276      librte_bpf.so.1
 277      librte_bus_dpaa.so.2
 278      librte_bus_fslmc.so.2
 279      librte_bus_ifpga.so.2
 280      librte_bus_pci.so.2
 281      librte_bus_vdev.so.2
 282      librte_bus_vmbus.so.2
 283      librte_cfgfile.so.2
 284      librte_cmdline.so.2
 285      librte_compressdev.so.1
 286    + librte_cryptodev.so.6
 287      librte_distributor.so.1
 288      librte_eal.so.9
 289      librte_efd.so.1
 290      librte_ethdev.so.11
 291      librte_eventdev.so.6
 292      librte_flow_classify.so.1
 293      librte_gro.so.1
 294      librte_gso.so.1
 295      librte_hash.so.2
 296      librte_ip_frag.so.1
 297      librte_jobstats.so.1
 298      librte_kni.so.2
 299      librte_kvargs.so.1
 300      librte_latencystats.so.1
 301      librte_lpm.so.2
 302    + librte_mbuf.so.5
 303      librte_member.so.1
 304      librte_mempool.so.5
 305      librte_meter.so.2
 306      librte_metrics.so.1
 307      librte_net.so.1
 308      librte_pci.so.1
 309    + librte_pdump.so.3
 310      librte_pipeline.so.3
 311      librte_pmd_bnxt.so.2
 312      librte_pmd_bond.so.2
 313      librte_pmd_i40e.so.2
 314      librte_pmd_ixgbe.so.2
 315      librte_pmd_dpaa2_qdma.so.1
 316      librte_pmd_ring.so.2
 317      librte_pmd_softnic.so.1
 318      librte_pmd_vhost.so.2
 319      librte_port.so.3
 320      librte_power.so.1
 321      librte_rawdev.so.1
 322      librte_reorder.so.1
 323      librte_ring.so.2
 324    + librte_sched.so.2
 325    + librte_security.so.2
 326      librte_table.so.3
 327      librte_timer.so.1
 328      librte_vhost.so.4
 329
 330
 331 Known Issues
 332 ------------
 333
 334 .. This section should contain new known issues in this release. Sample format:
 335
 336    * **Add title in present tense with full stop.**
 337
 338      Add a short 1-2 sentence description of the known issue
 339      in the present tense. Add information on any known workarounds.
 340
 341    This section is a comment. Do not overwrite or remove it.
 342    Also, make sure to start the actual text at the margin.
 343    =========================================================
 344
 345 * ``AVX-512`` support has been disabled for ``GCC`` builds when ``binutils 2.30``
 346   is detected [1] because of a crash [2]. This can affect ``native`` machine type
 347   build targets on the platforms that support ``AVX512F`` like ``Intel Skylake``
 348   processors, and can cause a possible performance drop. The immediate workaround
 349   is to use ``clang`` compiler on these platforms.
 350   Initial workaround in DPDK v18.11 was to disable ``AVX-512`` support for ``GCC``
 351   completely, but based on information on defect submitted to GCC community [3],
 352   issue has been identified as ``binutils 2.30`` issue. Since currently only GCC
 353   generates ``AVX-512`` instructions, the scope is limited to ``GCC`` and
 354   ``binutils 2.30``
 355
 356   - [1]: Commit ("mk: fix scope of disabling AVX512F support")
 357   - [2]: https://bugs.dpdk.org/show_bug.cgi?id=97
 358   - [3]: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=88096
 359
 360
 361 Tested Platforms
 362 ----------------
 363
 364 .. This section should contain a list of platforms that were tested
 365    with this release.
 366
 367    The format is:
 368
 369    * <vendor> platform with <vendor> <type of devices> combinations
 370
 371      * List of CPU
 372      * List of OS
 373      * List of devices
 374      * Other relevant details...
 375
 376    This section is a comment. Do not overwrite or remove it.
 377    Also, make sure to start the actual text at the margin.
 378    =========================================================