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