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