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