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