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