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 ENETC driver.**
 146
 147   New features:
 148
 149   * Added physical addressing mode support
 150   * Added SXGMII interface support
 151   * Added basic statistics support
 152   * Added promiscuous and allmulticast mode support
 153   * Added MTU update support
 154   * Added jumbo frame support
 155   * Added queue start/stop
 156   * Added CRC offload support
 157   * Added Rx checksum offload validation support
 158
 159 * **Updated the QuickAssist Technology PMD.**
 160
 161   Added support for AES-XTS with 128 and 256 bit AES keys.
 162
 163 * **Updated AESNI-MB PMD.**
 164
 165   Added support for out-of-place operations.
 166
 167 * **Updated the IPsec library.**
 168
 169   The IPsec library has been updated with AES-CTR and 3DES-CBC cipher algorithms
 170   support. The related ipsec-secgw test scripts have been added.
 171
 172 * **Updated the testpmd application.**
 173
 174   Improved testpmd application performance on ARM platform. For ``macswap``
 175   forwarding mode, NEON intrinsics were used to do swap to save CPU cycles.
 176
 177
 178 Removed Items
 179 -------------
 180
 181 .. This section should contain removed items in this release. Sample format:
 182
 183    * Add a short 1-2 sentence description of the removed item
 184      in 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
 191 API Changes
 192 -----------
 193
 194 .. This section should contain API changes. Sample format:
 195
 196    * sample: Add a short 1-2 sentence description of the API change
 197      which was announced in the previous releases and made in this release.
 198      Start with a scope label like "ethdev:".
 199      Use fixed width quotes for ``function_names`` or ``struct_names``.
 200      Use the past tense.
 201
 202    This section is a comment. Do not overwrite or remove it.
 203    Also, make sure to start the actual text at the margin.
 204    =========================================================
 205
 206 * eal: the type of the ``attr_value`` parameter of the function
 207   ``rte_service_attr_get()`` has been changed
 208   from ``uint32_t *`` to ``uint64_t *``.
 209
 210 * meter: replace ``enum rte_meter_color`` in meter library with new
 211   ``rte_color`` definition added in 19.02. To consolidate mulitple color
 212   definitions replicated at many places such as: rte_mtr.h, rte_tm.h,
 213   replacements with rte_color values are done.
 214
 215 * vfio: Functions ``rte_vfio_container_dma_map`` and
 216   ``rte_vfio_container_dma_unmap`` have been extended with an option to
 217   request mapping or un-mapping to the default vfio container fd.
 218
 219
 220 ABI Changes
 221 -----------
 222
 223 .. This section should contain ABI changes. Sample format:
 224
 225    * sample: Add a short 1-2 sentence description of the ABI change
 226      which was announced in the previous releases and made in this release.
 227      Start with a scope label like "ethdev:".
 228      Use fixed width quotes for ``function_names`` or ``struct_names``.
 229      Use the past tense.
 230
 231    This section is a comment. Do not overwrite or remove it.
 232    Also, make sure to start the actual text at the margin.
 233    =========================================================
 234
 235 * ethdev: Additional fields in rte_eth_dev_info.
 236
 237   The ``rte_eth_dev_info`` structure has had two extra fields
 238   added: ``min_mtu`` and ``max_mtu``. Each of these are of type ``uint16_t``.
 239   The values of these fields can be set specifically by the PMD drivers as
 240   supported values can vary from device to device.
 241
 242 * cryptodev: in 18.08 new structure ``rte_crypto_asym_op`` was introduced and
 243   included into ``rte_crypto_op``. As ``rte_crypto_asym_op`` structure was
 244   defined as cache-line aligned that caused unintended changes in
 245   ``rte_crypto_op`` structure layout and alignment. Remove cache-line
 246   alignment for ``rte_crypto_asym_op`` to restore expected ``rte_crypto_op``
 247   layout and alignment.
 248
 249
 250 Shared Library Versions
 251 -----------------------
 252
 253 .. Update any library version updated in this release
 254    and prepend with a ``+`` sign, like this:
 255
 256      libfoo.so.1
 257    + libupdated.so.2
 258      libbar.so.1
 259
 260    This section is a comment. Do not overwrite or remove it.
 261    =========================================================
 262
 263 The libraries prepended with a plus sign were incremented in this version.
 264
 265 .. code-block:: diff
 266
 267      librte_acl.so.2
 268      librte_bbdev.so.1
 269      librte_bitratestats.so.2
 270      librte_bpf.so.1
 271      librte_bus_dpaa.so.2
 272      librte_bus_fslmc.so.2
 273      librte_bus_ifpga.so.2
 274      librte_bus_pci.so.2
 275      librte_bus_vdev.so.2
 276      librte_bus_vmbus.so.2
 277      librte_cfgfile.so.2
 278      librte_cmdline.so.2
 279      librte_compressdev.so.1
 280    + librte_cryptodev.so.7
 281      librte_distributor.so.1
 282    + librte_eal.so.10
 283      librte_efd.so.1
 284    + librte_ethdev.so.12
 285      librte_eventdev.so.6
 286      librte_flow_classify.so.1
 287      librte_gro.so.1
 288      librte_gso.so.1
 289      librte_hash.so.2
 290      librte_ip_frag.so.1
 291      librte_ipsec.so.1
 292      librte_jobstats.so.1
 293      librte_kni.so.2
 294      librte_kvargs.so.1
 295      librte_latencystats.so.1
 296      librte_lpm.so.2
 297      librte_mbuf.so.5
 298      librte_member.so.1
 299      librte_mempool.so.5
 300      librte_meter.so.3
 301      librte_metrics.so.1
 302      librte_net.so.1
 303      librte_pci.so.1
 304      librte_pdump.so.3
 305      librte_pipeline.so.3
 306      librte_pmd_bnxt.so.2
 307      librte_pmd_bond.so.2
 308      librte_pmd_i40e.so.2
 309      librte_pmd_ixgbe.so.2
 310      librte_pmd_dpaa2_qdma.so.1
 311      librte_pmd_ring.so.2
 312      librte_pmd_softnic.so.1
 313      librte_pmd_vhost.so.2
 314      librte_port.so.3
 315      librte_power.so.1
 316      librte_rawdev.so.1
 317      librte_reorder.so.1
 318      librte_ring.so.2
 319      librte_sched.so.2
 320      librte_security.so.2
 321    + librte_stack.so.1
 322      librte_table.so.3
 323      librte_timer.so.1
 324      librte_vhost.so.4
 325
 326
 327 Known Issues
 328 ------------
 329
 330 .. This section should contain new known issues in this release. Sample format:
 331
 332    * **Add title in present tense with full stop.**
 333
 334      Add a short 1-2 sentence description of the known issue
 335      in the present tense. Add information on any known workarounds.
 336
 337    This section is a comment. Do not overwrite or remove it.
 338    Also, make sure to start the actual text at the margin.
 339    =========================================================
 340
 341 * **No software AES-XTS implementation.**
 342
 343   There are currently no cryptodev software PMDs available which implement
 344   support for the AES-XTS algorithm, so this feature can only be used
 345   if compatible hardware and an associated PMD is available.
 346
 347
 348 Tested Platforms
 349 ----------------
 350
 351 .. This section should contain a list of platforms that were tested
 352    with this release.
 353
 354    The format is:
 355
 356    * <vendor> platform with <vendor> <type of devices> combinations
 357
 358      * List of CPU
 359      * List of OS
 360      * List of devices
 361      * Other relevant details...
 362
 363    This section is a comment. Do not overwrite or remove it.
 364    Also, make sure to start the actual text at the margin.
 365    =========================================================