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