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