doc/guides/rel_notes/release_19_08.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright 2019 The DPDK contributors
   3
   4 .. include:: <isonum.txt>
   5
   6 DPDK Release 19.08
   7 ==================
   8
   9 .. **Read this first.**
  10
  11    The text in the sections below explains how to update the release notes.
  12
  13    Use proper spelling, capitalization and punctuation in all sections.
  14
  15    Variable and config names should be quoted as fixed width text:
  16    ``LIKE_THIS``.
  17
  18    Build the docs and view the output file to ensure the changes are correct::
  19
  20       make doc-guides-html
  21
  22       xdg-open build/doc/html/guides/rel_notes/release_19_08.html
  23
  24
  25 New Features
  26 ------------
  27
  28 .. This section should contain new features added in this release.
  29    Sample format:
  30
  31    * **Add a title in the past tense with a full stop.**
  32
  33      Add a short 1-2 sentence description in the past tense.
  34      The description should be enough to allow someone scanning
  35      the release notes to understand the new feature.
  36
  37      If the feature adds a lot of sub-features you can use a bullet list
  38      like this:
  39
  40      * Added feature foo to do something.
  41      * Enhanced feature bar to do something else.
  42
  43      Refer to the previous release notes for examples.
  44
  45      Suggested order in release notes items:
  46      * Core libs (EAL, mempool, ring, mbuf, buses)
  47      * Device abstraction libs and PMDs
  48        - ethdev (lib, PMDs)
  49        - cryptodev (lib, PMDs)
  50        - eventdev (lib, PMDs)
  51        - etc
  52      * Other libs
  53      * Apps, Examples, Tools (if significant)
  54
  55      This section is a comment. Do not overwrite or remove it.
  56      Also, make sure to start the actual text at the margin.
  57      =========================================================
  58
  59 * **Updated the EAL Pseudo-random Number Generator.**
  60
  61   The lrand48()-based rte_rand() function is replaced with a
  62   DPDK-native combined Linear Feedback Shift Register (LFSR)
  63   pseudo-random number generator (PRNG).
  64
  65   This new PRNG implementation is multi-thread safe, provides
  66   higher-quality pseudo-random numbers (including full 64 bit
  67   support) and improved performance.
  68
  69   In addition, <rte_random.h> is extended with a new function
  70   rte_rand_max() which supplies unbiased, bounded pseudo-random
  71   numbers.
  72
  73 * **Updated the bnxt PMD.**
  74
  75   Updated the bnxt PMD. The major enhancements include:
  76
  77   * Performance optimizations in non-vector Tx path
  78   * Added support for SSE vector mode
  79   * Updated HWRM API to version 1.10.0.74
  80
  81 * **Added support for Broadcom NetXtreme-E BCM57500 Ethernet controllers.**
  82
  83   Added support to the bnxt PMD for the BCM57500 (a.k.a. "Thor") family
  84   of Ethernet controllers. These controllers support link speeds up to
  85   200Gbps, 50G PAM-4, and PCIe 4.0.
  86
  87 * **Added hinic PMD.**
  88
  89   Added the new ``hinic`` net driver for Huawei Intelligent PCIE Network
  90   Adapters based on the Huawei Ethernet Controller Hi1822.
  91   See the :doc:`../nics/hinic` guide for more details on this new driver.
  92
  93 * **Updated the ice driver.**
  94
  95   Updated ice driver with new features and improvements, including:
  96
  97   * Enabled Tx outer/inner L3/L4 checksum offload.
  98   * Enabled generic filter framework and supported switch filter.
  99   * Supported UDP tunnel port add.
 100
 101 * **Updated Mellanox mlx5 driver.**
 102
 103   Updated Mellanox mlx5 driver with new features and improvements, including:
 104
 105   * Updated the packet header modification feature. Added support of TCP header
 106     sequence number and acknowledgment number modification.
 107
 108 * **Updated Solarflare network PMD.**
 109
 110   Updated the Solarflare ``sfc_efx`` driver with changes including:
 111
 112   * Added support for Rx interrupts.
 113
 114 * **Added memif PMD.**
 115
 116   Added the new Shared Memory Packet Interface (``memif``) PMD.
 117   See the :doc:`../nics/memif` guide for more details on this new driver.
 118
 119 * **Updated the AF_XDP PMD.**
 120
 121   Updated the AF_XDP PMD. The new features include:
 122
 123   * Enabled zero copy through mbuf's external memory mechanism to achieve
 124     high performance
 125   * Added multi-queue support to allow one af_xdp vdev with multiple netdev
 126     queues
 127   * Enabled need_wakeup feature which can provide efficient support for case
 128     that application and driver executing on the same core.
 129
 130 * **Enabled infinite Rx in the PCAP PMD.**
 131
 132   Added an infinite Rx feature which allows packets in the Rx PCAP of a PCAP
 133   device to be received repeatedly at a high rate. This can be useful for quick
 134   performance testing of DPDK apps.
 135
 136 * **Added Intel QuickData Technology PMD**
 137
 138   The PMD for Intel\ |reg|  QuickData Technology, part of
 139   Intel\ |reg|  I/O Acceleration Technology `(Intel I/OAT)
 140   <https://www.intel.com/content/www/us/en/wireless-network/accel-technology.html>`_,
 141   allows data copies to be done by hardware instead
 142   of via software, reducing cycles spent copying large blocks of data in
 143   applications.
 144
 145 * **Introduced NTB PMD.**
 146
 147   Added a PMD for Intel NTB (Non-transparent Bridge). This PMD implemented
 148   handshake between two separate hosts and can share local memory for peer
 149   host to directly access.
 150
 151 * **Updated telemetry library for global metrics support.**
 152
 153   Updated ``librte_telemetry`` to fetch the global metrics from the
 154   ``librte_metrics`` library.
 155
 156 * **Added new telemetry mode for l3fwd-power application.**
 157
 158   Added telemetry mode to l3fwd-power application to report
 159   application level busyness, empty and full polls of rte_eth_rx_burst().
 160
 161
 162 Removed Items
 163 -------------
 164
 165 .. This section should contain removed items in this release. Sample format:
 166
 167    * Add a short 1-2 sentence description of the removed item
 168      in the past tense.
 169
 170    This section is a comment. Do not overwrite or remove it.
 171    Also, make sure to start the actual text at the margin.
 172    =========================================================
 173
 174 * Removed KNI ethtool, CONFIG_RTE_KNI_KMOD_ETHTOOL, support.
 175
 176 * build: armv8 crypto extension is disabled.
 177
 178
 179 API Changes
 180 -----------
 181
 182 .. This section should contain API changes. Sample format:
 183
 184    * sample: Add a short 1-2 sentence description of the API change
 185      which was announced in the previous releases and made in this release.
 186      Start with a scope label like "ethdev:".
 187      Use fixed width quotes for ``function_names`` or ``struct_names``.
 188      Use the past tense.
 189
 190    This section is a comment. Do not overwrite or remove it.
 191    Also, make sure to start the actual text at the margin.
 192    =========================================================
 193
 194 * The ``rte_mem_config`` structure has been made private. The new accessor
 195   ``rte_mcfg_*`` functions were introduced to provide replacement for direct
 196   access to the shared mem config.
 197
 198 * The network structures, definitions and functions have
 199   been prefixed by ``rte_`` to resolve conflicts with libc headers.
 200
 201 * malloc: The function ``rte_malloc_set_limit`` was never implemented
 202   is deprecated and will be removed in a future release.
 203
 204 * eventdev: No longer marked as experimental.
 205
 206   The eventdev functions are no longer marked as experimental, and have
 207   become part of the normal DPDK API and ABI. Any future ABI changes will be
 208   announced at least one release before the ABI change is made. There are no
 209   ABI breaking changes planned.
 210
 211
 212 ABI Changes
 213 -----------
 214
 215 .. This section should contain ABI changes. Sample format:
 216
 217    * sample: Add a short 1-2 sentence description of the ABI change
 218      which was announced in the previous releases and made in this release.
 219      Start with a scope label like "ethdev:".
 220      Use fixed width quotes for ``function_names`` or ``struct_names``.
 221      Use the past tense.
 222
 223    This section is a comment. Do not overwrite or remove it.
 224    Also, make sure to start the actual text at the margin.
 225    =========================================================
 226
 227 * eventdev: Event based Rx adapter callback
 228
 229   The mbuf pointer array in the event eth Rx adapter callback
 230   has been replaced with an event array. Using
 231   an event array allows the application to change attributes
 232   of the events enqueued by the SW adapter.
 233
 234   The callback can drop packets and populate
 235   a callback argument with the number of dropped packets.
 236   Add a Rx adapter stats field to keep track of the total
 237   number of dropped packets.
 238
 239 * cryptodev: New member in ``rte_cryptodev_config`` to allow applications to
 240   disable features supported by the crypto device. Only the following features
 241   would be allowed to be disabled this way,
 242
 243   - ``RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO``
 244   - ``RTE_CRYPTODEV_FF_ASYMMETRIC_CRYPTO``
 245   - ``RTE_CRYPTODEV_FF_SECURITY``
 246
 247   Disabling unused features would facilitate efficient usage of HW/SW offload.
 248
 249
 250 Shared Library Versions
 251 -----------------------
 252
 253 .. Update any library version updated in this release
 254    and prepend with a ``+`` sign, like this:
 255
 256      libfoo.so.1
 257    + libupdated.so.2
 258      libbar.so.1
 259
 260    This section is a comment. Do not overwrite or remove it.
 261    =========================================================
 262
 263 The libraries prepended with a plus sign were incremented in this version.
 264
 265 .. code-block:: diff
 266
 267      librte_acl.so.2
 268      librte_bbdev.so.1
 269      librte_bitratestats.so.2
 270      librte_bpf.so.1
 271      librte_bus_dpaa.so.2
 272      librte_bus_fslmc.so.2
 273      librte_bus_ifpga.so.2
 274      librte_bus_pci.so.2
 275      librte_bus_vdev.so.2
 276      librte_bus_vmbus.so.2
 277      librte_cfgfile.so.2
 278      librte_cmdline.so.2
 279      librte_compressdev.so.1
 280    + librte_cryptodev.so.8
 281      librte_distributor.so.1
 282    + librte_eal.so.11
 283      librte_efd.so.1
 284      librte_ethdev.so.12
 285    + librte_eventdev.so.7
 286      librte_flow_classify.so.1
 287      librte_gro.so.1
 288      librte_gso.so.1
 289      librte_hash.so.2
 290      librte_ip_frag.so.1
 291      librte_ipsec.so.1
 292      librte_jobstats.so.1
 293      librte_kni.so.2
 294      librte_kvargs.so.1
 295      librte_latencystats.so.1
 296      librte_lpm.so.2
 297      librte_mbuf.so.5
 298      librte_member.so.1
 299      librte_mempool.so.5
 300      librte_meter.so.3
 301      librte_metrics.so.1
 302      librte_net.so.1
 303      librte_pci.so.1
 304      librte_pdump.so.3
 305      librte_pipeline.so.3
 306      librte_pmd_bnxt.so.2
 307      librte_pmd_bond.so.2
 308      librte_pmd_i40e.so.2
 309      librte_pmd_ixgbe.so.2
 310      librte_pmd_dpaa2_qdma.so.1
 311      librte_pmd_ring.so.2
 312      librte_pmd_softnic.so.1
 313      librte_pmd_vhost.so.2
 314      librte_port.so.3
 315      librte_power.so.1
 316      librte_rawdev.so.1
 317      librte_rcu.so.1
 318      librte_reorder.so.1
 319      librte_ring.so.2
 320      librte_sched.so.2
 321      librte_security.so.2
 322      librte_stack.so.1
 323      librte_table.so.3
 324      librte_timer.so.1
 325      librte_vhost.so.4
 326
 327
 328 Known Issues
 329 ------------
 330
 331 .. This section should contain new known issues in this release. Sample format:
 332
 333    * **Add title in present tense with full stop.**
 334
 335      Add a short 1-2 sentence description of the known issue
 336      in the present tense. Add information on any known workarounds.
 337
 338    This section is a comment. Do not overwrite or remove it.
 339    Also, make sure to start the actual text at the margin.
 340    =========================================================
 341
 342
 343 Tested Platforms
 344 ----------------
 345
 346 .. This section should contain a list of platforms that were tested
 347    with this release.
 348
 349    The format is:
 350
 351    * <vendor> platform with <vendor> <type of devices> combinations
 352
 353      * List of CPU
 354      * List of OS
 355      * List of devices
 356      * Other relevant details...
 357
 358    This section is a comment. Do not overwrite or remove it.
 359    Also, make sure to start the actual text at the margin.
 360    =========================================================
 361