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