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