doc/guides/rel_notes/release_19_08.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright 2019 The DPDK contributors
   3
   4 DPDK Release 19.08
   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_08.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 * **Updated the EAL Pseudo-random Number Generator.**
  58
  59   The lrand48()-based rte_rand() function is replaced with a
  60   DPDK-native combined Linear Feedback Shift Register (LFSR)
  61   pseudo-random number generator (PRNG).
  62
  63   This new PRNG implementation is multi-thread safe, provides
  64   higher-quality pseudo-random numbers (including full 64 bit
  65   support) and improved performance.
  66
  67 * **Updated the bnxt PMD.**
  68
  69   Updated the bnxt PMD. The major enhancements include:
  70
  71   * Performance optimizations in non-vector Tx path
  72   * Added support for SSE vector mode
  73   * Updated HWRM API to version 1.10.0.74
  74
  75 * **Added support for Broadcom NetXtreme-E BCM57500 Ethernet controllers.**
  76
  77   Added support to the bnxt PMD for the BCM57500 (a.k.a. "Thor") family
  78   of Ethernet controllers. These controllers support link speeds up to
  79   200Gbps, 50G PAM-4, and PCIe 4.0.
  80
  81 * **Updated the ice driver.**
  82
  83   Updated ice driver with new features and improvements, including:
  84
  85   * Enabled Tx outer/inner L3/L4 checksum offload.
  86
  87 * **Updated Solarflare network PMD.**
  88
  89   Updated the Solarflare ``sfc_efx`` driver with changes including:
  90
  91   * Added support for Rx interrupts.
  92
  93 * **Added memif PMD.**
  94
  95   Added the new Shared Memory Packet Interface (``memif``) PMD.
  96   See the :doc:`../nics/memif` guide for more details on this new driver.
  97
  98 * **Updated the AF_XDP PMD.**
  99
 100   Updated the AF_XDP PMD. The new features include:
 101
 102   * Enabled zero copy through mbuf's external memory mechanism to achieve
 103     high performance
 104   * Added multi-queue support to allow one af_xdp vdev with multiple netdev
 105     queues
 106
 107 * **Updated telemetry library for global metrics support.**
 108
 109   Updated ``librte_telemetry`` to fetch the global metrics from the
 110   ``librte_metrics`` library.
 111
 112 * **Added new telemetry mode for l3fwd-power application.**
 113
 114   Added telemetry mode to l3fwd-power application to report
 115   application level busyness, empty and full polls of rte_eth_rx_burst().
 116
 117
 118 Removed Items
 119 -------------
 120
 121 .. This section should contain removed items in this release. Sample format:
 122
 123    * Add a short 1-2 sentence description of the removed item
 124      in the past tense.
 125
 126    This section is a comment. Do not overwrite or remove it.
 127    Also, make sure to start the actual text at the margin.
 128    =========================================================
 129
 130 * Removed KNI ethtool, CONFIG_RTE_KNI_KMOD_ETHTOOL, support.
 131
 132 * build: armv8 crypto extension is disabled.
 133
 134
 135 API Changes
 136 -----------
 137
 138 .. This section should contain API changes. Sample format:
 139
 140    * sample: Add a short 1-2 sentence description of the API change
 141      which was announced in the previous releases and made in this release.
 142      Start with a scope label like "ethdev:".
 143      Use fixed width quotes for ``function_names`` or ``struct_names``.
 144      Use the past tense.
 145
 146    This section is a comment. Do not overwrite or remove it.
 147    Also, make sure to start the actual text at the margin.
 148    =========================================================
 149
 150 * The network structures, definitions and functions have
 151   been prefixed by ``rte_`` to resolve conflicts with libc headers.
 152
 153
 154 ABI Changes
 155 -----------
 156
 157 .. This section should contain ABI changes. Sample format:
 158
 159    * sample: Add a short 1-2 sentence description of the ABI change
 160      which was announced in the previous releases and made in this release.
 161      Start with a scope label like "ethdev:".
 162      Use fixed width quotes for ``function_names`` or ``struct_names``.
 163      Use the past tense.
 164
 165    This section is a comment. Do not overwrite or remove it.
 166    Also, make sure to start the actual text at the margin.
 167    =========================================================
 168
 169
 170 Shared Library Versions
 171 -----------------------
 172
 173 .. Update any library version updated in this release
 174    and prepend with a ``+`` sign, like this:
 175
 176      libfoo.so.1
 177    + libupdated.so.2
 178      libbar.so.1
 179
 180    This section is a comment. Do not overwrite or remove it.
 181    =========================================================
 182
 183 The libraries prepended with a plus sign were incremented in this version.
 184
 185 .. code-block:: diff
 186
 187      librte_acl.so.2
 188      librte_bbdev.so.1
 189      librte_bitratestats.so.2
 190      librte_bpf.so.1
 191      librte_bus_dpaa.so.2
 192      librte_bus_fslmc.so.2
 193      librte_bus_ifpga.so.2
 194      librte_bus_pci.so.2
 195      librte_bus_vdev.so.2
 196      librte_bus_vmbus.so.2
 197      librte_cfgfile.so.2
 198      librte_cmdline.so.2
 199      librte_compressdev.so.1
 200      librte_cryptodev.so.7
 201      librte_distributor.so.1
 202      librte_eal.so.10
 203      librte_efd.so.1
 204      librte_ethdev.so.12
 205      librte_eventdev.so.6
 206      librte_flow_classify.so.1
 207      librte_gro.so.1
 208      librte_gso.so.1
 209      librte_hash.so.2
 210      librte_ip_frag.so.1
 211      librte_ipsec.so.1
 212      librte_jobstats.so.1
 213      librte_kni.so.2
 214      librte_kvargs.so.1
 215      librte_latencystats.so.1
 216      librte_lpm.so.2
 217      librte_mbuf.so.5
 218      librte_member.so.1
 219      librte_mempool.so.5
 220      librte_meter.so.3
 221      librte_metrics.so.1
 222      librte_net.so.1
 223      librte_pci.so.1
 224      librte_pdump.so.3
 225      librte_pipeline.so.3
 226      librte_pmd_bnxt.so.2
 227      librte_pmd_bond.so.2
 228      librte_pmd_i40e.so.2
 229      librte_pmd_ixgbe.so.2
 230      librte_pmd_dpaa2_qdma.so.1
 231      librte_pmd_ring.so.2
 232      librte_pmd_softnic.so.1
 233      librte_pmd_vhost.so.2
 234      librte_port.so.3
 235      librte_power.so.1
 236      librte_rawdev.so.1
 237      librte_rcu.so.1
 238      librte_reorder.so.1
 239      librte_ring.so.2
 240      librte_sched.so.2
 241      librte_security.so.2
 242      librte_stack.so.1
 243      librte_table.so.3
 244      librte_timer.so.1
 245      librte_vhost.so.4
 246
 247
 248 Known Issues
 249 ------------
 250
 251 .. This section should contain new known issues in this release. Sample format:
 252
 253    * **Add title in present tense with full stop.**
 254
 255      Add a short 1-2 sentence description of the known issue
 256      in the present tense. Add information on any known workarounds.
 257
 258    This section is a comment. Do not overwrite or remove it.
 259    Also, make sure to start the actual text at the margin.
 260    =========================================================
 261
 262
 263 Tested Platforms
 264 ----------------
 265
 266 .. This section should contain a list of platforms that were tested
 267    with this release.
 268
 269    The format is:
 270
 271    * <vendor> platform with <vendor> <type of devices> combinations
 272
 273      * List of CPU
 274      * List of OS
 275      * List of devices
 276      * Other relevant details...
 277
 278    This section is a comment. Do not overwrite or remove it.
 279    Also, make sure to start the actual text at the margin.
 280    =========================================================
 281