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