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