doc/guides/rel_notes/release_17_05.rst

   1 DPDK Release 17.05
   2 ==================
   3
   4 .. **Read this first.**
   5
   6    The text in the sections below explains how to update the release notes.
   7
   8    Use proper spelling, capitalization and punctuation in all sections.
   9
  10    Variable and config names should be quoted as fixed width text:
  11    ``LIKE_THIS``.
  12
  13    Build the docs and view the output file to ensure the changes are correct::
  14
  15       make doc-guides-html
  16
  17       xdg-open build/doc/html/guides/rel_notes/release_17_05.html
  18
  19
  20 New Features
  21 ------------
  22
  23 .. This section should contain new features added in this release. Sample
  24    format:
  25
  26    * **Add a title in the past tense with a full stop.**
  27
  28      Add a short 1-2 sentence description in the past tense. The description
  29      should be enough to allow someone scanning the release notes to
  30      understand the new feature.
  31
  32      If the feature adds a lot of sub-features you can use a bullet list like
  33      this:
  34
  35      * Added feature foo to do something.
  36      * Enhanced feature bar to do something else.
  37
  38      Refer to the previous release notes for examples.
  39
  40      This section is a comment. do not overwrite or remove it.
  41      Also, make sure to start the actual text at the margin.
  42      =========================================================
  43
  44 * **Reorganized the mbuf structure.**
  45
  46   * Align fields to facilitate the writing of ``data_off``, ``refcnt``, and
  47     ``nb_segs`` in one operation.
  48   * Use 2 bytes for port and number of segments.
  49   * Move the sequence number in the second cache line.
  50   * Add a timestamp field.
  51   * Set default value for ``refcnt``, ``next`` and ``nb_segs`` at mbuf free.
  52
  53 * **Added mbuf raw free API**
  54
  55   Moved ``rte_mbuf_raw_free()`` and ``rte_pktmbuf_prefree_seg()`` functions to
  56   the public API.
  57
  58 * **Added free Tx mbuf on demand API.**
  59
  60   Added a new function ``rte_eth_tx_done_cleanup()`` which allows an application
  61   to request the driver to release mbufs from their Tx ring that are no longer
  62   in use, independent of whether or not the ``tx_rs_thresh`` has been crossed.
  63
  64 * **Added EAL dynamic log framework.**
  65
  66   Added new APIs to dynamically register named log types, and control
  67   the level of each type independently.
  68
  69 * **Added descriptor status ethdev API.**
  70
  71   Added a new API to get the status of a descriptor.
  72
  73   For Rx, it is almost similar to the ``rx_descriptor_done`` API, except
  74   it differentiates descriptors which are hold by the driver and not
  75   returned to the hardware. For Tx, it is a new API.
  76
  77 * **Increased number of next hops for LPM IPv6 to 2^21.**
  78
  79   The next_hop field is extended from 8 bits to 21 bits for IPv6.
  80
  81 * **Added VFIO hotplug support.**
  82
  83   How hotplug supported with UIO and VFIO drivers.
  84
  85 * **Added powerpc support in pci probing for vfio-pci devices.**
  86
  87   sPAPR IOMMU based pci probing enabled for vfio-pci devices.
  88
  89 * **Kept consistent PMD batching behaviour.**
  90
  91   Removed the limit of fm10k/i40e/ixgbe TX burst size and vhost RX/TX burst size
  92   in order to support the same policy of "make an best effort to RX/TX pkts"
  93   for PMDs.
  94
  95 * **Updated the ixgbe base driver.**
  96
  97   Updated the ixgbe base driver, including the following changes:
  98
  99   * Add link block check for KR.
 100   * Complete HW initialization even if SFP is not present.
 101   * Add VF xcast promiscuous mode.
 102
 103 * **Added powerpc support for i40e and its vector PMD .**
 104
 105   i40e PMD and its vector PMD enabled by default in powerpc.
 106
 107 * **Added VF max bandwidth setting on i40e.**
 108
 109   i40e HW supports to set the max bandwidth for a VF. Enable this capability.
 110
 111 * **Added VF TC min bandwidth setting on i40e.**
 112
 113   i40e HW supports to set the allocated bandwidth for a TC on a VF. Enable this
 114   capability.
 115
 116 * **Added VF TC max bandwidth setting on i40e.**
 117
 118   i40e HW supports to set the max bandwidth for a TC on a VF. Enable this
 119   capability.
 120
 121 * **Added TC strict priority mode setting on i40e.**
 122
 123   There're 2 TX scheduling modes supported for TCs by i40e HW, round ribon mode
 124   and strict priority mode. By default it's round robin mode. Enable the
 125   capability to change the TX scheduling mode for a TC. It's a global setting
 126   on a physical port.
 127
 128 * **Added i40e dynamic device personalization support.**
 129
 130   * Added dynamic device personalization processing to i40e FW.
 131
 132 * **Added Cloud Filter for QinQ steering to i40e.**
 133
 134   * Added a QinQ cloud filter on the i40e PMD, for steering traffic to a VM
 135     using both VLAN tags.
 136   * QinQ is not supported in Vector Mode on the i40e PMD.
 137   * Vector Mode must be disabled when using the QinQ Cloud Filter.
 138
 139 * **Added TSO support for tunneled and non-tunneled packets on mlx5 driver.**
 140
 141   Added support for Hardware TSO for tunneled and non-tunneled packets.
 142   Tunneling protocols supported are GRE and VXLAN.
 143
 144 * **Added support for Rx interrupts on mlx5 driver.**
 145
 146   Rx queues can be armed with an interrupt which will trigger on the
 147   next packet arrival.
 148
 149 * **Updated the sfc_efx driver.**
 150
 151   * Generic flow API support for Ethernet, VLAN, IPv4, IPv6, UDP and TCP
 152     pattern items with QUEUE action for ingress traffic.
 153
 154   * Support virtual functions (VFs)
 155
 156 * **Added LiquidIO network PMD.**
 157
 158   Added poll mode driver support for Cavium LiquidIO II server adapter VFs.
 159
 160 * **Added Atomic Rules Arkville PMD.**
 161
 162   Added a new poll mode driver for the Arkville family of
 163   devices from Atomic Rules.   The net/ark PMD supports line-rate
 164   agnostic, multi-queue data movement on Arkville core FPGA instances.
 165
 166 * **Added support for NXP DPAA2 - FSLMC bus.**
 167
 168   Added the new bus "fslmc" driver for NXP DPAA2 devices. See the
 169   "Network Interface Controller Drivers" document for more details on this new
 170   driver.
 171
 172 * **Added support for NXP DPAA2 Network PMD.**
 173
 174   Added the new "dpaa2" net driver for NXP DPAA2 devices. See the
 175   "Network Interface Controller Drivers" document for more details on this new
 176   driver.
 177
 178 * **Added support for the Wind River Systems AVP PMD.**
 179
 180   Added a new networking driver for the AVP device type. Theses devices are
 181   specific to the Wind River Systems virtualization platforms.
 182
 183 * **Added vmxnet3 version 3 support.**
 184
 185   Added support for vmxnet3 version 3 which includes several
 186   performance enhancements viz. configurable TX data ring, Receive
 187   Data Ring, ability to register memory regions.
 188
 189 * **Updated the tap driver.**
 190
 191   * Support MTU modification.
 192   * Support packet type for Rx.
 193   * Support segmented packets on Rx and Tx.
 194   * Speed up Rx on tap when no packets are available.
 195   * Support capturing traffic from another netdevice.
 196   * Dynamically change link status when the underlying interface state changes.
 197   * Generic flow API support for Ethernet, VLAN, IPv4, IPv6, UDP and TCP pattern
 198     items with DROP, QUEUE and PASSTHRU actions for ingress traffic.
 199
 200 * **Added MTU feature support to Virtio and Vhost.**
 201
 202   Implemented new Virtio MTU feature into Vhost and Virtio:
 203
 204   * Add ``rte_vhost_mtu_get()`` API to Vhost library.
 205   * Enable Vhost PMD's MTU get feature.
 206   * Get max MTU value from host in Virtio PMD
 207
 208 * **Added interrupt mode support for virtio-user.**
 209
 210   Implemented Rxq interrupt mode and LSC support for virtio-user as a virtual
 211   device. Supported cases:
 212
 213   * Rxq interrupt for virtio-user + vhost-user as the backend.
 214   * Rxq interrupt for virtio-user + vhost-kernel as the backend.
 215   * LSC interrupt for virtio-user + vhost-user as the backend.
 216
 217 * **Added event driven programming model library (rte_eventdev).**
 218
 219   This API introduces event driven programming model.
 220
 221   In a polling model, lcores poll ethdev ports and associated
 222   rx queues directly to look for packet. In an event driven model,
 223   by contrast, lcores call the scheduler that selects packets for
 224   them based on programmer-specified criteria. Eventdev library
 225   added support for event driven programming model, which offer
 226   applications automatic multicore scaling, dynamic load balancing,
 227   pipelining, packet ingress order maintenance and
 228   synchronization services to simplify application packet processing.
 229
 230   By introducing event driven programming model, DPDK can support
 231   both polling and event driven programming models for packet processing,
 232   and applications are free to choose whatever model
 233   (or combination of the two) that best suits their needs.
 234
 235 * **Added Software Eventdev PMD.**
 236
 237   Added support for the software eventdev PMD. The software eventdev is a
 238   software based scheduler device that implements the eventdev API. This
 239   PMD allows an application to configure a pipeline using the eventdev
 240   library, and run the scheduling workload on a CPU core.
 241
 242 * **Added Cavium OCTEONTX Eventdev PMD.**
 243
 244   Added the new octeontx ssovf eventdev driver for OCTEONTX devices. See the
 245   "Event Device Drivers" document for more details on this new driver.
 246
 247 * **Added information metric library.**
 248
 249   A library that allows information metrics to be added and updated
 250   by producers, typically other libraries, for later retrieval by
 251   consumers such as applications. It is intended to provide a
 252   reporting mechanism that is independent of other libraries such
 253   as ethdev.
 254
 255 * **Added bit-rate calculation library.**
 256
 257   A library that can be used to calculate device bit-rates. Calculated
 258   bitrates are reported using the metrics library.
 259
 260 * **Added latency stats library.**
 261
 262   A library that measures packet latency. The collected statistics are jitter
 263   and latency. For latency the minimum, average, and maximum is measured.
 264
 265 * **Updated the Cryptodev Scheduler PMD.**
 266
 267   * Added packet-size based distribution mode, which distributes the enqueued
 268     crypto operations among two slaves, based on their data lengths.
 269   * Added fail-over scheduling mode, which enqueues crypto operations to a
 270     primary slave first. Then, any operation that cannot be enqueued is
 271     enqueued to a secondary slave.
 272
 273 * **Updated the QAT PMD.**
 274
 275   The QAT PMD has been updated with additional support for:
 276
 277   * AES DOCSIS BPI algorithm.
 278   * DES DOCSIS BPI algorithm.
 279   * ZUC EEA3/EIA3 algorithms.
 280
 281 * **Updated the AESNI MB PMD.**
 282
 283   The AESNI MB PMD has been updated with additional support for:
 284
 285   * AES DOCSIS BPI algorithm.
 286
 287 * **Updated the OpenSSL PMD.**
 288
 289   The OpenSSL PMD has been updated with additional support for:
 290
 291   * DES DOCSIS BPI algorithm.
 292
 293
 294 Resolved Issues
 295 ---------------
 296
 297 .. This section should contain bug fixes added to the relevant
 298    sections. Sample format:
 299
 300    * **code/section Fixed issue in the past tense with a full stop.**
 301
 302      Add a short 1-2 sentence description of the resolved issue in the past
 303      tense.
 304
 305      The title should contain the code/lib section like a commit message.
 306
 307      Add the entries in alphabetic order in the relevant sections below.
 308
 309    This section is a comment. do not overwrite or remove it.
 310    Also, make sure to start the actual text at the margin.
 311    =========================================================
 312
 313
 314 EAL
 315 ~~~
 316
 317
 318 Drivers
 319 ~~~~~~~
 320
 321
 322 Libraries
 323 ~~~~~~~~~
 324
 325
 326 Examples
 327 ~~~~~~~~
 328
 329
 330 Other
 331 ~~~~~
 332
 333
 334 Known Issues
 335 ------------
 336
 337 .. This section should contain new known issues in this release. Sample format:
 338
 339    * **Add title in present tense with full stop.**
 340
 341      Add a short 1-2 sentence description of the known issue in the present
 342      tense. Add information on any known workarounds.
 343
 344    This section is a comment. do not overwrite or remove it.
 345    Also, make sure to start the actual text at the margin.
 346    =========================================================
 347
 348 * **LSC interrupt cannot work for virtio-user + vhost-kernel.**
 349
 350   LSC interrupt cannot be detected when setting the backend, tap device,
 351   up/down as we fail to find a way to monitor such event.
 352
 353
 354 API Changes
 355 -----------
 356
 357 .. This section should contain API changes. Sample format:
 358
 359    * Add a short 1-2 sentence description of the API change. Use fixed width
 360      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
 361      tense.
 362
 363    This section is a comment. do not overwrite or remove it.
 364    Also, make sure to start the actual text at the margin.
 365    =========================================================
 366
 367 * The LPM ``next_hop`` field is extended from 8 bits to 21 bits for IPv6
 368   while keeping ABI compatibility.
 369
 370 * **Reworked rte_ring library**
 371
 372   The rte_ring library has been reworked and updated. The following changes
 373   have been made to it:
 374
 375   * removed the build-time setting ``CONFIG_RTE_RING_SPLIT_PROD_CONS``
 376   * removed the build-time setting ``CONFIG_RTE_LIBRTE_RING_DEBUG``
 377   * removed the build-time setting ``CONFIG_RTE_RING_PAUSE_REP_COUNT``
 378   * removed the function ``rte_ring_set_water_mark`` as part of a general
 379     removal of watermarks support in the library.
 380   * added an extra parameter to the burst/bulk enqueue functions to
 381     return the number of free spaces in the ring after enqueue. This can
 382     be used by an application to implement its own watermark functionality.
 383   * added an extra parameter to the burst/bulk dequeue functions to return
 384     the number elements remaining in the ring after dequeue.
 385   * changed the return value of the enqueue and dequeue bulk functions to
 386     match that of the burst equivalents. In all cases, ring functions which
 387     operate on multiple packets now return the number of elements enqueued
 388     or dequeued, as appropriate. The updated functions are:
 389
 390     - ``rte_ring_mp_enqueue_bulk``
 391     - ``rte_ring_sp_enqueue_bulk``
 392     - ``rte_ring_enqueue_bulk``
 393     - ``rte_ring_mc_dequeue_bulk``
 394     - ``rte_ring_sc_dequeue_bulk``
 395     - ``rte_ring_dequeue_bulk``
 396
 397     NOTE: the above functions all have different parameters as well as
 398     different return values, due to the other listed changes above. This
 399     means that all instances of the functions in existing code will be
 400     flagged by the compiler. The return value usage should be checked
 401     while fixing the compiler error due to the extra parameter.
 402
 403 * **Reworked rte_vhost library**
 404
 405   The rte_vhost library has been reworked to make it generic enough so that
 406   user could build other vhost-user drivers on top of it. To achieve that,
 407   following changes have been made:
 408
 409   * The following vhost-pmd APIs are removed:
 410
 411     * ``rte_eth_vhost_feature_disable``
 412     * ``rte_eth_vhost_feature_enable``
 413     * ``rte_eth_vhost_feature_get``
 414
 415   * The vhost API ``rte_vhost_driver_callback_register(ops)`` is reworked to
 416     be per vhost-user socket file. Thus, it takes one more argument:
 417     ``rte_vhost_driver_callback_register(path, ops)``.
 418
 419   * The vhost API ``rte_vhost_get_queue_num`` is deprecated, instead,
 420     ``rte_vhost_get_vring_num`` should be used.
 421
 422   * Following macros are removed in ``rte_virtio_net.h``
 423
 424     * ``VIRTIO_RXQ``
 425     * ``VIRTIO_TXQ``
 426     * ``VIRTIO_QNUM``
 427
 428   * Following net specific header files are removed in ``rte_virtio_net.h``
 429
 430     * ``linux/virtio_net.h``
 431     * ``sys/socket.h``
 432     * ``linux/if.h``
 433     * ``rte_ether.h``
 434
 435   * The vhost struct ``virtio_net_device_ops`` is renamed to
 436     ``vhost_device_ops``
 437
 438   * The vhost API ``rte_vhost_driver_session_start`` is removed. Instead,
 439     ``rte_vhost_driver_start`` should be used, and no need to create a
 440     thread to call it.
 441
 442   * The vhost public header file ``rte_virtio_net.h`` is renamed to
 443     ``rte_vhost.h``
 444
 445
 446 ABI Changes
 447 -----------
 448
 449 .. This section should contain ABI changes. Sample format:
 450
 451    * Add a short 1-2 sentence description of the ABI change that was announced
 452      in the previous releases and made in this release. Use fixed width quotes
 453      for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 454
 455    This section is a comment. do not overwrite or remove it.
 456    Also, make sure to start the actual text at the margin.
 457    =========================================================
 458
 459 * **Reorganized the mbuf structure.**
 460
 461   The order and size of the fields in the ``mbuf`` structure changed,
 462   as described in the `New Features`_ section.
 463
 464 * The ``rte_cryptodev_info.sym`` structure has new field ``max_nb_sessions_per_qp``
 465   to support drivers which may support limited number of sessions per queue_pair.
 466
 467
 468 Removed Items
 469 -------------
 470
 471 .. This section should contain removed items in this release. Sample format:
 472
 473    * Add a short 1-2 sentence description of the removed item in the past
 474      tense.
 475
 476    This section is a comment. do not overwrite or remove it.
 477    Also, make sure to start the actual text at the margin.
 478    =========================================================
 479
 480 * KNI vhost support removed.
 481
 482 * dpdk_qat sample application removed.
 483
 484 Shared Library Versions
 485 -----------------------
 486
 487 .. Update any library version updated in this release and prepend with a ``+``
 488    sign, like this:
 489
 490      librte_acl.so.2
 491    + librte_cfgfile.so.2
 492      librte_cmdline.so.2
 493
 494    This section is a comment. do not overwrite or remove it.
 495    =========================================================
 496
 497
 498 The libraries prepended with a plus sign were incremented in this version.
 499
 500 .. code-block:: diff
 501
 502      librte_acl.so.2
 503    + librte_bitratestats.so.1
 504      librte_cfgfile.so.2
 505      librte_cmdline.so.2
 506      librte_cryptodev.so.2
 507      librte_distributor.so.1
 508    + librte_eal.so.4
 509      librte_ethdev.so.6
 510      librte_hash.so.2
 511      librte_ip_frag.so.1
 512      librte_jobstats.so.1
 513      librte_kni.so.2
 514      librte_kvargs.so.1
 515    + librte_latencystats.so.1
 516      librte_lpm.so.2
 517    + librte_mbuf.so.3
 518      librte_mempool.so.2
 519      librte_meter.so.1
 520    + librte_metrics.so.1
 521      librte_net.so.1
 522      librte_pdump.so.1
 523      librte_pipeline.so.3
 524      librte_pmd_bond.so.1
 525      librte_pmd_ring.so.2
 526      librte_port.so.3
 527      librte_power.so.1
 528      librte_reorder.so.1
 529      librte_ring.so.1
 530      librte_sched.so.1
 531      librte_table.so.2
 532      librte_timer.so.1
 533      librte_vhost.so.3
 534
 535
 536 Tested Platforms
 537 ----------------
 538
 539 .. This section should contain a list of platforms that were tested with this
 540    release.
 541
 542    The format is:
 543
 544    * <vendor> platform with <vendor> <type of devices> combinations
 545
 546      * List of CPU
 547      * List of OS
 548      * List of devices
 549      * Other relevant details...
 550
 551    This section is a comment. do not overwrite or remove it.
 552    Also, make sure to start the actual text at the margin.
 553    =========================================================