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
 165 Resolved Issues
 166 ---------------
 167
 168 .. This section should contain bug fixes added to the relevant
 169    sections. Sample format:
 170
 171    * **code/section Fixed issue in the past tense with a full stop.**
 172
 173      Add a short 1-2 sentence description of the resolved issue in the past
 174      tense.
 175
 176      The title should contain the code/lib section like a commit message.
 177
 178      Add the entries in alphabetic order in the relevant sections below.
 179
 180    This section is a comment. do not overwrite or remove it.
 181    Also, make sure to start the actual text at the margin.
 182    =========================================================
 183
 184
 185 EAL
 186 ~~~
 187
 188
 189 Drivers
 190 ~~~~~~~
 191
 192
 193 Libraries
 194 ~~~~~~~~~
 195
 196
 197 Examples
 198 ~~~~~~~~
 199
 200
 201 Other
 202 ~~~~~
 203
 204
 205 Known Issues
 206 ------------
 207
 208 .. This section should contain new known issues in this release. Sample format:
 209
 210    * **Add title in present tense with full stop.**
 211
 212      Add a short 1-2 sentence description of the known issue in the present
 213      tense. Add information on any known workarounds.
 214
 215    This section is a comment. do not overwrite or remove it.
 216    Also, make sure to start the actual text at the margin.
 217    =========================================================
 218
 219
 220 API Changes
 221 -----------
 222
 223 .. This section should contain API changes. Sample format:
 224
 225    * Add a short 1-2 sentence description of the API change. Use fixed width
 226      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
 227      tense.
 228
 229    This section is a comment. do not overwrite or remove it.
 230    Also, make sure to start the actual text at the margin.
 231    =========================================================
 232
 233 * The LPM ``next_hop`` field is extended from 8 bits to 21 bits for IPv6
 234   while keeping ABI compatibility.
 235
 236 * **Reworked rte_ring library**
 237
 238   The rte_ring library has been reworked and updated. The following changes
 239   have been made to it:
 240
 241   * removed the build-time setting ``CONFIG_RTE_RING_SPLIT_PROD_CONS``
 242   * removed the build-time setting ``CONFIG_RTE_LIBRTE_RING_DEBUG``
 243   * removed the build-time setting ``CONFIG_RTE_RING_PAUSE_REP_COUNT``
 244   * removed the function ``rte_ring_set_water_mark`` as part of a general
 245     removal of watermarks support in the library.
 246   * added an extra parameter to the burst/bulk enqueue functions to
 247     return the number of free spaces in the ring after enqueue. This can
 248     be used by an application to implement its own watermark functionality.
 249   * added an extra parameter to the burst/bulk dequeue functions to return
 250     the number elements remaining in the ring after dequeue.
 251   * changed the return value of the enqueue and dequeue bulk functions to
 252     match that of the burst equivalents. In all cases, ring functions which
 253     operate on multiple packets now return the number of elements enqueued
 254     or dequeued, as appropriate. The updated functions are:
 255
 256     - ``rte_ring_mp_enqueue_bulk``
 257     - ``rte_ring_sp_enqueue_bulk``
 258     - ``rte_ring_enqueue_bulk``
 259     - ``rte_ring_mc_dequeue_bulk``
 260     - ``rte_ring_sc_dequeue_bulk``
 261     - ``rte_ring_dequeue_bulk``
 262
 263     NOTE: the above functions all have different parameters as well as
 264     different return values, due to the other listed changes above. This
 265     means that all instances of the functions in existing code will be
 266     flagged by the compiler. The return value usage should be checked
 267     while fixing the compiler error due to the extra parameter.
 268
 269 ABI Changes
 270 -----------
 271
 272 .. This section should contain ABI changes. Sample format:
 273
 274    * Add a short 1-2 sentence description of the ABI change that was announced
 275      in the previous releases and made in this release. Use fixed width quotes
 276      for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 277
 278    This section is a comment. do not overwrite or remove it.
 279    Also, make sure to start the actual text at the margin.
 280    =========================================================
 281
 282
 283 Removed Items
 284 -------------
 285
 286 .. This section should contain removed items in this release. Sample format:
 287
 288    * Add a short 1-2 sentence description of the removed item in the past
 289      tense.
 290
 291    This section is a comment. do not overwrite or remove it.
 292    Also, make sure to start the actual text at the margin.
 293    =========================================================
 294
 295 * KNI vhost support removed.
 296
 297
 298 Shared Library Versions
 299 -----------------------
 300
 301 .. Update any library version updated in this release and prepend with a ``+``
 302    sign, like this:
 303
 304      librte_acl.so.2
 305    + librte_cfgfile.so.2
 306      librte_cmdline.so.2
 307
 308    This section is a comment. do not overwrite or remove it.
 309    =========================================================
 310
 311
 312 The libraries prepended with a plus sign were incremented in this version.
 313
 314 .. code-block:: diff
 315
 316      librte_acl.so.2
 317      librte_cfgfile.so.2
 318      librte_cmdline.so.2
 319      librte_cryptodev.so.2
 320      librte_distributor.so.1
 321      librte_eal.so.3
 322      librte_ethdev.so.6
 323      librte_hash.so.2
 324      librte_ip_frag.so.1
 325      librte_jobstats.so.1
 326      librte_kni.so.2
 327      librte_kvargs.so.1
 328      librte_lpm.so.2
 329      librte_mbuf.so.2
 330      librte_mempool.so.2
 331      librte_meter.so.1
 332      librte_net.so.1
 333      librte_pdump.so.1
 334      librte_pipeline.so.3
 335      librte_pmd_bond.so.1
 336      librte_pmd_ring.so.2
 337      librte_port.so.3
 338      librte_power.so.1
 339      librte_reorder.so.1
 340      librte_ring.so.1
 341      librte_sched.so.1
 342      librte_table.so.2
 343      librte_timer.so.1
 344      librte_vhost.so.3
 345
 346
 347 Tested Platforms
 348 ----------------
 349
 350 .. This section should contain a list of platforms that were tested with this
 351    release.
 352
 353    The format is:
 354
 355    * <vendor> platform with <vendor> <type of devices> combinations
 356
 357      * List of CPU
 358      * List of OS
 359      * List of devices
 360      * Other relevant details...
 361
 362    This section is a comment. do not overwrite or remove it.
 363    Also, make sure to start the actual text at the margin.
 364    =========================================================