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 new armv8 machine targets:**
  58
  59   * BlueField (Mellanox)
  60   * OcteonTX2 (Marvell)
  61   * ThunderX2 (Marvell)
  62
  63 * **Added Stack API.**
  64
  65   Added a new stack API for configuration and use of a bounded stack of
  66   pointers. The API provides MT-safe push and pop operations that can operate
  67   on one or more pointers per operation.
  68
  69   The library supports two stack implementations: standard (lock-based) and lock-free.
  70   The lock-free implementation is currently limited to x86-64 platforms.
  71
  72 * **Added Lock-Free Stack Mempool Handler.**
  73
  74   Added a new lock-free stack handler, which uses the newly added stack
  75   library.
  76
  77 * **Added RCU library.**
  78
  79   Added RCU library supporting quiescent state based memory reclamation method.
  80   This library helps identify the quiescent state of the reader threads so
  81   that the writers can free the memory associated with the lock free data
  82   structures.
  83
  84 * **Updated KNI module and PMD.**
  85
  86   Updated the KNI kernel module to set the max_mtu according to the given
  87   initial MTU size. Without it, the maximum MTU was 1500.
  88
  89   Updated the KNI PMD driver to set the mbuf_size and MTU based on
  90   the given mb-pool. This provide the ability to pass jumbo frames
  91   if the mb-pool contains suitable buffers' size.
  92
  93 * **Added the AF_XDP PMD.**
  94
  95   Added a Linux-specific PMD driver for AF_XDP, it can create the AF_XDP socket
  96   and bind it to a specific netdev queue, it allows a DPDK application to send
  97   and receive raw packets through the socket which would bypass the kernel
  98   network stack to achieve high performance packet processing.
  99
 100 * **Added a net PMD NFB.**
 101
 102   Added the new ``nfb`` net driver for Netcope NFB cards. See
 103   the :doc:`../nics/nfb` NIC guide for more details on this new driver.
 104
 105 * **Added IPN3KE net PMD.**
 106
 107   Added the new ``ipn3ke`` net driver for Intel® FPGA PAC(Programmable
 108   Acceleration Card) N3000. See the :doc:`../nics/ipn3ke` NIC guide for more
 109   details on this new driver.
 110
 111   Aside from this, ifpga_rawdev is also updated to support Intel® FPGA PAC
 112   N3000 with SPI interface access, I2C Read/Write and Ethernet PHY configuration.
 113
 114 * **Updated Solarflare network PMD.**
 115
 116   Updated the sfc_efx driver including the following changes:
 117
 118   * Added support for Rx descriptor status and related API in a secondary
 119     process.
 120   * Added support for Tx descriptor status API in a secondary process.
 121   * Added support for RSS RETA and hash configuration get API in a secondary
 122     process.
 123   * Added support for Rx packet types list in a secondary process.
 124   * Added Tx prepare to do Tx offloads checks.
 125   * Added support for VXLAN and GENEVE encapsulated TSO.
 126
 127 * **Updated Mellanox drivers.**
 128
 129    New features and improvements were done in mlx4 and mlx5 PMDs:
 130
 131    * Added firmware version reading.
 132
 133 * **Renamed avf to iavf.**
 134
 135   Renamed Intel Ethernet Adaptive Virtual Function driver ``avf`` to ``iavf``,
 136   which includes the directory name, lib name, filenames, makefile, docs,
 137   macros, functions, structs and any other strings in the code.
 138
 139 * **Updated the enic driver.**
 140
 141   * Fixed several flow (director) bugs related to MARK, SCTP, VLAN, VXLAN, and
 142     inner packet matching.
 143   * Added limited support for RAW.
 144   * Added limited support for RSS.
 145   * Added limited support for PASSTHRU.
 146
 147 * **Updated the ixgbe driver.**
 148
 149   New features for VF:
 150
 151   * Added promiscuous mode support.
 152
 153 * **Updated the ice driver.**
 154
 155   * Added support of SSE and AVX2 instructions in Rx and Tx paths.
 156   * Added package download support.
 157   * Added Safe Mode support.
 158   * Supported RSS for UPD/TCP/SCTP+IPV4/IPV6 packets.
 159
 160 * **Updated the i40e driver.**
 161
 162   New features for PF:
 163
 164   * Added support for VXLAN-GPE packet.
 165   * Added support for VXLAN-GPE classification.
 166
 167 * **Updated the ENETC driver.**
 168
 169   New features:
 170
 171   * Added physical addressing mode support
 172   * Added SXGMII interface support
 173   * Added basic statistics support
 174   * Added promiscuous and allmulticast mode support
 175   * Added MTU update support
 176   * Added jumbo frame support
 177   * Added queue start/stop
 178   * Added CRC offload support
 179   * Added Rx checksum offload validation support
 180
 181 * **Updated the atlantic PMD.**
 182
 183   Added MACSEC hardware offload experimental API.
 184
 185 * **Updated the QuickAssist Technology PMD.**
 186
 187   Added support for AES-XTS with 128 and 256 bit AES keys.
 188
 189 * **Added Intel QuickAssist Technology PMD for asymmetric crypto.**
 190
 191   A new QAT Crypto PMD has been added, which provides asymmetric cryptography
 192   algorithms, in this release modular exponentiation and modular multiplicative
 193   inverse algorithms were added.
 194
 195 * **Updated AESNI-MB PMD.**
 196
 197   Added support for out-of-place operations.
 198
 199 * **Updated the IPsec library.**
 200
 201   The IPsec library has been updated with AES-CTR and 3DES-CBC cipher algorithms
 202   support. The related ipsec-secgw test scripts have been added.
 203
 204 * **Updated the testpmd application.**
 205
 206   Improved testpmd application performance on ARM platform. For ``macswap``
 207   forwarding mode, NEON intrinsics were used to do swap to save CPU cycles.
 208
 209 * **Updated power management library.**
 210
 211   Added support for Intel Speed Select Technology - Base Frequency (SST-BF).
 212   ``rte_power_get_capabilities`` now has a bit in it's returned mask
 213   indicating it's a high frequency core.
 214
 215 * **Updated distributor sample application.**
 216
 217   Added support for Intel SST-BF feature so that the distributor core is
 218   pinned to a high frequency core if available.
 219
 220
 221 Removed Items
 222 -------------
 223
 224 .. This section should contain removed items in this release. Sample format:
 225
 226    * Add a short 1-2 sentence description of the removed item
 227      in the past tense.
 228
 229    This section is a comment. Do not overwrite or remove it.
 230    Also, make sure to start the actual text at the margin.
 231    =========================================================
 232
 233
 234 API Changes
 235 -----------
 236
 237 .. This section should contain API changes. Sample format:
 238
 239    * sample: Add a short 1-2 sentence description of the API change
 240      which was announced in the previous releases and made in this release.
 241      Start with a scope label like "ethdev:".
 242      Use fixed width quotes for ``function_names`` or ``struct_names``.
 243      Use the past tense.
 244
 245    This section is a comment. Do not overwrite or remove it.
 246    Also, make sure to start the actual text at the margin.
 247    =========================================================
 248
 249 * eal: the type of the ``attr_value`` parameter of the function
 250   ``rte_service_attr_get()`` has been changed
 251   from ``uint32_t *`` to ``uint64_t *``.
 252
 253 * meter: replace ``enum rte_meter_color`` in meter library with new
 254   ``rte_color`` definition added in 19.02. To consolidate mulitple color
 255   definitions replicated at many places such as: rte_mtr.h, rte_tm.h,
 256   replacements with rte_color values are done.
 257
 258 * vfio: Functions ``rte_vfio_container_dma_map`` and
 259   ``rte_vfio_container_dma_unmap`` have been extended with an option to
 260   request mapping or un-mapping to the default vfio container fd.
 261
 262 * power: ``rte_power_set_env`` and ``rte_power_unset_env`` functions
 263   have been modified to be thread safe.
 264
 265
 266 ABI Changes
 267 -----------
 268
 269 .. This section should contain ABI changes. Sample format:
 270
 271    * sample: Add a short 1-2 sentence description of the ABI change
 272      which was announced in the previous releases and made in this release.
 273      Start with a scope label like "ethdev:".
 274      Use fixed width quotes for ``function_names`` or ``struct_names``.
 275      Use the past tense.
 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 * ethdev: Additional fields in rte_eth_dev_info.
 282
 283   The ``rte_eth_dev_info`` structure has had two extra fields
 284   added: ``min_mtu`` and ``max_mtu``. Each of these are of type ``uint16_t``.
 285   The values of these fields can be set specifically by the PMD drivers as
 286   supported values can vary from device to device.
 287
 288 * cryptodev: in 18.08 new structure ``rte_crypto_asym_op`` was introduced and
 289   included into ``rte_crypto_op``. As ``rte_crypto_asym_op`` structure was
 290   defined as cache-line aligned that caused unintended changes in
 291   ``rte_crypto_op`` structure layout and alignment. Remove cache-line
 292   alignment for ``rte_crypto_asym_op`` to restore expected ``rte_crypto_op``
 293   layout and alignment.
 294
 295
 296 Shared Library Versions
 297 -----------------------
 298
 299 .. Update any library version updated in this release
 300    and prepend with a ``+`` sign, like this:
 301
 302      libfoo.so.1
 303    + libupdated.so.2
 304      libbar.so.1
 305
 306    This section is a comment. Do not overwrite or remove it.
 307    =========================================================
 308
 309 The libraries prepended with a plus sign were incremented in this version.
 310
 311 .. code-block:: diff
 312
 313      librte_acl.so.2
 314      librte_bbdev.so.1
 315      librte_bitratestats.so.2
 316      librte_bpf.so.1
 317      librte_bus_dpaa.so.2
 318      librte_bus_fslmc.so.2
 319      librte_bus_ifpga.so.2
 320      librte_bus_pci.so.2
 321      librte_bus_vdev.so.2
 322      librte_bus_vmbus.so.2
 323      librte_cfgfile.so.2
 324      librte_cmdline.so.2
 325      librte_compressdev.so.1
 326    + librte_cryptodev.so.7
 327      librte_distributor.so.1
 328    + librte_eal.so.10
 329      librte_efd.so.1
 330    + librte_ethdev.so.12
 331      librte_eventdev.so.6
 332      librte_flow_classify.so.1
 333      librte_gro.so.1
 334      librte_gso.so.1
 335      librte_hash.so.2
 336      librte_ip_frag.so.1
 337      librte_ipsec.so.1
 338      librte_jobstats.so.1
 339      librte_kni.so.2
 340      librte_kvargs.so.1
 341      librte_latencystats.so.1
 342      librte_lpm.so.2
 343      librte_mbuf.so.5
 344      librte_member.so.1
 345      librte_mempool.so.5
 346      librte_meter.so.3
 347      librte_metrics.so.1
 348      librte_net.so.1
 349      librte_pci.so.1
 350      librte_pdump.so.3
 351      librte_pipeline.so.3
 352      librte_pmd_bnxt.so.2
 353      librte_pmd_bond.so.2
 354      librte_pmd_i40e.so.2
 355      librte_pmd_ixgbe.so.2
 356      librte_pmd_dpaa2_qdma.so.1
 357      librte_pmd_ring.so.2
 358      librte_pmd_softnic.so.1
 359      librte_pmd_vhost.so.2
 360      librte_port.so.3
 361      librte_power.so.1
 362      librte_rawdev.so.1
 363    + librte_rcu.so.1
 364      librte_reorder.so.1
 365      librte_ring.so.2
 366      librte_sched.so.2
 367      librte_security.so.2
 368    + librte_stack.so.1
 369      librte_table.so.3
 370      librte_timer.so.1
 371      librte_vhost.so.4
 372
 373
 374 Known Issues
 375 ------------
 376
 377 .. This section should contain new known issues in this release. Sample format:
 378
 379    * **Add title in present tense with full stop.**
 380
 381      Add a short 1-2 sentence description of the known issue
 382      in the present tense. Add information on any known workarounds.
 383
 384    This section is a comment. Do not overwrite or remove it.
 385    Also, make sure to start the actual text at the margin.
 386    =========================================================
 387
 388 * **On x86 platforms, AVX512 support is disabled with binutils 2.31**
 389
 390   Because a defect in binutils 2.31 AVX512 support is disabled.
 391   DPDK defect: https://bugs.dpdk.org/show_bug.cgi?id=249
 392   GCC defect: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=90028
 393
 394 * **No software AES-XTS implementation.**
 395
 396   There are currently no cryptodev software PMDs available which implement
 397   support for the AES-XTS algorithm, so this feature can only be used
 398   if compatible hardware and an associated PMD is available.
 399
 400
 401 Tested Platforms
 402 ----------------
 403
 404 .. This section should contain a list of platforms that were tested
 405    with this release.
 406
 407    The format is:
 408
 409    * <vendor> platform with <vendor> <type of devices> combinations
 410
 411      * List of CPU
 412      * List of OS
 413      * List of devices
 414      * Other relevant details...
 415
 416    This section is a comment. Do not overwrite or remove it.
 417    Also, make sure to start the actual text at the margin.
 418    =========================================================