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 * **Added MCS lock.**
  60
  61   MCS lock provides scalability by spinning on a CPU/thread local variable
  62   which avoids expensive cache bouncings.
  63   It provides fairness by maintaining a list of acquirers and passing
  64   the lock to each CPU/thread in the order they acquired the lock.
  65
  66 * **Updated the EAL Pseudo-random Number Generator.**
  67
  68   The lrand48()-based rte_rand() function is replaced with a
  69   DPDK-native combined Linear Feedback Shift Register (LFSR)
  70   pseudo-random number generator (PRNG).
  71
  72   This new PRNG implementation is multi-thread safe, provides
  73   higher-quality pseudo-random numbers (including full 64 bit
  74   support) and improved performance.
  75
  76   In addition, <rte_random.h> is extended with a new function
  77   rte_rand_max() which supplies unbiased, bounded pseudo-random
  78   numbers.
  79
  80 * **Updated the bnxt PMD.**
  81
  82   Updated the bnxt PMD. The major enhancements include:
  83
  84   * Performance optimizations in non-vector Tx path
  85   * Added support for SSE vector mode
  86   * Updated HWRM API to version 1.10.0.74
  87
  88 * **Added support for Broadcom NetXtreme-E BCM57500 Ethernet controllers.**
  89
  90   Added support to the bnxt PMD for the BCM57500 (a.k.a. "Thor") family
  91   of Ethernet controllers. These controllers support link speeds up to
  92   200Gbps, 50G PAM-4, and PCIe 4.0.
  93
  94 * **Added hinic PMD.**
  95
  96   Added the new ``hinic`` net driver for Huawei Intelligent PCIE Network
  97   Adapters based on the Huawei Ethernet Controller Hi1822.
  98   See the :doc:`../nics/hinic` guide for more details on this new driver.
  99
 100 * **Updated the ice driver.**
 101
 102   Updated ice driver with new features and improvements, including:
 103
 104   * Enabled Tx outer/inner L3/L4 checksum offload.
 105   * Enabled generic filter framework and supported switch filter.
 106   * Supported UDP tunnel port add.
 107
 108 * **Updated Mellanox mlx5 driver.**
 109
 110   Updated Mellanox mlx5 driver with new features and improvements, including:
 111
 112   * Updated the packet header modification feature. Added support of TCP header
 113     sequence number and acknowledgment number modification.
 114
 115 * **Updated Solarflare network PMD.**
 116
 117   Updated the Solarflare ``sfc_efx`` driver with changes including:
 118
 119   * Added support for Rx interrupts.
 120
 121 * **Added memif PMD.**
 122
 123   Added the new Shared Memory Packet Interface (``memif``) PMD.
 124   See the :doc:`../nics/memif` guide for more details on this new driver.
 125
 126 * **Updated the AF_XDP PMD.**
 127
 128   Updated the AF_XDP PMD. The new features include:
 129
 130   * Enabled zero copy through mbuf's external memory mechanism to achieve
 131     high performance
 132   * Added multi-queue support to allow one af_xdp vdev with multiple netdev
 133     queues
 134   * Enabled need_wakeup feature which can provide efficient support for case
 135     that application and driver executing on the same core.
 136
 137 * **Enabled infinite Rx in the PCAP PMD.**
 138
 139   Added an infinite Rx feature which allows packets in the Rx PCAP of a PCAP
 140   device to be received repeatedly at a high rate. This can be useful for quick
 141   performance testing of DPDK apps.
 142
 143 * **Added a FPGA_LTE_FEC bbdev PMD.**
 144
 145   Added the new ``fpga_lte_fec`` bbdev driver for the Intel® FPGA PAC
 146   (Programmable  Acceleration Card) N3000.  See the
 147   :doc:`../bbdevs/fpga_lte_fec` BBDEV guide for more details on this new driver.
 148
 149 * **Updated TURBO_SW bbdev PMD.**
 150
 151   Updated the ``turbo_sw`` bbdev driver with changes including:
 152
 153   * Added option to build the driver with or without dependency of external
 154     SDK libraries.
 155   * Added support for 5GNR encode/decode operations.
 156
 157 * **Updated the QuickAssist Technology (QAT) symmetric crypto PMD.**
 158
 159   Added support for digest-encrypted cases where digest is appended
 160   to the data.
 161
 162 * **Added Intel QuickData Technology PMD**
 163
 164   The PMD for Intel\ |reg|  QuickData Technology, part of
 165   Intel\ |reg|  I/O Acceleration Technology `(Intel I/OAT)
 166   <https://www.intel.com/content/www/us/en/wireless-network/accel-technology.html>`_,
 167   allows data copies to be done by hardware instead
 168   of via software, reducing cycles spent copying large blocks of data in
 169   applications.
 170
 171 * **Introduced NTB PMD.**
 172
 173   Added a PMD for Intel NTB (Non-transparent Bridge). This PMD implemented
 174   handshake between two separate hosts and can share local memory for peer
 175   host to directly access.
 176
 177 * **Updated IPSec library Header Reconstruction.**
 178
 179   Updated the IPSec library with ECN and DSCP field header reconstruction
 180   feature followed by RFC4301. The IPSec-secgw sample application is also
 181   updated to support this feature by default.
 182
 183 * **Updated telemetry library for global metrics support.**
 184
 185   Updated ``librte_telemetry`` to fetch the global metrics from the
 186   ``librte_metrics`` library.
 187
 188 * **Added new telemetry mode for l3fwd-power application.**
 189
 190   Added telemetry mode to l3fwd-power application to report
 191   application level busyness, empty and full polls of rte_eth_rx_burst().
 192
 193
 194 Removed Items
 195 -------------
 196
 197 .. This section should contain removed items in this release. Sample format:
 198
 199    * Add a short 1-2 sentence description of the removed item
 200      in the past tense.
 201
 202    This section is a comment. Do not overwrite or remove it.
 203    Also, make sure to start the actual text at the margin.
 204    =========================================================
 205
 206 * Removed KNI ethtool, CONFIG_RTE_KNI_KMOD_ETHTOOL, support.
 207
 208 * build: armv8 crypto extension is disabled.
 209
 210
 211 API Changes
 212 -----------
 213
 214 .. This section should contain API changes. Sample format:
 215
 216    * sample: Add a short 1-2 sentence description of the API change
 217      which was announced in the previous releases and made in this release.
 218      Start with a scope label like "ethdev:".
 219      Use fixed width quotes for ``function_names`` or ``struct_names``.
 220      Use the past tense.
 221
 222    This section is a comment. Do not overwrite or remove it.
 223    Also, make sure to start the actual text at the margin.
 224    =========================================================
 225
 226 * The ``rte_mem_config`` structure has been made private. The new accessor
 227   ``rte_mcfg_*`` functions were introduced to provide replacement for direct
 228   access to the shared mem config.
 229
 230 * The network structures, definitions and functions have
 231   been prefixed by ``rte_`` to resolve conflicts with libc headers.
 232
 233 * malloc: The function ``rte_malloc_set_limit`` was never implemented
 234   is deprecated and will be removed in a future release.
 235
 236 * eventdev: No longer marked as experimental.
 237
 238   The eventdev functions are no longer marked as experimental, and have
 239   become part of the normal DPDK API and ABI. Any future ABI changes will be
 240   announced at least one release before the ABI change is made. There are no
 241   ABI breaking changes planned.
 242
 243 * ip_frag: IP fragmentation library converts input mbuf into fragments
 244   using input MTU size via ``rte_ipv4_fragment_packet`` interface.
 245   Once fragmentation is done, each ``mbuf->ol_flags`` are set to enable IP
 246   checksum H/W offload irrespective of the platform capability.
 247   Cleared IP checksum H/W offload flag from the library. The application must
 248   set this flag if it is supported by the platform and application wishes to
 249   use it.
 250
 251 * ip_frag: IP reassembly library converts the list of fragments into a
 252   reassembled packet via ``rte_ipv4_frag_reassemble_packet`` interface.
 253   Once reassembly is done, ``mbuf->ol_flags`` are set to enable IP checksum H/W
 254   offload irrespective of the platform capability. Cleared IP checksum H/W
 255   offload flag from the library. The application must set this flag if it is
 256   supported by the platform and application wishes to use it.
 257
 258
 259 ABI Changes
 260 -----------
 261
 262 .. This section should contain ABI changes. Sample format:
 263
 264    * sample: Add a short 1-2 sentence description of the ABI change
 265      which was announced in the previous releases and made in this release.
 266      Start with a scope label like "ethdev:".
 267      Use fixed width quotes for ``function_names`` or ``struct_names``.
 268      Use the past tense.
 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 * eventdev: Event based Rx adapter callback
 275
 276   The mbuf pointer array in the event eth Rx adapter callback
 277   has been replaced with an event array. Using
 278   an event array allows the application to change attributes
 279   of the events enqueued by the SW adapter.
 280
 281   The callback can drop packets and populate
 282   a callback argument with the number of dropped packets.
 283   Add a Rx adapter stats field to keep track of the total
 284   number of dropped packets.
 285
 286 * cryptodev: New member in ``rte_cryptodev_config`` to allow applications to
 287   disable features supported by the crypto device. Only the following features
 288   would be allowed to be disabled this way,
 289
 290   - ``RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO``
 291   - ``RTE_CRYPTODEV_FF_ASYMMETRIC_CRYPTO``
 292   - ``RTE_CRYPTODEV_FF_SECURITY``
 293
 294   Disabling unused features would facilitate efficient usage of HW/SW offload.
 295
 296 * bbdev: New operations and parameters added to support new 5GNR operations.
 297   The bbdev ABI is still kept experimental.
 298
 299
 300 Shared Library Versions
 301 -----------------------
 302
 303 .. Update any library version updated in this release
 304    and prepend with a ``+`` sign, like this:
 305
 306      libfoo.so.1
 307    + libupdated.so.2
 308      libbar.so.1
 309
 310    This section is a comment. Do not overwrite or remove it.
 311    =========================================================
 312
 313 The libraries prepended with a plus sign were incremented in this version.
 314
 315 .. code-block:: diff
 316
 317      librte_acl.so.2
 318      librte_bbdev.so.1
 319      librte_bitratestats.so.2
 320      librte_bpf.so.1
 321      librte_bus_dpaa.so.2
 322      librte_bus_fslmc.so.2
 323      librte_bus_ifpga.so.2
 324      librte_bus_pci.so.2
 325      librte_bus_vdev.so.2
 326      librte_bus_vmbus.so.2
 327      librte_cfgfile.so.2
 328      librte_cmdline.so.2
 329      librte_compressdev.so.1
 330    + librte_cryptodev.so.8
 331      librte_distributor.so.1
 332    + librte_eal.so.11
 333      librte_efd.so.1
 334      librte_ethdev.so.12
 335    + librte_eventdev.so.7
 336      librte_flow_classify.so.1
 337      librte_gro.so.1
 338      librte_gso.so.1
 339      librte_hash.so.2
 340      librte_ip_frag.so.1
 341      librte_ipsec.so.1
 342      librte_jobstats.so.1
 343      librte_kni.so.2
 344      librte_kvargs.so.1
 345      librte_latencystats.so.1
 346      librte_lpm.so.2
 347      librte_mbuf.so.5
 348      librte_member.so.1
 349      librte_mempool.so.5
 350      librte_meter.so.3
 351      librte_metrics.so.1
 352      librte_net.so.1
 353      librte_pci.so.1
 354      librte_pdump.so.3
 355      librte_pipeline.so.3
 356      librte_pmd_bnxt.so.2
 357      librte_pmd_bond.so.2
 358      librte_pmd_i40e.so.2
 359      librte_pmd_ixgbe.so.2
 360      librte_pmd_dpaa2_qdma.so.1
 361      librte_pmd_ring.so.2
 362      librte_pmd_softnic.so.1
 363      librte_pmd_vhost.so.2
 364      librte_port.so.3
 365      librte_power.so.1
 366      librte_rawdev.so.1
 367      librte_rcu.so.1
 368      librte_reorder.so.1
 369      librte_ring.so.2
 370      librte_sched.so.2
 371      librte_security.so.2
 372      librte_stack.so.1
 373      librte_table.so.3
 374      librte_timer.so.1
 375      librte_vhost.so.4
 376
 377
 378 Known Issues
 379 ------------
 380
 381 .. This section should contain new known issues in this release. Sample format:
 382
 383    * **Add title in present tense with full stop.**
 384
 385      Add a short 1-2 sentence description of the known issue
 386      in the present tense. Add information on any known workarounds.
 387
 388    This section is a comment. Do not overwrite or remove it.
 389    Also, make sure to start the actual text at the margin.
 390    =========================================================
 391
 392
 393 Tested Platforms
 394 ----------------
 395
 396 .. This section should contain a list of platforms that were tested
 397    with this release.
 398
 399    The format is:
 400
 401    * <vendor> platform with <vendor> <type of devices> combinations
 402
 403      * List of CPU
 404      * List of OS
 405      * List of devices
 406      * Other relevant details...
 407
 408    This section is a comment. Do not overwrite or remove it.
 409    Also, make sure to start the actual text at the margin.
 410    =========================================================
 411