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