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
 174 Resolved Issues
 175 ---------------
 176
 177 .. This section should contain bug fixes added to the relevant
 178    sections. Sample format:
 179
 180    * **code/section Fixed issue in the past tense with a full stop.**
 181
 182      Add a short 1-2 sentence description of the resolved issue in the past
 183      tense.
 184
 185      The title should contain the code/lib section like a commit message.
 186
 187      Add the entries in alphabetic order in the relevant sections below.
 188
 189    This section is a comment. do not overwrite or remove it.
 190    Also, make sure to start the actual text at the margin.
 191    =========================================================
 192
 193
 194 EAL
 195 ~~~
 196
 197
 198 Drivers
 199 ~~~~~~~
 200
 201
 202 Libraries
 203 ~~~~~~~~~
 204
 205
 206 Examples
 207 ~~~~~~~~
 208
 209
 210 Other
 211 ~~~~~
 212
 213
 214 Known Issues
 215 ------------
 216
 217 .. This section should contain new known issues in this release. Sample format:
 218
 219    * **Add title in present tense with full stop.**
 220
 221      Add a short 1-2 sentence description of the known issue in the present
 222      tense. Add information on any known workarounds.
 223
 224    This section is a comment. do not overwrite or remove it.
 225    Also, make sure to start the actual text at the margin.
 226    =========================================================
 227
 228 * **LSC interrupt cannot work for virtio-user + vhost-kernel.**
 229
 230   LSC interrupt cannot be detected when setting the backend, tap device,
 231   up/down as we fail to find a way to monitor such event.
 232
 233
 234 API Changes
 235 -----------
 236
 237 .. This section should contain API changes. Sample format:
 238
 239    * Add a short 1-2 sentence description of the API change. Use fixed width
 240      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
 241      tense.
 242
 243    This section is a comment. do not overwrite or remove it.
 244    Also, make sure to start the actual text at the margin.
 245    =========================================================
 246
 247 * The LPM ``next_hop`` field is extended from 8 bits to 21 bits for IPv6
 248   while keeping ABI compatibility.
 249
 250 * **Reworked rte_ring library**
 251
 252   The rte_ring library has been reworked and updated. The following changes
 253   have been made to it:
 254
 255   * removed the build-time setting ``CONFIG_RTE_RING_SPLIT_PROD_CONS``
 256   * removed the build-time setting ``CONFIG_RTE_LIBRTE_RING_DEBUG``
 257   * removed the build-time setting ``CONFIG_RTE_RING_PAUSE_REP_COUNT``
 258   * removed the function ``rte_ring_set_water_mark`` as part of a general
 259     removal of watermarks support in the library.
 260   * added an extra parameter to the burst/bulk enqueue functions to
 261     return the number of free spaces in the ring after enqueue. This can
 262     be used by an application to implement its own watermark functionality.
 263   * added an extra parameter to the burst/bulk dequeue functions to return
 264     the number elements remaining in the ring after dequeue.
 265   * changed the return value of the enqueue and dequeue bulk functions to
 266     match that of the burst equivalents. In all cases, ring functions which
 267     operate on multiple packets now return the number of elements enqueued
 268     or dequeued, as appropriate. The updated functions are:
 269
 270     - ``rte_ring_mp_enqueue_bulk``
 271     - ``rte_ring_sp_enqueue_bulk``
 272     - ``rte_ring_enqueue_bulk``
 273     - ``rte_ring_mc_dequeue_bulk``
 274     - ``rte_ring_sc_dequeue_bulk``
 275     - ``rte_ring_dequeue_bulk``
 276
 277     NOTE: the above functions all have different parameters as well as
 278     different return values, due to the other listed changes above. This
 279     means that all instances of the functions in existing code will be
 280     flagged by the compiler. The return value usage should be checked
 281     while fixing the compiler error due to the extra parameter.
 282
 283 * **Reworked rte_vhost library**
 284
 285   The rte_vhost library has been reworked to make it generic enough so that
 286   user could build other vhost-user drivers on top of it. To achieve that,
 287   following changes have been made:
 288
 289   * The following vhost-pmd APIs are removed:
 290
 291     * ``rte_eth_vhost_feature_disable``
 292     * ``rte_eth_vhost_feature_enable``
 293     * ``rte_eth_vhost_feature_get``
 294
 295   * The vhost API ``rte_vhost_driver_callback_register(ops)`` is reworked to
 296     be per vhost-user socket file. Thus, it takes one more argument:
 297     ``rte_vhost_driver_callback_register(path, ops)``.
 298
 299   * The vhost API ``rte_vhost_get_queue_num`` is deprecated, instead,
 300     ``rte_vhost_get_vring_num`` should be used.
 301
 302   * Following macros are removed in ``rte_virtio_net.h``
 303
 304     * ``VIRTIO_RXQ``
 305     * ``VIRTIO_TXQ``
 306     * ``VIRTIO_QNUM``
 307
 308   * Following net specific header files are removed in ``rte_virtio_net.h``
 309
 310     * ``linux/virtio_net.h``
 311     * ``sys/socket.h``
 312     * ``linux/if.h``
 313     * ``rte_ether.h``
 314
 315   * The vhost struct ``virtio_net_device_ops`` is renamed to
 316     ``vhost_device_ops``
 317
 318   * The vhost API ``rte_vhost_driver_session_start`` is removed. Instead,
 319     ``rte_vhost_driver_start`` should be used, and no need to create a
 320     thread to call it.
 321
 322
 323 ABI Changes
 324 -----------
 325
 326 .. This section should contain ABI changes. Sample format:
 327
 328    * Add a short 1-2 sentence description of the ABI change that was announced
 329      in the previous releases and made in this release. Use fixed width quotes
 330      for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 331
 332    This section is a comment. do not overwrite or remove it.
 333    Also, make sure to start the actual text at the margin.
 334    =========================================================
 335
 336
 337 Removed Items
 338 -------------
 339
 340 .. This section should contain removed items in this release. Sample format:
 341
 342    * Add a short 1-2 sentence description of the removed item in the past
 343      tense.
 344
 345    This section is a comment. do not overwrite or remove it.
 346    Also, make sure to start the actual text at the margin.
 347    =========================================================
 348
 349 * KNI vhost support removed.
 350
 351
 352 Shared Library Versions
 353 -----------------------
 354
 355 .. Update any library version updated in this release and prepend with a ``+``
 356    sign, like this:
 357
 358      librte_acl.so.2
 359    + librte_cfgfile.so.2
 360      librte_cmdline.so.2
 361
 362    This section is a comment. do not overwrite or remove it.
 363    =========================================================
 364
 365
 366 The libraries prepended with a plus sign were incremented in this version.
 367
 368 .. code-block:: diff
 369
 370      librte_acl.so.2
 371      librte_cfgfile.so.2
 372      librte_cmdline.so.2
 373      librte_cryptodev.so.2
 374      librte_distributor.so.1
 375      librte_eal.so.3
 376      librte_ethdev.so.6
 377      librte_hash.so.2
 378      librte_ip_frag.so.1
 379      librte_jobstats.so.1
 380      librte_kni.so.2
 381      librte_kvargs.so.1
 382      librte_lpm.so.2
 383      librte_mbuf.so.2
 384      librte_mempool.so.2
 385      librte_meter.so.1
 386      librte_net.so.1
 387      librte_pdump.so.1
 388      librte_pipeline.so.3
 389      librte_pmd_bond.so.1
 390      librte_pmd_ring.so.2
 391      librte_port.so.3
 392      librte_power.so.1
 393      librte_reorder.so.1
 394      librte_ring.so.1
 395      librte_sched.so.1
 396      librte_table.so.2
 397      librte_timer.so.1
 398      librte_vhost.so.3
 399
 400
 401 Tested Platforms
 402 ----------------
 403
 404 .. This section should contain a list of platforms that were tested with this
 405    release.
 406
 407    The format is:
 408
 409    * <vendor> platform with <vendor> <type of devices> combinations
 410
 411      * List of CPU
 412      * List of OS
 413      * List of devices
 414      * Other relevant details...
 415
 416    This section is a comment. do not overwrite or remove it.
 417    Also, make sure to start the actual text at the margin.
 418    =========================================================