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