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 TSO support for tunneled and non-tunneled packets on mlx5 driver.**
 133
 134   Added support for Hardware TSO for tunneled and non-tunneled packets.
 135   Tunneling protocols supported are GRE and VXLAN.
 136
 137 * **Added support for Rx interrupts on mlx5 driver.**
 138
 139   Rx queues can be armed with an interrupt which will trigger on the
 140   next packet arrival.
 141
 142 * **Updated the sfc_efx driver.**
 143
 144   * Generic flow API support for Ethernet, VLAN, IPv4, IPv6, UDP and TCP
 145     pattern items with QUEUE action for ingress traffic.
 146
 147   * Support virtual functions (VFs)
 148
 149 * **Added LiquidIO network PMD.**
 150
 151   Added poll mode driver support for Cavium LiquidIO II server adapter VFs.
 152
 153 * **Added support for the Wind River Systems AVP PMD.**
 154
 155   Added a new networking driver for the AVP device type. Theses devices are
 156   specific to the Wind River Systems virtualization platforms.
 157
 158 * **Added vmxnet3 version 3 support.**
 159
 160   Added support for vmxnet3 version 3 which includes several
 161   performance enhancements viz. configurable TX data ring, Receive
 162   Data Ring, ability to register memory regions.
 163
 164 * **Updated the tap driver.**
 165
 166   * Support MTU modification.
 167   * Support packet type for Rx.
 168   * Support segmented packets on Rx and Tx.
 169   * Speed up Rx on tap when no packets are available.
 170   * Support capturing traffic from another netdevice.
 171   * Dynamically change link status when the underlying interface state changes.
 172   * Generic flow API support for Ethernet, VLAN, IPv4, IPv6, UDP and TCP pattern
 173     items with DROP, QUEUE and PASSTHRU actions for ingress traffic.
 174
 175 * **Added MTU feature support to Virtio and Vhost.**
 176
 177   Implemented new Virtio MTU feature into Vhost and Virtio:
 178
 179   * Add ``rte_vhost_mtu_get()`` API to Vhost library.
 180   * Enable Vhost PMD's MTU get feature.
 181   * Get max MTU value from host in Virtio PMD
 182
 183 * **Added interrupt mode support for virtio-user.**
 184
 185   Implemented Rxq interrupt mode and LSC support for virtio-user as a virtual
 186   device. Supported cases:
 187
 188   * Rxq interrupt for virtio-user + vhost-user as the backend.
 189   * Rxq interrupt for virtio-user + vhost-kernel as the backend.
 190   * LSC interrupt for virtio-user + vhost-user as the backend.
 191
 192 * **Added event driven programming model library (rte_eventdev).**
 193
 194   This API introduces event driven programming model.
 195
 196   In a polling model, lcores poll ethdev ports and associated
 197   rx queues directly to look for packet. In an event driven model,
 198   by contrast, lcores call the scheduler that selects packets for
 199   them based on programmer-specified criteria. Eventdev library
 200   added support for event driven programming model, which offer
 201   applications automatic multicore scaling, dynamic load balancing,
 202   pipelining, packet ingress order maintenance and
 203   synchronization services to simplify application packet processing.
 204
 205   By introducing event driven programming model, DPDK can support
 206   both polling and event driven programming models for packet processing,
 207   and applications are free to choose whatever model
 208   (or combination of the two) that best suits their needs.
 209
 210 * **Added Software Eventdev PMD.**
 211
 212   Added support for the software eventdev PMD. The software eventdev is a
 213   software based scheduler device that implements the eventdev API. This
 214   PMD allows an application to configure a pipeline using the eventdev
 215   library, and run the scheduling workload on a CPU core.
 216
 217 * **Added Cavium OCTEONTX Eventdev PMD.**
 218
 219   Added the new octeontx ssovf eventdev driver for OCTEONTX devices. See the
 220   "Event Device Drivers" document for more details on this new driver.
 221
 222
 223 Resolved Issues
 224 ---------------
 225
 226 .. This section should contain bug fixes added to the relevant
 227    sections. Sample format:
 228
 229    * **code/section Fixed issue in the past tense with a full stop.**
 230
 231      Add a short 1-2 sentence description of the resolved issue in the past
 232      tense.
 233
 234      The title should contain the code/lib section like a commit message.
 235
 236      Add the entries in alphabetic order in the relevant sections below.
 237
 238    This section is a comment. do not overwrite or remove it.
 239    Also, make sure to start the actual text at the margin.
 240    =========================================================
 241
 242
 243 EAL
 244 ~~~
 245
 246
 247 Drivers
 248 ~~~~~~~
 249
 250
 251 Libraries
 252 ~~~~~~~~~
 253
 254
 255 Examples
 256 ~~~~~~~~
 257
 258
 259 Other
 260 ~~~~~
 261
 262
 263 Known Issues
 264 ------------
 265
 266 .. This section should contain new known issues in this release. Sample format:
 267
 268    * **Add title in present tense with full stop.**
 269
 270      Add a short 1-2 sentence description of the known issue in the present
 271      tense. Add information on any known workarounds.
 272
 273    This section is a comment. do not overwrite or remove it.
 274    Also, make sure to start the actual text at the margin.
 275    =========================================================
 276
 277 * **LSC interrupt cannot work for virtio-user + vhost-kernel.**
 278
 279   LSC interrupt cannot be detected when setting the backend, tap device,
 280   up/down as we fail to find a way to monitor such event.
 281
 282
 283 API Changes
 284 -----------
 285
 286 .. This section should contain API changes. Sample format:
 287
 288    * Add a short 1-2 sentence description of the API change. Use fixed width
 289      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
 290      tense.
 291
 292    This section is a comment. do not overwrite or remove it.
 293    Also, make sure to start the actual text at the margin.
 294    =========================================================
 295
 296 * The LPM ``next_hop`` field is extended from 8 bits to 21 bits for IPv6
 297   while keeping ABI compatibility.
 298
 299 * **Reworked rte_ring library**
 300
 301   The rte_ring library has been reworked and updated. The following changes
 302   have been made to it:
 303
 304   * removed the build-time setting ``CONFIG_RTE_RING_SPLIT_PROD_CONS``
 305   * removed the build-time setting ``CONFIG_RTE_LIBRTE_RING_DEBUG``
 306   * removed the build-time setting ``CONFIG_RTE_RING_PAUSE_REP_COUNT``
 307   * removed the function ``rte_ring_set_water_mark`` as part of a general
 308     removal of watermarks support in the library.
 309   * added an extra parameter to the burst/bulk enqueue functions to
 310     return the number of free spaces in the ring after enqueue. This can
 311     be used by an application to implement its own watermark functionality.
 312   * added an extra parameter to the burst/bulk dequeue functions to return
 313     the number elements remaining in the ring after dequeue.
 314   * changed the return value of the enqueue and dequeue bulk functions to
 315     match that of the burst equivalents. In all cases, ring functions which
 316     operate on multiple packets now return the number of elements enqueued
 317     or dequeued, as appropriate. The updated functions are:
 318
 319     - ``rte_ring_mp_enqueue_bulk``
 320     - ``rte_ring_sp_enqueue_bulk``
 321     - ``rte_ring_enqueue_bulk``
 322     - ``rte_ring_mc_dequeue_bulk``
 323     - ``rte_ring_sc_dequeue_bulk``
 324     - ``rte_ring_dequeue_bulk``
 325
 326     NOTE: the above functions all have different parameters as well as
 327     different return values, due to the other listed changes above. This
 328     means that all instances of the functions in existing code will be
 329     flagged by the compiler. The return value usage should be checked
 330     while fixing the compiler error due to the extra parameter.
 331
 332 * **Reworked rte_vhost library**
 333
 334   The rte_vhost library has been reworked to make it generic enough so that
 335   user could build other vhost-user drivers on top of it. To achieve that,
 336   following changes have been made:
 337
 338   * The following vhost-pmd APIs are removed:
 339
 340     * ``rte_eth_vhost_feature_disable``
 341     * ``rte_eth_vhost_feature_enable``
 342     * ``rte_eth_vhost_feature_get``
 343
 344   * The vhost API ``rte_vhost_driver_callback_register(ops)`` is reworked to
 345     be per vhost-user socket file. Thus, it takes one more argument:
 346     ``rte_vhost_driver_callback_register(path, ops)``.
 347
 348   * The vhost API ``rte_vhost_get_queue_num`` is deprecated, instead,
 349     ``rte_vhost_get_vring_num`` should be used.
 350
 351   * Following macros are removed in ``rte_virtio_net.h``
 352
 353     * ``VIRTIO_RXQ``
 354     * ``VIRTIO_TXQ``
 355     * ``VIRTIO_QNUM``
 356
 357   * Following net specific header files are removed in ``rte_virtio_net.h``
 358
 359     * ``linux/virtio_net.h``
 360     * ``sys/socket.h``
 361     * ``linux/if.h``
 362     * ``rte_ether.h``
 363
 364   * The vhost struct ``virtio_net_device_ops`` is renamed to
 365     ``vhost_device_ops``
 366
 367   * The vhost API ``rte_vhost_driver_session_start`` is removed. Instead,
 368     ``rte_vhost_driver_start`` should be used, and no need to create a
 369     thread to call it.
 370
 371   * The vhost public header file ``rte_virtio_net.h`` is renamed to
 372     ``rte_vhost.h``
 373
 374
 375 ABI Changes
 376 -----------
 377
 378 .. This section should contain ABI changes. Sample format:
 379
 380    * Add a short 1-2 sentence description of the ABI change that was announced
 381      in the previous releases and made in this release. Use fixed width quotes
 382      for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 383
 384    This section is a comment. do not overwrite or remove it.
 385    Also, make sure to start the actual text at the margin.
 386    =========================================================
 387
 388 * **Reorganized the mbuf structure.**
 389
 390   The order and size of the fields in the ``mbuf`` structure changed,
 391   as described in the `New Features`_ section.
 392
 393
 394 Removed Items
 395 -------------
 396
 397 .. This section should contain removed items in this release. Sample format:
 398
 399    * Add a short 1-2 sentence description of the removed item in the past
 400      tense.
 401
 402    This section is a comment. do not overwrite or remove it.
 403    Also, make sure to start the actual text at the margin.
 404    =========================================================
 405
 406 * KNI vhost support removed.
 407
 408
 409 Shared Library Versions
 410 -----------------------
 411
 412 .. Update any library version updated in this release and prepend with a ``+``
 413    sign, like this:
 414
 415      librte_acl.so.2
 416    + librte_cfgfile.so.2
 417      librte_cmdline.so.2
 418
 419    This section is a comment. do not overwrite or remove it.
 420    =========================================================
 421
 422
 423 The libraries prepended with a plus sign were incremented in this version.
 424
 425 .. code-block:: diff
 426
 427      librte_acl.so.2
 428      librte_cfgfile.so.2
 429      librte_cmdline.so.2
 430      librte_cryptodev.so.2
 431      librte_distributor.so.1
 432      librte_eal.so.3
 433      librte_ethdev.so.6
 434      librte_hash.so.2
 435      librte_ip_frag.so.1
 436      librte_jobstats.so.1
 437      librte_kni.so.2
 438      librte_kvargs.so.1
 439      librte_lpm.so.2
 440    + librte_mbuf.so.3
 441      librte_mempool.so.2
 442      librte_meter.so.1
 443      librte_net.so.1
 444      librte_pdump.so.1
 445      librte_pipeline.so.3
 446      librte_pmd_bond.so.1
 447      librte_pmd_ring.so.2
 448      librte_port.so.3
 449      librte_power.so.1
 450      librte_reorder.so.1
 451      librte_ring.so.1
 452      librte_sched.so.1
 453      librte_table.so.2
 454      librte_timer.so.1
 455      librte_vhost.so.3
 456
 457
 458 Tested Platforms
 459 ----------------
 460
 461 .. This section should contain a list of platforms that were tested with this
 462    release.
 463
 464    The format is:
 465
 466    * <vendor> platform with <vendor> <type of devices> combinations
 467
 468      * List of CPU
 469      * List of OS
 470      * List of devices
 471      * Other relevant details...
 472
 473    This section is a comment. do not overwrite or remove it.
 474    Also, make sure to start the actual text at the margin.
 475    =========================================================