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