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