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   * Added support for match on ICMP/ICMP6 code and type.
 115   * Added support for matching on GRE's key and C,K,S present bits.
 116   * Added support for IP-in-IP tunnel.
 117
 118 * **Updated Solarflare network PMD.**
 119
 120   Updated the Solarflare ``sfc_efx`` driver with changes including:
 121
 122   * Added support for Rx interrupts.
 123
 124 * **Added memif PMD.**
 125
 126   Added the new Shared Memory Packet Interface (``memif``) PMD.
 127   See the :doc:`../nics/memif` guide for more details on this new driver.
 128
 129 * **Updated the AF_XDP PMD.**
 130
 131   Updated the AF_XDP PMD. The new features include:
 132
 133   * Enabled zero copy through mbuf's external memory mechanism to achieve
 134     high performance
 135   * Added multi-queue support to allow one af_xdp vdev with multiple netdev
 136     queues
 137   * Enabled need_wakeup feature which can provide efficient support for case
 138     that application and driver executing on the same core.
 139
 140 * **Enabled infinite Rx in the PCAP PMD.**
 141
 142   Added an infinite Rx feature which allows packets in the Rx PCAP of a PCAP
 143   device to be received repeatedly at a high rate. This can be useful for quick
 144   performance testing of DPDK apps.
 145
 146 * **Added a FPGA_LTE_FEC bbdev PMD.**
 147
 148   Added the new ``fpga_lte_fec`` bbdev driver for the Intel® FPGA PAC
 149   (Programmable  Acceleration Card) N3000.  See the
 150   :doc:`../bbdevs/fpga_lte_fec` BBDEV guide for more details on this new driver.
 151
 152 * **Updated TURBO_SW bbdev PMD.**
 153
 154   Updated the ``turbo_sw`` bbdev driver with changes including:
 155
 156   * Added option to build the driver with or without dependency of external
 157     SDK libraries.
 158   * Added support for 5GNR encode/decode operations.
 159
 160 * **Updated the QuickAssist Technology (QAT) symmetric crypto PMD.**
 161
 162   Added support for digest-encrypted cases where digest is appended
 163   to the data.
 164
 165 * **Added Intel QuickData Technology PMD**
 166
 167   The PMD for Intel\ |reg|  QuickData Technology, part of
 168   Intel\ |reg|  I/O Acceleration Technology `(Intel I/OAT)
 169   <https://www.intel.com/content/www/us/en/wireless-network/accel-technology.html>`_,
 170   allows data copies to be done by hardware instead
 171   of via software, reducing cycles spent copying large blocks of data in
 172   applications.
 173
 174 * **Added Marvell OCTEON TX2 drivers.**
 175
 176   Added the new ``ethdev``, ``eventdev``, ``mempool``, ``eventdev Rx adapter``,
 177   ``eventdev Tx adapter``, ``eventdev Timer adapter`` and ``rawdev DMA``
 178   drivers for various HW coprocessors available in ``OCTEON TX2`` SoC.
 179
 180   See :doc:`../platform/octeontx2` and driver informations:
 181
 182   * :doc:`../nics/octeontx2`
 183   * :doc:`../mempool/octeontx2`
 184   * :doc:`../eventdevs/octeontx2`
 185   * :doc:`../rawdevs/octeontx2_dma`
 186
 187 * **Introduced NTB PMD.**
 188
 189   Added a PMD for Intel NTB (Non-transparent Bridge). This PMD implemented
 190   handshake between two separate hosts and can share local memory for peer
 191   host to directly access.
 192
 193 * **Updated IPSec library Header Reconstruction.**
 194
 195   Updated the IPSec library with ECN and DSCP field header reconstruction
 196   feature followed by RFC4301. The IPSec-secgw sample application is also
 197   updated to support this feature by default.
 198
 199 * **Updated telemetry library for global metrics support.**
 200
 201   Updated ``librte_telemetry`` to fetch the global metrics from the
 202   ``librte_metrics`` library.
 203
 204 * **Added new telemetry mode for l3fwd-power application.**
 205
 206   Added telemetry mode to l3fwd-power application to report
 207   application level busyness, empty and full polls of rte_eth_rx_burst().
 208
 209 * **Updated the pdump application.**
 210
 211   Add support for pdump to exit with primary process.
 212
 213 * **Updated test-compress-perf tool application.**
 214
 215   Added multiple cores feature to compression perf tool application.
 216
 217
 218 Removed Items
 219 -------------
 220
 221 .. This section should contain removed items in this release. Sample format:
 222
 223    * Add a short 1-2 sentence description of the removed item
 224      in the past tense.
 225
 226    This section is a comment. Do not overwrite or remove it.
 227    Also, make sure to start the actual text at the margin.
 228    =========================================================
 229
 230 * Removed KNI ethtool, CONFIG_RTE_KNI_KMOD_ETHTOOL, support.
 231
 232 * build: armv8 crypto extension is disabled.
 233
 234
 235 API Changes
 236 -----------
 237
 238 .. This section should contain API changes. Sample format:
 239
 240    * sample: Add a short 1-2 sentence description of the API change
 241      which was announced in the previous releases and made in this release.
 242      Start with a scope label like "ethdev:".
 243      Use fixed width quotes for ``function_names`` or ``struct_names``.
 244      Use the past tense.
 245
 246    This section is a comment. Do not overwrite or remove it.
 247    Also, make sure to start the actual text at the margin.
 248    =========================================================
 249
 250 * The ``rte_mem_config`` structure has been made private. The new accessor
 251   ``rte_mcfg_*`` functions were introduced to provide replacement for direct
 252   access to the shared mem config.
 253
 254 * The network structures, definitions and functions have
 255   been prefixed by ``rte_`` to resolve conflicts with libc headers.
 256
 257 * malloc: The function ``rte_malloc_set_limit`` was never implemented
 258   is deprecated and will be removed in a future release.
 259
 260 * cryptodev: the ``uint8_t *data`` member of ``key`` structure in the xforms
 261   structure (``rte_crypto_cipher_xform``, ``rte_crypto_auth_xform``, and
 262   ``rte_crypto_aead_xform``) have been changed to ``const uint8_t *data``.
 263
 264 * eventdev: No longer marked as experimental.
 265
 266   The eventdev functions are no longer marked as experimental, and have
 267   become part of the normal DPDK API and ABI. Any future ABI changes will be
 268   announced at least one release before the ABI change is made. There are no
 269   ABI breaking changes planned.
 270
 271 * ip_frag: IP fragmentation library converts input mbuf into fragments
 272   using input MTU size via ``rte_ipv4_fragment_packet`` interface.
 273   Once fragmentation is done, each ``mbuf->ol_flags`` are set to enable IP
 274   checksum H/W offload irrespective of the platform capability.
 275   Cleared IP checksum H/W offload flag from the library. The application must
 276   set this flag if it is supported by the platform and application wishes to
 277   use it.
 278
 279 * ip_frag: IP reassembly library converts the list of fragments into a
 280   reassembled packet via ``rte_ipv4_frag_reassemble_packet`` interface.
 281   Once reassembly is done, ``mbuf->ol_flags`` are set to enable IP checksum H/W
 282   offload irrespective of the platform capability. Cleared IP checksum H/W
 283   offload flag from the library. The application must set this flag if it is
 284   supported by the platform and application wishes to use it.
 285
 286 * sched: Macros ``RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS`` and
 287   ``RTE_SCHED_PIPE_PROFILES_PER_PORT`` are removed for flexible configuration
 288   of pipe traffic classes and their queues size, and for runtime configuration
 289   of maximum number of pipe profiles, respectively. In addtion, wrr_weights
 290   field of struct ``rte_sched_pipe_params`` is modifed to be used only for
 291   best-effort tc, and qsize field of struct ``rte_sched_port_params`` is
 292   changed to allow different size of the each queue.
 293
 294
 295 ABI Changes
 296 -----------
 297
 298 .. This section should contain ABI changes. Sample format:
 299
 300    * sample: Add a short 1-2 sentence description of the ABI change
 301      which was announced in the previous releases and made in this release.
 302      Start with a scope label like "ethdev:".
 303      Use fixed width quotes for ``function_names`` or ``struct_names``.
 304      Use the past tense.
 305
 306    This section is a comment. Do not overwrite or remove it.
 307    Also, make sure to start the actual text at the margin.
 308    =========================================================
 309
 310 * eventdev: Event based Rx adapter callback
 311
 312   The mbuf pointer array in the event eth Rx adapter callback
 313   has been replaced with an event array. Using
 314   an event array allows the application to change attributes
 315   of the events enqueued by the SW adapter.
 316
 317   The callback can drop packets and populate
 318   a callback argument with the number of dropped packets.
 319   Add a Rx adapter stats field to keep track of the total
 320   number of dropped packets.
 321
 322 * cryptodev: New member in ``rte_cryptodev_config`` to allow applications to
 323   disable features supported by the crypto device. Only the following features
 324   would be allowed to be disabled this way,
 325
 326   - ``RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO``
 327   - ``RTE_CRYPTODEV_FF_ASYMMETRIC_CRYPTO``
 328   - ``RTE_CRYPTODEV_FF_SECURITY``
 329
 330   Disabling unused features would facilitate efficient usage of HW/SW offload.
 331
 332 * bbdev: New operations and parameters added to support new 5GNR operations.
 333   The bbdev ABI is still kept experimental.
 334
 335
 336 Shared Library Versions
 337 -----------------------
 338
 339 .. Update any library version updated in this release
 340    and prepend with a ``+`` sign, like this:
 341
 342      libfoo.so.1
 343    + libupdated.so.2
 344      libbar.so.1
 345
 346    This section is a comment. Do not overwrite or remove it.
 347    =========================================================
 348
 349 The libraries prepended with a plus sign were incremented in this version.
 350
 351 .. code-block:: diff
 352
 353      librte_acl.so.2
 354      librte_bbdev.so.1
 355      librte_bitratestats.so.2
 356      librte_bpf.so.1
 357      librte_bus_dpaa.so.2
 358      librte_bus_fslmc.so.2
 359      librte_bus_ifpga.so.2
 360      librte_bus_pci.so.2
 361      librte_bus_vdev.so.2
 362      librte_bus_vmbus.so.2
 363      librte_cfgfile.so.2
 364      librte_cmdline.so.2
 365      librte_compressdev.so.1
 366    + librte_cryptodev.so.8
 367      librte_distributor.so.1
 368    + librte_eal.so.11
 369      librte_efd.so.1
 370      librte_ethdev.so.12
 371    + librte_eventdev.so.7
 372      librte_flow_classify.so.1
 373      librte_gro.so.1
 374      librte_gso.so.1
 375      librte_hash.so.2
 376      librte_ip_frag.so.1
 377      librte_ipsec.so.1
 378      librte_jobstats.so.1
 379      librte_kni.so.2
 380      librte_kvargs.so.1
 381      librte_latencystats.so.1
 382      librte_lpm.so.2
 383      librte_mbuf.so.5
 384      librte_member.so.1
 385      librte_mempool.so.5
 386      librte_meter.so.3
 387      librte_metrics.so.1
 388      librte_net.so.1
 389      librte_pci.so.1
 390      librte_pdump.so.3
 391      librte_pipeline.so.3
 392      librte_pmd_bnxt.so.2
 393      librte_pmd_bond.so.2
 394      librte_pmd_i40e.so.2
 395      librte_pmd_ixgbe.so.2
 396      librte_pmd_dpaa2_qdma.so.1
 397      librte_pmd_ring.so.2
 398      librte_pmd_softnic.so.1
 399      librte_pmd_vhost.so.2
 400      librte_port.so.3
 401      librte_power.so.1
 402      librte_rawdev.so.1
 403      librte_rcu.so.1
 404      librte_reorder.so.1
 405      librte_ring.so.2
 406    + librte_sched.so.3
 407      librte_security.so.2
 408      librte_stack.so.1
 409      librte_table.so.3
 410      librte_timer.so.1
 411      librte_vhost.so.4
 412
 413
 414 Known Issues
 415 ------------
 416
 417 .. This section should contain new known issues in this release. Sample format:
 418
 419    * **Add title in present tense with full stop.**
 420
 421      Add a short 1-2 sentence description of the known issue
 422      in the present tense. Add information on any known workarounds.
 423
 424    This section is a comment. Do not overwrite or remove it.
 425    Also, make sure to start the actual text at the margin.
 426    =========================================================
 427
 428
 429 Tested Platforms
 430 ----------------
 431
 432 .. This section should contain a list of platforms that were tested
 433    with this release.
 434
 435    The format is:
 436
 437    * <vendor> platform with <vendor> <type of devices> combinations
 438
 439      * List of CPU
 440      * List of OS
 441      * List of devices
 442      * Other relevant details...
 443
 444    This section is a comment. Do not overwrite or remove it.
 445    Also, make sure to start the actual text at the margin.
 446    =========================================================
 447