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 * malloc: The function ``rte_malloc_set_limit`` was never implemented
 166   is deprecated and will be removed in a future release.
 167
 168
 169 ABI Changes
 170 -----------
 171
 172 .. This section should contain ABI changes. Sample format:
 173
 174    * sample: Add a short 1-2 sentence description of the ABI change
 175      which was announced in the previous releases and made in this release.
 176      Start with a scope label like "ethdev:".
 177      Use fixed width quotes for ``function_names`` or ``struct_names``.
 178      Use the past tense.
 179
 180    This section is a comment. Do not overwrite or remove it.
 181    Also, make sure to start the actual text at the margin.
 182    =========================================================
 183
 184
 185 Shared Library Versions
 186 -----------------------
 187
 188 .. Update any library version updated in this release
 189    and prepend with a ``+`` sign, like this:
 190
 191      libfoo.so.1
 192    + libupdated.so.2
 193      libbar.so.1
 194
 195    This section is a comment. Do not overwrite or remove it.
 196    =========================================================
 197
 198 The libraries prepended with a plus sign were incremented in this version.
 199
 200 .. code-block:: diff
 201
 202      librte_acl.so.2
 203      librte_bbdev.so.1
 204      librte_bitratestats.so.2
 205      librte_bpf.so.1
 206      librte_bus_dpaa.so.2
 207      librte_bus_fslmc.so.2
 208      librte_bus_ifpga.so.2
 209      librte_bus_pci.so.2
 210      librte_bus_vdev.so.2
 211      librte_bus_vmbus.so.2
 212      librte_cfgfile.so.2
 213      librte_cmdline.so.2
 214      librte_compressdev.so.1
 215      librte_cryptodev.so.7
 216      librte_distributor.so.1
 217      librte_eal.so.10
 218      librte_efd.so.1
 219      librte_ethdev.so.12
 220      librte_eventdev.so.6
 221      librte_flow_classify.so.1
 222      librte_gro.so.1
 223      librte_gso.so.1
 224      librte_hash.so.2
 225      librte_ip_frag.so.1
 226      librte_ipsec.so.1
 227      librte_jobstats.so.1
 228      librte_kni.so.2
 229      librte_kvargs.so.1
 230      librte_latencystats.so.1
 231      librte_lpm.so.2
 232      librte_mbuf.so.5
 233      librte_member.so.1
 234      librte_mempool.so.5
 235      librte_meter.so.3
 236      librte_metrics.so.1
 237      librte_net.so.1
 238      librte_pci.so.1
 239      librte_pdump.so.3
 240      librte_pipeline.so.3
 241      librte_pmd_bnxt.so.2
 242      librte_pmd_bond.so.2
 243      librte_pmd_i40e.so.2
 244      librte_pmd_ixgbe.so.2
 245      librte_pmd_dpaa2_qdma.so.1
 246      librte_pmd_ring.so.2
 247      librte_pmd_softnic.so.1
 248      librte_pmd_vhost.so.2
 249      librte_port.so.3
 250      librte_power.so.1
 251      librte_rawdev.so.1
 252      librte_rcu.so.1
 253      librte_reorder.so.1
 254      librte_ring.so.2
 255      librte_sched.so.2
 256      librte_security.so.2
 257      librte_stack.so.1
 258      librte_table.so.3
 259      librte_timer.so.1
 260      librte_vhost.so.4
 261
 262
 263 Known Issues
 264 ------------
 265
 266 .. This section should contain new known issues in this release. Sample format:
 267
 268    * **Add title in present tense with full stop.**
 269
 270      Add a short 1-2 sentence description of the known issue
 271      in the present tense. Add information on any known workarounds.
 272
 273    This section is a comment. Do not overwrite or remove it.
 274    Also, make sure to start the actual text at the margin.
 275    =========================================================
 276
 277
 278 Tested Platforms
 279 ----------------
 280
 281 .. This section should contain a list of platforms that were tested
 282    with this release.
 283
 284    The format is:
 285
 286    * <vendor> platform with <vendor> <type of devices> combinations
 287
 288      * List of CPU
 289      * List of OS
 290      * List of devices
 291      * Other relevant details...
 292
 293    This section is a comment. Do not overwrite or remove it.
 294    Also, make sure to start the actual text at the margin.
 295    =========================================================
 296