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