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