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