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