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