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