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