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