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 TSO support for tunneled and non-tunneled packets on mlx5 driver.**
 110
 111   Added support for Hardware TSO for tunneled and non-tunneled packets.
 112   Tunneling protocols supported are GRE and VXLAN.
 113
 114 * **Added support for Rx interrupts on mlx5 driver.**
 115
 116   Rx queues can be armed with an interrupt which will trigger on the
 117   next packet arrival.
 118
 119 * **Updated the sfc_efx driver.**
 120
 121   * Generic flow API support for Ethernet, VLAN, IPv4, IPv6, UDP and TCP
 122     pattern items with QUEUE action for ingress traffic.
 123
 124   * Support virtual functions (VFs)
 125
 126 * **Added LiquidIO network PMD.**
 127
 128   Added poll mode driver support for Cavium LiquidIO II server adapter VFs.
 129
 130 * **Added support for the Wind River Systems AVP PMD.**
 131
 132   Added a new networking driver for the AVP device type. Theses devices are
 133   specific to the Wind River Systems virtualization platforms.
 134
 135 * **Added vmxnet3 version 3 support.**
 136
 137   Added support for vmxnet3 version 3 which includes several
 138   performance enhancements viz. configurable TX data ring, Receive
 139   Data Ring, ability to register memory regions.
 140
 141 * **Updated the tap driver.**
 142
 143   * Support MTU modification.
 144   * Support packet type for Rx.
 145   * Support segmented packets on Rx and Tx.
 146   * Speed up Rx on tap when no packets are available.
 147   * Support capturing traffic from another netdevice.
 148   * Dynamically change link status when the underlying interface state changes.
 149   * Generic flow API support for Ethernet, VLAN, IPv4, IPv6, UDP and TCP pattern
 150     items with DROP, QUEUE and PASSTHRU actions for ingress traffic.
 151
 152
 153 Resolved Issues
 154 ---------------
 155
 156 .. This section should contain bug fixes added to the relevant
 157    sections. Sample format:
 158
 159    * **code/section Fixed issue in the past tense with a full stop.**
 160
 161      Add a short 1-2 sentence description of the resolved issue in the past
 162      tense.
 163
 164      The title should contain the code/lib section like a commit message.
 165
 166      Add the entries in alphabetic order in the relevant sections below.
 167
 168    This section is a comment. do not overwrite or remove it.
 169    Also, make sure to start the actual text at the margin.
 170    =========================================================
 171
 172
 173 EAL
 174 ~~~
 175
 176
 177 Drivers
 178 ~~~~~~~
 179
 180
 181 Libraries
 182 ~~~~~~~~~
 183
 184
 185 Examples
 186 ~~~~~~~~
 187
 188
 189 Other
 190 ~~~~~
 191
 192
 193 Known Issues
 194 ------------
 195
 196 .. This section should contain new known issues in this release. Sample format:
 197
 198    * **Add title in present tense with full stop.**
 199
 200      Add a short 1-2 sentence description of the known issue in the present
 201      tense. Add information on any known workarounds.
 202
 203    This section is a comment. do not overwrite or remove it.
 204    Also, make sure to start the actual text at the margin.
 205    =========================================================
 206
 207
 208 API Changes
 209 -----------
 210
 211 .. This section should contain API changes. Sample format:
 212
 213    * Add a short 1-2 sentence description of the API change. Use fixed width
 214      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
 215      tense.
 216
 217    This section is a comment. do not overwrite or remove it.
 218    Also, make sure to start the actual text at the margin.
 219    =========================================================
 220
 221 * The LPM ``next_hop`` field is extended from 8 bits to 21 bits for IPv6
 222   while keeping ABI compatibility.
 223
 224 * **Reworked rte_ring library**
 225
 226   The rte_ring library has been reworked and updated. The following changes
 227   have been made to it:
 228
 229   * removed the build-time setting ``CONFIG_RTE_RING_SPLIT_PROD_CONS``
 230   * removed the build-time setting ``CONFIG_RTE_LIBRTE_RING_DEBUG``
 231   * removed the build-time setting ``CONFIG_RTE_RING_PAUSE_REP_COUNT``
 232   * removed the function ``rte_ring_set_water_mark`` as part of a general
 233     removal of watermarks support in the library.
 234   * added an extra parameter to the burst/bulk enqueue functions to
 235     return the number of free spaces in the ring after enqueue. This can
 236     be used by an application to implement its own watermark functionality.
 237   * added an extra parameter to the burst/bulk dequeue functions to return
 238     the number elements remaining in the ring after dequeue.
 239   * changed the return value of the enqueue and dequeue bulk functions to
 240     match that of the burst equivalents. In all cases, ring functions which
 241     operate on multiple packets now return the number of elements enqueued
 242     or dequeued, as appropriate. The updated functions are:
 243
 244     - ``rte_ring_mp_enqueue_bulk``
 245     - ``rte_ring_sp_enqueue_bulk``
 246     - ``rte_ring_enqueue_bulk``
 247     - ``rte_ring_mc_dequeue_bulk``
 248     - ``rte_ring_sc_dequeue_bulk``
 249     - ``rte_ring_dequeue_bulk``
 250
 251     NOTE: the above functions all have different parameters as well as
 252     different return values, due to the other listed changes above. This
 253     means that all instances of the functions in existing code will be
 254     flagged by the compiler. The return value usage should be checked
 255     while fixing the compiler error due to the extra parameter.
 256
 257 ABI Changes
 258 -----------
 259
 260 .. This section should contain ABI changes. Sample format:
 261
 262    * Add a short 1-2 sentence description of the ABI change that was announced
 263      in the previous releases and made in this release. Use fixed width quotes
 264      for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 265
 266    This section is a comment. do not overwrite or remove it.
 267    Also, make sure to start the actual text at the margin.
 268    =========================================================
 269
 270
 271 Removed Items
 272 -------------
 273
 274 .. This section should contain removed items in this release. Sample format:
 275
 276    * Add a short 1-2 sentence description of the removed item in the past
 277      tense.
 278
 279    This section is a comment. do not overwrite or remove it.
 280    Also, make sure to start the actual text at the margin.
 281    =========================================================
 282
 283 * KNI vhost support removed.
 284
 285
 286 Shared Library Versions
 287 -----------------------
 288
 289 .. Update any library version updated in this release and prepend with a ``+``
 290    sign, like this:
 291
 292      librte_acl.so.2
 293    + librte_cfgfile.so.2
 294      librte_cmdline.so.2
 295
 296    This section is a comment. do not overwrite or remove it.
 297    =========================================================
 298
 299
 300 The libraries prepended with a plus sign were incremented in this version.
 301
 302 .. code-block:: diff
 303
 304      librte_acl.so.2
 305      librte_cfgfile.so.2
 306      librte_cmdline.so.2
 307      librte_cryptodev.so.2
 308      librte_distributor.so.1
 309      librte_eal.so.3
 310      librte_ethdev.so.6
 311      librte_hash.so.2
 312      librte_ip_frag.so.1
 313      librte_jobstats.so.1
 314      librte_kni.so.2
 315      librte_kvargs.so.1
 316      librte_lpm.so.2
 317      librte_mbuf.so.2
 318      librte_mempool.so.2
 319      librte_meter.so.1
 320      librte_net.so.1
 321      librte_pdump.so.1
 322      librte_pipeline.so.3
 323      librte_pmd_bond.so.1
 324      librte_pmd_ring.so.2
 325      librte_port.so.3
 326      librte_power.so.1
 327      librte_reorder.so.1
 328      librte_ring.so.1
 329      librte_sched.so.1
 330      librte_table.so.2
 331      librte_timer.so.1
 332      librte_vhost.so.3
 333
 334
 335 Tested Platforms
 336 ----------------
 337
 338 .. This section should contain a list of platforms that were tested with this
 339    release.
 340
 341    The format is:
 342
 343    * <vendor> platform with <vendor> <type of devices> combinations
 344
 345      * List of CPU
 346      * List of OS
 347      * List of devices
 348      * Other relevant details...
 349
 350    This section is a comment. do not overwrite or remove it.
 351    Also, make sure to start the actual text at the margin.
 352    =========================================================