doc/guides/rel_notes/release_19_05.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright 2019 The DPDK contributors
   3
   4 DPDK Release 19.05
   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_05.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 Stack API.**
  58
  59   Added a new stack API for configuration and use of a bounded stack of
  60   pointers. The API provides MT-safe push and pop operations that can operate
  61   on one or more pointers per operation.
  62
  63   The library supports two stack implementations: standard (lock-based) and lock-free.
  64   The lock-free implementation is currently limited to x86-64 platforms.
  65
  66 * **Added Lock-Free Stack Mempool Handler.**
  67
  68   Added a new lock-free stack handler, which uses the newly added stack
  69   library.
  70
  71 * **Updated KNI module and PMD.**
  72
  73   Updated the KNI kernel module to set the max_mtu according to the given
  74   initial MTU size. Without it, the maximum MTU was 1500.
  75
  76   Updated the KNI PMD driver to set the mbuf_size and MTU based on
  77   the given mb-pool. This provide the ability to pass jumbo frames
  78   if the mb-pool contains suitable buffers' size.
  79
  80 * **Updated Solarflare network PMD.**
  81
  82   Updated the sfc_efx driver including the following changes:
  83
  84   * Added support for Rx descriptor status and related API in a secondary
  85     process.
  86   * Added support for Tx descriptor status API in a secondary process.
  87   * Added support for RSS RETA and hash configuration get API in a secondary
  88     process.
  89   * Added support for Rx packet types list in a secondary process.
  90
  91 * **Updated Mellanox drivers.**
  92
  93    New features and improvements were done in mlx4 and mlx5 PMDs:
  94
  95    * Added firmware version reading.
  96
  97 * **Renamed avf to iavf.**
  98
  99   Renamed Intel Ethernet Adaptive Virtual Function driver ``avf`` to ``iavf``,
 100   which includes the directory name, lib name, filenames, makefile, docs,
 101   macros, functions, structs and any other strings in the code.
 102
 103 * **Updated the enic driver.**
 104
 105   * Fixed several flow (director) bugs related to MARK, SCTP, VLAN, VXLAN, and
 106     inner packet matching.
 107   * Added limited support for RAW.
 108   * Added limited support for RSS.
 109   * Added limited support for PASSTHRU.
 110
 111 * **Updated the ixgbe driver.**
 112
 113   New features for VF:
 114
 115   * Added promiscuous mode support.
 116
 117 * **Updated the ice driver.**
 118
 119   * Added support of SSE and AVX2 instructions in Rx and Tx paths.
 120   * Added package download support.
 121   * Added Safe Mode support.
 122   * Supported RSS for UPD/TCP/SCTP+IPV4/IPV6 packets.
 123
 124 * **Updated the QuickAssist Technology PMD.**
 125
 126   Added support for AES-XTS with 128 and 256 bit AES keys.
 127
 128 * **Updated AESNI-MB PMD.**
 129
 130   Added support for out-of-place operations.
 131
 132 * **Updated the IPsec library.**
 133
 134   The IPsec library has been updated with AES-CTR and 3DES-CBC cipher algorithms
 135   support. The related ipsec-secgw test scripts have been added.
 136
 137 * **Updated the testpmd application.**
 138
 139   Improved testpmd application performance on ARM platform. For ``macswap``
 140   forwarding mode, NEON intrinsics were used to do swap to save CPU cycles.
 141
 142
 143 Removed Items
 144 -------------
 145
 146 .. This section should contain removed items in this release. Sample format:
 147
 148    * Add a short 1-2 sentence description of the removed item
 149      in the past tense.
 150
 151    This section is a comment. Do not overwrite or remove it.
 152    Also, make sure to start the actual text at the margin.
 153    =========================================================
 154
 155
 156 API Changes
 157 -----------
 158
 159 .. This section should contain API changes. Sample format:
 160
 161    * sample: Add a short 1-2 sentence description of the API change
 162      which was announced in the previous releases and made in this release.
 163      Start with a scope label like "ethdev:".
 164      Use fixed width quotes for ``function_names`` or ``struct_names``.
 165      Use 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 * eal: the type of the ``attr_value`` parameter of the function
 172   ``rte_service_attr_get()`` has been changed
 173   from ``uint32_t *`` to ``uint64_t *``.
 174
 175 * vfio: Functions ``rte_vfio_container_dma_map`` and
 176   ``rte_vfio_container_dma_unmap`` have been extended with an option to
 177   request mapping or un-mapping to the default vfio container fd.
 178
 179
 180 ABI Changes
 181 -----------
 182
 183 .. This section should contain ABI changes. Sample format:
 184
 185    * sample: Add a short 1-2 sentence description of the ABI change
 186      which was announced in the previous releases and made in this release.
 187      Start with a scope label like "ethdev:".
 188      Use fixed width quotes for ``function_names`` or ``struct_names``.
 189      Use the past tense.
 190
 191    This section is a comment. Do not overwrite or remove it.
 192    Also, make sure to start the actual text at the margin.
 193    =========================================================
 194
 195 * ethdev: Additional fields in rte_eth_dev_info.
 196
 197   The ``rte_eth_dev_info`` structure has had two extra fields
 198   added: ``min_mtu`` and ``max_mtu``. Each of these are of type ``uint16_t``.
 199   The values of these fields can be set specifically by the PMD drivers as
 200   supported values can vary from device to device.
 201
 202 * cryptodev: in 18.08 new structure ``rte_crypto_asym_op`` was introduced and
 203   included into ``rte_crypto_op``. As ``rte_crypto_asym_op`` structure was
 204   defined as cache-line aligned that caused unintended changes in
 205   ``rte_crypto_op`` structure layout and alignment. Remove cache-line
 206   alignment for ``rte_crypto_asym_op`` to restore expected ``rte_crypto_op``
 207   layout and alignment.
 208
 209
 210 Shared Library Versions
 211 -----------------------
 212
 213 .. Update any library version updated in this release
 214    and prepend with a ``+`` sign, like this:
 215
 216      libfoo.so.1
 217    + libupdated.so.2
 218      libbar.so.1
 219
 220    This section is a comment. Do not overwrite or remove it.
 221    =========================================================
 222
 223 The libraries prepended with a plus sign were incremented in this version.
 224
 225 .. code-block:: diff
 226
 227      librte_acl.so.2
 228      librte_bbdev.so.1
 229      librte_bitratestats.so.2
 230      librte_bpf.so.1
 231      librte_bus_dpaa.so.2
 232      librte_bus_fslmc.so.2
 233      librte_bus_ifpga.so.2
 234      librte_bus_pci.so.2
 235      librte_bus_vdev.so.2
 236      librte_bus_vmbus.so.2
 237      librte_cfgfile.so.2
 238      librte_cmdline.so.2
 239      librte_compressdev.so.1
 240    + librte_cryptodev.so.7
 241      librte_distributor.so.1
 242    + librte_eal.so.10
 243      librte_efd.so.1
 244    + librte_ethdev.so.12
 245      librte_eventdev.so.6
 246      librte_flow_classify.so.1
 247      librte_gro.so.1
 248      librte_gso.so.1
 249      librte_hash.so.2
 250      librte_ip_frag.so.1
 251      librte_ipsec.so.1
 252      librte_jobstats.so.1
 253      librte_kni.so.2
 254      librte_kvargs.so.1
 255      librte_latencystats.so.1
 256      librte_lpm.so.2
 257      librte_mbuf.so.5
 258      librte_member.so.1
 259      librte_mempool.so.5
 260      librte_meter.so.2
 261      librte_metrics.so.1
 262      librte_net.so.1
 263      librte_pci.so.1
 264      librte_pdump.so.3
 265      librte_pipeline.so.3
 266      librte_pmd_bnxt.so.2
 267      librte_pmd_bond.so.2
 268      librte_pmd_i40e.so.2
 269      librte_pmd_ixgbe.so.2
 270      librte_pmd_dpaa2_qdma.so.1
 271      librte_pmd_ring.so.2
 272      librte_pmd_softnic.so.1
 273      librte_pmd_vhost.so.2
 274      librte_port.so.3
 275      librte_power.so.1
 276      librte_rawdev.so.1
 277      librte_reorder.so.1
 278      librte_ring.so.2
 279      librte_sched.so.2
 280      librte_security.so.2
 281    + librte_stack.so.1
 282      librte_table.so.3
 283      librte_timer.so.1
 284      librte_vhost.so.4
 285
 286
 287 Known Issues
 288 ------------
 289
 290 .. This section should contain new known issues in this release. Sample format:
 291
 292    * **Add title in present tense with full stop.**
 293
 294      Add a short 1-2 sentence description of the known issue
 295      in the present tense. Add information on any known workarounds.
 296
 297    This section is a comment. Do not overwrite or remove it.
 298    Also, make sure to start the actual text at the margin.
 299    =========================================================
 300
 301 * **No software AES-XTS implementation.**
 302
 303   There are currently no cryptodev software PMDs available which implement
 304   support for the AES-XTS algorithm, so this feature can only be used
 305   if compatible hardware and an associated PMD is available.
 306
 307
 308 Tested Platforms
 309 ----------------
 310
 311 .. This section should contain a list of platforms that were tested
 312    with this release.
 313
 314    The format is:
 315
 316    * <vendor> platform with <vendor> <type of devices> combinations
 317
 318      * List of CPU
 319      * List of OS
 320      * List of devices
 321      * Other relevant details...
 322
 323    This section is a comment. Do not overwrite or remove it.
 324    Also, make sure to start the actual text at the margin.
 325    =========================================================