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