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