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