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