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