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