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